eventespresso / event-espresso-core

modules/add_new_state/EED_Add_New_State.module.php

Indentation +738 added lines, -738 removed lines

@@ -22,744 +22,744 @@
 
 
 
-    /**
-     * @return EED_Module|EED_Add_New_State
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks()
-    {
-        add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
-        add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'translate_js_strings'), 0);
-        add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'wp_enqueue_scripts'), 10);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
-        add_filter('FHEE__EE_State_Select_Input____construct__state_options',
-            array('EED_Add_New_State', 'state_options'), 10, 1);
-        add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
-            array('EED_Add_New_State', 'country_options'), 10, 1);
-    }
-
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-            array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
-        add_action('wp_ajax_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
-        add_action('wp_ajax_nopriv_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
-        add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-            array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
-        add_action('AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
-            array('EED_Add_New_State', 'update_country_settings'), 10, 3);
-        add_action('AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
-            array('EED_Add_New_State', 'update_country_settings'), 10, 3);
-        add_filter('FHEE__EE_State_Select_Input____construct__state_options',
-            array('EED_Add_New_State', 'state_options'), 10, 1);
-        add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
-            array('EED_Add_New_State', 'country_options'), 10, 1);
-        add_filter('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
-            array('EED_Add_New_State', 'filter_checkout_request_params'), 10, 1);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
-        add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function set_definitions()
-    {
-        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
-        define('ANS_TEMPLATES_PATH', str_replace(
-                                         '\\',
-                                         DS,
-                                         plugin_dir_path(__FILE__)) . 'templates' . DS
-        );
-    }
-
-
-
-    /**
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['ans_no_country']        = esc_html__(
-            'In order to proceed, you need to select the Country that your State/Province belongs to.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_no_name']           = esc_html__(
-            'In order to proceed, you need to enter the name of your State/Province.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_no_abbreviation']   = esc_html__(
-            'In order to proceed, you need to enter an abbreviation for the name of your State/Province.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_save_success']      = esc_html__(
-            'The new state was successfully saved to the database.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['ans_server_save_error'] = esc_html__(
-            'An unknown error has occurred on the server while saving the new state to the database.',
-            'event_espresso'
-        );
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public static function wp_enqueue_scripts()
-    {
-        if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
-            wp_register_script('add_new_state', ANS_ASSETS_URL . 'add_new_state.js',
-                array('espresso_core', 'single_page_checkout'), EVENT_ESPRESSO_VERSION, true);
-            wp_enqueue_script('add_new_state');
-        }
-    }
-
-
-
-    /**
-     * display_add_new_state_micro_form
-     *
-     * @param EE_Form_Section_Proper $question_group_reg_form
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    //	public static function display_add_new_state_micro_form( $html, EE_Form_Input_With_Options_Base $input ){
-    public static function display_add_new_state_micro_form(EE_Form_Section_Proper $question_group_reg_form)
-    {
-        // only add the 'new_state_micro_form' when displaying reg forms,
-        // not during processing since we process the 'new_state_micro_form' in it's own AJAX request
-        $action = EE_Registry::instance()->REQ->get('action', '');
-        // is the "state" question in this form section?
-        $input = $question_group_reg_form->get_subsection('state');
-        if ($action === 'process_reg_step' || $action === 'update_reg_step') {
-            //ok then all we need to do is make sure the input's HTML name is consistent
-            //by forcing it to set it now, like it did while getting the form for display
-            if ($input instanceof EE_State_Select_Input) {
-                $input->html_name();
-            }
-            return $question_group_reg_form;
-        }
-        // we're only doing this for state select inputs
-        if ($input instanceof EE_State_Select_Input && ! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
-            // grab any set values from the request
-            $country_name        = str_replace('state', 'nsmf_new_state_country', $input->html_name());
-            $state_name          = str_replace('state', 'nsmf_new_state_name', $input->html_name());
-            $abbrv_name          = str_replace('state', 'nsmf_new_state_abbrv', $input->html_name());
-            $new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
-            $country_options     = array();
-            $countries           = EEM_Country::instance()->get_all_countries();
-            if (! empty($countries)) {
-                foreach ($countries as $country) {
-                    if ($country instanceof EE_Country) {
-                        $country_options[$country->ID()] = $country->name();
-                    }
-                }
-            }
-            $new_state_micro_form = new EE_Form_Section_Proper(
-                array(
-                    'name'            => 'new_state_micro_form',
-                    'html_id'         => 'new_state_micro_form',
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'subsections'     => array(
-                        // add hidden input to indicate that a new state is being added
-                        'add_new_state'               => new EE_Hidden_Input(
-                            array(
-                                'html_name' => str_replace(
-                                    'state',
-                                    'nsmf_add_new_state',
-                                    $input->html_name()
-                                ),
-                                'html_id'   => str_replace(
-                                    'state',
-                                    'nsmf_add_new_state',
-                                    $input->html_id()
-                                ),
-                                'default'   => 0,
-                            )
-                        ),
-                        // add link for displaying hidden container
-                        'click_here_link'             => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__click_here_link',
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('click here to add a new state/province', 'event_espresso'),
-                                    '',
-                                    'display-' . $input->html_id(),
-                                    'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
-                                    '',
-                                    'data-target="' . $input->html_id() . '"'
-                                )
-                            )
-                        ),
-                        // add initial html for hidden container
-                        'add_new_state_micro_form'    => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
-                                EEH_HTML::div('', $input->html_id() . '-dv', 'ee-form-add-new-state-dv',
-                                    'display: none;') .
-                                EEH_HTML::h6(
-                                    esc_html__(
-                                        'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::ul() .
-                                EEH_HTML::li(
-                                    esc_html__(
-                                        'first select the Country that your State/Province belongs to',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::li(
-                                    esc_html__('enter the name of your State/Province', 'event_espresso')
-                                ) .
-                                EEH_HTML::li(
-                                    esc_html__(
-                                        'enter a two to six letter abbreviation for the name of your State/Province',
-                                        'event_espresso'
-                                    )
-                                ) .
-                                EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
-                                EEH_HTML::ulx()
-                            )
-                        ),
-                        // NEW STATE COUNTRY
-                        'new_state_country'           => new EE_Country_Select_Input(
-                            $country_options,
-                            array(
-                                'html_name'       => $country_name,
-                                'html_id'         => str_replace(
-                                    'state',
-                                    'nsmf_new_state_country', $input->html_id()
-                                ),
-                                'html_class'      => $input->html_class() . ' new-state-country',
-                                'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
-                                'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
-                                'required'        => false,
-                            )
-                        ),
-                        // NEW STATE NAME
-                        'new_state_name'              => new EE_Text_Input(
-                            array(
-                                'html_name'       => $state_name,
-                                'html_id'         => str_replace(
-                                    'state',
-                                    'nsmf_new_state_name', $input->html_id()
-                                ),
-                                'html_class'      => $input->html_class() . ' new-state-state',
-                                'html_label_text' => esc_html__('New State/Province Name',
-                                    'event_espresso'),
-                                'default'         => EE_Registry::instance()->REQ->get($state_name, ''),
-                                'required'        => false,
-                            )
-                        ),
-                        'spacer'                      => new EE_Form_Section_HTML(EEH_HTML::br()),
-                        // NEW STATE NAME
-                        'new_state_abbrv'             => new EE_Text_Input(
-                            array(
-                                'html_name'             => $abbrv_name,
-                                'html_id'               => str_replace('state', 'nsmf_new_state_abbrv',
-                                    $input->html_id()),
-                                'html_class'            => $input->html_class() . ' new-state-abbrv',
-                                'html_label_text'       => esc_html__(
-                                                               'New State/Province Abbreviation',
-                                                               'event_espresso'
-                                                           ) . ' *',
-                                'html_other_attributes' => 'size="24"',
-                                'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
-                                'required'              => false,
-                            )
-                        ),
-                        // "submit" button
-                        'add_new_state_submit_button' => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
-                                EEH_HTML::nbsp(3) .
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('ADD', 'event_espresso'),
-                                    '',
-                                    'submit-' . $new_state_submit_id,
-                                    'ee-form-add-new-state-submit button button-secondary',
-                                    '',
-                                    'data-target="' . $new_state_submit_id . '"'
-                                )
-                            )
-                        ),
-                        // extra info
-                        'add_new_state_extra'         => new EE_Form_Section_HTML(
-                            apply_filters(
-                                'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_extra',
-                                EEH_HTML::br(2)
-                                .
-                                EEH_HTML::div('', '', 'small-text')
-                                .
-                                EEH_HTML::strong(
-                                    '* ' .
-                                    esc_html__(
-                                        'Don\'t know your State/Province Abbreviation?',
-                                        'event_espresso'
-                                    )
-                                )
-                                .
-                                EEH_HTML::br()
-                                .
-                                sprintf(
-                                    esc_html__(
-                                        'You can look here: %s, for a list of Countries and links to their State/Province Abbreviations ("Subdivisions assigned codes" column).',
-                                        'event_espresso'
-                                    ),
-                                    EEH_HTML::link(
-                                        'http://en.wikipedia.org/wiki/ISO_3166-2',
-                                        'http://en.wikipedia.org/wiki/ISO_3166-2',
-                                        '',
-                                        '',
-                                        'ee-form-add-new-state-wiki-lnk',
-                                        '',
-                                        'target="_blank"'
-                                    )
-                                )
-                                .
-                                EEH_HTML::divx()
-                                .
-                                EEH_HTML::br()
-                                .
-                                EEH_HTML::link(
-                                    '',
-                                    esc_html__('cancel new State/Province', 'event_espresso'),
-                                    '',
-                                    'hide-' . $input->html_id(),
-                                    'ee-form-cancel-new-state-lnk smaller-text',
-                                    '',
-                                    'data-target="' . $input->html_id() . '"'
-                                )
-                                .
-                                EEH_HTML::divx()
-                                .
-                                EEH_HTML::br()
-                            )
-                        ),
-                    ),
-                )
-            );
-            $question_group_reg_form->add_subsections(
-                array('new_state_micro_form' => $new_state_micro_form),
-                'state',
-                false
-            );
-        }
-        return $question_group_reg_form;
-    }
-
-
-
-    /**
-     * set_new_state_input_width
-     *
-     * @return int|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function add_new_state()
-    {
-        $REQ = EE_Registry::instance()->load_core('Request_Handler');
-        if (absint($REQ->get('nsmf_add_new_state')) === 1) {
-            EE_Registry::instance()->load_model('State');
-            // grab country ISO code, new state name, and new state abbreviation
-            $state_country = $REQ->is_set('nsmf_new_state_country')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_country'))
-                : false;
-            $state_name    = $REQ->is_set('nsmf_new_state_name')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_name'))
-                : false;
-            $state_abbr    = $REQ->is_set('nsmf_new_state_abbrv')
-                ? sanitize_text_field($REQ->get('nsmf_new_state_abbrv'))
-                : false;
-            if ($state_country && $state_name && $state_abbr) {
-                $new_state = EED_Add_New_State::save_new_state_to_db(array(
-                    'CNT_ISO'    => strtoupper($state_country),
-                    'STA_abbrev' => strtoupper($state_abbr),
-                    'STA_name'   => ucwords($state_name),
-                    'STA_active' => false,
-                ));
-                if ($new_state instanceof EE_State) {
-                    // clean house
-                    EE_Registry::instance()->REQ->un_set('nsmf_add_new_state');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_country');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_name');
-                    EE_Registry::instance()->REQ->un_set('nsmf_new_state_abbrv');
-                    // get any existing new states
-                    $new_states                   = EE_Registry::instance()->SSN->get_session_data(
-                        'nsmf_new_states'
-                    );
-                    $new_states[$new_state->ID()] = $new_state;
-                    EE_Registry::instance()->SSN->set_session_data(
-                        array('nsmf_new_states' => $new_states)
-                    );
-                    if (EE_Registry::instance()->REQ->ajax) {
-                        echo wp_json_encode(array(
-                            'success'      => true,
-                            'id'           => $new_state->ID(),
-                            'name'         => $new_state->name(),
-                            'abbrev'       => $new_state->abbrev(),
-                            'country_iso'  => $new_state->country_iso(),
-                            'country_name' => $new_state->country()->name(),
-                        ));
-                        exit();
-                    }
-                    return $new_state->ID();
-                }
-            } else {
-                $error = esc_html__(
-                    'A new State/Province could not be added because invalid or missing data was received.',
-                    'event_espresso'
-                );
-                if (EE_Registry::instance()->REQ->ajax) {
-                    echo wp_json_encode(array('error' => $error));
-                    exit();
-                }
-                EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * recursively drills down through request params to remove any that were added by this module
-     *
-     * @param array $request_params
-     * @return array
-     */
-    public static function filter_checkout_request_params($request_params)
-    {
-        foreach ($request_params as $form_section) {
-            if (is_array($form_section)) {
-                EED_Add_New_State::unset_new_state_request_params($form_section);
-                EED_Add_New_State::filter_checkout_request_params($form_section);
-            }
-        }
-        return $request_params;
-    }
-
-
-
-    /**
-     * @param array $request_params
-     * @return array
-     */
-    public static function unset_new_state_request_params($request_params)
-    {
-        unset(
-            $request_params['new_state_micro_form'],
-            $request_params['new_state_micro_add_new_state'],
-            $request_params['new_state_micro_new_state_country'],
-            $request_params['new_state_micro_new_state_name'],
-            $request_params['new_state_micro_new_state_abbrv']
-        );
-        return $request_params;
-    }
-
-
-
-    /**
-     * @param array $props_n_values
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function save_new_state_to_db($props_n_values = array())
-    {
-        $existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
-        if (! empty($existing_state)) {
-            return array_pop($existing_state);
-        }
-        $new_state = EE_State::new_instance($props_n_values);
-        if ($new_state instanceof EE_State) {
-            $country_settings_url = add_query_arg(
-                array(
-                    'page'    => 'espresso_general_settings',
-                    'action'  => 'country_settings',
-                    'country' => $new_state->country_iso(),
-                ),
-                admin_url('admin.php')
-            );
-            // if not non-ajax admin
-            new PersistentAdminNotice(
-                'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev(),
-                sprintf(
-                    esc_html__(
-                        'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
-                        'event_espresso'
-                    ),
-                    '<b>' . $new_state->name() . '</b>',
-                    '<b>' . $new_state->abbrev() . '</b>',
-                    '<b>' . $new_state->country()->name() . '</b>',
-                    '<a href="'
-                    . $country_settings_url
-                    . '">'
-                    . esc_html__('Event Espresso - General Settings > Countries Tab',
-                        'event_espresso')
-                    . '</a>',
-                    '<br />'
-                )
-            );
-            $new_state->save();
-            EEM_State::instance()->reset_cached_states();
-            return $new_state;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @param string $CNT_ISO
-     * @param string $STA_ID
-     * @param array  $cols_n_values
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
-    {
-        if (! $CNT_ISO) {
-            EE_Error::add_error(
-                esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
-            : false;
-        if (! $STA_abbrev && ! empty($STA_ID)) {
-            $state = EEM_State::instance()->get_one_by_ID($STA_ID);
-            if ($state instanceof EE_State) {
-                $STA_abbrev = $state->abbrev();
-            }
-        }
-        if (! $STA_abbrev) {
-            EE_Error::add_error(
-                esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $persistent_admin_notice_manager->dismissNotice($CNT_ISO . '-' . $STA_abbrev, true, true);
-    }
-
-
-
-    /**
-     * @param EE_State[]                            $state_options
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EE_Registration                       $registration
-     * @param EE_Question                           $question
-     * @param                                       $answer
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function inject_new_reg_state_into_options(
-        $state_options = array(),
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration $registration,
-        EE_Question $question,
-        $answer
-    ) {
-        if ($answer instanceof EE_Answer && $question instanceof EE_Question
-            && $question->type() === EEM_Question::QST_type_state
-        ) {
-            $STA_ID = $answer->value();
-            if (! empty($STA_ID)) {
-                $state = EEM_State::instance()->get_one_by_ID($STA_ID);
-                if ($state instanceof EE_State) {
-                    $country = $state->country();
-                    if ($country instanceof EE_Country) {
-                        if (! isset($state_options[$country->name()])) {
-                            $state_options[$country->name()] = array();
-                        }
-                        if (! isset($state_options[$country->name()][$STA_ID])) {
-                            $state_options[$country->name()][$STA_ID] = $state->name();
-                        }
-                    }
-                }
-            }
-        }
-        return $state_options;
-    }
-
-
-
-    /**
-     * @param EE_Country[]                          $country_options
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EE_Registration                       $registration
-     * @param EE_Question                           $question
-     * @param                                       $answer
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function inject_new_reg_country_into_options(
-        $country_options = array(),
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EE_Registration $registration,
-        EE_Question $question,
-        $answer
-    ) {
-        if ($answer instanceof EE_Answer && $question instanceof EE_Question
-            && $question->type()
-               === EEM_Question::QST_type_country
-        ) {
-            $CNT_ISO = $answer->value();
-            if (! empty($CNT_ISO)) {
-                $country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
-                if ($country instanceof EE_Country) {
-                    if (! isset($country_options[$CNT_ISO])) {
-                        $country_options[$CNT_ISO] = $country->name();
-                    }
-                }
-            }
-        }
-        return $country_options;
-    }
-
-
-
-    /**
-     * @param EE_State[] $state_options
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function state_options($state_options = array())
-    {
-        $new_states = EED_Add_New_State::_get_new_states();
-        foreach ($new_states as $new_state) {
-            if (
-                $new_state instanceof EE_State
-                && $new_state->country() instanceof EE_Country
-            ) {
-                $state_options[$new_state->country()->name()][$new_state->ID()] = $new_state->name();
-            }
-        }
-        return $state_options;
-    }
-
-
-
-    /**
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_new_states()
-    {
-        $new_states = array();
-        if (EE_Registry::instance()->SSN instanceof EE_Session) {
-            $new_states = EE_Registry::instance()->SSN->get_session_data(
-                'nsmf_new_states'
-            );
-        }
-        return is_array($new_states) ? $new_states : array();
-    }
-
-
-
-    /**
-     * @param EE_Country[] $country_options
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function country_options($country_options = array())
-    {
-        $new_states = EED_Add_New_State::_get_new_states();
-        foreach ($new_states as $new_state) {
-            if (
-                $new_state instanceof EE_State
-                && $new_state->country() instanceof EE_Country
-            ) {
-                $country_options[$new_state->country()->ID()] = $new_state->country()->name();
-            }
-        }
-        return $country_options;
-    }
+	/**
+	 * @return EED_Module|EED_Add_New_State
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks()
+	{
+		add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
+		add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'translate_js_strings'), 0);
+		add_action('wp_enqueue_scripts', array('EED_Add_New_State', 'wp_enqueue_scripts'), 10);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
+		add_filter('FHEE__EE_State_Select_Input____construct__state_options',
+			array('EED_Add_New_State', 'state_options'), 10, 1);
+		add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
+			array('EED_Add_New_State', 'country_options'), 10, 1);
+	}
+
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		add_action('wp_loaded', array('EED_Add_New_State', 'set_definitions'), 2);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+			array('EED_Add_New_State', 'display_add_new_state_micro_form'), 1, 1);
+		add_action('wp_ajax_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
+		add_action('wp_ajax_nopriv_espresso_add_new_state', array('EED_Add_New_State', 'add_new_state'));
+		add_filter('FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+			array('EED_Add_New_State', 'unset_new_state_request_params'), 10, 1);
+		add_action('AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
+			array('EED_Add_New_State', 'update_country_settings'), 10, 3);
+		add_action('AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
+			array('EED_Add_New_State', 'update_country_settings'), 10, 3);
+		add_filter('FHEE__EE_State_Select_Input____construct__state_options',
+			array('EED_Add_New_State', 'state_options'), 10, 1);
+		add_filter('FHEE__EE_Country_Select_Input____construct__country_options',
+			array('EED_Add_New_State', 'country_options'), 10, 1);
+		add_filter('FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
+			array('EED_Add_New_State', 'filter_checkout_request_params'), 10, 1);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			array('EED_Add_New_State', 'inject_new_reg_state_into_options'), 10, 5);
+		add_filter('FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			array('EED_Add_New_State', 'inject_new_reg_country_into_options'), 10, 5);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function set_definitions()
+	{
+		define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets' . DS);
+		define('ANS_TEMPLATES_PATH', str_replace(
+										 '\\',
+										 DS,
+										 plugin_dir_path(__FILE__)) . 'templates' . DS
+		);
+	}
+
+
+
+	/**
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['ans_no_country']        = esc_html__(
+			'In order to proceed, you need to select the Country that your State/Province belongs to.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_no_name']           = esc_html__(
+			'In order to proceed, you need to enter the name of your State/Province.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_no_abbreviation']   = esc_html__(
+			'In order to proceed, you need to enter an abbreviation for the name of your State/Province.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_save_success']      = esc_html__(
+			'The new state was successfully saved to the database.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['ans_server_save_error'] = esc_html__(
+			'An unknown error has occurred on the server while saving the new state to the database.',
+			'event_espresso'
+		);
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public static function wp_enqueue_scripts()
+	{
+		if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
+			wp_register_script('add_new_state', ANS_ASSETS_URL . 'add_new_state.js',
+				array('espresso_core', 'single_page_checkout'), EVENT_ESPRESSO_VERSION, true);
+			wp_enqueue_script('add_new_state');
+		}
+	}
+
+
+
+	/**
+	 * display_add_new_state_micro_form
+	 *
+	 * @param EE_Form_Section_Proper $question_group_reg_form
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	//	public static function display_add_new_state_micro_form( $html, EE_Form_Input_With_Options_Base $input ){
+	public static function display_add_new_state_micro_form(EE_Form_Section_Proper $question_group_reg_form)
+	{
+		// only add the 'new_state_micro_form' when displaying reg forms,
+		// not during processing since we process the 'new_state_micro_form' in it's own AJAX request
+		$action = EE_Registry::instance()->REQ->get('action', '');
+		// is the "state" question in this form section?
+		$input = $question_group_reg_form->get_subsection('state');
+		if ($action === 'process_reg_step' || $action === 'update_reg_step') {
+			//ok then all we need to do is make sure the input's HTML name is consistent
+			//by forcing it to set it now, like it did while getting the form for display
+			if ($input instanceof EE_State_Select_Input) {
+				$input->html_name();
+			}
+			return $question_group_reg_form;
+		}
+		// we're only doing this for state select inputs
+		if ($input instanceof EE_State_Select_Input && ! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+			// grab any set values from the request
+			$country_name        = str_replace('state', 'nsmf_new_state_country', $input->html_name());
+			$state_name          = str_replace('state', 'nsmf_new_state_name', $input->html_name());
+			$abbrv_name          = str_replace('state', 'nsmf_new_state_abbrv', $input->html_name());
+			$new_state_submit_id = str_replace('state', 'new_state', $input->html_id());
+			$country_options     = array();
+			$countries           = EEM_Country::instance()->get_all_countries();
+			if (! empty($countries)) {
+				foreach ($countries as $country) {
+					if ($country instanceof EE_Country) {
+						$country_options[$country->ID()] = $country->name();
+					}
+				}
+			}
+			$new_state_micro_form = new EE_Form_Section_Proper(
+				array(
+					'name'            => 'new_state_micro_form',
+					'html_id'         => 'new_state_micro_form',
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'subsections'     => array(
+						// add hidden input to indicate that a new state is being added
+						'add_new_state'               => new EE_Hidden_Input(
+							array(
+								'html_name' => str_replace(
+									'state',
+									'nsmf_add_new_state',
+									$input->html_name()
+								),
+								'html_id'   => str_replace(
+									'state',
+									'nsmf_add_new_state',
+									$input->html_id()
+								),
+								'default'   => 0,
+							)
+						),
+						// add link for displaying hidden container
+						'click_here_link'             => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__click_here_link',
+								EEH_HTML::link(
+									'',
+									esc_html__('click here to add a new state/province', 'event_espresso'),
+									'',
+									'display-' . $input->html_id(),
+									'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
+									'',
+									'data-target="' . $input->html_id() . '"'
+								)
+							)
+						),
+						// add initial html for hidden container
+						'add_new_state_micro_form'    => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
+								EEH_HTML::div('', $input->html_id() . '-dv', 'ee-form-add-new-state-dv',
+									'display: none;') .
+								EEH_HTML::h6(
+									esc_html__(
+										'Is your state/province missing from the dropdown menu above? You can add it by completing the following steps:',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::ul() .
+								EEH_HTML::li(
+									esc_html__(
+										'first select the Country that your State/Province belongs to',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::li(
+									esc_html__('enter the name of your State/Province', 'event_espresso')
+								) .
+								EEH_HTML::li(
+									esc_html__(
+										'enter a two to six letter abbreviation for the name of your State/Province',
+										'event_espresso'
+									)
+								) .
+								EEH_HTML::li(esc_html__('click the ADD button', 'event_espresso')) .
+								EEH_HTML::ulx()
+							)
+						),
+						// NEW STATE COUNTRY
+						'new_state_country'           => new EE_Country_Select_Input(
+							$country_options,
+							array(
+								'html_name'       => $country_name,
+								'html_id'         => str_replace(
+									'state',
+									'nsmf_new_state_country', $input->html_id()
+								),
+								'html_class'      => $input->html_class() . ' new-state-country',
+								'html_label_text' => esc_html__('New State/Province Country', 'event_espresso'),
+								'default'         => EE_Registry::instance()->REQ->get($country_name, ''),
+								'required'        => false,
+							)
+						),
+						// NEW STATE NAME
+						'new_state_name'              => new EE_Text_Input(
+							array(
+								'html_name'       => $state_name,
+								'html_id'         => str_replace(
+									'state',
+									'nsmf_new_state_name', $input->html_id()
+								),
+								'html_class'      => $input->html_class() . ' new-state-state',
+								'html_label_text' => esc_html__('New State/Province Name',
+									'event_espresso'),
+								'default'         => EE_Registry::instance()->REQ->get($state_name, ''),
+								'required'        => false,
+							)
+						),
+						'spacer'                      => new EE_Form_Section_HTML(EEH_HTML::br()),
+						// NEW STATE NAME
+						'new_state_abbrv'             => new EE_Text_Input(
+							array(
+								'html_name'             => $abbrv_name,
+								'html_id'               => str_replace('state', 'nsmf_new_state_abbrv',
+									$input->html_id()),
+								'html_class'            => $input->html_class() . ' new-state-abbrv',
+								'html_label_text'       => esc_html__(
+															   'New State/Province Abbreviation',
+															   'event_espresso'
+														   ) . ' *',
+								'html_other_attributes' => 'size="24"',
+								'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
+								'required'              => false,
+							)
+						),
+						// "submit" button
+						'add_new_state_submit_button' => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_submit_button',
+								EEH_HTML::nbsp(3) .
+								EEH_HTML::link(
+									'',
+									esc_html__('ADD', 'event_espresso'),
+									'',
+									'submit-' . $new_state_submit_id,
+									'ee-form-add-new-state-submit button button-secondary',
+									'',
+									'data-target="' . $new_state_submit_id . '"'
+								)
+							)
+						),
+						// extra info
+						'add_new_state_extra'         => new EE_Form_Section_HTML(
+							apply_filters(
+								'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_extra',
+								EEH_HTML::br(2)
+								.
+								EEH_HTML::div('', '', 'small-text')
+								.
+								EEH_HTML::strong(
+									'* ' .
+									esc_html__(
+										'Don\'t know your State/Province Abbreviation?',
+										'event_espresso'
+									)
+								)
+								.
+								EEH_HTML::br()
+								.
+								sprintf(
+									esc_html__(
+										'You can look here: %s, for a list of Countries and links to their State/Province Abbreviations ("Subdivisions assigned codes" column).',
+										'event_espresso'
+									),
+									EEH_HTML::link(
+										'http://en.wikipedia.org/wiki/ISO_3166-2',
+										'http://en.wikipedia.org/wiki/ISO_3166-2',
+										'',
+										'',
+										'ee-form-add-new-state-wiki-lnk',
+										'',
+										'target="_blank"'
+									)
+								)
+								.
+								EEH_HTML::divx()
+								.
+								EEH_HTML::br()
+								.
+								EEH_HTML::link(
+									'',
+									esc_html__('cancel new State/Province', 'event_espresso'),
+									'',
+									'hide-' . $input->html_id(),
+									'ee-form-cancel-new-state-lnk smaller-text',
+									'',
+									'data-target="' . $input->html_id() . '"'
+								)
+								.
+								EEH_HTML::divx()
+								.
+								EEH_HTML::br()
+							)
+						),
+					),
+				)
+			);
+			$question_group_reg_form->add_subsections(
+				array('new_state_micro_form' => $new_state_micro_form),
+				'state',
+				false
+			);
+		}
+		return $question_group_reg_form;
+	}
+
+
+
+	/**
+	 * set_new_state_input_width
+	 *
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function add_new_state()
+	{
+		$REQ = EE_Registry::instance()->load_core('Request_Handler');
+		if (absint($REQ->get('nsmf_add_new_state')) === 1) {
+			EE_Registry::instance()->load_model('State');
+			// grab country ISO code, new state name, and new state abbreviation
+			$state_country = $REQ->is_set('nsmf_new_state_country')
+				? sanitize_text_field($REQ->get('nsmf_new_state_country'))
+				: false;
+			$state_name    = $REQ->is_set('nsmf_new_state_name')
+				? sanitize_text_field($REQ->get('nsmf_new_state_name'))
+				: false;
+			$state_abbr    = $REQ->is_set('nsmf_new_state_abbrv')
+				? sanitize_text_field($REQ->get('nsmf_new_state_abbrv'))
+				: false;
+			if ($state_country && $state_name && $state_abbr) {
+				$new_state = EED_Add_New_State::save_new_state_to_db(array(
+					'CNT_ISO'    => strtoupper($state_country),
+					'STA_abbrev' => strtoupper($state_abbr),
+					'STA_name'   => ucwords($state_name),
+					'STA_active' => false,
+				));
+				if ($new_state instanceof EE_State) {
+					// clean house
+					EE_Registry::instance()->REQ->un_set('nsmf_add_new_state');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_country');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_name');
+					EE_Registry::instance()->REQ->un_set('nsmf_new_state_abbrv');
+					// get any existing new states
+					$new_states                   = EE_Registry::instance()->SSN->get_session_data(
+						'nsmf_new_states'
+					);
+					$new_states[$new_state->ID()] = $new_state;
+					EE_Registry::instance()->SSN->set_session_data(
+						array('nsmf_new_states' => $new_states)
+					);
+					if (EE_Registry::instance()->REQ->ajax) {
+						echo wp_json_encode(array(
+							'success'      => true,
+							'id'           => $new_state->ID(),
+							'name'         => $new_state->name(),
+							'abbrev'       => $new_state->abbrev(),
+							'country_iso'  => $new_state->country_iso(),
+							'country_name' => $new_state->country()->name(),
+						));
+						exit();
+					}
+					return $new_state->ID();
+				}
+			} else {
+				$error = esc_html__(
+					'A new State/Province could not be added because invalid or missing data was received.',
+					'event_espresso'
+				);
+				if (EE_Registry::instance()->REQ->ajax) {
+					echo wp_json_encode(array('error' => $error));
+					exit();
+				}
+				EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * recursively drills down through request params to remove any that were added by this module
+	 *
+	 * @param array $request_params
+	 * @return array
+	 */
+	public static function filter_checkout_request_params($request_params)
+	{
+		foreach ($request_params as $form_section) {
+			if (is_array($form_section)) {
+				EED_Add_New_State::unset_new_state_request_params($form_section);
+				EED_Add_New_State::filter_checkout_request_params($form_section);
+			}
+		}
+		return $request_params;
+	}
+
+
+
+	/**
+	 * @param array $request_params
+	 * @return array
+	 */
+	public static function unset_new_state_request_params($request_params)
+	{
+		unset(
+			$request_params['new_state_micro_form'],
+			$request_params['new_state_micro_add_new_state'],
+			$request_params['new_state_micro_new_state_country'],
+			$request_params['new_state_micro_new_state_name'],
+			$request_params['new_state_micro_new_state_abbrv']
+		);
+		return $request_params;
+	}
+
+
+
+	/**
+	 * @param array $props_n_values
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function save_new_state_to_db($props_n_values = array())
+	{
+		$existing_state = EEM_State::instance()->get_all(array($props_n_values, 'limit' => 1));
+		if (! empty($existing_state)) {
+			return array_pop($existing_state);
+		}
+		$new_state = EE_State::new_instance($props_n_values);
+		if ($new_state instanceof EE_State) {
+			$country_settings_url = add_query_arg(
+				array(
+					'page'    => 'espresso_general_settings',
+					'action'  => 'country_settings',
+					'country' => $new_state->country_iso(),
+				),
+				admin_url('admin.php')
+			);
+			// if not non-ajax admin
+			new PersistentAdminNotice(
+				'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev(),
+				sprintf(
+					esc_html__(
+						'A new State named "%1$s (%2$s)" was dynamically added from an Event Espresso form for the Country of "%3$s".%5$sTo verify, edit, and/or delete this new State, please go to the %4$s and update the States / Provinces section.%5$sCheck "Yes" to have this new State added to dropdown select lists in forms.',
+						'event_espresso'
+					),
+					'<b>' . $new_state->name() . '</b>',
+					'<b>' . $new_state->abbrev() . '</b>',
+					'<b>' . $new_state->country()->name() . '</b>',
+					'<a href="'
+					. $country_settings_url
+					. '">'
+					. esc_html__('Event Espresso - General Settings > Countries Tab',
+						'event_espresso')
+					. '</a>',
+					'<br />'
+				)
+			);
+			$new_state->save();
+			EEM_State::instance()->reset_cached_states();
+			return $new_state;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @param string $CNT_ISO
+	 * @param string $STA_ID
+	 * @param array  $cols_n_values
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
+	{
+		if (! $CNT_ISO) {
+			EE_Error::add_error(
+				esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$STA_abbrev = is_array($cols_n_values) && isset($cols_n_values['STA_abbrev']) ? $cols_n_values['STA_abbrev']
+			: false;
+		if (! $STA_abbrev && ! empty($STA_ID)) {
+			$state = EEM_State::instance()->get_one_by_ID($STA_ID);
+			if ($state instanceof EE_State) {
+				$STA_abbrev = $state->abbrev();
+			}
+		}
+		if (! $STA_abbrev) {
+			EE_Error::add_error(
+				esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$persistent_admin_notice_manager->dismissNotice($CNT_ISO . '-' . $STA_abbrev, true, true);
+	}
+
+
+
+	/**
+	 * @param EE_State[]                            $state_options
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EE_Registration                       $registration
+	 * @param EE_Question                           $question
+	 * @param                                       $answer
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function inject_new_reg_state_into_options(
+		$state_options = array(),
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration $registration,
+		EE_Question $question,
+		$answer
+	) {
+		if ($answer instanceof EE_Answer && $question instanceof EE_Question
+			&& $question->type() === EEM_Question::QST_type_state
+		) {
+			$STA_ID = $answer->value();
+			if (! empty($STA_ID)) {
+				$state = EEM_State::instance()->get_one_by_ID($STA_ID);
+				if ($state instanceof EE_State) {
+					$country = $state->country();
+					if ($country instanceof EE_Country) {
+						if (! isset($state_options[$country->name()])) {
+							$state_options[$country->name()] = array();
+						}
+						if (! isset($state_options[$country->name()][$STA_ID])) {
+							$state_options[$country->name()][$STA_ID] = $state->name();
+						}
+					}
+				}
+			}
+		}
+		return $state_options;
+	}
+
+
+
+	/**
+	 * @param EE_Country[]                          $country_options
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EE_Registration                       $registration
+	 * @param EE_Question                           $question
+	 * @param                                       $answer
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function inject_new_reg_country_into_options(
+		$country_options = array(),
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EE_Registration $registration,
+		EE_Question $question,
+		$answer
+	) {
+		if ($answer instanceof EE_Answer && $question instanceof EE_Question
+			&& $question->type()
+			   === EEM_Question::QST_type_country
+		) {
+			$CNT_ISO = $answer->value();
+			if (! empty($CNT_ISO)) {
+				$country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
+				if ($country instanceof EE_Country) {
+					if (! isset($country_options[$CNT_ISO])) {
+						$country_options[$CNT_ISO] = $country->name();
+					}
+				}
+			}
+		}
+		return $country_options;
+	}
+
+
+
+	/**
+	 * @param EE_State[] $state_options
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function state_options($state_options = array())
+	{
+		$new_states = EED_Add_New_State::_get_new_states();
+		foreach ($new_states as $new_state) {
+			if (
+				$new_state instanceof EE_State
+				&& $new_state->country() instanceof EE_Country
+			) {
+				$state_options[$new_state->country()->name()][$new_state->ID()] = $new_state->name();
+			}
+		}
+		return $state_options;
+	}
+
+
+
+	/**
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_new_states()
+	{
+		$new_states = array();
+		if (EE_Registry::instance()->SSN instanceof EE_Session) {
+			$new_states = EE_Registry::instance()->SSN->get_session_data(
+				'nsmf_new_states'
+			);
+		}
+		return is_array($new_states) ? $new_states : array();
+	}
+
+
+
+	/**
+	 * @param EE_Country[] $country_options
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function country_options($country_options = array())
+	{
+		$new_states = EED_Add_New_State::_get_new_states();
+		foreach ($new_states as $new_state) {
+			if (
+				$new_state instanceof EE_State
+				&& $new_state->country() instanceof EE_Country
+			) {
+				$country_options[$new_state->country()->ID()] = $new_state->country()->name();
+			}
+		}
+		return $country_options;
+	}
 
 
 

core/db_classes/EE_Attendee.class.php

Indentation +742 added lines, -742 removed lines

@@ -27,746 +27,746 @@
 class EE_Attendee extends EE_CPT_Base implements EEI_Contact, EEI_Address, EEI_Admin_Links, EEI_Attendee
 {
 
-    /**
-     * Sets some dynamic defaults
-     *
-     * @param array  $fieldValues
-     * @param bool   $bydb
-     * @param string $timezone
-     * @param array  $date_formats
-     * @throws EE_Error
-     */
-    protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
-    {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
-            $lname                        = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
-        }
-        if (! isset($fieldValues['ATT_slug'])) {
-            //			$fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
-            $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
-        }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
-            $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
-        }
-        parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Attendee
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Attendee First Name
-     *
-     * @access        public
-     * @param string $fname
-     * @throws EE_Error
-     */
-    public function set_fname($fname = '')
-    {
-        $this->set('ATT_fname', $fname);
-    }
-
-
-    /**
-     *        Set Attendee Last Name
-     *
-     * @access        public
-     * @param string $lname
-     * @throws EE_Error
-     */
-    public function set_lname($lname = '')
-    {
-        $this->set('ATT_lname', $lname);
-    }
-
-
-    /**
-     *        Set Attendee Address
-     *
-     * @access        public
-     * @param string $address
-     * @throws EE_Error
-     */
-    public function set_address($address = '')
-    {
-        $this->set('ATT_address', $address);
-    }
-
-
-    /**
-     *        Set Attendee Address2
-     *
-     * @access        public
-     * @param        string $address2
-     * @throws EE_Error
-     */
-    public function set_address2($address2 = '')
-    {
-        $this->set('ATT_address2', $address2);
-    }
-
-
-    /**
-     *        Set Attendee City
-     *
-     * @access        public
-     * @param        string $city
-     * @throws EE_Error
-     */
-    public function set_city($city = '')
-    {
-        $this->set('ATT_city', $city);
-    }
-
-
-    /**
-     *        Set Attendee State ID
-     *
-     * @access        public
-     * @param        int $STA_ID
-     * @throws EE_Error
-     */
-    public function set_state($STA_ID = 0)
-    {
-        $this->set('STA_ID', $STA_ID);
-    }
-
-
-    /**
-     *        Set Attendee Country ISO Code
-     *
-     * @access        public
-     * @param        string $CNT_ISO
-     * @throws EE_Error
-     */
-    public function set_country($CNT_ISO = '')
-    {
-        $this->set('CNT_ISO', $CNT_ISO);
-    }
-
-
-    /**
-     *        Set Attendee Zip/Postal Code
-     *
-     * @access        public
-     * @param        string $zip
-     * @throws EE_Error
-     */
-    public function set_zip($zip = '')
-    {
-        $this->set('ATT_zip', $zip);
-    }
-
-
-    /**
-     *        Set Attendee Email Address
-     *
-     * @access        public
-     * @param        string $email
-     * @throws EE_Error
-     */
-    public function set_email($email = '')
-    {
-        $this->set('ATT_email', $email);
-    }
-
-
-    /**
-     *        Set Attendee Phone
-     *
-     * @access        public
-     * @param        string $phone
-     * @throws EE_Error
-     */
-    public function set_phone($phone = '')
-    {
-        $this->set('ATT_phone', $phone);
-    }
-
-
-    /**
-     *        set deleted
-     *
-     * @access        public
-     * @param        bool $ATT_deleted
-     * @throws EE_Error
-     */
-    public function set_deleted($ATT_deleted = false)
-    {
-        $this->set('ATT_deleted', $ATT_deleted);
-    }
-
-
-    /**
-     * Returns the value for the post_author id saved with the cpt
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws EE_Error
-     */
-    public function wp_user()
-    {
-        return $this->get('ATT_author');
-    }
-
-
-    /**
-     *        get Attendee First Name
-     *
-     * @access        public
-     * @return string
-     * @throws EE_Error
-     */
-    public function fname()
-    {
-        return $this->get('ATT_fname');
-    }
-
-
-    /**
-     * echoes out the attendee's first name
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function e_full_name()
-    {
-        echo $this->full_name();
-    }
-
-
-    /**
-     * Returns the first and last name concatenated together with a space.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     * @throws EE_Error
-     */
-    public function full_name($apply_html_entities = false)
-    {
-        $full_name = array(
-            $this->fname(),
-            $this->lname(),
-        );
-        $full_name = array_filter($full_name);
-        $full_name = implode(' ', $full_name);
-        return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
-    }
-
-
-    /**
-     * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
-     * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
-     * attendee.
-     *
-     * @param bool $apply_html_entities
-     * @return string
-     * @throws EE_Error
-     */
-    public function ATT_full_name($apply_html_entities = false)
-    {
-        return $apply_html_entities
-            ? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
-            : $this->get('ATT_full_name');
-    }
-
-
-    /**
-     *        get Attendee Last Name
-     *
-     * @access        public
-     * @return string
-     * @throws EE_Error
-     */
-    public function lname()
-    {
-        return $this->get('ATT_lname');
-    }
-
-
-    /**
-     * Gets the attendee's full address as an array so client code can decide hwo to display it
-     *
-     * @return array numerically indexed, with each part of the address that is known.
-     * Eg, if the user only responded to state and country,
-     * it would be array(0=>'Alabama',1=>'USA')
-     * @return array
-     * @throws EE_Error
-     */
-    public function full_address_as_array()
-    {
-        $full_address_array     = array();
-        $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
-        foreach ($initial_address_fields as $address_field_name) {
-            $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
-                $full_address_array[] = $address_fields_value;
-            }
-        }
-        //now handle state and country
-        $state_obj = $this->state_obj();
-        if ($state_obj instanceof EE_State) {
-            $full_address_array[] = $state_obj->name();
-        }
-        $country_obj = $this->country_obj();
-        if ($country_obj instanceof EE_Country) {
-            $full_address_array[] = $country_obj->name();
-        }
-        //lastly get the xip
-        $zip_value = $this->zip();
-        if (! empty($zip_value)) {
-            $full_address_array[] = $zip_value;
-        }
-        return $full_address_array;
-    }
-
-
-    /**
-     *        get Attendee Address
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function address()
-    {
-        return $this->get('ATT_address');
-    }
-
-
-    /**
-     *        get Attendee Address2
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function address2()
-    {
-        return $this->get('ATT_address2');
-    }
-
-
-    /**
-     *        get Attendee City
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function city()
-    {
-        return $this->get('ATT_city');
-    }
-
-
-    /**
-     *        get Attendee State ID
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_ID()
-    {
-        return $this->get('STA_ID');
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
-    }
-
-
-    /**
-     * Gets the state set to this attendee
-     *
-     * @return EE_State
-     * @throws EE_Error
-     */
-    public function state_obj()
-    {
-        return $this->get_first_related('State');
-    }
-
-
-    /**
-     * Returns the state's name, otherwise 'Unknown'
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state_name()
-    {
-        if ($this->state_obj()) {
-            return $this->state_obj()->name();
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * either displays the state abbreviation or the state name, as determined
-     * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_abbrev();
-        }
-        return $this->state_name();
-    }
-
-
-    /**
-     *    get Attendee Country ISO Code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country_ID()
-    {
-        return $this->get('CNT_ISO');
-    }
-
-
-    /**
-     * Gets country set for this attendee
-     *
-     * @return EE_Country
-     * @throws EE_Error
-     */
-    public function country_obj()
-    {
-        return $this->get_first_related('Country');
-    }
-
-
-    /**
-     * Returns the country's name if known, otherwise 'Unknown'
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country_name()
-    {
-        if ($this->country_obj()) {
-            return $this->country_obj()->name();
-        }
-        return '';
-    }
-
-
-    /**
-     * either displays the country ISO2 code or the country name, as determined
-     * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
-     * defaults to abbreviation
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        }
-        return $this->country_name();
-    }
-
-
-    /**
-     *        get Attendee Zip/Postal Code
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function zip()
-    {
-        return $this->get('ATT_zip');
-    }
-
-
-    /**
-     *        get Attendee Email Address
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function email()
-    {
-        return $this->get('ATT_email');
-    }
-
-
-    /**
-     *        get Attendee Phone #
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function phone()
-    {
-        return $this->get('ATT_phone');
-    }
-
-
-    /**
-     *    get deleted
-     *
-     * @return        bool
-     * @throws EE_Error
-     */
-    public function deleted()
-    {
-        return $this->get('ATT_deleted');
-    }
-
-
-    /**
-     * Gets registrations of this attendee
-     *
-     * @param array $query_params
-     * @return EE_Registration[]
-     * @throws EE_Error
-     */
-    public function get_registrations($query_params = array())
-    {
-        return $this->get_many_related('Registration', $query_params);
-    }
-
-
-    /**
-     * Gets the most recent registration of this attendee
-     *
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public function get_most_recent_registration()
-    {
-        return $this->get_first_related(
-            'Registration',
-            array('order_by' => array('REG_date' => 'DESC'))
-        ); //null, 'REG_date', 'DESC', '=', 'OBJECT_K');
-    }
-
-
-    /**
-     * Gets the most recent registration for this attend at this event
-     *
-     * @param int $event_id
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public function get_most_recent_registration_for_event($event_id)
-    {
-        return $this->get_first_related(
-            'Registration',
-            array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC'))
-        );
-    }
-
-
-    /**
-     * returns any events attached to this attendee ($_Event property);
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function events()
-    {
-        return $this->get_many_related('Event');
-    }
-
-
-    /**
-     * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
-     * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
-     * used to save the billing info
-     *
-     * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
-     * @return EE_Form_Section_Proper|null
-     * @throws EE_Error
-     */
-    public function billing_info_for_payment_method($payment_method)
-    {
-        $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
-            return null;
-        }
-        $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
-            return null;
-        }
-        $billing_form = $pm_type->billing_form();
-        //double-check the form isn't totally hidden, in which case pretend there is no form
-        $form_totally_hidden = true;
-        foreach($billing_form->inputs_in_subsections() as $input){
-            if(! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
-                $form_totally_hidden = false;
-                break;
-            }
-        }
-        if($form_totally_hidden) {
-            return null;
-        }
-        if ($billing_form instanceof EE_Form_Section_Proper) {
-            $billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
-        }
-
-        return $billing_form;
-    }
-
-
-    /**
-     * Gets the postmeta key that holds this attendee's billing info for the
-     * specified payment method
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_billing_info_postmeta_name($payment_method)
-    {
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
-        }
-        return null;
-    }
-
-
-    /**
-     * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
-     * retrieve it
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Payment_Method             $payment_method
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
-    {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
-            EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
-            return false;
-        }
-        $billing_form->clean_sensitive_data();
-        return update_post_meta(
-            $this->ID(),
-            $this->get_billing_info_postmeta_name($payment_method),
-            $billing_form->input_values(true)
-        );
-    }
-
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_details_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_admin_edit_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'edit_attendee',
-                'post'   => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_edit_link();
-    }
-
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'   => 'espresso_registrations',
-                'action' => 'contact_list',
-            ),
-            admin_url('admin.php')
-        );
-    }
+	/**
+	 * Sets some dynamic defaults
+	 *
+	 * @param array  $fieldValues
+	 * @param bool   $bydb
+	 * @param string $timezone
+	 * @param array  $date_formats
+	 * @throws EE_Error
+	 */
+	protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
+	{
+		if (! isset($fieldValues['ATT_full_name'])) {
+			$fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+			$lname                        = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
+			$fieldValues['ATT_full_name'] = $fname . $lname;
+		}
+		if (! isset($fieldValues['ATT_slug'])) {
+			//			$fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
+			$fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
+		}
+		if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+			$fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
+		}
+		parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Attendee
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Attendee First Name
+	 *
+	 * @access        public
+	 * @param string $fname
+	 * @throws EE_Error
+	 */
+	public function set_fname($fname = '')
+	{
+		$this->set('ATT_fname', $fname);
+	}
+
+
+	/**
+	 *        Set Attendee Last Name
+	 *
+	 * @access        public
+	 * @param string $lname
+	 * @throws EE_Error
+	 */
+	public function set_lname($lname = '')
+	{
+		$this->set('ATT_lname', $lname);
+	}
+
+
+	/**
+	 *        Set Attendee Address
+	 *
+	 * @access        public
+	 * @param string $address
+	 * @throws EE_Error
+	 */
+	public function set_address($address = '')
+	{
+		$this->set('ATT_address', $address);
+	}
+
+
+	/**
+	 *        Set Attendee Address2
+	 *
+	 * @access        public
+	 * @param        string $address2
+	 * @throws EE_Error
+	 */
+	public function set_address2($address2 = '')
+	{
+		$this->set('ATT_address2', $address2);
+	}
+
+
+	/**
+	 *        Set Attendee City
+	 *
+	 * @access        public
+	 * @param        string $city
+	 * @throws EE_Error
+	 */
+	public function set_city($city = '')
+	{
+		$this->set('ATT_city', $city);
+	}
+
+
+	/**
+	 *        Set Attendee State ID
+	 *
+	 * @access        public
+	 * @param        int $STA_ID
+	 * @throws EE_Error
+	 */
+	public function set_state($STA_ID = 0)
+	{
+		$this->set('STA_ID', $STA_ID);
+	}
+
+
+	/**
+	 *        Set Attendee Country ISO Code
+	 *
+	 * @access        public
+	 * @param        string $CNT_ISO
+	 * @throws EE_Error
+	 */
+	public function set_country($CNT_ISO = '')
+	{
+		$this->set('CNT_ISO', $CNT_ISO);
+	}
+
+
+	/**
+	 *        Set Attendee Zip/Postal Code
+	 *
+	 * @access        public
+	 * @param        string $zip
+	 * @throws EE_Error
+	 */
+	public function set_zip($zip = '')
+	{
+		$this->set('ATT_zip', $zip);
+	}
+
+
+	/**
+	 *        Set Attendee Email Address
+	 *
+	 * @access        public
+	 * @param        string $email
+	 * @throws EE_Error
+	 */
+	public function set_email($email = '')
+	{
+		$this->set('ATT_email', $email);
+	}
+
+
+	/**
+	 *        Set Attendee Phone
+	 *
+	 * @access        public
+	 * @param        string $phone
+	 * @throws EE_Error
+	 */
+	public function set_phone($phone = '')
+	{
+		$this->set('ATT_phone', $phone);
+	}
+
+
+	/**
+	 *        set deleted
+	 *
+	 * @access        public
+	 * @param        bool $ATT_deleted
+	 * @throws EE_Error
+	 */
+	public function set_deleted($ATT_deleted = false)
+	{
+		$this->set('ATT_deleted', $ATT_deleted);
+	}
+
+
+	/**
+	 * Returns the value for the post_author id saved with the cpt
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function wp_user()
+	{
+		return $this->get('ATT_author');
+	}
+
+
+	/**
+	 *        get Attendee First Name
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function fname()
+	{
+		return $this->get('ATT_fname');
+	}
+
+
+	/**
+	 * echoes out the attendee's first name
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function e_full_name()
+	{
+		echo $this->full_name();
+	}
+
+
+	/**
+	 * Returns the first and last name concatenated together with a space.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function full_name($apply_html_entities = false)
+	{
+		$full_name = array(
+			$this->fname(),
+			$this->lname(),
+		);
+		$full_name = array_filter($full_name);
+		$full_name = implode(' ', $full_name);
+		return $apply_html_entities ? htmlentities($full_name, ENT_QUOTES, 'UTF-8') : $full_name;
+	}
+
+
+	/**
+	 * This returns the value of the `ATT_full_name` field which is usually equivalent to calling `full_name()` unless
+	 * the post_title field has been directly modified in the db for the post (espresso_attendees post type) for this
+	 * attendee.
+	 *
+	 * @param bool $apply_html_entities
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function ATT_full_name($apply_html_entities = false)
+	{
+		return $apply_html_entities
+			? htmlentities($this->get('ATT_full_name'), ENT_QUOTES, 'UTF-8')
+			: $this->get('ATT_full_name');
+	}
+
+
+	/**
+	 *        get Attendee Last Name
+	 *
+	 * @access        public
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function lname()
+	{
+		return $this->get('ATT_lname');
+	}
+
+
+	/**
+	 * Gets the attendee's full address as an array so client code can decide hwo to display it
+	 *
+	 * @return array numerically indexed, with each part of the address that is known.
+	 * Eg, if the user only responded to state and country,
+	 * it would be array(0=>'Alabama',1=>'USA')
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function full_address_as_array()
+	{
+		$full_address_array     = array();
+		$initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
+		foreach ($initial_address_fields as $address_field_name) {
+			$address_fields_value = $this->get($address_field_name);
+			if (! empty($address_fields_value)) {
+				$full_address_array[] = $address_fields_value;
+			}
+		}
+		//now handle state and country
+		$state_obj = $this->state_obj();
+		if ($state_obj instanceof EE_State) {
+			$full_address_array[] = $state_obj->name();
+		}
+		$country_obj = $this->country_obj();
+		if ($country_obj instanceof EE_Country) {
+			$full_address_array[] = $country_obj->name();
+		}
+		//lastly get the xip
+		$zip_value = $this->zip();
+		if (! empty($zip_value)) {
+			$full_address_array[] = $zip_value;
+		}
+		return $full_address_array;
+	}
+
+
+	/**
+	 *        get Attendee Address
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function address()
+	{
+		return $this->get('ATT_address');
+	}
+
+
+	/**
+	 *        get Attendee Address2
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function address2()
+	{
+		return $this->get('ATT_address2');
+	}
+
+
+	/**
+	 *        get Attendee City
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function city()
+	{
+		return $this->get('ATT_city');
+	}
+
+
+	/**
+	 *        get Attendee State ID
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_ID()
+	{
+		return $this->get('STA_ID');
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof EE_State ? $this->state_obj()->abbrev() : '';
+	}
+
+
+	/**
+	 * Gets the state set to this attendee
+	 *
+	 * @return EE_State
+	 * @throws EE_Error
+	 */
+	public function state_obj()
+	{
+		return $this->get_first_related('State');
+	}
+
+
+	/**
+	 * Returns the state's name, otherwise 'Unknown'
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state_name()
+	{
+		if ($this->state_obj()) {
+			return $this->state_obj()->name();
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * either displays the state abbreviation or the state name, as determined
+	 * by the "FHEE__EEI_Address__state__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_abbrev();
+		}
+		return $this->state_name();
+	}
+
+
+	/**
+	 *    get Attendee Country ISO Code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country_ID()
+	{
+		return $this->get('CNT_ISO');
+	}
+
+
+	/**
+	 * Gets country set for this attendee
+	 *
+	 * @return EE_Country
+	 * @throws EE_Error
+	 */
+	public function country_obj()
+	{
+		return $this->get_first_related('Country');
+	}
+
+
+	/**
+	 * Returns the country's name if known, otherwise 'Unknown'
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country_name()
+	{
+		if ($this->country_obj()) {
+			return $this->country_obj()->name();
+		}
+		return '';
+	}
+
+
+	/**
+	 * either displays the country ISO2 code or the country name, as determined
+	 * by the "FHEE__EEI_Address__country__use_abbreviation" filter.
+	 * defaults to abbreviation
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		}
+		return $this->country_name();
+	}
+
+
+	/**
+	 *        get Attendee Zip/Postal Code
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function zip()
+	{
+		return $this->get('ATT_zip');
+	}
+
+
+	/**
+	 *        get Attendee Email Address
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function email()
+	{
+		return $this->get('ATT_email');
+	}
+
+
+	/**
+	 *        get Attendee Phone #
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function phone()
+	{
+		return $this->get('ATT_phone');
+	}
+
+
+	/**
+	 *    get deleted
+	 *
+	 * @return        bool
+	 * @throws EE_Error
+	 */
+	public function deleted()
+	{
+		return $this->get('ATT_deleted');
+	}
+
+
+	/**
+	 * Gets registrations of this attendee
+	 *
+	 * @param array $query_params
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 */
+	public function get_registrations($query_params = array())
+	{
+		return $this->get_many_related('Registration', $query_params);
+	}
+
+
+	/**
+	 * Gets the most recent registration of this attendee
+	 *
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public function get_most_recent_registration()
+	{
+		return $this->get_first_related(
+			'Registration',
+			array('order_by' => array('REG_date' => 'DESC'))
+		); //null, 'REG_date', 'DESC', '=', 'OBJECT_K');
+	}
+
+
+	/**
+	 * Gets the most recent registration for this attend at this event
+	 *
+	 * @param int $event_id
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public function get_most_recent_registration_for_event($event_id)
+	{
+		return $this->get_first_related(
+			'Registration',
+			array(array('EVT_ID' => $event_id), 'order_by' => array('REG_date' => 'DESC'))
+		);
+	}
+
+
+	/**
+	 * returns any events attached to this attendee ($_Event property);
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function events()
+	{
+		return $this->get_many_related('Event');
+	}
+
+
+	/**
+	 * Gets the billing info array where keys match espresso_reg_page_billing_inputs(),
+	 * and keys are their cleaned values. @see EE_Attendee::save_and_clean_billing_info_for_payment_method() which was
+	 * used to save the billing info
+	 *
+	 * @param EE_Payment_Method $payment_method the _gateway_name property on the gateway class
+	 * @return EE_Form_Section_Proper|null
+	 * @throws EE_Error
+	 */
+	public function billing_info_for_payment_method($payment_method)
+	{
+		$pm_type = $payment_method->type_obj();
+		if (! $pm_type instanceof EE_PMT_Base) {
+			return null;
+		}
+		$billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
+		if (! $billing_info) {
+			return null;
+		}
+		$billing_form = $pm_type->billing_form();
+		//double-check the form isn't totally hidden, in which case pretend there is no form
+		$form_totally_hidden = true;
+		foreach($billing_form->inputs_in_subsections() as $input){
+			if(! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+				$form_totally_hidden = false;
+				break;
+			}
+		}
+		if($form_totally_hidden) {
+			return null;
+		}
+		if ($billing_form instanceof EE_Form_Section_Proper) {
+			$billing_form->receive_form_submission(array($billing_form->name() => $billing_info), false);
+		}
+
+		return $billing_form;
+	}
+
+
+	/**
+	 * Gets the postmeta key that holds this attendee's billing info for the
+	 * specified payment method
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_billing_info_postmeta_name($payment_method)
+	{
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			return 'billing_info_' . $payment_method->type_obj()->system_name();
+		}
+		return null;
+	}
+
+
+	/**
+	 * Saves the billing info to the attendee. @see EE_Attendee::billing_info_for_payment_method() which is used to
+	 * retrieve it
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Payment_Method             $payment_method
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
+	{
+		if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+			EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
+			return false;
+		}
+		$billing_form->clean_sensitive_data();
+		return update_post_meta(
+			$this->ID(),
+			$this->get_billing_info_postmeta_name($payment_method),
+			$billing_form->input_values(true)
+		);
+	}
+
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_details_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_admin_edit_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'edit_attendee',
+				'post'   => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_edit_link();
+	}
+
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'   => 'espresso_registrations',
+				'action' => 'contact_list',
+			),
+			admin_url('admin.php')
+		);
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -38,16 +38,16 @@ 
      */
     protected function __construct($fieldValues = null, $bydb = false, $timezone = null, $date_formats = array())
     {
-        if (! isset($fieldValues['ATT_full_name'])) {
-            $fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'] . ' ' : '';
+        if ( ! isset($fieldValues['ATT_full_name'])) {
+            $fname                        = isset($fieldValues['ATT_fname']) ? $fieldValues['ATT_fname'].' ' : '';
             $lname                        = isset($fieldValues['ATT_lname']) ? $fieldValues['ATT_lname'] : '';
-            $fieldValues['ATT_full_name'] = $fname . $lname;
+            $fieldValues['ATT_full_name'] = $fname.$lname;
         }
-        if (! isset($fieldValues['ATT_slug'])) {
+        if ( ! isset($fieldValues['ATT_slug'])) {
             //			$fieldValues['ATT_slug'] = sanitize_key(wp_generate_password(20));
             $fieldValues['ATT_slug'] = sanitize_title($fieldValues['ATT_full_name']);
         }
-        if (! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
+        if ( ! isset($fieldValues['ATT_short_bio']) && isset($fieldValues['ATT_bio'])) {
             $fieldValues['ATT_short_bio'] = substr($fieldValues['ATT_bio'], 0, 50);
         }
         parent::__construct($fieldValues, $bydb, $timezone, $date_formats);
@@ -327,7 +327,7 @@ 
         $initial_address_fields = array('ATT_address', 'ATT_address2', 'ATT_city',);
         foreach ($initial_address_fields as $address_field_name) {
             $address_fields_value = $this->get($address_field_name);
-            if (! empty($address_fields_value)) {
+            if ( ! empty($address_fields_value)) {
                 $full_address_array[] = $address_fields_value;
             }
         }
@@ -342,7 +342,7 @@ 
         }
         //lastly get the xip
         $zip_value = $this->zip();
-        if (! empty($zip_value)) {
+        if ( ! empty($zip_value)) {
             $full_address_array[] = $zip_value;
         }
         return $full_address_array;
@@ -624,23 +624,23 @@ 
     public function billing_info_for_payment_method($payment_method)
     {
         $pm_type = $payment_method->type_obj();
-        if (! $pm_type instanceof EE_PMT_Base) {
+        if ( ! $pm_type instanceof EE_PMT_Base) {
             return null;
         }
         $billing_info = $this->get_post_meta($this->get_billing_info_postmeta_name($payment_method), true);
-        if (! $billing_info) {
+        if ( ! $billing_info) {
             return null;
         }
         $billing_form = $pm_type->billing_form();
         //double-check the form isn't totally hidden, in which case pretend there is no form
         $form_totally_hidden = true;
-        foreach($billing_form->inputs_in_subsections() as $input){
-            if(! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
+        foreach ($billing_form->inputs_in_subsections() as $input) {
+            if ( ! $input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
                 $form_totally_hidden = false;
                 break;
             }
         }
-        if($form_totally_hidden) {
+        if ($form_totally_hidden) {
             return null;
         }
         if ($billing_form instanceof EE_Form_Section_Proper) {
@@ -662,7 +662,7 @@ 
     public function get_billing_info_postmeta_name($payment_method)
     {
         if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            return 'billing_info_' . $payment_method->type_obj()->system_name();
+            return 'billing_info_'.$payment_method->type_obj()->system_name();
         }
         return null;
     }
@@ -679,7 +679,7 @@ 
      */
     public function save_and_clean_billing_info_for_payment_method($billing_form, $payment_method)
     {
-        if (! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
+        if ( ! $billing_form instanceof EE_Billing_Attendee_Info_Form) {
             EE_Error::add_error(__('Cannot save billing info because there is none.', 'event_espresso'));
             return false;
         }

core/libraries/form_sections/strategies/layout/EE_Form_Section_Layout_Base.strategy.php

Indentation +284 added lines, -284 removed lines

@@ -15,288 +15,288 @@
 abstract class EE_Form_Section_Layout_Base
 {
 
-    /**
-     * Form form section to lay out
-     *
-     * @var EE_Form_Section_Proper
-     */
-    protected $_form_section;
-
-
-
-    /**
-     *  __construct
-     */
-    public function __construct()
-    {
-    }
-
-
-
-    /**
-     * The form section on which this strategy is to perform
-     *
-     * @param EE_Form_Section_Proper $form
-     */
-    public function _construct_finalize(EE_Form_Section_Proper $form)
-    {
-        $this->_form_section = $form;
-    }
-
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     */
-    public function form_section()
-    {
-        return $this->_form_section;
-    }
-
-
-
-    /**
-     * Also has teh side effect of enqueuing any needed JS and CSS for
-     * this form.
-     * Creates all the HTML necessary for displaying this form, its inputs, and
-     * proper subsections.
-     * Returns the HTML
-     *
-     * @return string HTML for displaying
-     * @throws EE_Error
-     */
-    public function layout_form()
-    {
-        $html = '';
-        // layout_form_begin
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
-            $this->layout_form_begin(),
-            $this->_form_section
-        );
-        // layout_form_loop
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
-            $this->layout_form_loop(),
-            $this->_form_section
-        );
-        // layout_form_end
-        $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
-            $this->layout_form_end(),
-            $this->_form_section
-        );
-        $html = $this->add_form_section_hooks_and_filters($html);
-        return $html;
-    }
-
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function layout_form_loop()
-    {
-        $html = '';
-        foreach ($this->_form_section->subsections() as $name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
-                    $this->layout_input($subsection),
-                    $this->_form_section,
-                    $subsection
-                );
-            } elseif ($subsection instanceof EE_Form_Section_Base) {
-                $html .= apply_filters(
-                    'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
-                    $this->layout_subsection($subsection),
-                    $this->_form_section,
-                    $subsection
-                );
-            }
-        }
-        return $html;
-    }
-
-
-
-    /**
-     * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
-     *
-     * @return string
-     */
-    abstract public function layout_form_begin();
-
-
-
-    /**
-     * Should be used to end the form section (eg a /table tag, or a /div tag, etc)
-     *
-     * @return string
-     */
-    abstract public function layout_form_end();
-
-
-
-    /**
-     * Should be used internally by layout_form() to layout each input (eg, if this layout
-     * is putting each input in a row of its own, this should probably be called by a
-     *  foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop.
-     * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely
-     * customize the form's layout, but would like to make use of it for laying out
-     * 'easy-to-layout' inputs
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string html
-     */
-    abstract public function layout_input($input);
-
-
-
-    /**
-     * Similar to layout_input(), should be used internally by layout_form() within a
-     * loop to layout each proper subsection. Unlike layout_input(), however, it is assumed
-     * that the proper subsection will layout its container, label, etc on its own.
-     *
-     * @param EE_Form_Section_Base $subsection
-     * @return string html
-     */
-    abstract public function layout_subsection($subsection);
-
-
-
-    /**
-     * Gets the HTML for the label tag and its contents for the input
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function display_label($input)
-    {
-        if($input->get_display_strategy() instanceof EE_Hidden_Display_Strategy){
-            return '';
-        }
-        $class = $input->required()
-            ? 'ee-required-label ' . $input->html_label_class()
-            : $input->html_label_class();
-        $label_text = $input->required()
-            ? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
-            : $input->html_label_text();
-        return '<label id="'
-               . $input->html_label_id()
-               . '" class="'
-               . $class
-               . '" style="'
-               . $input->html_label_style()
-               . '" for="' . $input->html_name()
-               . '">'
-               . $label_text
-               . '</label>';
-    }
-
-
-
-    /**
-     * Gets the HTML for all the form's form-wide errors (ie, errors which
-     * are not for specific inputs. E.g., if two inputs somehow disagree,
-     * those errors would probably be on the form section, not one of its inputs)
-     * @return string
-     */
-    public function display_form_wide_errors()
-    {
-        $html = '';
-        if ($this->_form_section->get_validation_errors()) {
-            $html .= "<div class='ee-form-wide-errors'>";
-            //get all the errors on THIS form section (errors which aren't
-            //for specific inputs, but instead for the entire form section)
-            foreach ($this->_form_section->get_validation_errors() as $error) {
-                $html .= $error->getMessage() . '<br>';
-            }
-            $html .= '</div>';
-        }
-        return apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__display_form_wide_errors',
-            $html,
-            $this
-        );
-    }
-
-
-
-    /**
-     * returns the HTML for the server-side validation errors for the specified input
-     * Note that if JS is enabled, it should remove these and instead
-     * populate the form's errors in the jquery validate fashion
-     * using the localized data provided to the JS
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function display_errors($input)
-    {
-        if ($input->get_validation_errors()) {
-            return "<label  id='"
-                   . $input->html_id()
-                   . "-error' class='error' for='{$input->html_name()}'>"
-                   . $input->get_validation_error_string()
-                   . '</label>';
-        }
-        return '';
-    }
-
-
-
-    /**
-     * Displays the help span for the specified input
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function display_help_text($input)
-    {
-        $help_text  = $input->html_help_text();
-        if ($help_text !== '' && $help_text !== null) {
-            $tag = is_admin() ? 'p' : 'span';
-            return '<'
-                   . $tag
-                   . ' id="'
-                   . $input->html_id()
-                   . '-help" class="'
-                   . $input->html_help_class()
-                   . '" style="'
-                   . $input->html_help_style()
-                   . '">'
-                   . $help_text
-                   . '</'
-                   . $tag
-                   . '>';
-        }
-        return '';
-    }
-
-
-
-    /**
-     * Does an action and hook onto the end of teh form
-     *
-     * @param string $html
-     * @return string
-     */
-    public function add_form_section_hooks_and_filters($html)
-    {
-        // replace dashes and spaces with underscores
-        $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
-        do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
-        $html = (string) apply_filters(
-            'AFEE__Form_Section_Layout__' . $hook_name . '__html',
-            $html,
-            $this->_form_section
-        );
-        $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
-        $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
-        return $html;
-    }
+	/**
+	 * Form form section to lay out
+	 *
+	 * @var EE_Form_Section_Proper
+	 */
+	protected $_form_section;
+
+
+
+	/**
+	 *  __construct
+	 */
+	public function __construct()
+	{
+	}
+
+
+
+	/**
+	 * The form section on which this strategy is to perform
+	 *
+	 * @param EE_Form_Section_Proper $form
+	 */
+	public function _construct_finalize(EE_Form_Section_Proper $form)
+	{
+		$this->_form_section = $form;
+	}
+
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 */
+	public function form_section()
+	{
+		return $this->_form_section;
+	}
+
+
+
+	/**
+	 * Also has teh side effect of enqueuing any needed JS and CSS for
+	 * this form.
+	 * Creates all the HTML necessary for displaying this form, its inputs, and
+	 * proper subsections.
+	 * Returns the HTML
+	 *
+	 * @return string HTML for displaying
+	 * @throws EE_Error
+	 */
+	public function layout_form()
+	{
+		$html = '';
+		// layout_form_begin
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
+			$this->layout_form_begin(),
+			$this->_form_section
+		);
+		// layout_form_loop
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
+			$this->layout_form_loop(),
+			$this->_form_section
+		);
+		// layout_form_end
+		$html .= apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
+			$this->layout_form_end(),
+			$this->_form_section
+		);
+		$html = $this->add_form_section_hooks_and_filters($html);
+		return $html;
+	}
+
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function layout_form_loop()
+	{
+		$html = '';
+		foreach ($this->_form_section->subsections() as $name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$html .= apply_filters(
+					'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'
+					. $name . '__in_' . $this->_form_section->name(),
+					$this->layout_input($subsection),
+					$this->_form_section,
+					$subsection
+				);
+			} elseif ($subsection instanceof EE_Form_Section_Base) {
+				$html .= apply_filters(
+					'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'
+					. $name . '__in_' . $this->_form_section->name(),
+					$this->layout_subsection($subsection),
+					$this->_form_section,
+					$subsection
+				);
+			}
+		}
+		return $html;
+	}
+
+
+
+	/**
+	 * Should be used to start teh form section (Eg a table tag, or a div tag, etc.)
+	 *
+	 * @return string
+	 */
+	abstract public function layout_form_begin();
+
+
+
+	/**
+	 * Should be used to end the form section (eg a /table tag, or a /div tag, etc)
+	 *
+	 * @return string
+	 */
+	abstract public function layout_form_end();
+
+
+
+	/**
+	 * Should be used internally by layout_form() to layout each input (eg, if this layout
+	 * is putting each input in a row of its own, this should probably be called by a
+	 *  foreach loop in layout_form() (WITHOUT adding any content directly within layout_form()'s foreach loop.
+	 * Eg, this method should add the tr and td tags). This method is exposed in case you want to completely
+	 * customize the form's layout, but would like to make use of it for laying out
+	 * 'easy-to-layout' inputs
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string html
+	 */
+	abstract public function layout_input($input);
+
+
+
+	/**
+	 * Similar to layout_input(), should be used internally by layout_form() within a
+	 * loop to layout each proper subsection. Unlike layout_input(), however, it is assumed
+	 * that the proper subsection will layout its container, label, etc on its own.
+	 *
+	 * @param EE_Form_Section_Base $subsection
+	 * @return string html
+	 */
+	abstract public function layout_subsection($subsection);
+
+
+
+	/**
+	 * Gets the HTML for the label tag and its contents for the input
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function display_label($input)
+	{
+		if($input->get_display_strategy() instanceof EE_Hidden_Display_Strategy){
+			return '';
+		}
+		$class = $input->required()
+			? 'ee-required-label ' . $input->html_label_class()
+			: $input->html_label_class();
+		$label_text = $input->required()
+			? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
+			: $input->html_label_text();
+		return '<label id="'
+			   . $input->html_label_id()
+			   . '" class="'
+			   . $class
+			   . '" style="'
+			   . $input->html_label_style()
+			   . '" for="' . $input->html_name()
+			   . '">'
+			   . $label_text
+			   . '</label>';
+	}
+
+
+
+	/**
+	 * Gets the HTML for all the form's form-wide errors (ie, errors which
+	 * are not for specific inputs. E.g., if two inputs somehow disagree,
+	 * those errors would probably be on the form section, not one of its inputs)
+	 * @return string
+	 */
+	public function display_form_wide_errors()
+	{
+		$html = '';
+		if ($this->_form_section->get_validation_errors()) {
+			$html .= "<div class='ee-form-wide-errors'>";
+			//get all the errors on THIS form section (errors which aren't
+			//for specific inputs, but instead for the entire form section)
+			foreach ($this->_form_section->get_validation_errors() as $error) {
+				$html .= $error->getMessage() . '<br>';
+			}
+			$html .= '</div>';
+		}
+		return apply_filters(
+			'FHEE__EE_Form_Section_Layout_Base__display_form_wide_errors',
+			$html,
+			$this
+		);
+	}
+
+
+
+	/**
+	 * returns the HTML for the server-side validation errors for the specified input
+	 * Note that if JS is enabled, it should remove these and instead
+	 * populate the form's errors in the jquery validate fashion
+	 * using the localized data provided to the JS
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function display_errors($input)
+	{
+		if ($input->get_validation_errors()) {
+			return "<label  id='"
+				   . $input->html_id()
+				   . "-error' class='error' for='{$input->html_name()}'>"
+				   . $input->get_validation_error_string()
+				   . '</label>';
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * Displays the help span for the specified input
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function display_help_text($input)
+	{
+		$help_text  = $input->html_help_text();
+		if ($help_text !== '' && $help_text !== null) {
+			$tag = is_admin() ? 'p' : 'span';
+			return '<'
+				   . $tag
+				   . ' id="'
+				   . $input->html_id()
+				   . '-help" class="'
+				   . $input->html_help_class()
+				   . '" style="'
+				   . $input->html_help_style()
+				   . '">'
+				   . $help_text
+				   . '</'
+				   . $tag
+				   . '>';
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * Does an action and hook onto the end of teh form
+	 *
+	 * @param string $html
+	 * @return string
+	 */
+	public function add_form_section_hooks_and_filters($html)
+	{
+		// replace dashes and spaces with underscores
+		$hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
+		do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
+		$html = (string) apply_filters(
+			'AFEE__Form_Section_Layout__' . $hook_name . '__html',
+			$html,
+			$this->_form_section
+		);
+		$html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
+		$html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
+		return $html;
+	}
 }

Spacing +15 added lines, -15 removed lines

@@ -70,19 +70,19 @@ 
         $html = '';
         // layout_form_begin
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__start__for_'.$this->_form_section->name(),
             $this->layout_form_begin(),
             $this->_form_section
         );
         // layout_form_loop
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__loop__for_'.$this->_form_section->name(),
             $this->layout_form_loop(),
             $this->_form_section
         );
         // layout_form_end
         $html .= apply_filters(
-            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_' . $this->_form_section->name(),
+            'FHEE__EE_Form_Section_Layout_Base__layout_form__end__for_'.$this->_form_section->name(),
             $this->layout_form_end(),
             $this->_form_section
         );
@@ -103,7 +103,7 @@ 
             if ($subsection instanceof EE_Form_Input_Base) {
                 $html .= apply_filters(
                     'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
+                    . $name.'__in_'.$this->_form_section->name(),
                     $this->layout_input($subsection),
                     $this->_form_section,
                     $subsection
@@ -111,7 +111,7 @@ 
             } elseif ($subsection instanceof EE_Form_Section_Base) {
                 $html .= apply_filters(
                     'FHEE__EE_Form_Section_Layout_Base__layout_form__loop_for_non_input_'
-                    . $name . '__in_' . $this->_form_section->name(),
+                    . $name.'__in_'.$this->_form_section->name(),
                     $this->layout_subsection($subsection),
                     $this->_form_section,
                     $subsection
@@ -176,14 +176,14 @@ 
      */
     public function display_label($input)
     {
-        if($input->get_display_strategy() instanceof EE_Hidden_Display_Strategy){
+        if ($input->get_display_strategy() instanceof EE_Hidden_Display_Strategy) {
             return '';
         }
         $class = $input->required()
-            ? 'ee-required-label ' . $input->html_label_class()
+            ? 'ee-required-label '.$input->html_label_class()
             : $input->html_label_class();
         $label_text = $input->required()
-            ? $input->html_label_text() . '<span class="ee-asterisk">*</span>'
+            ? $input->html_label_text().'<span class="ee-asterisk">*</span>'
             : $input->html_label_text();
         return '<label id="'
                . $input->html_label_id()
@@ -191,7 +191,7 @@ 
                . $class
                . '" style="'
                . $input->html_label_style()
-               . '" for="' . $input->html_name()
+               . '" for="'.$input->html_name()
                . '">'
                . $label_text
                . '</label>';
@@ -213,7 +213,7 @@ 
             //get all the errors on THIS form section (errors which aren't
             //for specific inputs, but instead for the entire form section)
             foreach ($this->_form_section->get_validation_errors() as $error) {
-                $html .= $error->getMessage() . '<br>';
+                $html .= $error->getMessage().'<br>';
             }
             $html .= '</div>';
         }
@@ -257,7 +257,7 @@ 
      */
     public function display_help_text($input)
     {
-        $help_text  = $input->html_help_text();
+        $help_text = $input->html_help_text();
         if ($help_text !== '' && $help_text !== null) {
             $tag = is_admin() ? 'p' : 'span';
             return '<'
@@ -289,14 +289,14 @@ 
     {
         // replace dashes and spaces with underscores
         $hook_name = str_replace(array('-', ' '), '_', $this->_form_section->html_id());
-        do_action('AHEE__Form_Section_Layout__' . $hook_name, $this->_form_section);
+        do_action('AHEE__Form_Section_Layout__'.$hook_name, $this->_form_section);
         $html = (string) apply_filters(
-            'AFEE__Form_Section_Layout__' . $hook_name . '__html',
+            'AFEE__Form_Section_Layout__'.$hook_name.'__html',
             $html,
             $this->_form_section
         );
-        $html .= EEH_HTML::nl() . '<!-- AHEE__Form_Section_Layout__' . $hook_name . '__html -->';
-        $html .= EEH_HTML::nl() . '<!-- AFEE__Form_Section_Layout__' . $hook_name . ' -->';
+        $html .= EEH_HTML::nl().'<!-- AHEE__Form_Section_Layout__'.$hook_name.'__html -->';
+        $html .= EEH_HTML::nl().'<!-- AFEE__Form_Section_Layout__'.$hook_name.' -->';
         return $html;
     }
 }

core/helpers/EEH_Qtip_Loader.helper.php

Spacing +42 added lines, -42 removed lines

@@ -32,7 +32,7 @@ 
 	 */
 	public static function instance() {
 		// check if class object is instantiated
-		if ( self::$_instance === NULL  or ! is_object( self::$_instance ) or ! ( self::$_instance instanceof EEH_Qtip_Loader )) {
+		if (self::$_instance === NULL or ! is_object(self::$_instance) or ! (self::$_instance instanceof EEH_Qtip_Loader)) {
 			self::$_instance = new self();
 		}
 		return self::$_instance;
@@ -48,8 +48,8 @@ 
 	 */
 	private function __construct() {
 		//let's just make sure this is instantiated in the right place.
-		if ( did_action( 'wp_print_styles' ) || did_action( 'admin_head' )) {
-			EE_Error::doing_it_wrong( 'EEH_Qtip_Loader', __('This helper must be instantiated before or within a callback for the WordPress wp_enqueue_scripts hook action hook.', 'event_espresso' ), '4.1' );
+		if (did_action('wp_print_styles') || did_action('admin_head')) {
+			EE_Error::doing_it_wrong('EEH_Qtip_Loader', __('This helper must be instantiated before or within a callback for the WordPress wp_enqueue_scripts hook action hook.', 'event_espresso'), '4.1');
 		}
 	}
 
@@ -61,25 +61,25 @@ 
 	 * @return void
 	 */
 	public function register_and_enqueue() {
-		$qtips_js = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.js';
-		$qtip_map = EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.map';
-		$qtipcss = !defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.css';
+		$qtips_js = ! defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.js' : EE_THIRD_PARTY_URL.'qtip/jquery.qtip.js';
+		$qtip_map = EE_THIRD_PARTY_URL.'qtip/jquery.qtip.min.map';
+		$qtipcss = ! defined('SCRIPT_DEBUG') ? EE_THIRD_PARTY_URL . 'qtip/jquery.qtip.min.css' : EE_THIRD_PARTY_URL.'qtip/jquery.qtip.css';
 
-		wp_register_script('qtip-map', $qtip_map, array(), '3', TRUE );
-		wp_register_script('qtip', $qtips_js, array('jquery'), '3.0.3', TRUE );
-		wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS . 'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, TRUE );
+		wp_register_script('qtip-map', $qtip_map, array(), '3', TRUE);
+		wp_register_script('qtip', $qtips_js, array('jquery'), '3.0.3', TRUE);
+		wp_register_script('ee-qtip-helper', EE_HELPERS_ASSETS.'ee-qtip-helper.js', array('qtip', 'jquery-cookie'), EVENT_ESPRESSO_VERSION, TRUE);
 
-		wp_register_style('qtip-css', $qtipcss, array(), '2.2' );
+		wp_register_style('qtip-css', $qtipcss, array(), '2.2');
 
 		//k now let's see if there are any registered qtips.  If there are, then we need to setup the localized script for ee-qtip-helper.js (and enqueue ee-qtip-helper.js of course!)
-		if ( !empty( $this->_qtips ) ) {
+		if ( ! empty($this->_qtips)) {
 			wp_enqueue_script('ee-qtip-helper');
 			wp_enqueue_style('qtip-css');
 			$qtips = array();
-			foreach ( $this->_qtips as $qtip ) {
+			foreach ($this->_qtips as $qtip) {
 				$qts = $qtip->get_tips();
-				foreach ( $qts as $qt ) {
-					if ( ! $qt instanceof EE_Qtip )
+				foreach ($qts as $qt) {
+					if ( ! $qt instanceof EE_Qtip)
 						continue;
 					$qtips[] = array(
 						'content_id' => $qt->content_id,
@@ -88,8 +88,8 @@ 
 						);
 				}
 			}
-			if ( !empty($qtips) )
-				wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array( 'qtips' => $qtips ) );
+			if ( ! empty($qtips))
+				wp_localize_script('ee-qtip-helper', 'EE_QTIP_HELPER', array('qtips' => $qtips));
 
 		} else {
 			//qtips has been requested without any registration (so assuming its just directly used in the admin).
@@ -111,24 +111,24 @@ 
 	 * @param  string|array $configname name of the Qtip class (full class name is expected and will be used for looking for file, Qtip config classes must extend EE_Qtip_Config) [if this is an array, then we loop through the array to instantiate and setup the qtips]
 	 * @return void
 	 */
-	public function register( $configname, $paths = array() ) {
+	public function register($configname, $paths = array()) {
 
 		//let's just make sure this is instantiated in the right place.
-		if ( did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts') ) {
-			EE_Error::doing_it_wrong( 'EEH_Qtip_Loader->register()', __('EE_Qtip_Config objects must be registered before wp_enqueue_scripts is called.', 'event_espresso' ), '4.1' );
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			EE_Error::doing_it_wrong('EEH_Qtip_Loader->register()', __('EE_Qtip_Config objects must be registered before wp_enqueue_scripts is called.', 'event_espresso'), '4.1');
 		}
 
 		$configname = (array) $configname; //typecast to array
-		foreach ( $configname as $config ) {
-			$this->_register( $config, $paths );
+		foreach ($configname as $config) {
+			$this->_register($config, $paths);
 		}
 
 		//hook into appropriate footer
 		$footer_action = is_admin() ? 'admin_footer' : 'wp_footer';
-		add_action($footer_action, array($this, 'setup_qtip'), 10 );
+		add_action($footer_action, array($this, 'setup_qtip'), 10);
 
 		//make sure we "turn on" qtip js.
-		add_filter('FHEE_load_qtip', '__return_true' );
+		add_filter('FHEE_load_qtip', '__return_true');
 	}
 
 
@@ -142,15 +142,15 @@ 
 	 * @throws EE_Error
 	 * @return void
 	 */
-	private function _register( $config, $paths ) {
+	private function _register($config, $paths) {
 		//before doing anything we have to make sure that EE_Qtip_Config parent is required.
-		EE_Registry::instance()->load_lib( 'Qtip_Config', array(), TRUE );
+		EE_Registry::instance()->load_lib('Qtip_Config', array(), TRUE);
 
-		if ( !empty( $paths ) ) {
+		if ( ! empty($paths)) {
 			$paths = (array) $paths;
-			foreach ( $paths as $path ) {
-				$path = $path . $config . '.lib.php';
-				if ( !is_readable($path ) ) {
+			foreach ($paths as $path) {
+				$path = $path.$config.'.lib.php';
+				if ( ! is_readable($path)) {
 					continue;
 				} else {
 					require_once $path;
@@ -159,26 +159,26 @@ 
 		}
 
 		//does class exist at this point?  If it does then let's instantiate.  If it doesn't then let's continue with other paths.
-		if ( !class_exists($config) ) {
-			$path = EE_LIBRARIES . 'qtips/' . $config . '.lib.php';
-			if ( !is_readable($path ) ) {
-				throw new EE_Error( sprintf( __('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config ) );
+		if ( ! class_exists($config)) {
+			$path = EE_LIBRARIES.'qtips/'.$config.'.lib.php';
+			if ( ! is_readable($path)) {
+				throw new EE_Error(sprintf(__('Unable to load the Qtip Config registered for this page (%s) because none of the file paths attempted are readable.  Please check the spelling of the paths you\'ve used in the registration', 'event_espresso'), $config));
 			} else {
 				require_once $path;
 			}
 		}
 
 		//now we attempt a class_exists one more time.
-		if ( !class_exists( $config ) )
-			throw new EE_Error( sprintf( __('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config ) );
+		if ( ! class_exists($config))
+			throw new EE_Error(sprintf(__('The Qtip_Config class being registered (%s) does not exist, please check the spelling.', 'event_espresso'), $config));
 
 		//made it HERE?  FINALLY, let's get things setup.
 		$a = new ReflectionClass($config);
 		$qtip = $a->newInstance();
 
 		//verify that $qtip is a valid object
-		if ( ! $qtip instanceof EE_Qtip_Config )
-			throw new EE_Error( sprintf( esc_html__( 'The class given for the Qtip loader (%1$s) is not a child of the %2$sEE_Qtip_Config%3$s class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config, '<strong>', '</strong>' ) );
+		if ( ! $qtip instanceof EE_Qtip_Config)
+			throw new EE_Error(sprintf(esc_html__('The class given for the Qtip loader (%1$s) is not a child of the %2$sEE_Qtip_Config%3$s class. Please make sure you are extending EE_Qtip_Config.', 'event_espresso'), $config, '<strong>', '</strong>'));
 
 		$this->_qtips[] = $a->newInstance();
 
@@ -194,12 +194,12 @@ 
 	 * @return void
 	 */
 	public function setup_qtip() {
-		if ( empty( $this->_qtips ) )
+		if (empty($this->_qtips))
 			return; //no qtips!
 
 		$content = array();
 
-		foreach ( $this->_qtips as $qtip ) {
+		foreach ($this->_qtips as $qtip) {
 			$content[] = $this->_generate_content_container($qtip);
 		}
 
@@ -216,10 +216,10 @@ 
 	private function _generate_content_container($qtip) {
 		$qts = $qtip->get_tips();
 		$content = array();
-		foreach ( $qts as $qt ) {
-			if ( ! $qt instanceof EE_Qtip )
+		foreach ($qts as $qt) {
+			if ( ! $qt instanceof EE_Qtip)
 				continue;
-			$content[] = '<div class="ee-qtip-helper-content hidden" id="' . $qt->content_id . '">' . $qt->content . '</div>';
+			$content[] = '<div class="ee-qtip-helper-content hidden" id="'.$qt->content_id.'">'.$qt->content.'</div>';
 		}
 
 		return implode('<br />', $content);

core/domain/DomainBase.php

Indentation +120 added lines, -120 removed lines

@@ -19,126 +19,126 @@
 abstract class DomainBase implements DomainInterface
 {
 
-    /**
-     * Equivalent to `__FILE__` for main plugin file.
-     *
-     * @var FilePath
-     */
-    private $plugin_file;
+	/**
+	 * Equivalent to `__FILE__` for main plugin file.
+	 *
+	 * @var FilePath
+	 */
+	private $plugin_file;
 
-    /**
-     * String indicating version for plugin
-     *
-     * @var string
-     */
-    private $version;
-
-    /**
-     * @var string $plugin_basename
-     */
-    private $plugin_basename;
-
-    /**
-     * @var string $plugin_path
-     */
-    private $plugin_path;
-
-    /**
-     * @var string $plugin_url
-     */
-    private $plugin_url;
-
-
-
-    /**
-     * Initializes internal properties.
-     *
-     * @param FilePath $plugin_file
-     * @param Version  $version
-     */
-    public function __construct(FilePath $plugin_file, Version $version)
-    {
-        $this->plugin_file = $plugin_file;
-        $this->version = $version;
-        $this->plugin_basename = plugin_basename($this->pluginFile());
-        $this->plugin_path = plugin_dir_path($this->pluginFile());
-        $this->plugin_url = plugin_dir_url($this->pluginFile());
-    }
-
-
-    /**
-     * @return string
-     */
-    public function pluginFile()
-    {
-        return (string) $this->plugin_file;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginBasename()
-    {
-        return $this->plugin_basename;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginPath()
-    {
-        return $this->plugin_path;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function pluginUrl()
-    {
-        return $this->plugin_url;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function version()
-    {
-        return (string) $this->version;
-    }
-
-
-
-    /**
-     * @return Version
-     */
-    public function versionValueObject()
-    {
-        return $this->version;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function distributionAssetsPath()
-    {
-        return $this->pluginPath() . 'assets/dist/';
-    }
+	/**
+	 * String indicating version for plugin
+	 *
+	 * @var string
+	 */
+	private $version;
+
+	/**
+	 * @var string $plugin_basename
+	 */
+	private $plugin_basename;
+
+	/**
+	 * @var string $plugin_path
+	 */
+	private $plugin_path;
+
+	/**
+	 * @var string $plugin_url
+	 */
+	private $plugin_url;
+
+
+
+	/**
+	 * Initializes internal properties.
+	 *
+	 * @param FilePath $plugin_file
+	 * @param Version  $version
+	 */
+	public function __construct(FilePath $plugin_file, Version $version)
+	{
+		$this->plugin_file = $plugin_file;
+		$this->version = $version;
+		$this->plugin_basename = plugin_basename($this->pluginFile());
+		$this->plugin_path = plugin_dir_path($this->pluginFile());
+		$this->plugin_url = plugin_dir_url($this->pluginFile());
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginFile()
+	{
+		return (string) $this->plugin_file;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginBasename()
+	{
+		return $this->plugin_basename;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginPath()
+	{
+		return $this->plugin_path;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function pluginUrl()
+	{
+		return $this->plugin_url;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function version()
+	{
+		return (string) $this->version;
+	}
+
+
+
+	/**
+	 * @return Version
+	 */
+	public function versionValueObject()
+	{
+		return $this->version;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsPath()
+	{
+		return $this->pluginPath() . 'assets/dist/';
+	}
 
-
-    /**
-     * @return string
-     */
-    public function distributionAssetsUrl()
-    {
-        return $this->pluginUrl() . 'assets/dist/';
-    }
+
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsUrl()
+	{
+		return $this->pluginUrl() . 'assets/dist/';
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -130,7 +130,7 @@ 
      */
     public function distributionAssetsPath()
     {
-        return $this->pluginPath() . 'assets/dist/';
+        return $this->pluginPath().'assets/dist/';
     }
 
 
@@ -139,6 +139,6 @@ 
      */
     public function distributionAssetsUrl()
     {
-        return $this->pluginUrl() . 'assets/dist/';
+        return $this->pluginUrl().'assets/dist/';
     }
 }

core/EE_Dependency_Map.core.php

Spacing +25 added lines, -25 removed lines

@@ -7,7 +7,7 @@ 
 use EventEspresso\core\services\request\RequestInterface;
 use EventEspresso\core\services\request\ResponseInterface;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -129,7 +129,7 @@ 
      */
     public static function instance() {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Dependency_Map) {
+        if ( ! self::$_instance instanceof EE_Dependency_Map) {
             self::$_instance = new EE_Dependency_Map(/*$request, $response, $legacy_request*/);
         }
         return self::$_instance;
@@ -211,8 +211,8 @@ 
     ) {
         $class = trim($class, '\\');
         $registered = false;
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
-            self::$_instance->_dependency_map[ $class ] = array();
+        if (empty(self::$_instance->_dependency_map[$class])) {
+            self::$_instance->_dependency_map[$class] = array();
         }
         // we need to make sure that any aliases used when registering a dependency
         // get resolved to the correct class name
@@ -220,7 +220,7 @@ 
             $alias = self::$_instance->get_alias($dependency);
             if (
                 $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
+                || ! isset(self::$_instance->_dependency_map[$class][$alias])
             ) {
                 unset($dependencies[$dependency]);
                 $dependencies[$alias] = $load_source;
@@ -233,13 +233,13 @@ 
         // ie: with A = B + C, entries in B take precedence over duplicate entries in C
         // Union is way faster than array_merge() but should be used with caution...
         // especially with numerically indexed arrays
-        $dependencies += self::$_instance->_dependency_map[ $class ];
+        $dependencies += self::$_instance->_dependency_map[$class];
         // now we need to ensure that the resulting dependencies
         // array only has the entries that are required for the class
         // so first count how many dependencies were originally registered for the class
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
+        $dependency_count = count(self::$_instance->_dependency_map[$class]);
         // if that count is non-zero (meaning dependencies were already registered)
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
+        self::$_instance->_dependency_map[$class] = $dependency_count
             // then truncate the  final array to match that count
             ? array_slice($dependencies, 0, $dependency_count)
             // otherwise just take the incoming array because nothing previously existed
@@ -257,7 +257,7 @@ 
      */
     public static function register_class_loader($class_name, $loader = 'load_core')
     {
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
+        if ( ! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
             throw new DomainException(
                 esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
             );
@@ -281,7 +281,7 @@ 
             );
         }
         $class_name = self::$_instance->get_alias($class_name);
-        if (! isset(self::$_instance->_class_loaders[$class_name])) {
+        if ( ! isset(self::$_instance->_class_loaders[$class_name])) {
             self::$_instance->_class_loaders[$class_name] = $loader;
             return true;
         }
@@ -366,7 +366,7 @@ 
     public function class_loader($class_name)
     {
         // all legacy models use load_model()
-        if(strpos($class_name, 'EEM_') === 0){
+        if (strpos($class_name, 'EEM_') === 0) {
             return 'load_model';
         }
         $class_name = $this->get_alias($class_name);
@@ -395,7 +395,7 @@ 
     public function add_alias($class_name, $alias, $for_class = '')
     {
         if ($for_class !== '') {
-            if (! isset($this->_aliases[$for_class])) {
+            if ( ! isset($this->_aliases[$for_class])) {
                 $this->_aliases[$for_class] = array();
             }
             $this->_aliases[$for_class][$class_name] = $alias;
@@ -441,10 +441,10 @@ 
      */
     public function get_alias($class_name = '', $for_class = '')
     {
-        if (! $this->has_alias($class_name, $for_class)) {
+        if ( ! $this->has_alias($class_name, $for_class)) {
             return $class_name;
         }
-        if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) {
+        if ($for_class !== '' && isset($this->_aliases[$for_class][$class_name])) {
             return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class);
         }
         return $this->get_alias($this->_aliases[$class_name]);
@@ -714,13 +714,13 @@ 
             'EE_Front_Controller'      => 'load_core',
             'EE_Module_Request_Router' => 'load_core',
             'EE_Registry'              => 'load_core',
-            'EE_Request'               => function () use (&$legacy_request) {
+            'EE_Request'               => function() use (&$legacy_request) {
                 return $legacy_request;
             },
-            'EventEspresso\core\services\request\Request' => function () use (&$request) {
+            'EventEspresso\core\services\request\Request' => function() use (&$request) {
                 return $request;
             },
-            'EventEspresso\core\services\request\Response' => function () use (&$response) {
+            'EventEspresso\core\services\request\Response' => function() use (&$response) {
                 return $response;
             },
             'EE_Request_Handler'       => 'load_core',
@@ -742,7 +742,7 @@ 
             'EE_Messages_Data_Handler_Collection'  => 'load_lib',
             'EE_Message_Template_Group_Collection' => 'load_lib',
             'EE_Payment_Method_Manager'            => 'load_lib',
-            'EE_Messages_Generator'                => function () {
+            'EE_Messages_Generator'                => function() {
                 return EE_Registry::instance()->load_lib(
                     'Messages_Generator',
                     array(),
@@ -750,7 +750,7 @@ 
                     false
                 );
             },
-            'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
+            'EE_Messages_Template_Defaults'        => function($arguments = array()) {
                 return EE_Registry::instance()->load_lib(
                     'Messages_Template_Defaults',
                     $arguments,
@@ -763,22 +763,22 @@ 
             // 'EEM_Message_Template_Group'           => 'load_model',
             // 'EEM_Message_Template'                 => 'load_model',
             //load_helper
-            'EEH_Parse_Shortcodes'                 => function () {
+            'EEH_Parse_Shortcodes'                 => function() {
                 if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
                     return new EEH_Parse_Shortcodes();
                 }
                 return null;
             },
-            'EE_Template_Config'                   => function () {
+            'EE_Template_Config'                   => function() {
                 return EE_Config::instance()->template_settings;
             },
-            'EE_Currency_Config'                   => function () {
+            'EE_Currency_Config'                   => function() {
                 return EE_Config::instance()->currency;
             },
-            'EE_Registration_Config'                   => function () {
+            'EE_Registration_Config'                   => function() {
                 return EE_Config::instance()->registration;
             },
-            'EventEspresso\core\services\loaders\Loader' => function () {
+            'EventEspresso\core\services\loaders\Loader' => function() {
                 return LoaderFactory::getLoader();
             },
         );
@@ -834,7 +834,7 @@ 
             'EventEspresso\core\services\request\ResponseInterface'               => 'EventEspresso\core\services\request\Response',
             'EventEspresso\core\domain\DomainInterface'                           => 'EventEspresso\core\domain\Domain',
         );
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
             $this->_aliases['EventEspresso\core\services\notices\NoticeConverterInterface'] = 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices';
         }
     }

Indentation +836 added lines, -836 removed lines

@@ -8,7 +8,7 @@ 
 use EventEspresso\core\services\request\ResponseInterface;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -25,841 +25,841 @@ 
 class EE_Dependency_Map
 {
 
-    /**
-     * This means that the requested class dependency is not present in the dependency map
-     */
-    const not_registered = 0;
-
-    /**
-     * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
-     */
-    const load_new_object = 1;
-
-    /**
-     * This instructs class loaders to return a previously instantiated and cached object for the requested class.
-     * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
-     */
-    const load_from_cache = 2;
-
-    /**
-     * When registering a dependency,
-     * this indicates to keep any existing dependencies that already exist,
-     * and simply discard any new dependencies declared in the incoming data
-     */
-    const KEEP_EXISTING_DEPENDENCIES = 0;
-
-    /**
-     * When registering a dependency,
-     * this indicates to overwrite any existing dependencies that already exist using the incoming data
-     */
-    const OVERWRITE_DEPENDENCIES = 1;
-
-
-
-    /**
-     * @type EE_Dependency_Map $_instance
-     */
-    protected static $_instance;
-
-    /**
-     * @type RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * @type LegacyRequestInterface $legacy_request
-     */
-    protected $legacy_request;
-
-    /**
-     * @type ResponseInterface $response
-     */
-    protected $response;
-
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @type array $_dependency_map
-     */
-    protected $_dependency_map = array();
-
-    /**
-     * @type array $_class_loaders
-     */
-    protected $_class_loaders = array();
-
-    /**
-     * @type array $_aliases
-     */
-    protected $_aliases = array();
-
-
-
-    /**
-     * EE_Dependency_Map constructor.
-     */
-    protected function __construct()
-    {
-        // add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
-        do_action('EE_Dependency_Map____construct');
-    }
-
-
-
-    /**
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function initialize()
-    {
-        $this->_register_core_dependencies();
-        $this->_register_core_class_loaders();
-        $this->_register_core_aliases();
-    }
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Dependency_Map
-     */
-    public static function instance() {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Dependency_Map) {
-            self::$_instance = new EE_Dependency_Map(/*$request, $response, $legacy_request*/);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param RequestInterface $request
-     */
-    public function setRequest(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
-
-
-    /**
-     * @param LegacyRequestInterface $legacy_request
-     */
-    public function setLegacyRequest(LegacyRequestInterface $legacy_request)
-    {
-        $this->legacy_request = $legacy_request;
-    }
-
-
-    /**
-     * @param ResponseInterface $response
-     */
-    public function setResponse(ResponseInterface $response)
-    {
-        $this->response = $response;
-    }
-
-
-
-    /**
-     * @param LoaderInterface $loader
-     */
-    public function setLoader(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-
-    /**
-     * @param string $class
-     * @param array  $dependencies
-     * @param int    $overwrite
-     * @return bool
-     */
-    public static function register_dependencies(
-        $class,
-        array $dependencies,
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
-    ) {
-        return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
-    }
-
-
-
-    /**
-     * Assigns an array of class names and corresponding load sources (new or cached)
-     * to the class specified by the first parameter.
-     * IMPORTANT !!!
-     * The order of elements in the incoming $dependencies array MUST match
-     * the order of the constructor parameters for the class in question.
-     * This is especially important when overriding any existing dependencies that are registered.
-     * the third parameter controls whether any duplicate dependencies are overwritten or not.
-     *
-     * @param string $class
-     * @param array  $dependencies
-     * @param int    $overwrite
-     * @return bool
-     */
-    public function registerDependencies(
-        $class,
-        array $dependencies,
-        $overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
-    ) {
-        $class = trim($class, '\\');
-        $registered = false;
-        if (empty(self::$_instance->_dependency_map[ $class ])) {
-            self::$_instance->_dependency_map[ $class ] = array();
-        }
-        // we need to make sure that any aliases used when registering a dependency
-        // get resolved to the correct class name
-        foreach ($dependencies as $dependency => $load_source) {
-            $alias = self::$_instance->get_alias($dependency);
-            if (
-                $overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
-                || ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
-            ) {
-                unset($dependencies[$dependency]);
-                $dependencies[$alias] = $load_source;
-                $registered = true;
-            }
-        }
-        // now add our two lists of dependencies together.
-        // using Union (+=) favours the arrays in precedence from left to right,
-        // so $dependencies is NOT overwritten because it is listed first
-        // ie: with A = B + C, entries in B take precedence over duplicate entries in C
-        // Union is way faster than array_merge() but should be used with caution...
-        // especially with numerically indexed arrays
-        $dependencies += self::$_instance->_dependency_map[ $class ];
-        // now we need to ensure that the resulting dependencies
-        // array only has the entries that are required for the class
-        // so first count how many dependencies were originally registered for the class
-        $dependency_count = count(self::$_instance->_dependency_map[ $class ]);
-        // if that count is non-zero (meaning dependencies were already registered)
-        self::$_instance->_dependency_map[ $class ] = $dependency_count
-            // then truncate the  final array to match that count
-            ? array_slice($dependencies, 0, $dependency_count)
-            // otherwise just take the incoming array because nothing previously existed
-            : $dependencies;
-        return $registered;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @param string $loader
-     * @return bool
-     * @throws DomainException
-     */
-    public static function register_class_loader($class_name, $loader = 'load_core')
-    {
-        if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
-            throw new DomainException(
-                esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
-            );
-        }
-        // check that loader is callable or method starts with "load_" and exists in EE_Registry
-        if (
-            ! is_callable($loader)
-            && (
-                strpos($loader, 'load_') !== 0
-                || ! method_exists('EE_Registry', $loader)
-            )
-        ) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        '"%1$s" is not a valid loader method on EE_Registry.',
-                        'event_espresso'
-                    ),
-                    $loader
-                )
-            );
-        }
-        $class_name = self::$_instance->get_alias($class_name);
-        if (! isset(self::$_instance->_class_loaders[$class_name])) {
-            self::$_instance->_class_loaders[$class_name] = $loader;
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function dependency_map()
-    {
-        return $this->_dependency_map;
-    }
-
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name
-     *
-     * @param string $class_name
-     * @return boolean
-     */
-    public function has($class_name = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        return isset($this->_dependency_map[$class_name]) ? true : false;
-    }
-
-
-
-    /**
-     * returns TRUE if dependency map contains a listing for the provided class name AND dependency
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return bool
-     */
-    public function has_dependency_for_class($class_name = '', $dependency = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        $dependency = $this->get_alias($dependency);
-        return isset($this->_dependency_map[$class_name][$dependency])
-            ? true
-            : false;
-    }
-
-
-
-    /**
-     * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
-     *
-     * @param string $class_name
-     * @param string $dependency
-     * @return int
-     */
-    public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
-    {
-        // all legacy models have the same dependencies
-        if (strpos($class_name, 'EEM_') === 0) {
-            $class_name = 'LEGACY_MODELS';
-        }
-        $dependency = $this->get_alias($dependency);
-        return $this->has_dependency_for_class($class_name, $dependency)
-            ? $this->_dependency_map[$class_name][$dependency]
-            : EE_Dependency_Map::not_registered;
-    }
-
-
-
-    /**
-     * @param string $class_name
-     * @return string | Closure
-     */
-    public function class_loader($class_name)
-    {
-        // all legacy models use load_model()
-        if(strpos($class_name, 'EEM_') === 0){
-            return 'load_model';
-        }
-        $class_name = $this->get_alias($class_name);
-        return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function class_loaders()
-    {
-        return $this->_class_loaders;
-    }
-
-
-
-    /**
-     * adds an alias for a classname
-     *
-     * @param string $class_name the class name that should be used (concrete class to replace interface)
-     * @param string $alias      the class name that would be type hinted for (abstract parent or interface)
-     * @param string $for_class  the class that has the dependency (is type hinting for the interface)
-     */
-    public function add_alias($class_name, $alias, $for_class = '')
-    {
-        if ($for_class !== '') {
-            if (! isset($this->_aliases[$for_class])) {
-                $this->_aliases[$for_class] = array();
-            }
-            $this->_aliases[$for_class][$class_name] = $alias;
-        }
-        $this->_aliases[$class_name] = $alias;
-    }
-
-
-
-    /**
-     * returns TRUE if the provided class name has an alias
-     *
-     * @param string $class_name
-     * @param string $for_class
-     * @return bool
-     */
-    public function has_alias($class_name = '', $for_class = '')
-    {
-        return isset($this->_aliases[$for_class][$class_name])
-               || (
-                   isset($this->_aliases[$class_name])
-                   && ! is_array($this->_aliases[$class_name])
-               );
-    }
-
-
-
-    /**
-     * returns alias for class name if one exists, otherwise returns the original classname
-     * functions recursively, so that multiple aliases can be used to drill down to a classname
-     *  for example:
-     *      if the following two entries were added to the _aliases array:
-     *          array(
-     *              'interface_alias'           => 'some\namespace\interface'
-     *              'some\namespace\interface'  => 'some\namespace\classname'
-     *          )
-     *      then one could use EE_Registry::instance()->create( 'interface_alias' )
-     *      to load an instance of 'some\namespace\classname'
-     *
-     * @param string $class_name
-     * @param string $for_class
-     * @return string
-     */
-    public function get_alias($class_name = '', $for_class = '')
-    {
-        if (! $this->has_alias($class_name, $for_class)) {
-            return $class_name;
-        }
-        if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) {
-            return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class);
-        }
-        return $this->get_alias($this->_aliases[$class_name]);
-    }
-
-
-
-    /**
-     * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
-     * if one exists, or whether a new object should be generated every time the requested class is loaded.
-     * This is done by using the following class constants:
-     *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
-     *        EE_Dependency_Map::load_new_object - generates a new object every time
-     */
-    protected function _register_core_dependencies()
-    {
-        $this->_dependency_map = array(
-            'EE_Request_Handler'                                                                                          => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_System'                                                                                                   => array(
-                'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-                'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Session'                                                                                                  => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
-                'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Cart'                                                                                                     => array(
-                'EE_Session' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Front_Controller'                                                                                         => array(
-                'EE_Registry'              => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
-                'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messenger_Collection_Loader'                                                                              => array(
-                'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Message_Type_Collection_Loader'                                                                           => array(
-                'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Message_Resource_Manager'                                                                                 => array(
-                'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
-                'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
-                'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Message_Factory'                                                                                          => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_messages'                                                                                                 => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Generator'                                                                                       => array(
-                'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
-                'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
-                'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
-                'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Processor'                                                                                       => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Messages_Queue'                                                                                           => array(
-                'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
-            ),
-            'EE_Messages_Template_Defaults'                                                                               => array(
-                'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
-                'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Message_To_Generate_From_Request'                                                                         => array(
-                'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
-                'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandBus'                                                             => array(
-                'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\services\commands\CommandHandler'                                                              => array(
-                'EE_Registry'         => EE_Dependency_Map::load_from_cache,
-                'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
-                'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
-                'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
-                'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
-                'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
-                'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
-                'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
-                'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
-                'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
-                'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
-                'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\database\TableManager'                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Data_Migration_Class_Base'                                                                                => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_1_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_2_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_3_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_4_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_5_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_6_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_7_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_8_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_DMS_Core_4_9_0'                                                                                           => array(
-                'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\assets\Registry'                                                                 => array(
-                'EE_Template_Config' => EE_Dependency_Map::load_from_cache,
-                'EE_Currency_Config' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
-                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\cache\BasicCacheManager'                        => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\cache\PostRelatedCacheManager'                  => array(
-                'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\services\validation\email\EmailValidationService' => array(
-                'EE_Registration_Config'                                  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\domain\values\EmailAddress'                              => array(
-                null,
-                'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\orm\ModelFieldFactory' => array(
-                'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
-            ),
-            'LEGACY_MODELS'                                                   => array(
-                null,
-                'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Module_Request_Router' => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Registration_Processor' => array(
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' => array(
-                null,
-                'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
-                'EE_Request' => EE_Dependency_Map::load_from_cache,
-            ),
-            'EE_Admin_Transactions_List_Table' => array(
-                null,
-                'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
-            ),
-        );
-    }
-
-
-
-    /**
-     * Registers how core classes are loaded.
-     * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
-     *        'EE_Request_Handler' => 'load_core'
-     *        'EE_Messages_Queue'  => 'load_lib'
-     *        'EEH_Debug_Tools'    => 'load_helper'
-     * or, if greater control is required, by providing a custom closure. For example:
-     *        'Some_Class' => function () {
-     *            return new Some_Class();
-     *        },
-     * This is required for instantiating dependencies
-     * where an interface has been type hinted in a class constructor. For example:
-     *        'Required_Interface' => function () {
-     *            return new A_Class_That_Implements_Required_Interface();
-     *        },
-     *
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _register_core_class_loaders()
-    {
-        //for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot
-        //be used in a closure.
-        $request = &$this->request;
-        $response = &$this->response;
-        $legacy_request = &$this->legacy_request;
-        // $loader = &$this->loader;
-        $this->_class_loaders = array(
-            //load_core
-            'EE_Capabilities'          => 'load_core',
-            'EE_Encryption'            => 'load_core',
-            'EE_Front_Controller'      => 'load_core',
-            'EE_Module_Request_Router' => 'load_core',
-            'EE_Registry'              => 'load_core',
-            'EE_Request'               => function () use (&$legacy_request) {
-                return $legacy_request;
-            },
-            'EventEspresso\core\services\request\Request' => function () use (&$request) {
-                return $request;
-            },
-            'EventEspresso\core\services\request\Response' => function () use (&$response) {
-                return $response;
-            },
-            'EE_Request_Handler'       => 'load_core',
-            'EE_Session'               => 'load_core',
-            'EE_Cron_Tasks'            => 'load_core',
-            'EE_System'                => 'load_core',
-            'EE_Maintenance_Mode'      => 'load_core',
-            'EE_Register_CPTs'         => 'load_core',
-            'EE_Admin'                 => 'load_core',
-            //load_lib
-            'EE_Message_Resource_Manager'          => 'load_lib',
-            'EE_Message_Type_Collection'           => 'load_lib',
-            'EE_Message_Type_Collection_Loader'    => 'load_lib',
-            'EE_Messenger_Collection'              => 'load_lib',
-            'EE_Messenger_Collection_Loader'       => 'load_lib',
-            'EE_Messages_Processor'                => 'load_lib',
-            'EE_Message_Repository'                => 'load_lib',
-            'EE_Messages_Queue'                    => 'load_lib',
-            'EE_Messages_Data_Handler_Collection'  => 'load_lib',
-            'EE_Message_Template_Group_Collection' => 'load_lib',
-            'EE_Payment_Method_Manager'            => 'load_lib',
-            'EE_Messages_Generator'                => function () {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Generator',
-                    array(),
-                    false,
-                    false
-                );
-            },
-            'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
-                return EE_Registry::instance()->load_lib(
-                    'Messages_Template_Defaults',
-                    $arguments,
-                    false,
-                    false
-                );
-            },
-            //load_model
-            // 'EEM_Attendee'                         => 'load_model',
-            // 'EEM_Message_Template_Group'           => 'load_model',
-            // 'EEM_Message_Template'                 => 'load_model',
-            //load_helper
-            'EEH_Parse_Shortcodes'                 => function () {
-                if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
-                    return new EEH_Parse_Shortcodes();
-                }
-                return null;
-            },
-            'EE_Template_Config'                   => function () {
-                return EE_Config::instance()->template_settings;
-            },
-            'EE_Currency_Config'                   => function () {
-                return EE_Config::instance()->currency;
-            },
-            'EE_Registration_Config'                   => function () {
-                return EE_Config::instance()->registration;
-            },
-            'EventEspresso\core\services\loaders\Loader' => function () {
-                return LoaderFactory::getLoader();
-            },
-        );
-    }
-
-
-
-    /**
-     * can be used for supplying alternate names for classes,
-     * or for connecting interface names to instantiable classes
-     */
-    protected function _register_core_aliases()
-    {
-        $this->_aliases = array(
-            'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
-            'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
-            'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
-            'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
-            'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
-            'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
-            'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
-            'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
-            'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
-            'CreateRegCodeCommandHandler'                                                  => 'EventEspresso\core\services\commands\registration\CreateRegCodeCommand',
-            'CreateRegUrlLinkCommandHandler'                                               => 'EventEspresso\core\services\commands\registration\CreateRegUrlLinkCommand',
-            'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
-            'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
-            'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
-            'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
-            'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
-            'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
-            'CreateTransactionCommandHandler'                                     => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
-            'CreateAttendeeCommandHandler'                                        => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
-            'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
-            'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
-            'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
-            'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
-            'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
-            'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
-            'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
-            'CommandFactoryInterface'                                                     => 'EventEspresso\core\services\commands\CommandFactoryInterface',
-            'EventEspresso\core\services\commands\CommandFactoryInterface'                => 'EventEspresso\core\services\commands\CommandFactory',
-            'EventEspresso\core\domain\services\session\SessionIdentifierInterface'       => 'EE_Session',
-            'EmailValidatorInterface'                                                     => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
-            'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
-            'NoticeConverterInterface'                                            => 'EventEspresso\core\services\notices\NoticeConverterInterface',
-            'EventEspresso\core\services\notices\NoticeConverterInterface'        => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
-            'NoticesContainerInterface'                                           => 'EventEspresso\core\services\notices\NoticesContainerInterface',
-            'EventEspresso\core\services\notices\NoticesContainerInterface'       => 'EventEspresso\core\services\notices\NoticesContainer',
-            'EventEspresso\core\services\request\RequestInterface'                => 'EventEspresso\core\services\request\Request',
-            'EventEspresso\core\services\request\ResponseInterface'               => 'EventEspresso\core\services\request\Response',
-            'EventEspresso\core\domain\DomainInterface'                           => 'EventEspresso\core\domain\Domain',
-        );
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
-            $this->_aliases['EventEspresso\core\services\notices\NoticeConverterInterface'] = 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices';
-        }
-    }
-
-
-
-    /**
-     * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
-     * request Primarily used by unit tests.
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function reset()
-    {
-        $this->_register_core_class_loaders();
-        $this->_register_core_dependencies();
-    }
+	/**
+	 * This means that the requested class dependency is not present in the dependency map
+	 */
+	const not_registered = 0;
+
+	/**
+	 * This instructs class loaders to ALWAYS return a newly instantiated object for the requested class.
+	 */
+	const load_new_object = 1;
+
+	/**
+	 * This instructs class loaders to return a previously instantiated and cached object for the requested class.
+	 * IF a previously instantiated object does not exist, a new one will be created and added to the cache.
+	 */
+	const load_from_cache = 2;
+
+	/**
+	 * When registering a dependency,
+	 * this indicates to keep any existing dependencies that already exist,
+	 * and simply discard any new dependencies declared in the incoming data
+	 */
+	const KEEP_EXISTING_DEPENDENCIES = 0;
+
+	/**
+	 * When registering a dependency,
+	 * this indicates to overwrite any existing dependencies that already exist using the incoming data
+	 */
+	const OVERWRITE_DEPENDENCIES = 1;
+
+
+
+	/**
+	 * @type EE_Dependency_Map $_instance
+	 */
+	protected static $_instance;
+
+	/**
+	 * @type RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * @type LegacyRequestInterface $legacy_request
+	 */
+	protected $legacy_request;
+
+	/**
+	 * @type ResponseInterface $response
+	 */
+	protected $response;
+
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @type array $_dependency_map
+	 */
+	protected $_dependency_map = array();
+
+	/**
+	 * @type array $_class_loaders
+	 */
+	protected $_class_loaders = array();
+
+	/**
+	 * @type array $_aliases
+	 */
+	protected $_aliases = array();
+
+
+
+	/**
+	 * EE_Dependency_Map constructor.
+	 */
+	protected function __construct()
+	{
+		// add_action('EE_Load_Espresso_Core__handle_request__initialize_core_loading', array($this, 'initialize'));
+		do_action('EE_Dependency_Map____construct');
+	}
+
+
+
+	/**
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function initialize()
+	{
+		$this->_register_core_dependencies();
+		$this->_register_core_class_loaders();
+		$this->_register_core_aliases();
+	}
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Dependency_Map
+	 */
+	public static function instance() {
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Dependency_Map) {
+			self::$_instance = new EE_Dependency_Map(/*$request, $response, $legacy_request*/);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param RequestInterface $request
+	 */
+	public function setRequest(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
+
+
+	/**
+	 * @param LegacyRequestInterface $legacy_request
+	 */
+	public function setLegacyRequest(LegacyRequestInterface $legacy_request)
+	{
+		$this->legacy_request = $legacy_request;
+	}
+
+
+	/**
+	 * @param ResponseInterface $response
+	 */
+	public function setResponse(ResponseInterface $response)
+	{
+		$this->response = $response;
+	}
+
+
+
+	/**
+	 * @param LoaderInterface $loader
+	 */
+	public function setLoader(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+
+	/**
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @param int    $overwrite
+	 * @return bool
+	 */
+	public static function register_dependencies(
+		$class,
+		array $dependencies,
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
+	) {
+		return self::$_instance->registerDependencies($class, $dependencies, $overwrite);
+	}
+
+
+
+	/**
+	 * Assigns an array of class names and corresponding load sources (new or cached)
+	 * to the class specified by the first parameter.
+	 * IMPORTANT !!!
+	 * The order of elements in the incoming $dependencies array MUST match
+	 * the order of the constructor parameters for the class in question.
+	 * This is especially important when overriding any existing dependencies that are registered.
+	 * the third parameter controls whether any duplicate dependencies are overwritten or not.
+	 *
+	 * @param string $class
+	 * @param array  $dependencies
+	 * @param int    $overwrite
+	 * @return bool
+	 */
+	public function registerDependencies(
+		$class,
+		array $dependencies,
+		$overwrite = EE_Dependency_Map::KEEP_EXISTING_DEPENDENCIES
+	) {
+		$class = trim($class, '\\');
+		$registered = false;
+		if (empty(self::$_instance->_dependency_map[ $class ])) {
+			self::$_instance->_dependency_map[ $class ] = array();
+		}
+		// we need to make sure that any aliases used when registering a dependency
+		// get resolved to the correct class name
+		foreach ($dependencies as $dependency => $load_source) {
+			$alias = self::$_instance->get_alias($dependency);
+			if (
+				$overwrite === EE_Dependency_Map::OVERWRITE_DEPENDENCIES
+				|| ! isset(self::$_instance->_dependency_map[ $class ][ $alias ])
+			) {
+				unset($dependencies[$dependency]);
+				$dependencies[$alias] = $load_source;
+				$registered = true;
+			}
+		}
+		// now add our two lists of dependencies together.
+		// using Union (+=) favours the arrays in precedence from left to right,
+		// so $dependencies is NOT overwritten because it is listed first
+		// ie: with A = B + C, entries in B take precedence over duplicate entries in C
+		// Union is way faster than array_merge() but should be used with caution...
+		// especially with numerically indexed arrays
+		$dependencies += self::$_instance->_dependency_map[ $class ];
+		// now we need to ensure that the resulting dependencies
+		// array only has the entries that are required for the class
+		// so first count how many dependencies were originally registered for the class
+		$dependency_count = count(self::$_instance->_dependency_map[ $class ]);
+		// if that count is non-zero (meaning dependencies were already registered)
+		self::$_instance->_dependency_map[ $class ] = $dependency_count
+			// then truncate the  final array to match that count
+			? array_slice($dependencies, 0, $dependency_count)
+			// otherwise just take the incoming array because nothing previously existed
+			: $dependencies;
+		return $registered;
+	}
+
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $loader
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public static function register_class_loader($class_name, $loader = 'load_core')
+	{
+		if (! $loader instanceof Closure && strpos($class_name, '\\') !== false) {
+			throw new DomainException(
+				esc_html__('Don\'t use class loaders for FQCNs.', 'event_espresso')
+			);
+		}
+		// check that loader is callable or method starts with "load_" and exists in EE_Registry
+		if (
+			! is_callable($loader)
+			&& (
+				strpos($loader, 'load_') !== 0
+				|| ! method_exists('EE_Registry', $loader)
+			)
+		) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'"%1$s" is not a valid loader method on EE_Registry.',
+						'event_espresso'
+					),
+					$loader
+				)
+			);
+		}
+		$class_name = self::$_instance->get_alias($class_name);
+		if (! isset(self::$_instance->_class_loaders[$class_name])) {
+			self::$_instance->_class_loaders[$class_name] = $loader;
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function dependency_map()
+	{
+		return $this->_dependency_map;
+	}
+
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name
+	 *
+	 * @param string $class_name
+	 * @return boolean
+	 */
+	public function has($class_name = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		return isset($this->_dependency_map[$class_name]) ? true : false;
+	}
+
+
+
+	/**
+	 * returns TRUE if dependency map contains a listing for the provided class name AND dependency
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return bool
+	 */
+	public function has_dependency_for_class($class_name = '', $dependency = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		$dependency = $this->get_alias($dependency);
+		return isset($this->_dependency_map[$class_name][$dependency])
+			? true
+			: false;
+	}
+
+
+
+	/**
+	 * returns loading strategy for whether a previously cached dependency should be loaded or a new instance returned
+	 *
+	 * @param string $class_name
+	 * @param string $dependency
+	 * @return int
+	 */
+	public function loading_strategy_for_class_dependency($class_name = '', $dependency = '')
+	{
+		// all legacy models have the same dependencies
+		if (strpos($class_name, 'EEM_') === 0) {
+			$class_name = 'LEGACY_MODELS';
+		}
+		$dependency = $this->get_alias($dependency);
+		return $this->has_dependency_for_class($class_name, $dependency)
+			? $this->_dependency_map[$class_name][$dependency]
+			: EE_Dependency_Map::not_registered;
+	}
+
+
+
+	/**
+	 * @param string $class_name
+	 * @return string | Closure
+	 */
+	public function class_loader($class_name)
+	{
+		// all legacy models use load_model()
+		if(strpos($class_name, 'EEM_') === 0){
+			return 'load_model';
+		}
+		$class_name = $this->get_alias($class_name);
+		return isset($this->_class_loaders[$class_name]) ? $this->_class_loaders[$class_name] : '';
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function class_loaders()
+	{
+		return $this->_class_loaders;
+	}
+
+
+
+	/**
+	 * adds an alias for a classname
+	 *
+	 * @param string $class_name the class name that should be used (concrete class to replace interface)
+	 * @param string $alias      the class name that would be type hinted for (abstract parent or interface)
+	 * @param string $for_class  the class that has the dependency (is type hinting for the interface)
+	 */
+	public function add_alias($class_name, $alias, $for_class = '')
+	{
+		if ($for_class !== '') {
+			if (! isset($this->_aliases[$for_class])) {
+				$this->_aliases[$for_class] = array();
+			}
+			$this->_aliases[$for_class][$class_name] = $alias;
+		}
+		$this->_aliases[$class_name] = $alias;
+	}
+
+
+
+	/**
+	 * returns TRUE if the provided class name has an alias
+	 *
+	 * @param string $class_name
+	 * @param string $for_class
+	 * @return bool
+	 */
+	public function has_alias($class_name = '', $for_class = '')
+	{
+		return isset($this->_aliases[$for_class][$class_name])
+			   || (
+				   isset($this->_aliases[$class_name])
+				   && ! is_array($this->_aliases[$class_name])
+			   );
+	}
+
+
+
+	/**
+	 * returns alias for class name if one exists, otherwise returns the original classname
+	 * functions recursively, so that multiple aliases can be used to drill down to a classname
+	 *  for example:
+	 *      if the following two entries were added to the _aliases array:
+	 *          array(
+	 *              'interface_alias'           => 'some\namespace\interface'
+	 *              'some\namespace\interface'  => 'some\namespace\classname'
+	 *          )
+	 *      then one could use EE_Registry::instance()->create( 'interface_alias' )
+	 *      to load an instance of 'some\namespace\classname'
+	 *
+	 * @param string $class_name
+	 * @param string $for_class
+	 * @return string
+	 */
+	public function get_alias($class_name = '', $for_class = '')
+	{
+		if (! $this->has_alias($class_name, $for_class)) {
+			return $class_name;
+		}
+		if ($for_class !== '' && isset($this->_aliases[ $for_class ][ $class_name ])) {
+			return $this->get_alias($this->_aliases[$for_class][$class_name], $for_class);
+		}
+		return $this->get_alias($this->_aliases[$class_name]);
+	}
+
+
+
+	/**
+	 * Registers the core dependencies and whether a previously instantiated object should be loaded from the cache,
+	 * if one exists, or whether a new object should be generated every time the requested class is loaded.
+	 * This is done by using the following class constants:
+	 *        EE_Dependency_Map::load_from_cache - loads previously instantiated object
+	 *        EE_Dependency_Map::load_new_object - generates a new object every time
+	 */
+	protected function _register_core_dependencies()
+	{
+		$this->_dependency_map = array(
+			'EE_Request_Handler'                                                                                          => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_System'                                                                                                   => array(
+				'EE_Registry'                                 => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+				'EE_Maintenance_Mode'                         => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Session'                                                                                                  => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request'              => EE_Dependency_Map::load_from_cache,
+				'EE_Encryption'                                            => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Cart'                                                                                                     => array(
+				'EE_Session' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Front_Controller'                                                                                         => array(
+				'EE_Registry'              => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'       => EE_Dependency_Map::load_from_cache,
+				'EE_Module_Request_Router' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messenger_Collection_Loader'                                                                              => array(
+				'EE_Messenger_Collection' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Message_Type_Collection_Loader'                                                                           => array(
+				'EE_Message_Type_Collection' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Message_Resource_Manager'                                                                                 => array(
+				'EE_Messenger_Collection_Loader'    => EE_Dependency_Map::load_new_object,
+				'EE_Message_Type_Collection_Loader' => EE_Dependency_Map::load_new_object,
+				'EEM_Message_Template_Group'        => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Message_Factory'                                                                                          => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_messages'                                                                                                 => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Generator'                                                                                       => array(
+				'EE_Messages_Queue'                    => EE_Dependency_Map::load_new_object,
+				'EE_Messages_Data_Handler_Collection'  => EE_Dependency_Map::load_new_object,
+				'EE_Message_Template_Group_Collection' => EE_Dependency_Map::load_new_object,
+				'EEH_Parse_Shortcodes'                 => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Processor'                                                                                       => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Messages_Queue'                                                                                           => array(
+				'EE_Message_Repository' => EE_Dependency_Map::load_new_object,
+			),
+			'EE_Messages_Template_Defaults'                                                                               => array(
+				'EEM_Message_Template_Group' => EE_Dependency_Map::load_from_cache,
+				'EEM_Message_Template'       => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Message_To_Generate_From_Request'                                                                         => array(
+				'EE_Message_Resource_Manager' => EE_Dependency_Map::load_from_cache,
+				'EE_Request_Handler'          => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandBus'                                                             => array(
+				'EventEspresso\core\services\commands\CommandHandlerManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\services\commands\CommandHandler'                                                              => array(
+				'EE_Registry'         => EE_Dependency_Map::load_from_cache,
+				'CommandBusInterface' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandHandlerManager'                                                  => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CompositeCommandHandler'                                                => array(
+				'EventEspresso\core\services\commands\CommandBus'     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\commands\CommandFactory' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\CommandFactory'                                                         => array(
+				'EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\middleware\CapChecker'                                                  => array(
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker'                                         => array(
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\capabilities\RegistrationsCapChecker'                                     => array(
+				'EE_Capabilities' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CreateRegistrationCommandHandler'                          => array(
+				'EventEspresso\core\domain\services\registration\CreateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommandHandler'                     => array(
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommandHandler'                    => array(
+				'EventEspresso\core\domain\services\registration\CopyRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler'         => array(
+				'EventEspresso\core\domain\services\registration\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler' => array(
+				'EventEspresso\core\domain\services\registration\UpdateRegistrationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommandHandler'                              => array(
+				'EventEspresso\core\domain\services\ticket\CreateTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\ticket\CancelTicketLineItemCommandHandler'                              => array(
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\registration\CancelRegistrationService'                                   => array(
+				'EventEspresso\core\domain\services\ticket\CancelTicketLineItemService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler'                                  => array(
+				'EEM_Attendee' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\database\TableManager'                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Data_Migration_Class_Base'                                                                                => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_1_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_2_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_3_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_4_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_5_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_6_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_7_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_8_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_DMS_Core_4_9_0'                                                                                           => array(
+				'EventEspresso\core\services\database\TableAnalysis' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\database\TableManager'  => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\assets\Registry'                                                                 => array(
+				'EE_Template_Config' => EE_Dependency_Map::load_from_cache,
+				'EE_Currency_Config' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCancelled'                                             => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoCheckout'                                              => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEventAttendees'                                        => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoEvents'                                                => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoThankYou'                                              => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTicketSelector'                                        => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\entities\shortcodes\EspressoTxnPage'                                               => array(
+				'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\cache\BasicCacheManager'                        => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\cache\PostRelatedCacheManager'                  => array(
+				'EventEspresso\core\services\cache\TransientCacheStorage' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\services\validation\email\EmailValidationService' => array(
+				'EE_Registration_Config'                                  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\domain\values\EmailAddress'                              => array(
+				null,
+				'EventEspresso\core\domain\services\validation\email\EmailValidationService' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\orm\ModelFieldFactory' => array(
+				'EventEspresso\core\services\loaders\Loader'              => EE_Dependency_Map::load_from_cache,
+			),
+			'LEGACY_MODELS'                                                   => array(
+				null,
+				'EventEspresso\core\services\database\ModelFieldFactory' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Module_Request_Router' => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Registration_Processor' => array(
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager' => array(
+				null,
+				'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker' => EE_Dependency_Map::load_from_cache,
+				'EE_Request' => EE_Dependency_Map::load_from_cache,
+			),
+			'EE_Admin_Transactions_List_Table' => array(
+				null,
+				'EventEspresso\core\domain\values\session\SessionLifespan' => EE_Dependency_Map::load_from_cache,
+			),
+		);
+	}
+
+
+
+	/**
+	 * Registers how core classes are loaded.
+	 * This can either be done by simply providing the name of one of the EE_Registry loader methods such as:
+	 *        'EE_Request_Handler' => 'load_core'
+	 *        'EE_Messages_Queue'  => 'load_lib'
+	 *        'EEH_Debug_Tools'    => 'load_helper'
+	 * or, if greater control is required, by providing a custom closure. For example:
+	 *        'Some_Class' => function () {
+	 *            return new Some_Class();
+	 *        },
+	 * This is required for instantiating dependencies
+	 * where an interface has been type hinted in a class constructor. For example:
+	 *        'Required_Interface' => function () {
+	 *            return new A_Class_That_Implements_Required_Interface();
+	 *        },
+	 *
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _register_core_class_loaders()
+	{
+		//for PHP5.3 compat, we need to register any properties called here in a variable because `$this` cannot
+		//be used in a closure.
+		$request = &$this->request;
+		$response = &$this->response;
+		$legacy_request = &$this->legacy_request;
+		// $loader = &$this->loader;
+		$this->_class_loaders = array(
+			//load_core
+			'EE_Capabilities'          => 'load_core',
+			'EE_Encryption'            => 'load_core',
+			'EE_Front_Controller'      => 'load_core',
+			'EE_Module_Request_Router' => 'load_core',
+			'EE_Registry'              => 'load_core',
+			'EE_Request'               => function () use (&$legacy_request) {
+				return $legacy_request;
+			},
+			'EventEspresso\core\services\request\Request' => function () use (&$request) {
+				return $request;
+			},
+			'EventEspresso\core\services\request\Response' => function () use (&$response) {
+				return $response;
+			},
+			'EE_Request_Handler'       => 'load_core',
+			'EE_Session'               => 'load_core',
+			'EE_Cron_Tasks'            => 'load_core',
+			'EE_System'                => 'load_core',
+			'EE_Maintenance_Mode'      => 'load_core',
+			'EE_Register_CPTs'         => 'load_core',
+			'EE_Admin'                 => 'load_core',
+			//load_lib
+			'EE_Message_Resource_Manager'          => 'load_lib',
+			'EE_Message_Type_Collection'           => 'load_lib',
+			'EE_Message_Type_Collection_Loader'    => 'load_lib',
+			'EE_Messenger_Collection'              => 'load_lib',
+			'EE_Messenger_Collection_Loader'       => 'load_lib',
+			'EE_Messages_Processor'                => 'load_lib',
+			'EE_Message_Repository'                => 'load_lib',
+			'EE_Messages_Queue'                    => 'load_lib',
+			'EE_Messages_Data_Handler_Collection'  => 'load_lib',
+			'EE_Message_Template_Group_Collection' => 'load_lib',
+			'EE_Payment_Method_Manager'            => 'load_lib',
+			'EE_Messages_Generator'                => function () {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Generator',
+					array(),
+					false,
+					false
+				);
+			},
+			'EE_Messages_Template_Defaults'        => function ($arguments = array()) {
+				return EE_Registry::instance()->load_lib(
+					'Messages_Template_Defaults',
+					$arguments,
+					false,
+					false
+				);
+			},
+			//load_model
+			// 'EEM_Attendee'                         => 'load_model',
+			// 'EEM_Message_Template_Group'           => 'load_model',
+			// 'EEM_Message_Template'                 => 'load_model',
+			//load_helper
+			'EEH_Parse_Shortcodes'                 => function () {
+				if (EE_Registry::instance()->load_helper('Parse_Shortcodes')) {
+					return new EEH_Parse_Shortcodes();
+				}
+				return null;
+			},
+			'EE_Template_Config'                   => function () {
+				return EE_Config::instance()->template_settings;
+			},
+			'EE_Currency_Config'                   => function () {
+				return EE_Config::instance()->currency;
+			},
+			'EE_Registration_Config'                   => function () {
+				return EE_Config::instance()->registration;
+			},
+			'EventEspresso\core\services\loaders\Loader' => function () {
+				return LoaderFactory::getLoader();
+			},
+		);
+	}
+
+
+
+	/**
+	 * can be used for supplying alternate names for classes,
+	 * or for connecting interface names to instantiable classes
+	 */
+	protected function _register_core_aliases()
+	{
+		$this->_aliases = array(
+			'CommandBusInterface'                                                          => 'EventEspresso\core\services\commands\CommandBusInterface',
+			'EventEspresso\core\services\commands\CommandBusInterface'                     => 'EventEspresso\core\services\commands\CommandBus',
+			'CommandHandlerManagerInterface'                                               => 'EventEspresso\core\services\commands\CommandHandlerManagerInterface',
+			'EventEspresso\core\services\commands\CommandHandlerManagerInterface'          => 'EventEspresso\core\services\commands\CommandHandlerManager',
+			'CapChecker'                                                                   => 'EventEspresso\core\services\commands\middleware\CapChecker',
+			'AddActionHook'                                                                => 'EventEspresso\core\services\commands\middleware\AddActionHook',
+			'CapabilitiesChecker'                                                          => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CapabilitiesCheckerInterface'                                                 => 'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface',
+			'EventEspresso\core\domain\services\capabilities\CapabilitiesCheckerInterface' => 'EventEspresso\core\domain\services\capabilities\CapabilitiesChecker',
+			'CreateRegistrationService'                                                    => 'EventEspresso\core\domain\services\registration\CreateRegistrationService',
+			'CreateRegCodeCommandHandler'                                                  => 'EventEspresso\core\services\commands\registration\CreateRegCodeCommand',
+			'CreateRegUrlLinkCommandHandler'                                               => 'EventEspresso\core\services\commands\registration\CreateRegUrlLinkCommand',
+			'CreateRegistrationCommandHandler'                                             => 'EventEspresso\core\services\commands\registration\CreateRegistrationCommand',
+			'CopyRegistrationDetailsCommandHandler'                                        => 'EventEspresso\core\services\commands\registration\CopyRegistrationDetailsCommand',
+			'CopyRegistrationPaymentsCommandHandler'                                       => 'EventEspresso\core\services\commands\registration\CopyRegistrationPaymentsCommand',
+			'CancelRegistrationAndTicketLineItemCommandHandler'                            => 'EventEspresso\core\services\commands\registration\CancelRegistrationAndTicketLineItemCommandHandler',
+			'UpdateRegistrationAndTransactionAfterChangeCommandHandler'                    => 'EventEspresso\core\services\commands\registration\UpdateRegistrationAndTransactionAfterChangeCommandHandler',
+			'CreateTicketLineItemCommandHandler'                                           => 'EventEspresso\core\services\commands\ticket\CreateTicketLineItemCommand',
+			'CreateTransactionCommandHandler'                                     => 'EventEspresso\core\services\commands\transaction\CreateTransactionCommandHandler',
+			'CreateAttendeeCommandHandler'                                        => 'EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler',
+			'TableManager'                                                                 => 'EventEspresso\core\services\database\TableManager',
+			'TableAnalysis'                                                                => 'EventEspresso\core\services\database\TableAnalysis',
+			'EspressoShortcode'                                                            => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'ShortcodeInterface'                                                           => 'EventEspresso\core\services\shortcodes\ShortcodeInterface',
+			'EventEspresso\core\services\shortcodes\ShortcodeInterface'                    => 'EventEspresso\core\services\shortcodes\EspressoShortcode',
+			'EventEspresso\core\services\cache\CacheStorageInterface'                      => 'EventEspresso\core\services\cache\TransientCacheStorage',
+			'LoaderInterface'                                                              => 'EventEspresso\core\services\loaders\LoaderInterface',
+			'EventEspresso\core\services\loaders\LoaderInterface'                          => 'EventEspresso\core\services\loaders\Loader',
+			'CommandFactoryInterface'                                                     => 'EventEspresso\core\services\commands\CommandFactoryInterface',
+			'EventEspresso\core\services\commands\CommandFactoryInterface'                => 'EventEspresso\core\services\commands\CommandFactory',
+			'EventEspresso\core\domain\services\session\SessionIdentifierInterface'       => 'EE_Session',
+			'EmailValidatorInterface'                                                     => 'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface',
+			'EventEspresso\core\domain\services\validation\email\EmailValidatorInterface' => 'EventEspresso\core\domain\services\validation\email\EmailValidationService',
+			'NoticeConverterInterface'                                            => 'EventEspresso\core\services\notices\NoticeConverterInterface',
+			'EventEspresso\core\services\notices\NoticeConverterInterface'        => 'EventEspresso\core\services\notices\ConvertNoticesToEeErrors',
+			'NoticesContainerInterface'                                           => 'EventEspresso\core\services\notices\NoticesContainerInterface',
+			'EventEspresso\core\services\notices\NoticesContainerInterface'       => 'EventEspresso\core\services\notices\NoticesContainer',
+			'EventEspresso\core\services\request\RequestInterface'                => 'EventEspresso\core\services\request\Request',
+			'EventEspresso\core\services\request\ResponseInterface'               => 'EventEspresso\core\services\request\Response',
+			'EventEspresso\core\domain\DomainInterface'                           => 'EventEspresso\core\domain\Domain',
+		);
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && is_admin()) {
+			$this->_aliases['EventEspresso\core\services\notices\NoticeConverterInterface'] = 'EventEspresso\core\services\notices\ConvertNoticesToAdminNotices';
+		}
+	}
+
+
+
+	/**
+	 * This is used to reset the internal map and class_loaders to their original default state at the beginning of the
+	 * request Primarily used by unit tests.
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function reset()
+	{
+		$this->_register_core_class_loaders();
+		$this->_register_core_dependencies();
+	}
 
 
 }

core/services/request/InvalidRequestStackMiddlewareException.php

Indentation +29 added lines, -29 removed lines

@@ -19,33 +19,33 @@
 class InvalidRequestStackMiddlewareException extends InvalidDataTypeException
 {
 
-    /**
-     * @param  mixed     $middleware_app_class
-     * @param  string    $message
-     * @param int        $code
-     * @param Exception $previous
-     */
-    public function __construct($middleware_app_class, $message = '', $code = 0, Exception $previous = null)
-    {
-        if(is_array($middleware_app_class)) {
-            $middleware_app_class = reset($middleware_app_class);
-        }
-        if (empty($message)) {
-            $message = sprintf(
-                esc_html__(
-                    'The supplied Request Stack Middleware class "%1$s" is invalid or could no be found.',
-                    'event_espresso'
-                ),
-                $middleware_app_class
-            );
-        }
-        parent::__construct(
-            '$middleware_app_class',
-            $middleware_app_class,
-            'EventEspresso\core\services\request\middleware\Middleware',
-            $message,
-            $code,
-            $previous
-        );
-    }
+	/**
+	 * @param  mixed     $middleware_app_class
+	 * @param  string    $message
+	 * @param int        $code
+	 * @param Exception $previous
+	 */
+	public function __construct($middleware_app_class, $message = '', $code = 0, Exception $previous = null)
+	{
+		if(is_array($middleware_app_class)) {
+			$middleware_app_class = reset($middleware_app_class);
+		}
+		if (empty($message)) {
+			$message = sprintf(
+				esc_html__(
+					'The supplied Request Stack Middleware class "%1$s" is invalid or could no be found.',
+					'event_espresso'
+				),
+				$middleware_app_class
+			);
+		}
+		parent::__construct(
+			'$middleware_app_class',
+			$middleware_app_class,
+			'EventEspresso\core\services\request\middleware\Middleware',
+			$message,
+			$code,
+			$previous
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
      */
     public function __construct($middleware_app_class, $message = '', $code = 0, Exception $previous = null)
     {
-        if(is_array($middleware_app_class)) {
+        if (is_array($middleware_app_class)) {
             $middleware_app_class = reset($middleware_app_class);
         }
         if (empty($message)) {

core/services/request/RequestStackBuilder.php

Indentation +87 added lines, -87 removed lines

@@ -24,97 +24,97 @@
 class RequestStackBuilder extends SplDoublyLinkedList
 {
 
-    /**
-     * @type LoaderInterface $loader
-     */
-    private $loader;
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	private $loader;
 
 
-    /**
-     * RequestStackBuilder constructor.
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-        $this->setIteratorMode(SplDoublyLinkedList::IT_MODE_LIFO | SplDoublyLinkedList::IT_MODE_KEEP);
-    }
+	/**
+	 * RequestStackBuilder constructor.
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+		$this->setIteratorMode(SplDoublyLinkedList::IT_MODE_LIFO | SplDoublyLinkedList::IT_MODE_KEEP);
+	}
 
 
-    /**
-     * builds decorated middleware stack
-     * by continuously injecting previous middleware app into the next
-     *
-     * @param RequestStackCoreAppInterface $application
-     * @return RequestStack
-     * @throws Exception
-     */
-    public function resolve(RequestStackCoreAppInterface $application)
-    {
-        $core_app = $application;
-        // NOW... because the RequestStack is following the decorator pattern,
-        // the first stack app we add will end up at the center of the stack,
-        // and will end up being the last item to actually run, but we don't want that!
-        // Basically we're dealing with TWO stacks, and transferring items from one to the other,
-        // BUT... we want the final stack to be in the same order as the first.
-        // So we need to reverse the iterator mode when transferring items,
-        // because if we don't, the second stack will end  up in the incorrect order.
-        $this->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO | SplDoublyLinkedList::IT_MODE_KEEP);
-        for ($this->rewind(); $this->valid(); $this->next()) {
-            try {
-                $middleware_app       = $this->validateMiddlewareAppDetails($this->current(), true);
-                $middleware_app_class = array_shift($middleware_app);
-                $middleware_app_args  = is_array($middleware_app) ? $middleware_app : array();
-                $middleware_app_args  = array($application, $this->loader) + $middleware_app_args;
-                $application          = $this->loader->getShared($middleware_app_class, $middleware_app_args);
-            } catch (InvalidRequestStackMiddlewareException $exception) {
-                if(WP_DEBUG) {
-                    new ExceptionStackTraceDisplay($exception);
-                    continue;
-                }
-                error_log($exception->getMessage());
-            }
-        }
-        return new RequestStack($application, $core_app);
-    }
+	/**
+	 * builds decorated middleware stack
+	 * by continuously injecting previous middleware app into the next
+	 *
+	 * @param RequestStackCoreAppInterface $application
+	 * @return RequestStack
+	 * @throws Exception
+	 */
+	public function resolve(RequestStackCoreAppInterface $application)
+	{
+		$core_app = $application;
+		// NOW... because the RequestStack is following the decorator pattern,
+		// the first stack app we add will end up at the center of the stack,
+		// and will end up being the last item to actually run, but we don't want that!
+		// Basically we're dealing with TWO stacks, and transferring items from one to the other,
+		// BUT... we want the final stack to be in the same order as the first.
+		// So we need to reverse the iterator mode when transferring items,
+		// because if we don't, the second stack will end  up in the incorrect order.
+		$this->setIteratorMode(SplDoublyLinkedList::IT_MODE_FIFO | SplDoublyLinkedList::IT_MODE_KEEP);
+		for ($this->rewind(); $this->valid(); $this->next()) {
+			try {
+				$middleware_app       = $this->validateMiddlewareAppDetails($this->current(), true);
+				$middleware_app_class = array_shift($middleware_app);
+				$middleware_app_args  = is_array($middleware_app) ? $middleware_app : array();
+				$middleware_app_args  = array($application, $this->loader) + $middleware_app_args;
+				$application          = $this->loader->getShared($middleware_app_class, $middleware_app_args);
+			} catch (InvalidRequestStackMiddlewareException $exception) {
+				if(WP_DEBUG) {
+					new ExceptionStackTraceDisplay($exception);
+					continue;
+				}
+				error_log($exception->getMessage());
+			}
+		}
+		return new RequestStack($application, $core_app);
+	}
 
 
-    /**
-     * Ensures that the app details that have been pushed onto RequestStackBuilder
-     * are all ordered correctly so that the middleware can be properly constructed
-     *
-     * @param array $middleware_app
-     * @param bool  $recurse
-     * @return array
-     * @throws InvalidRequestStackMiddlewareException
-     */
-    protected function validateMiddlewareAppDetails(array $middleware_app, $recurse = false)
-    {
-        $middleware_app_class = reset($middleware_app);
-        // is array empty ?
-        if($middleware_app_class === false) {
-            throw new InvalidRequestStackMiddlewareException($middleware_app_class);
-        }
-        // are the class and arguments in the wrong order ?
-        if(is_array($middleware_app_class)) {
-            if ($recurse === true) {
-                return $this->validateMiddlewareAppDetails(array_reverse($middleware_app));
-            }
-            throw new InvalidRequestStackMiddlewareException($middleware_app_class);
-        }
-        // is filter callback working like legacy middleware and sending a numerically indexed array ?
-        if(is_int($middleware_app_class)) {
-            if ($recurse === true) {
-                $middleware_app = array_reverse($middleware_app);
-                return $this->validateMiddlewareAppDetails(array(reset($middleware_app), array()));
-            }
-            throw new InvalidRequestStackMiddlewareException($middleware_app_class);
-        }
-        // is $middleware_app_class a valid FQCN (or class is already loaded) ?
-        if(! class_exists($middleware_app_class)) {
-            throw new InvalidRequestStackMiddlewareException($middleware_app_class);
-        }
-        return $middleware_app;
-    }
+	/**
+	 * Ensures that the app details that have been pushed onto RequestStackBuilder
+	 * are all ordered correctly so that the middleware can be properly constructed
+	 *
+	 * @param array $middleware_app
+	 * @param bool  $recurse
+	 * @return array
+	 * @throws InvalidRequestStackMiddlewareException
+	 */
+	protected function validateMiddlewareAppDetails(array $middleware_app, $recurse = false)
+	{
+		$middleware_app_class = reset($middleware_app);
+		// is array empty ?
+		if($middleware_app_class === false) {
+			throw new InvalidRequestStackMiddlewareException($middleware_app_class);
+		}
+		// are the class and arguments in the wrong order ?
+		if(is_array($middleware_app_class)) {
+			if ($recurse === true) {
+				return $this->validateMiddlewareAppDetails(array_reverse($middleware_app));
+			}
+			throw new InvalidRequestStackMiddlewareException($middleware_app_class);
+		}
+		// is filter callback working like legacy middleware and sending a numerically indexed array ?
+		if(is_int($middleware_app_class)) {
+			if ($recurse === true) {
+				$middleware_app = array_reverse($middleware_app);
+				return $this->validateMiddlewareAppDetails(array(reset($middleware_app), array()));
+			}
+			throw new InvalidRequestStackMiddlewareException($middleware_app_class);
+		}
+		// is $middleware_app_class a valid FQCN (or class is already loaded) ?
+		if(! class_exists($middleware_app_class)) {
+			throw new InvalidRequestStackMiddlewareException($middleware_app_class);
+		}
+		return $middleware_app;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -69,7 +69,7 @@ 
                 $middleware_app_args  = array($application, $this->loader) + $middleware_app_args;
                 $application          = $this->loader->getShared($middleware_app_class, $middleware_app_args);
             } catch (InvalidRequestStackMiddlewareException $exception) {
-                if(WP_DEBUG) {
+                if (WP_DEBUG) {
                     new ExceptionStackTraceDisplay($exception);
                     continue;
                 }
@@ -93,18 +93,18 @@ 
     {
         $middleware_app_class = reset($middleware_app);
         // is array empty ?
-        if($middleware_app_class === false) {
+        if ($middleware_app_class === false) {
             throw new InvalidRequestStackMiddlewareException($middleware_app_class);
         }
         // are the class and arguments in the wrong order ?
-        if(is_array($middleware_app_class)) {
+        if (is_array($middleware_app_class)) {
             if ($recurse === true) {
                 return $this->validateMiddlewareAppDetails(array_reverse($middleware_app));
             }
             throw new InvalidRequestStackMiddlewareException($middleware_app_class);
         }
         // is filter callback working like legacy middleware and sending a numerically indexed array ?
-        if(is_int($middleware_app_class)) {
+        if (is_int($middleware_app_class)) {
             if ($recurse === true) {
                 $middleware_app = array_reverse($middleware_app);
                 return $this->validateMiddlewareAppDetails(array(reset($middleware_app), array()));
@@ -112,7 +112,7 @@ 
             throw new InvalidRequestStackMiddlewareException($middleware_app_class);
         }
         // is $middleware_app_class a valid FQCN (or class is already loaded) ?
-        if(! class_exists($middleware_app_class)) {
+        if ( ! class_exists($middleware_app_class)) {
             throw new InvalidRequestStackMiddlewareException($middleware_app_class);
         }
         return $middleware_app;

core/domain/DomainInterface.php

Indentation +32 added lines, -32 removed lines

@@ -16,49 +16,49 @@
 interface DomainInterface extends InterminableInterface
 {
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginFile();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginFile();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginBasename();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginBasename();
 
 
-    /**
-     * @return string
-     */
-    public function pluginPath();
+	/**
+	 * @return string
+	 */
+	public function pluginPath();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function pluginUrl();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function pluginUrl();
 
 
-    /**
-     * @return string
-     * @throws DomainException
-     */
-    public function version();
+	/**
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function version();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsPath();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsPath();
 
 
-    /**
-     * @return string
-     */
-    public function distributionAssetsUrl();
+	/**
+	 * @return string
+	 */
+	public function distributionAssetsUrl();
 
 }