eventespresso / event-espresso-core

core/db_models/fields/EE_Boolean_Field.php

Indentation +54 added lines, -54 removed lines

@@ -2,62 +2,62 @@
 
 class EE_Boolean_Field extends EE_Integer_Field
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('boolean');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('boolean');
+	}
 
-    /**
-     * Double-checks the value being returned is an boolean.
-     * @since 4.9.74.p
-     * @param mixed $value_of_field_on_model_object
-     * @return boolean
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        return (bool) parent::prepare_for_get($value_of_field_on_model_object);
-    }
+	/**
+	 * Double-checks the value being returned is an boolean.
+	 * @since 4.9.74.p
+	 * @param mixed $value_of_field_on_model_object
+	 * @return boolean
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		return (bool) parent::prepare_for_get($value_of_field_on_model_object);
+	}
 
-    /**
-     * @since 4.9.74.p
-     * @param $value_inputted_for_field_on_model_object
-     * @return boolean
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return filter_var($value_inputted_for_field_on_model_object, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * @since 4.9.74.p
+	 * @param $value_inputted_for_field_on_model_object
+	 * @return boolean
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return filter_var($value_inputted_for_field_on_model_object, FILTER_VALIDATE_BOOLEAN);
+	}
 
-    /**
-     * Make sure we're returning booleans
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return boolean
-     */
-    public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
-    {
-        return filter_var($value_inputted_for_field_on_model_object, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * Make sure we're returning booleans
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return boolean
+	 */
+	public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
+	{
+		return filter_var($value_inputted_for_field_on_model_object, FILTER_VALIDATE_BOOLEAN);
+	}
 
-    /**
-     * Gets a nice Yes/No value for this field
-     *
-     * @param boolean $value_on_field_to_be_outputted
-     * @return string Yes or No
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
-    {
-        return apply_filters(
-            'FHEE__EE_Boolean_Field__prepare_for_pretty_echoing__return',
-            $value_on_field_to_be_outputted ? __('Yes', 'event_espresso') : __('No', 'event_espresso'),
-            $value_on_field_to_be_outputted
-        );
-    }
+	/**
+	 * Gets a nice Yes/No value for this field
+	 *
+	 * @param boolean $value_on_field_to_be_outputted
+	 * @return string Yes or No
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
+	{
+		return apply_filters(
+			'FHEE__EE_Boolean_Field__prepare_for_pretty_echoing__return',
+			$value_on_field_to_be_outputted ? __('Yes', 'event_espresso') : __('No', 'event_espresso'),
+			$value_on_field_to_be_outputted
+		);
+	}
 }

core/db_models/EEM_WP_User.model.php

Indentation +122 added lines, -122 removed lines

@@ -13,132 +13,132 @@
 class EEM_WP_User extends EEM_Base
 {
 
-    /**
-     * private instance of the EEM_WP_User object
-     *
-     * @type EEM_WP_User
-     */
-    protected static $_instance;
+	/**
+	 * private instance of the EEM_WP_User object
+	 *
+	 * @type EEM_WP_User
+	 */
+	protected static $_instance;
 
 
-    /**
-     *    constructor
-     *
-     * @param null              $timezone
-     * @param ModelFieldFactory $model_field_factory
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
-    {
-        $this->singular_item = esc_html__('WP_User', 'event_espresso');
-        $this->plural_item = esc_html__('WP_Users', 'event_espresso');
-        global $wpdb;
-        $this->_tables = array(
-            'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
-        );
-        $this->_fields = array(
-            'WP_User' => array(
-                'ID'                  => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    esc_html__('WP_User ID', 'event_espresso')
-                ),
-                'user_login'          => $model_field_factory->createPlainTextField(
-                    'user_login',
-                    esc_html__('User Login', 'event_espresso'),
-                    false
-                ),
-                'user_pass'           => $model_field_factory->createPlainTextField(
-                    'user_pass',
-                    esc_html__('User Password', 'event_espresso'),
-                    false
-                ),
-                'user_nicename'       => $model_field_factory->createPlainTextField(
-                    'user_nicename',
-                    esc_html__(' User Nice Name', 'event_espresso'),
-                    false
-                ),
-                'user_email'          => $model_field_factory->createEmailField(
-                    'user_email',
-                    esc_html__('User Email', 'event_espresso'),
-                    false
-                ),
-                'user_registered'     => $model_field_factory->createDatetimeField(
-                    'user_registered',
-                    esc_html__('Date User Registered', 'event_espresso'),
-                    $timezone
-                ),
-                'user_activation_key' => $model_field_factory->createPlainTextField(
-                    'user_activation_key',
-                    esc_html__('User Activation Key', 'event_espresso'),
-                    false
-                ),
-                'user_status'         => $model_field_factory->createIntegerField(
-                    'user_status',
-                    esc_html__('User Status', 'event_espresso')
-                ),
-                'display_name'        => $model_field_factory->createPlainTextField(
-                    'display_name',
-                    esc_html__('Display Name', 'event_espresso'),
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'       => new EE_Has_Many_Relation(),
-            // all models are related to the change log
-            // 'Change_Log'     => new EE_Has_Many_Relation(),
-            'Event'          => new EE_Has_Many_Relation(),
-            'Message'        => new EE_Has_Many_Relation(),
-            'Payment_Method' => new EE_Has_Many_Relation(),
-            'Price'          => new EE_Has_Many_Relation(),
-            'Price_Type'     => new EE_Has_Many_Relation(),
-            'Question'       => new EE_Has_Many_Relation(),
-            'Question_Group' => new EE_Has_Many_Relation(),
-            'Ticket'         => new EE_Has_Many_Relation(),
-            'Venue'          => new EE_Has_Many_Relation(),
-        );
-        $this->foreign_key_aliases = [
-            'Event.EVT_wp_user'          => 'WP_User.ID',
-            'Payment_Method.PMD_wp_user' => 'WP_User.ID',
-            'Price.PRC_wp_user'          => 'WP_User.ID',
-            'Price_Type.PRT_wp_user'     => 'WP_User.ID',
-            'Question.QST_wp_user'       => 'WP_User.ID',
-            'Question_Group.QSG_wp_user' => 'WP_User.ID',
-            'Ticket.VNU_wp_user'         => 'WP_User.ID',
-            'Venue.TKT_wp_user'          => 'WP_User.ID',
-        ];
-        $this->_wp_core_model = true;
-        $this->_caps_slug = 'users';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
-        }
-        // @todo: account for create_users controls whether they can create users at all
-        parent::__construct($timezone);
-    }
+	/**
+	 *    constructor
+	 *
+	 * @param null              $timezone
+	 * @param ModelFieldFactory $model_field_factory
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone = null, ModelFieldFactory $model_field_factory)
+	{
+		$this->singular_item = esc_html__('WP_User', 'event_espresso');
+		$this->plural_item = esc_html__('WP_Users', 'event_espresso');
+		global $wpdb;
+		$this->_tables = array(
+			'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
+		);
+		$this->_fields = array(
+			'WP_User' => array(
+				'ID'                  => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					esc_html__('WP_User ID', 'event_espresso')
+				),
+				'user_login'          => $model_field_factory->createPlainTextField(
+					'user_login',
+					esc_html__('User Login', 'event_espresso'),
+					false
+				),
+				'user_pass'           => $model_field_factory->createPlainTextField(
+					'user_pass',
+					esc_html__('User Password', 'event_espresso'),
+					false
+				),
+				'user_nicename'       => $model_field_factory->createPlainTextField(
+					'user_nicename',
+					esc_html__(' User Nice Name', 'event_espresso'),
+					false
+				),
+				'user_email'          => $model_field_factory->createEmailField(
+					'user_email',
+					esc_html__('User Email', 'event_espresso'),
+					false
+				),
+				'user_registered'     => $model_field_factory->createDatetimeField(
+					'user_registered',
+					esc_html__('Date User Registered', 'event_espresso'),
+					$timezone
+				),
+				'user_activation_key' => $model_field_factory->createPlainTextField(
+					'user_activation_key',
+					esc_html__('User Activation Key', 'event_espresso'),
+					false
+				),
+				'user_status'         => $model_field_factory->createIntegerField(
+					'user_status',
+					esc_html__('User Status', 'event_espresso')
+				),
+				'display_name'        => $model_field_factory->createPlainTextField(
+					'display_name',
+					esc_html__('Display Name', 'event_espresso'),
+					false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'       => new EE_Has_Many_Relation(),
+			// all models are related to the change log
+			// 'Change_Log'     => new EE_Has_Many_Relation(),
+			'Event'          => new EE_Has_Many_Relation(),
+			'Message'        => new EE_Has_Many_Relation(),
+			'Payment_Method' => new EE_Has_Many_Relation(),
+			'Price'          => new EE_Has_Many_Relation(),
+			'Price_Type'     => new EE_Has_Many_Relation(),
+			'Question'       => new EE_Has_Many_Relation(),
+			'Question_Group' => new EE_Has_Many_Relation(),
+			'Ticket'         => new EE_Has_Many_Relation(),
+			'Venue'          => new EE_Has_Many_Relation(),
+		);
+		$this->foreign_key_aliases = [
+			'Event.EVT_wp_user'          => 'WP_User.ID',
+			'Payment_Method.PMD_wp_user' => 'WP_User.ID',
+			'Price.PRC_wp_user'          => 'WP_User.ID',
+			'Price_Type.PRT_wp_user'     => 'WP_User.ID',
+			'Question.QST_wp_user'       => 'WP_User.ID',
+			'Question_Group.QSG_wp_user' => 'WP_User.ID',
+			'Ticket.VNU_wp_user'         => 'WP_User.ID',
+			'Venue.TKT_wp_user'          => 'WP_User.ID',
+		];
+		$this->_wp_core_model = true;
+		$this->_caps_slug = 'users';
+		$this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ] = 'list';
+		$this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
+		}
+		// @todo: account for create_users controls whether they can create users at all
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * We don't need a foreign key to the WP_User model, we just need its primary key
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function wp_user_field_name()
-    {
-        return $this->primary_key_name();
-    }
+	/**
+	 * We don't need a foreign key to the WP_User model, we just need its primary key
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function wp_user_field_name()
+	{
+		return $this->primary_key_name();
+	}
 
 
-    /**
-     * This WP_User model IS owned, even though it doesn't have a foreign key to itself
-     *
-     * @return boolean
-     */
-    public function is_owned()
-    {
-        return true;
-    }
+	/**
+	 * This WP_User model IS owned, even though it doesn't have a foreign key to itself
+	 *
+	 * @return boolean
+	 */
+	public function is_owned()
+	{
+		return true;
+	}
 }

modules/add_new_state/EED_Add_New_State.module.php

Indentation +819 added lines, -819 removed lines

@@ -19,823 +19,823 @@
 {
 
 
-    /**
-     * @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/');
-        define(
-            'ANS_TEMPLATES_PATH',
-            str_replace(
-                '\\',
-                '/',
-                plugin_dir_path(__FILE__)
-            ) . 'templates/'
-        );
-    }
-
-
-    /**
-     * @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(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'
-                                ) . ' *',
-                                'other_html_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 . '" data-value-field-name="' . $input->valueFieldName() . '"'
-                                )
-                            )
-                        ),
-                        // 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|StateOptions $deprecated
-     * @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(),
-        $deprecated,
-        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|CountryOptions $deprecated
-     * @param EE_Registration                       $registration
-     * @param EE_Question                           $question
-     * @param                                       $answer
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function inject_new_reg_country_into_options(
-        $country_options = array(),
-        $deprecated,
-        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/');
+		define(
+			'ANS_TEMPLATES_PATH',
+			str_replace(
+				'\\',
+				'/',
+				plugin_dir_path(__FILE__)
+			) . 'templates/'
+		);
+	}
+
+
+	/**
+	 * @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(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'
+								) . ' *',
+								'other_html_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 . '" data-value-field-name="' . $input->valueFieldName() . '"'
+								)
+							)
+						),
+						// 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|StateOptions $deprecated
+	 * @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(),
+		$deprecated,
+		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|CountryOptions $deprecated
+	 * @param EE_Registration                       $registration
+	 * @param EE_Question                           $question
+	 * @param                                       $answer
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function inject_new_reg_country_into_options(
+		$country_options = array(),
+		$deprecated,
+		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;
+	}
 }

Spacing +45 added lines, -45 removed lines

@@ -161,14 +161,14 @@ 
      */
     public static function set_definitions()
     {
-        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+        define('ANS_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
         define(
             'ANS_TEMPLATES_PATH',
             str_replace(
                 '\\',
                 '/',
                 plugin_dir_path(__FILE__)
-            ) . 'templates/'
+            ).'templates/'
         );
     }
 
@@ -218,7 +218,7 @@ 
         if (apply_filters('EED_Single_Page_Checkout__SPCO_active', false)) {
             wp_register_script(
                 'add_new_state',
-                ANS_ASSETS_URL . 'add_new_state.js',
+                ANS_ASSETS_URL.'add_new_state.js',
                 array('espresso_core', 'single_page_checkout'),
                 EVENT_ESPRESSO_VERSION,
                 true
@@ -266,10 +266,10 @@ 
             $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)) {
+            if ( ! empty($countries)) {
                 foreach ($countries as $country) {
                     if ($country instanceof EE_Country) {
-                        $country_options[ $country->ID() ] = $country->name();
+                        $country_options[$country->ID()] = $country->name();
                     }
                 }
             }
@@ -303,10 +303,10 @@ 
                                     '',
                                     esc_html__('click here to add a new state/province', 'event_espresso'),
                                     '',
-                                    'display-' . $input->html_id(),
+                                    'display-'.$input->html_id(),
                                     'ee-form-add-new-state-lnk display-the-hidden smaller-text hide-if-no-js',
                                     '',
-                                    'data-target="' . $input->html_id() . '"'
+                                    'data-target="'.$input->html_id().'"'
                                 )
                             )
                         ),
@@ -316,33 +316,33 @@ 
                                 'FHEE__EED_Add_New_State__display_add_new_state_micro_form__add_new_state_micro_form',
                                 EEH_HTML::div(
                                     '',
-                                    $input->html_id() . '-dv',
+                                    $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::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::li(esc_html__('click the ADD button', 'event_espresso')).
                                 EEH_HTML::ulx()
                             )
                         ),
@@ -356,7 +356,7 @@ 
                                     'nsmf_new_state_country',
                                     $input->html_id()
                                 ),
-                                'html_class'      => $input->html_class() . ' new-state-country',
+                                '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,
@@ -371,7 +371,7 @@ 
                                     'nsmf_new_state_name',
                                     $input->html_id()
                                 ),
-                                'html_class'      => $input->html_class() . ' new-state-state',
+                                'html_class'      => $input->html_class().' new-state-state',
                                 'html_label_text' => esc_html__(
                                     'New State/Province Name',
                                     'event_espresso'
@@ -390,11 +390,11 @@ 
                                     'nsmf_new_state_abbrv',
                                     $input->html_id()
                                 ),
-                                'html_class'            => $input->html_class() . ' new-state-abbrv',
+                                'html_class'            => $input->html_class().' new-state-abbrv',
                                 'html_label_text'       => esc_html__(
                                     'New State/Province Abbreviation',
                                     'event_espresso'
-                                ) . ' *',
+                                ).' *',
                                 'other_html_attributes' => 'size="24"',
                                 'default'               => EE_Registry::instance()->REQ->get($abbrv_name, ''),
                                 'required'              => false,
@@ -404,15 +404,15 @@ 
                         '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::nbsp(3).
                                 EEH_HTML::link(
                                     '',
                                     esc_html__('ADD', 'event_espresso'),
                                     '',
-                                    'submit-' . $new_state_submit_id,
+                                    'submit-'.$new_state_submit_id,
                                     'ee-form-add-new-state-submit button button-secondary',
                                     '',
-                                    'data-target="' . $new_state_submit_id . '" data-value-field-name="' . $input->valueFieldName() . '"'
+                                    'data-target="'.$new_state_submit_id.'" data-value-field-name="'.$input->valueFieldName().'"'
                                 )
                             )
                         ),
@@ -425,7 +425,7 @@ 
                                 EEH_HTML::div('', '', 'small-text')
                                 .
                                 EEH_HTML::strong(
-                                    '* ' .
+                                    '* '.
                                     esc_html__(
                                         'Don\'t know your State/Province Abbreviation?',
                                         'event_espresso'
@@ -458,10 +458,10 @@ 
                                     '',
                                     esc_html__('cancel new State/Province', 'event_espresso'),
                                     '',
-                                    'hide-' . $input->html_id(),
+                                    'hide-'.$input->html_id(),
                                     'ee-form-cancel-new-state-lnk smaller-text',
                                     '',
-                                    'data-target="' . $input->html_id() . '"'
+                                    'data-target="'.$input->html_id().'"'
                                 )
                                 .
                                 EEH_HTML::divx()
@@ -526,7 +526,7 @@ 
                     $new_states = EE_Registry::instance()->SSN->get_session_data(
                         'nsmf_new_states'
                     );
-                    $new_states[ $new_state->ID() ] = $new_state;
+                    $new_states[$new_state->ID()] = $new_state;
                     EE_Registry::instance()->SSN->set_session_data(
                         array('nsmf_new_states' => $new_states)
                     );
@@ -607,7 +607,7 @@ 
     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)) {
+        if ( ! empty($existing_state)) {
             return array_pop($existing_state);
         }
         $new_state = EE_State::new_instance($props_n_values);
@@ -622,15 +622,15 @@ 
             );
             // if not non-ajax admin
             new PersistentAdminNotice(
-                'new-state-added-' . $new_state->country_iso() . '-' . $new_state->abbrev(),
+                '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>',
+                    '<b>'.$new_state->name().'</b>',
+                    '<b>'.$new_state->abbrev().'</b>',
+                    '<b>'.$new_state->country()->name().'</b>',
                     '<a href="'
                     . $country_settings_url
                     . '">'
@@ -663,7 +663,7 @@ 
      */
     public static function update_country_settings($CNT_ISO = '', $STA_ID = '', $cols_n_values = array())
     {
-        if (! $CNT_ISO) {
+        if ( ! $CNT_ISO) {
             EE_Error::add_error(
                 esc_html__('An invalid or missing Country ISO Code was received.', 'event_espresso'),
                 __FILE__,
@@ -673,13 +673,13 @@ 
         }
         $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)) {
+        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) {
+        if ( ! $STA_abbrev) {
             EE_Error::add_error(
                 esc_html__('An invalid or missing State Abbreviation was received.', 'event_espresso'),
                 __FILE__,
@@ -691,7 +691,7 @@ 
         $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
             'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
         );
-        $persistent_admin_notice_manager->dismissNotice($CNT_ISO . '-' . $STA_abbrev, true, true);
+        $persistent_admin_notice_manager->dismissNotice($CNT_ISO.'-'.$STA_abbrev, true, true);
     }
 
 
@@ -719,16 +719,16 @@ 
             && $question->type() === EEM_Question::QST_type_state
         ) {
             $STA_ID = $answer->value();
-            if (! empty($STA_ID)) {
+            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()])) {
+                            $state_options[$country->name()] = array();
                         }
-                        if (! isset($state_options[ $country->name() ][ $STA_ID ])) {
-                            $state_options[ $country->name() ][ $STA_ID ] = $state->name();
+                        if ( ! isset($state_options[$country->name()][$STA_ID])) {
+                            $state_options[$country->name()][$STA_ID] = $state->name();
                         }
                     }
                 }
@@ -763,11 +763,11 @@ 
             && $question->type() === EEM_Question::QST_type_country
         ) {
             $CNT_ISO = $answer->value();
-            if (! empty($CNT_ISO)) {
+            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();
+                    if ( ! isset($country_options[$CNT_ISO])) {
+                        $country_options[$CNT_ISO] = $country->name();
                     }
                 }
             }
@@ -792,7 +792,7 @@ 
                 $new_state instanceof EE_State
                 && $new_state->country() instanceof EE_Country
             ) {
-                $state_options[ $new_state->country()->name() ][ $new_state->ID() ] = $new_state->name();
+                $state_options[$new_state->country()->name()][$new_state->ID()] = $new_state->name();
             }
         }
         return $state_options;
@@ -833,7 +833,7 @@ 
                 $new_state instanceof EE_State
                 && $new_state->country() instanceof EE_Country
             ) {
-                $country_options[ $new_state->country()->ID() ] = $new_state->country()->name();
+                $country_options[$new_state->country()->ID()] = $new_state->country()->name();
             }
         }
         return $country_options;

modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php

Indentation +636 added lines, -636 removed lines

@@ -12,640 +12,640 @@
 abstract class EE_SPCO_Reg_Step
 {
 
-    /**
-     *    $_completed - TRUE if this step has fully completed it's duties
-     *
-     * @access protected
-     * @type bool $_completed
-     */
-    protected $_completed = false;
-
-    /**
-     *    $_is_current_step - TRUE if this is the current step
-     *
-     * @access protected
-     * @type bool $_is_current_step
-     */
-    protected $_is_current_step = false;
-
-    /**
-     *    $_order - when the reg step should be run relative to other steps
-     *
-     * @access protected
-     * @type int $_template
-     */
-    protected $_order = 0;
-
-    /**
-     *    $_slug - URL param for this step
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_slug;
-
-    /**
-     *    $_name - Step Name - translatable string
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_name;
-
-    /**
-     *    $_submit_button_text - translatable string that appears on this step's submit button
-     *
-     * @access protected
-     * @type string $_slug
-     */
-    protected $_submit_button_text;
-
-    /**
-     *    $_template - template name
-     *
-     * @access protected
-     * @type string $_template
-     */
-    protected $_template;
-
-    /**
-     *    $_reg_form_name - the form input name and id attribute
-     *
-     * @access protected
-     * @var string $_reg_form_name
-     */
-    protected $_reg_form_name;
-
-    /**
-     *    $_success_message - text to display upon successful form submission
-     *
-     * @access private
-     * @var string $_success_message
-     */
-    protected $_success_message;
-
-    /**
-     *    $_instructions - a brief description of how to complete the reg step.
-     *    Usually displayed in conjunction with the previous step's success message.
-     *
-     * @access private
-     * @var string $_instructions
-     */
-    protected $_instructions;
-
-    /**
-     *    $_valid_data - the normalized and validated data for this step
-     *
-     * @access public
-     * @var array $_valid_data
-     */
-    protected $_valid_data = array();
-
-    /**
-     *    $reg_form - the registration form for this step
-     *
-     * @access public
-     * @var EE_Form_Section_Proper $reg_form
-     */
-    public $reg_form;
-
-    /**
-     *    $checkout - EE_Checkout object for handling the properties of the current checkout process
-     *
-     * @access public
-     * @var EE_Checkout $checkout
-     */
-    public $checkout;
-
-
-    /**
-     * @return void
-     */
-    abstract public function translate_js_strings();
-
-
-    /**
-     * @return void
-     */
-    abstract public function enqueue_styles_and_scripts();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function initialize_reg_step();
-
-
-    /**
-     * @return string
-     */
-    abstract public function generate_reg_form();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function process_reg_step();
-
-
-    /**
-     * @return boolean
-     */
-    abstract public function update_reg_step();
-
-
-    /**
-     * @return boolean
-     */
-    public function completed()
-    {
-        return $this->_completed;
-    }
-
-
-    /**
-     * set_completed - toggles $_completed to TRUE
-     */
-    public function set_completed()
-    {
-        // DEBUG LOG
-        // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-        $this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
-    }
-
-
-    /**
-     * set_completed - toggles $_completed to FALSE
-     */
-    public function set_not_completed()
-    {
-        $this->_completed = false;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->_slug;
-    }
-
-
-    /**
-     * submit_button_text
-     * the text that appears on the reg step form submit button
-     *
-     * @return string
-     */
-    public function submit_button_text()
-    {
-        return $this->_submit_button_text;
-    }
-
-
-    /**
-     * set_submit_button_text
-     * sets the text that appears on the reg step form submit button
-     *
-     * @param string $submit_button_text
-     */
-    public function set_submit_button_text($submit_button_text = '')
-    {
-        if (! empty($submit_button_text)) {
-            $this->_submit_button_text = $submit_button_text;
-        } elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($this->checkout->revisit) {
-                $this->_submit_button_text = sprintf(
-                    __('Update %s', 'event_espresso'),
-                    $this->checkout->current_step->name()
-                );
-            } else {
-                $this->_submit_button_text = sprintf(
-                    __('Proceed to %s', 'event_espresso'),
-                    $this->checkout->next_step->name()
-                );
-            }
-        }
-        // filters the submit button text
-        $this->_submit_button_text = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-            $this->_submit_button_text,
-            $this->checkout
-        );
-    }
-
-
-    /**
-     * @param boolean $is_current_step
-     */
-    public function set_is_current_step($is_current_step)
-    {
-        $this->_is_current_step = $is_current_step;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function is_current_step()
-    {
-        return $this->_is_current_step;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function is_final_step()
-    {
-        return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration ? true : false;
-    }
-
-
-    /**
-     * @param int $order
-     */
-    public function set_order($order)
-    {
-        $this->_order = $order;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function order()
-    {
-        return $this->_order;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function template(): string
-    {
-        return $this->_template;
-    }
-
-
-    /**
-     * @param string $template
-     */
-    public function setTemplate(string $template): void
-    {
-        $this->_template = $template;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function success_message()
-    {
-        return $this->_success_message;
-    }
-
-
-    /**
-     * _set_success_message
-     *
-     * @param string $success_message
-     */
-    protected function _set_success_message($success_message)
-    {
-        $this->_success_message = $success_message;
-    }
-
-
-    /**
-     * _reset_success_message
-     *
-     * @return void
-     */
-    protected function _reset_success_message()
-    {
-        $this->_success_message = '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function _instructions()
-    {
-        return $this->_instructions;
-    }
-
-
-    /**
-     * @param string $instructions
-     */
-    public function set_instructions($instructions)
-    {
-        $this->_instructions = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
-            $instructions,
-            $this
-        );
-    }
-
-
-    /**
-     * @param array $valid_data
-     */
-    public function set_valid_data($valid_data)
-    {
-        $this->_valid_data = $valid_data;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function valid_data()
-    {
-        if (empty($this->_valid_data)) {
-            $this->_valid_data = $this->reg_form->valid_data();
-        }
-        return $this->_valid_data;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function reg_form_name()
-    {
-        if (empty($this->_reg_form_name)) {
-            $this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
-        }
-        return $this->_reg_form_name;
-    }
-
-
-    /**
-     * @param string $reg_form_name
-     */
-    protected function set_reg_form_name($reg_form_name)
-    {
-        $this->_reg_form_name = $reg_form_name;
-    }
-
-
-    /**
-     * reg_step_url
-     *
-     * @param string $action
-     * @return string
-     */
-    public function reg_step_url($action = '')
-    {
-        $query_args = array('step' => $this->slug());
-        if (! empty($action)) {
-            $query_args['action'] = $action;
-        }
-        // final step has no display
-        if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
-            $query_args['action'] = 'process_reg_step';
-        }
-        if ($this->checkout->revisit) {
-            $query_args['revisit'] = true;
-        }
-        if ($this->checkout->reg_url_link) {
-            $query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
-        }
-        return add_query_arg($query_args, $this->checkout->reg_page_base_url);
-    }
-
-
-    /**
-     * creates the default hidden inputs section
-     *
-     * @return EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    public function reg_step_hidden_inputs()
-    {
-        // hidden inputs for admin registrations
-        if ($this->checkout->admin_request) {
-            return new EE_Form_Section_Proper(
-                array(
-                    'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                    'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                    'subsections'     => array(
-                        'next_step' => new EE_Fixed_Hidden_Input(
-                            array(
-                                'html_name' => 'next_step',
-                                'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                                'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                    ? $this->checkout->next_step->slug()
-                                    : '',
-                            )
-                        ),
-                    ),
-                )
-            );
-        }
-        // hidden inputs for frontend registrations
-        return new EE_Form_Section_Proper(
-            array(
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
-                'subsections'     => array(
-                    'action'         => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'action',
-                            'html_id'   => 'spco-' . $this->slug() . '-action',
-                            'default'   => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
-                                empty($this->checkout->reg_url_link)
-                                    ? 'process_reg_step'
-                                    : 'update_reg_step',
-                                $this
-                            ),
-                        )
-                    ),
-                    'next_step'      => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'next_step',
-                            'html_id'   => 'spco-' . $this->slug() . '-next-step',
-                            'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
-                                ? $this->checkout->next_step->slug()
-                                : '',
-                        )
-                    ),
-                    'e_reg_url_link' => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'e_reg_url_link',
-                            'html_id'   => 'spco-reg_url_link',
-                            'default'   => $this->checkout->reg_url_link,
-                        )
-                    ),
-                    'revisit'        => new EE_Fixed_Hidden_Input(
-                        array(
-                            'html_name' => 'revisit',
-                            'html_id'   => 'spco-revisit',
-                            'default'   => $this->checkout->revisit,
-                        )
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * generate_reg_form_for_actions
-     *
-     * @param array $actions
-     * @return void
-     */
-    public function generate_reg_form_for_actions($actions = array())
-    {
-        $actions = array_merge(
-            array(
-                'generate_reg_form',
-                'display_spco_reg_step',
-                'process_reg_step',
-                'update_reg_step',
-            ),
-            $actions
-        );
-        $this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true) ? true : false;
-    }
-
-
-    /**
-     * @return string
-     * @throws \EE_Error
-     */
-    public function display_reg_form()
-    {
-        $html = '';
-        if ($this->reg_form instanceof EE_Form_Section_Proper) {
-            do_action('AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form', $this->reg_form, $this);
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
-            if (EE_Registry::instance()->REQ->ajax) {
-                $this->reg_form->localize_validation_rules();
-                $this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
-            }
-            $html .= $this->reg_form->get_html();
-            $html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
-            $html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
-        }
-        return $html;
-    }
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     * @throws \EE_Error
-     */
-    public function reg_step_submit_button()
-    {
-        if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            return '';
-        }
-        ob_start();
-        do_action(
-            'AHEE__before_spco_whats_next_buttons',
-            $this->slug(),
-            $this->checkout->next_step->slug(),
-            $this->checkout
-        );
-        $html = ob_get_clean();
-        // generate submit button
-        $sbmt_btn = new EE_Submit_Input(
-            array(
-                'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
-                'html_class'            => 'spco-next-step-btn',
-                'other_html_attributes' => ' rel="' . $this->slug() . '"',
-                'default'               => $this->submit_button_text(),
-            )
-        );
-        $sbmt_btn->set_button_css_attributes(true, 'large');
-        $sbmt_btn_html = $sbmt_btn->get_html_for_input();
-        $html .= EEH_HTML::div(
-            apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
-            'spco-' . $this->slug() . '-whats-next-buttons-dv',
-            'spco-whats-next-buttons'
-        );
-        return $html;
-    }
-
-
-    /**
-     * div_class - returns nothing for current step, but a css class of "hidden" for others
-     *
-     * @return string
-     */
-    public function div_class()
-    {
-        return $this->is_current_step() ? '' : ' hidden';
-    }
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_lnk_url()
-    {
-        return add_query_arg(array('step' => $this->slug()), $this->checkout->reg_page_base_url);
-    }
-
-
-    /**
-     * div_class - returns  a css class of "hidden" for current step, but nothing for others
-     *
-     * @return string
-     */
-    public function edit_link_class()
-    {
-        return $this->is_current_step() ? ' hidden' : '';
-    }
-
-
-    /**
-     * update_checkout with changes that have been made to the cart
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    public function update_checkout()
-    {
-        // grab the cart grand total and reset TXN total
-        $this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
-        $this->checkout->stash_transaction_and_checkout();
-    }
-
-
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
-     * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
-     * reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout'));
-    }
+	/**
+	 *    $_completed - TRUE if this step has fully completed it's duties
+	 *
+	 * @access protected
+	 * @type bool $_completed
+	 */
+	protected $_completed = false;
+
+	/**
+	 *    $_is_current_step - TRUE if this is the current step
+	 *
+	 * @access protected
+	 * @type bool $_is_current_step
+	 */
+	protected $_is_current_step = false;
+
+	/**
+	 *    $_order - when the reg step should be run relative to other steps
+	 *
+	 * @access protected
+	 * @type int $_template
+	 */
+	protected $_order = 0;
+
+	/**
+	 *    $_slug - URL param for this step
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_slug;
+
+	/**
+	 *    $_name - Step Name - translatable string
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_name;
+
+	/**
+	 *    $_submit_button_text - translatable string that appears on this step's submit button
+	 *
+	 * @access protected
+	 * @type string $_slug
+	 */
+	protected $_submit_button_text;
+
+	/**
+	 *    $_template - template name
+	 *
+	 * @access protected
+	 * @type string $_template
+	 */
+	protected $_template;
+
+	/**
+	 *    $_reg_form_name - the form input name and id attribute
+	 *
+	 * @access protected
+	 * @var string $_reg_form_name
+	 */
+	protected $_reg_form_name;
+
+	/**
+	 *    $_success_message - text to display upon successful form submission
+	 *
+	 * @access private
+	 * @var string $_success_message
+	 */
+	protected $_success_message;
+
+	/**
+	 *    $_instructions - a brief description of how to complete the reg step.
+	 *    Usually displayed in conjunction with the previous step's success message.
+	 *
+	 * @access private
+	 * @var string $_instructions
+	 */
+	protected $_instructions;
+
+	/**
+	 *    $_valid_data - the normalized and validated data for this step
+	 *
+	 * @access public
+	 * @var array $_valid_data
+	 */
+	protected $_valid_data = array();
+
+	/**
+	 *    $reg_form - the registration form for this step
+	 *
+	 * @access public
+	 * @var EE_Form_Section_Proper $reg_form
+	 */
+	public $reg_form;
+
+	/**
+	 *    $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 *
+	 * @access public
+	 * @var EE_Checkout $checkout
+	 */
+	public $checkout;
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function translate_js_strings();
+
+
+	/**
+	 * @return void
+	 */
+	abstract public function enqueue_styles_and_scripts();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function initialize_reg_step();
+
+
+	/**
+	 * @return string
+	 */
+	abstract public function generate_reg_form();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function process_reg_step();
+
+
+	/**
+	 * @return boolean
+	 */
+	abstract public function update_reg_step();
+
+
+	/**
+	 * @return boolean
+	 */
+	public function completed()
+	{
+		return $this->_completed;
+	}
+
+
+	/**
+	 * set_completed - toggles $_completed to TRUE
+	 */
+	public function set_completed()
+	{
+		// DEBUG LOG
+		// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+		$this->_completed = apply_filters('FHEE__EE_SPCO_Reg_Step__set_completed___completed', true, $this);
+	}
+
+
+	/**
+	 * set_completed - toggles $_completed to FALSE
+	 */
+	public function set_not_completed()
+	{
+		$this->_completed = false;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->_slug;
+	}
+
+
+	/**
+	 * submit_button_text
+	 * the text that appears on the reg step form submit button
+	 *
+	 * @return string
+	 */
+	public function submit_button_text()
+	{
+		return $this->_submit_button_text;
+	}
+
+
+	/**
+	 * set_submit_button_text
+	 * sets the text that appears on the reg step form submit button
+	 *
+	 * @param string $submit_button_text
+	 */
+	public function set_submit_button_text($submit_button_text = '')
+	{
+		if (! empty($submit_button_text)) {
+			$this->_submit_button_text = $submit_button_text;
+		} elseif ($this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($this->checkout->revisit) {
+				$this->_submit_button_text = sprintf(
+					__('Update %s', 'event_espresso'),
+					$this->checkout->current_step->name()
+				);
+			} else {
+				$this->_submit_button_text = sprintf(
+					__('Proceed to %s', 'event_espresso'),
+					$this->checkout->next_step->name()
+				);
+			}
+		}
+		// filters the submit button text
+		$this->_submit_button_text = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+			$this->_submit_button_text,
+			$this->checkout
+		);
+	}
+
+
+	/**
+	 * @param boolean $is_current_step
+	 */
+	public function set_is_current_step($is_current_step)
+	{
+		$this->_is_current_step = $is_current_step;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function is_current_step()
+	{
+		return $this->_is_current_step;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function is_final_step()
+	{
+		return $this instanceof EE_SPCO_Reg_Step_Finalize_Registration ? true : false;
+	}
+
+
+	/**
+	 * @param int $order
+	 */
+	public function set_order($order)
+	{
+		$this->_order = $order;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function order()
+	{
+		return $this->_order;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function template(): string
+	{
+		return $this->_template;
+	}
+
+
+	/**
+	 * @param string $template
+	 */
+	public function setTemplate(string $template): void
+	{
+		$this->_template = $template;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function success_message()
+	{
+		return $this->_success_message;
+	}
+
+
+	/**
+	 * _set_success_message
+	 *
+	 * @param string $success_message
+	 */
+	protected function _set_success_message($success_message)
+	{
+		$this->_success_message = $success_message;
+	}
+
+
+	/**
+	 * _reset_success_message
+	 *
+	 * @return void
+	 */
+	protected function _reset_success_message()
+	{
+		$this->_success_message = '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function _instructions()
+	{
+		return $this->_instructions;
+	}
+
+
+	/**
+	 * @param string $instructions
+	 */
+	public function set_instructions($instructions)
+	{
+		$this->_instructions = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step__set_instructions__instructions',
+			$instructions,
+			$this
+		);
+	}
+
+
+	/**
+	 * @param array $valid_data
+	 */
+	public function set_valid_data($valid_data)
+	{
+		$this->_valid_data = $valid_data;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function valid_data()
+	{
+		if (empty($this->_valid_data)) {
+			$this->_valid_data = $this->reg_form->valid_data();
+		}
+		return $this->_valid_data;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function reg_form_name()
+	{
+		if (empty($this->_reg_form_name)) {
+			$this->set_reg_form_name('ee-spco-' . $this->slug() . '-reg-step-form');
+		}
+		return $this->_reg_form_name;
+	}
+
+
+	/**
+	 * @param string $reg_form_name
+	 */
+	protected function set_reg_form_name($reg_form_name)
+	{
+		$this->_reg_form_name = $reg_form_name;
+	}
+
+
+	/**
+	 * reg_step_url
+	 *
+	 * @param string $action
+	 * @return string
+	 */
+	public function reg_step_url($action = '')
+	{
+		$query_args = array('step' => $this->slug());
+		if (! empty($action)) {
+			$query_args['action'] = $action;
+		}
+		// final step has no display
+		if ($this instanceof EE_SPCO_Reg_Step_Finalize_Registration && $action === 'display_spco_reg_step') {
+			$query_args['action'] = 'process_reg_step';
+		}
+		if ($this->checkout->revisit) {
+			$query_args['revisit'] = true;
+		}
+		if ($this->checkout->reg_url_link) {
+			$query_args['e_reg_url_link'] = $this->checkout->reg_url_link;
+		}
+		return add_query_arg($query_args, $this->checkout->reg_page_base_url);
+	}
+
+
+	/**
+	 * creates the default hidden inputs section
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	public function reg_step_hidden_inputs()
+	{
+		// hidden inputs for admin registrations
+		if ($this->checkout->admin_request) {
+			return new EE_Form_Section_Proper(
+				array(
+					'layout_strategy' => new EE_Div_Per_Section_Layout(),
+					'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+					'subsections'     => array(
+						'next_step' => new EE_Fixed_Hidden_Input(
+							array(
+								'html_name' => 'next_step',
+								'html_id'   => 'spco-' . $this->slug() . '-next-step',
+								'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+									? $this->checkout->next_step->slug()
+									: '',
+							)
+						),
+					),
+				)
+			);
+		}
+		// hidden inputs for frontend registrations
+		return new EE_Form_Section_Proper(
+			array(
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'html_id'         => 'ee-' . $this->slug() . '-hidden-inputs',
+				'subsections'     => array(
+					'action'         => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'action',
+							'html_id'   => 'spco-' . $this->slug() . '-action',
+							'default'   => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step__reg_step_hidden_inputs__default_form_action',
+								empty($this->checkout->reg_url_link)
+									? 'process_reg_step'
+									: 'update_reg_step',
+								$this
+							),
+						)
+					),
+					'next_step'      => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'next_step',
+							'html_id'   => 'spco-' . $this->slug() . '-next-step',
+							'default'   => $this->checkout->next_step instanceof EE_SPCO_Reg_Step
+								? $this->checkout->next_step->slug()
+								: '',
+						)
+					),
+					'e_reg_url_link' => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'e_reg_url_link',
+							'html_id'   => 'spco-reg_url_link',
+							'default'   => $this->checkout->reg_url_link,
+						)
+					),
+					'revisit'        => new EE_Fixed_Hidden_Input(
+						array(
+							'html_name' => 'revisit',
+							'html_id'   => 'spco-revisit',
+							'default'   => $this->checkout->revisit,
+						)
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * generate_reg_form_for_actions
+	 *
+	 * @param array $actions
+	 * @return void
+	 */
+	public function generate_reg_form_for_actions($actions = array())
+	{
+		$actions = array_merge(
+			array(
+				'generate_reg_form',
+				'display_spco_reg_step',
+				'process_reg_step',
+				'update_reg_step',
+			),
+			$actions
+		);
+		$this->checkout->generate_reg_form = in_array($this->checkout->action, $actions, true) ? true : false;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function display_reg_form()
+	{
+		$html = '';
+		if ($this->reg_form instanceof EE_Form_Section_Proper) {
+			do_action('AHEE__EE_SPCO_Reg_Step__display_reg_form__reg_form', $this->reg_form, $this);
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_open($this->reg_step_url()) : '';
+			if (EE_Registry::instance()->REQ->ajax) {
+				$this->reg_form->localize_validation_rules();
+				$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
+			}
+			$html .= $this->reg_form->get_html();
+			$html .= ! $this->checkout->admin_request ? $this->reg_step_submit_button() : '';
+			$html .= ! $this->checkout->admin_request ? $this->reg_form->form_close() : '';
+		}
+		return $html;
+	}
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function reg_step_submit_button()
+	{
+		if (! $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			return '';
+		}
+		ob_start();
+		do_action(
+			'AHEE__before_spco_whats_next_buttons',
+			$this->slug(),
+			$this->checkout->next_step->slug(),
+			$this->checkout
+		);
+		$html = ob_get_clean();
+		// generate submit button
+		$sbmt_btn = new EE_Submit_Input(
+			array(
+				'html_name'             => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+				'html_id'               => 'spco-go-to-step-' . $this->checkout->next_step->slug(),
+				'html_class'            => 'spco-next-step-btn',
+				'other_html_attributes' => ' rel="' . $this->slug() . '"',
+				'default'               => $this->submit_button_text(),
+			)
+		);
+		$sbmt_btn->set_button_css_attributes(true, 'large');
+		$sbmt_btn_html = $sbmt_btn->get_html_for_input();
+		$html .= EEH_HTML::div(
+			apply_filters('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', $sbmt_btn_html, $this),
+			'spco-' . $this->slug() . '-whats-next-buttons-dv',
+			'spco-whats-next-buttons'
+		);
+		return $html;
+	}
+
+
+	/**
+	 * div_class - returns nothing for current step, but a css class of "hidden" for others
+	 *
+	 * @return string
+	 */
+	public function div_class()
+	{
+		return $this->is_current_step() ? '' : ' hidden';
+	}
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_lnk_url()
+	{
+		return add_query_arg(array('step' => $this->slug()), $this->checkout->reg_page_base_url);
+	}
+
+
+	/**
+	 * div_class - returns  a css class of "hidden" for current step, but nothing for others
+	 *
+	 * @return string
+	 */
+	public function edit_link_class()
+	{
+		return $this->is_current_step() ? ' hidden' : '';
+	}
+
+
+	/**
+	 * update_checkout with changes that have been made to the cart
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function update_checkout()
+	{
+		// grab the cart grand total and reset TXN total
+		$this->checkout->transaction->set_total($this->checkout->cart->get_cart_grand_total());
+		$this->checkout->stash_transaction_and_checkout();
+	}
+
+
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon
+	 * serialization EE_Checkout will handle the reimplementation of itself upon waking, but we won't bother with the
+	 * reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout'));
+	}
 }

core/domain/services/registration/form/v1/AutoCopyAttendeeInfoForm.php

Indentation +17 added lines, -17 removed lines

@@ -8,21 +8,21 @@
 class AutoCopyAttendeeInfoForm extends EE_Form_Section_HTML
 {
 
-    /**
-     * CopyAttendeeInfoForm constructor.
-     */
-    public function __construct(string $slug)
-    {
-        parent::__construct(
-            EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $slug . '/_auto_copy_attendee_info.template.php',
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
-                    []
-                ),
-                true,
-                true
-            )
-        );
-    }
+	/**
+	 * CopyAttendeeInfoForm constructor.
+	 */
+	public function __construct(string $slug)
+	{
+		parent::__construct(
+			EEH_Template::locate_template(
+				SPCO_REG_STEPS_PATH . $slug . '/_auto_copy_attendee_info.template.php',
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
+					[]
+				),
+				true,
+				true
+			)
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     {
         parent::__construct(
             EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $slug . '/_auto_copy_attendee_info.template.php',
+                SPCO_REG_STEPS_PATH.$slug.'/_auto_copy_attendee_info.template.php',
                 apply_filters(
                     'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
                     []

core/domain/services/registration/form/v1/CountryOptions.php

Indentation +96 added lines, -96 removed lines

@@ -13,109 +13,109 @@
 
 class CountryOptions
 {
-    /**
-     * the action being performed on the current step
-     *
-     * @var string
-     */
-    public $action = '';
+	/**
+	 * the action being performed on the current step
+	 *
+	 * @var string
+	 */
+	public $action = '';
 
-    /**
-     * @var EEM_Answer
-     */
-    public $answer_model;
+	/**
+	 * @var EEM_Answer
+	 */
+	public $answer_model;
 
-    /**
-     * @var EEM_Country
-     */
-    public $country_model;
+	/**
+	 * @var EEM_Country
+	 */
+	public $country_model;
 
-    /**
-     * @var [][]
-     */
-    private $country_options = [];
+	/**
+	 * @var [][]
+	 */
+	private $country_options = [];
 
 
-    /**
-     * CountryOptions constructor.
-     *
-     * @param string      $action
-     * @param EEM_Answer  $answer_model
-     * @param EEM_Country $country_model
-     */
-    public function __construct(string $action, EEM_Answer $answer_model, EEM_Country $country_model)
-    {
-        $this->action        = $action;
-        $this->answer_model  = $answer_model;
-        $this->country_model = $country_model;
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            [$this, 'forLegacyFormInput'],
-            10,
-            4
-        );
-    }
+	/**
+	 * CountryOptions constructor.
+	 *
+	 * @param string      $action
+	 * @param EEM_Answer  $answer_model
+	 * @param EEM_Country $country_model
+	 */
+	public function __construct(string $action, EEM_Answer $answer_model, EEM_Country $country_model)
+	{
+		$this->action        = $action;
+		$this->answer_model  = $answer_model;
+		$this->country_model = $country_model;
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			[$this, 'forLegacyFormInput'],
+			10,
+			4
+		);
+	}
 
 
-    /**
-     * Gets the list of countries for the form input
-     *
-     * @param array|null           $countries_list deprecated prop from an old hook
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer deprecated prop from an old hook
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function forLegacyFormInput(
-        array $countries_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        if (! isset($this->country_options[ $this->action ])) {
-            $this->generateLegacyCountryOptions($question, $registration);
-        }
-        return $this->country_options[ $this->action ];
-    }
+	/**
+	 * Gets the list of countries for the form input
+	 *
+	 * @param array|null           $countries_list deprecated prop from an old hook
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer deprecated prop from an old hook
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function forLegacyFormInput(
+		array $countries_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		if (! isset($this->country_options[ $this->action ])) {
+			$this->generateLegacyCountryOptions($question, $registration);
+		}
+		return $this->country_options[ $this->action ];
+	}
 
 
-    /**
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function generateLegacyCountryOptions(EE_Question $question = null, EE_Registration $registration = null)
-    {
-        // get possibly cached list of countries
-        $countries = $this->action === 'process_reg_step'
-            ? $this->country_model->get_all_countries()
-            : $this->country_model->get_all_active_countries();
-        // start with an empty option
-        $country_options = ['' => ''];
-        if (! empty($countries)) {
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
-                }
-            }
-        }
-        if ($question instanceof EE_Question && $registration instanceof EE_Registration) {
-            $answer = $this->answer_model->get_one(
-                [['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
-            );
-        } else {
-            $answer = EE_Answer::new_instance();
-        }
-        $this->country_options[ $this->action ] = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            $country_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-    }
+	/**
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function generateLegacyCountryOptions(EE_Question $question = null, EE_Registration $registration = null)
+	{
+		// get possibly cached list of countries
+		$countries = $this->action === 'process_reg_step'
+			? $this->country_model->get_all_countries()
+			: $this->country_model->get_all_active_countries();
+		// start with an empty option
+		$country_options = ['' => ''];
+		if (! empty($countries)) {
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$country_options[ $country->ID() ] = $country->name();
+				}
+			}
+		}
+		if ($question instanceof EE_Question && $registration instanceof EE_Registration) {
+			$answer = $this->answer_model->get_one(
+				[['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
+			);
+		} else {
+			$answer = EE_Answer::new_instance();
+		}
+		$this->country_options[ $this->action ] = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			$country_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -74,10 +74,10 @@ 
         EE_Registration $registration = null,
         EE_Answer $answer = null
     ): array {
-        if (! isset($this->country_options[ $this->action ])) {
+        if ( ! isset($this->country_options[$this->action])) {
             $this->generateLegacyCountryOptions($question, $registration);
         }
-        return $this->country_options[ $this->action ];
+        return $this->country_options[$this->action];
     }
 
 
@@ -95,10 +95,10 @@ 
             : $this->country_model->get_all_active_countries();
         // start with an empty option
         $country_options = ['' => ''];
-        if (! empty($countries)) {
+        if ( ! empty($countries)) {
             foreach ($countries as $country) {
                 if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
+                    $country_options[$country->ID()] = $country->name();
                 }
             }
         }
@@ -109,7 +109,7 @@ 
         } else {
             $answer = EE_Answer::new_instance();
         }
-        $this->country_options[ $this->action ] = apply_filters(
+        $this->country_options[$this->action] = apply_filters(
             'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
             $country_options,
             $this,

core/domain/services/registration/form/v1/StateOptions.php

Indentation +85 added lines, -85 removed lines

@@ -12,97 +12,97 @@
 
 class StateOptions
 {
-    /**
-     * the action being performed on the current step
-     *
-     * @var string
-     */
-    public $action = '';
+	/**
+	 * the action being performed on the current step
+	 *
+	 * @var string
+	 */
+	public $action = '';
 
-    /**
-     * @var EEM_State
-     */
-    public $state_model;
+	/**
+	 * @var EEM_State
+	 */
+	public $state_model;
 
-    /**
-     * @var [][]
-     */
-    private $state_options = [];
+	/**
+	 * @var [][]
+	 */
+	private $state_options = [];
 
 
-    /**
-     * CountryOptions constructor.
-     *
-     * @param string    $action
-     * @param EEM_State $state_model
-     */
-    public function __construct(string $action, EEM_State $state_model)
-    {
-        $this->action      = $action;
-        $this->state_model = $state_model;
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            [$this, 'forLegacyFormInput'],
-            10,
-            4
-        );
-    }
+	/**
+	 * CountryOptions constructor.
+	 *
+	 * @param string    $action
+	 * @param EEM_State $state_model
+	 */
+	public function __construct(string $action, EEM_State $state_model)
+	{
+		$this->action      = $action;
+		$this->state_model = $state_model;
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			[$this, 'forLegacyFormInput'],
+			10,
+			4
+		);
+	}
 
 
-    /**
-     * Gets the list of states for the form input
-     *
-     * @param array|null           $states_list deprecated prop from an old hook
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @return array 2d keys are state IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function forLegacyFormInput(
-        array $states_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        if (! isset($this->state_options[ $this->action ])) {
-            $this->generateLegacyStateOptions($question, $registration, $answer);
-        }
-        return $this->state_options[ $this->action ];
-    }
+	/**
+	 * Gets the list of states for the form input
+	 *
+	 * @param array|null           $states_list deprecated prop from an old hook
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @return array 2d keys are state IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function forLegacyFormInput(
+		array $states_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		if (! isset($this->state_options[ $this->action ])) {
+			$this->generateLegacyStateOptions($question, $registration, $answer);
+		}
+		return $this->state_options[ $this->action ];
+	}
 
 
-    /**
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function generateLegacyStateOptions(
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ) {
-        $state_options = ['' => ['' => '']];
-        $states        = $this->action === 'process_reg_step'
-            ? $this->state_model->get_all_states()
-            : $this->state_model->get_all_active_states();
-        if (! empty($states)) {
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
-                }
-            }
-        }
-        $this->state_options[ $this->action ] = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            $state_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-    }
+	/**
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function generateLegacyStateOptions(
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	) {
+		$state_options = ['' => ['' => '']];
+		$states        = $this->action === 'process_reg_step'
+			? $this->state_model->get_all_states()
+			: $this->state_model->get_all_active_states();
+		if (! empty($states)) {
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+				}
+			}
+		}
+		$this->state_options[ $this->action ] = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			$state_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -66,10 +66,10 @@ 
         EE_Registration $registration = null,
         EE_Answer $answer = null
     ): array {
-        if (! isset($this->state_options[ $this->action ])) {
+        if ( ! isset($this->state_options[$this->action])) {
             $this->generateLegacyStateOptions($question, $registration, $answer);
         }
-        return $this->state_options[ $this->action ];
+        return $this->state_options[$this->action];
     }
 
 
@@ -89,14 +89,14 @@ 
         $states        = $this->action === 'process_reg_step'
             ? $this->state_model->get_all_states()
             : $this->state_model->get_all_active_states();
-        if (! empty($states)) {
+        if ( ! empty($states)) {
             foreach ($states as $state) {
                 if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+                    $state_options[$state->country()->name()][$state->ID()] = $state->name();
                 }
             }
         }
-        $this->state_options[ $this->action ] = apply_filters(
+        $this->state_options[$this->action] = apply_filters(
             'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
             $state_options,
             $this,

core/services/loaders/LoaderFactory.php

Indentation +61 added lines, -61 removed lines

@@ -71,71 +71,71 @@
 class LoaderFactory
 {
 
-    /**
-     * @var LoaderInterface $loader ;
-     */
-    private static $loader;
+	/**
+	 * @var LoaderInterface $loader ;
+	 */
+	private static $loader;
 
 
-    /**
-     * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
-     *                                              BootstrapDependencyInjectionContainer::buildLoader()
-     *                                              otherwise can be left null
-     * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getLoader(
-        $generator = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ): LoaderInterface {
-        if (
-            ! LoaderFactory::$loader instanceof LoaderInterface
-            && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            $core_loader = new CoreLoader($generator);
-            LoaderFactory::$loader = new Loader(
-                $core_loader,
-                new CachingLoader(
-                    $core_loader,
-                    new LooseCollection(''),
-                    $object_identifier
-                ),
-                $class_cache
-            );
-        }
-        return LoaderFactory::$loader;
-    }
+	/**
+	 * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
+	 *                                              BootstrapDependencyInjectionContainer::buildLoader()
+	 *                                              otherwise can be left null
+	 * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getLoader(
+		$generator = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	): LoaderInterface {
+		if (
+			! LoaderFactory::$loader instanceof LoaderInterface
+			&& ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			$core_loader = new CoreLoader($generator);
+			LoaderFactory::$loader = new Loader(
+				$core_loader,
+				new CachingLoader(
+					$core_loader,
+					new LooseCollection(''),
+					$object_identifier
+				),
+				$class_cache
+			);
+		}
+		return LoaderFactory::$loader;
+	}
 
 
-    /**
-     * Used for instantiating a new instance of a class
-     *
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public static function getNew($fqcn, array $arguments = [])
-    {
-        return LoaderFactory::getLoader()->getNew($fqcn, $arguments);
-    }
+	/**
+	 * Used for instantiating a new instance of a class
+	 *
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public static function getNew($fqcn, array $arguments = [])
+	{
+		return LoaderFactory::getLoader()->getNew($fqcn, $arguments);
+	}
 
 
-    /**
-     * Used for getting a shared instance of a class
-     *
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public static function getShared($fqcn, array $arguments = [])
-    {
-        return LoaderFactory::getLoader()->getShared($fqcn, $arguments);
-    }
+	/**
+	 * Used for getting a shared instance of a class
+	 *
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public static function getShared($fqcn, array $arguments = [])
+	{
+		return LoaderFactory::getLoader()->getShared($fqcn, $arguments);
+	}
 }

caffeinated/modules/event_single_caff/EED_Event_Single_Caff.module.php

Indentation +224 added lines, -224 removed lines

@@ -26,228 +26,228 @@
 {
 
 
-    /**
-     * @return EED_Event_Single_Caff
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::setDefinitions();
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__template_settings',
-            array('EED_Event_Single_Caff', 'load_scripts_styles'),
-            10
-        );
-        add_action(
-            'AHEE__template_settings__template__before_settings_form',
-            array('EED_Event_Single_Caff', 'template_settings_form'),
-            10
-        );
-        add_filter(
-            'FHEE__General_Settings_Admin_Page__update_template_settings__data',
-            array('EED_Event_Single_Caff', 'update_template_settings'),
-            10,
-            2
-        );
-        // AJAX
-        add_action(
-            'wp_ajax_espresso_update_event_single_order',
-            array('EED_Event_Single_Caff', 'update_event_single_order')
-        );
-        add_action(
-            'wp_ajax_nopriv_espresso_update_event_single_order',
-            array('EED_Event_Single_Caff', 'update_event_single_order')
-        );
-    }
-
-
-    public static function load_scripts_styles()
-    {
-        add_action('admin_enqueue_scripts', array('EED_Event_Single_Caff', 'enqueue_scripts_styles'), 10);
-    }
-
-
-    public static function enqueue_scripts_styles()
-    {
-        wp_register_style(
-            'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
-            array(),
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('eed-event-single-sortable');
-        wp_register_script(
-            'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
-            array('espresso_core', 'jquery-ui-sortable'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('eed-event-single-sortable');
-    }
-
-
-    /**
-     * Set constants only if they haven't been set yet.
-     */
-    public static function setDefinitions()
-    {
-        if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
-            define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
-            define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        }
-    }
-
-
-    /**
-     *    template_settings_form
-     *
-     * @access    public
-     * @static
-     * @return    void
-     */
-    public static function template_settings_form()
-    {
-        $config = EE_Registry::instance()->CFG->template_settings;
-        $config = isset($config->EED_Event_Single) && $config->EED_Event_Single instanceof EE_Event_Single_Config
-            ? $config->EED_Event_Single : new EE_Event_Single_Config();
-        $config->use_sortable_display_order = isset($config->use_sortable_display_order)
-            ? $config->use_sortable_display_order : false;
-        $config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
-
-        $event_single_order_array = array();
-        $event_single_order_array[ $config->display_order_tickets ] = 'tickets';
-        $event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
-        $event_single_order_array[ $config->display_order_event ] = 'event';
-        $event_single_order_array[ $config->display_order_venue ] = 'venue';
-        // get template parts
-        $template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
-        // convert to array so that we can add more properties
-        $config = get_object_vars($config);
-        $config['event_single_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
-            'event-single-sortable-js',
-            '',
-            'single-sortable-li single-sortable-js'
-        );
-        EEH_Template::display_template(
-            EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
-            $config
-        );
-    }
-
-
-    /**
-     * update_template_settings
-     *
-     * @param EE_Template_Config $CFG
-     * @param array              $REQ
-     * @return EE_Template_Config
-     */
-    public static function update_template_settings(EE_Template_Config $CFG, $REQ)
-    {
-        if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
-            $CFG->EED_Event_Single = new EE_Event_Single_Config();
-        }
-        $display_order_event = $CFG->EED_Event_Single->display_order_event !== null
-            ? $CFG->EED_Event_Single->display_order_event
-            : EED_Event_Single::EVENT_DETAILS_PRIORITY;
-        $display_order_datetimes = $CFG->EED_Event_Single->display_order_datetimes !== null
-            ? $CFG->EED_Event_Single->display_order_datetimes
-            : EED_Event_Single::EVENT_DATETIMES_PRIORITY;
-        $display_order_tickets = $CFG->EED_Event_Single->display_order_tickets !== null
-            ? $CFG->EED_Event_Single->display_order_tickets
-            : EED_Event_Single::EVENT_TICKETS_PRIORITY;
-        $display_order_venue = $CFG->EED_Event_Single->display_order_venue !== null
-            ? $CFG->EED_Event_Single->display_order_venue
-            : EED_Event_Single::EVENT_VENUES_PRIORITY;
-        $CFG->EED_Event_Single = new EE_Event_Single_Config();
-        $CFG->EED_Event_Single->display_status_banner_single = ! empty($REQ['display_status_banner_single'])
-                                                               && $REQ['display_status_banner_single'];
-        $CFG->EED_Event_Single->display_venue = ! empty($REQ['display_venue']) && $REQ['display_venue'];
-        $CFG->EED_Event_Single->use_sortable_display_order = ! empty($REQ['EED_Events_Single_use_sortable_display_order'])
-            ? absint($REQ['EED_Events_Single_use_sortable_display_order'])
-            : 0;
-        $CFG->EED_Event_Single->display_order_event = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_event
-            : EED_Event_Single::EVENT_DETAILS_PRIORITY;
-        $CFG->EED_Event_Single->display_order_datetimes = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_datetimes
-            : EED_Event_Single::EVENT_DATETIMES_PRIORITY;
-        $CFG->EED_Event_Single->display_order_tickets = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_tickets
-            : EED_Event_Single::EVENT_TICKETS_PRIORITY;
-        $CFG->EED_Event_Single->display_order_venue = $CFG->EED_Event_Single->use_sortable_display_order
-            ? $display_order_venue
-            : EED_Event_Single::EVENT_VENUES_PRIORITY;
-        do_action('AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ);
-        return $CFG;
-    }
-
-
-    /**
-     * update_event_single_order
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function update_event_single_order()
-    {
-        $config_saved = false;
-        $template_parts = sanitize_text_field($_POST['elements']);
-        if (! empty($template_parts)) {
-            $template_parts = explode(',', trim($template_parts, ','));
-            foreach ($template_parts as $key => $template_part) {
-                $template_part = "display_order_$template_part";
-                $priority = ($key * 10) + EED_Event_Single::EVENT_DETAILS_PRIORITY;
-                EE_Registry::instance()->CFG->template_settings->EED_Event_Single->{$template_part} = $priority;
-                do_action("AHEE__EED_Event_Single__update_event_single_order__$template_part", $priority);
-            }
-            $config_saved = EE_Registry::instance()->CFG->update_espresso_config(false, false);
-        }
-        if ($config_saved) {
-            EE_Error::add_success(__('Display Order has been successfully updated.', 'event_espresso'));
-        } else {
-            EE_Error::add_error(
-                __('Display Order was not updated.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        echo wp_json_encode(EE_Error::get_notices(false));
-        exit();
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	/**
+	 * @return EED_Event_Single_Caff
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::setDefinitions();
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__template_settings',
+			array('EED_Event_Single_Caff', 'load_scripts_styles'),
+			10
+		);
+		add_action(
+			'AHEE__template_settings__template__before_settings_form',
+			array('EED_Event_Single_Caff', 'template_settings_form'),
+			10
+		);
+		add_filter(
+			'FHEE__General_Settings_Admin_Page__update_template_settings__data',
+			array('EED_Event_Single_Caff', 'update_template_settings'),
+			10,
+			2
+		);
+		// AJAX
+		add_action(
+			'wp_ajax_espresso_update_event_single_order',
+			array('EED_Event_Single_Caff', 'update_event_single_order')
+		);
+		add_action(
+			'wp_ajax_nopriv_espresso_update_event_single_order',
+			array('EED_Event_Single_Caff', 'update_event_single_order')
+		);
+	}
+
+
+	public static function load_scripts_styles()
+	{
+		add_action('admin_enqueue_scripts', array('EED_Event_Single_Caff', 'enqueue_scripts_styles'), 10);
+	}
+
+
+	public static function enqueue_scripts_styles()
+	{
+		wp_register_style(
+			'eed-event-single-sortable',
+			EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
+			array(),
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('eed-event-single-sortable');
+		wp_register_script(
+			'eed-event-single-sortable',
+			EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
+			array('espresso_core', 'jquery-ui-sortable'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('eed-event-single-sortable');
+	}
+
+
+	/**
+	 * Set constants only if they haven't been set yet.
+	 */
+	public static function setDefinitions()
+	{
+		if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
+			define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
+			define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		}
+	}
+
+
+	/**
+	 *    template_settings_form
+	 *
+	 * @access    public
+	 * @static
+	 * @return    void
+	 */
+	public static function template_settings_form()
+	{
+		$config = EE_Registry::instance()->CFG->template_settings;
+		$config = isset($config->EED_Event_Single) && $config->EED_Event_Single instanceof EE_Event_Single_Config
+			? $config->EED_Event_Single : new EE_Event_Single_Config();
+		$config->use_sortable_display_order = isset($config->use_sortable_display_order)
+			? $config->use_sortable_display_order : false;
+		$config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
+
+		$event_single_order_array = array();
+		$event_single_order_array[ $config->display_order_tickets ] = 'tickets';
+		$event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
+		$event_single_order_array[ $config->display_order_event ] = 'event';
+		$event_single_order_array[ $config->display_order_venue ] = 'venue';
+		// get template parts
+		$template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
+		// convert to array so that we can add more properties
+		$config = get_object_vars($config);
+		$config['event_single_display_order'] = $template_parts->generate_sortable_list_of_template_parts(
+			'event-single-sortable-js',
+			'',
+			'single-sortable-li single-sortable-js'
+		);
+		EEH_Template::display_template(
+			EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
+			$config
+		);
+	}
+
+
+	/**
+	 * update_template_settings
+	 *
+	 * @param EE_Template_Config $CFG
+	 * @param array              $REQ
+	 * @return EE_Template_Config
+	 */
+	public static function update_template_settings(EE_Template_Config $CFG, $REQ)
+	{
+		if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
+			$CFG->EED_Event_Single = new EE_Event_Single_Config();
+		}
+		$display_order_event = $CFG->EED_Event_Single->display_order_event !== null
+			? $CFG->EED_Event_Single->display_order_event
+			: EED_Event_Single::EVENT_DETAILS_PRIORITY;
+		$display_order_datetimes = $CFG->EED_Event_Single->display_order_datetimes !== null
+			? $CFG->EED_Event_Single->display_order_datetimes
+			: EED_Event_Single::EVENT_DATETIMES_PRIORITY;
+		$display_order_tickets = $CFG->EED_Event_Single->display_order_tickets !== null
+			? $CFG->EED_Event_Single->display_order_tickets
+			: EED_Event_Single::EVENT_TICKETS_PRIORITY;
+		$display_order_venue = $CFG->EED_Event_Single->display_order_venue !== null
+			? $CFG->EED_Event_Single->display_order_venue
+			: EED_Event_Single::EVENT_VENUES_PRIORITY;
+		$CFG->EED_Event_Single = new EE_Event_Single_Config();
+		$CFG->EED_Event_Single->display_status_banner_single = ! empty($REQ['display_status_banner_single'])
+															   && $REQ['display_status_banner_single'];
+		$CFG->EED_Event_Single->display_venue = ! empty($REQ['display_venue']) && $REQ['display_venue'];
+		$CFG->EED_Event_Single->use_sortable_display_order = ! empty($REQ['EED_Events_Single_use_sortable_display_order'])
+			? absint($REQ['EED_Events_Single_use_sortable_display_order'])
+			: 0;
+		$CFG->EED_Event_Single->display_order_event = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_event
+			: EED_Event_Single::EVENT_DETAILS_PRIORITY;
+		$CFG->EED_Event_Single->display_order_datetimes = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_datetimes
+			: EED_Event_Single::EVENT_DATETIMES_PRIORITY;
+		$CFG->EED_Event_Single->display_order_tickets = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_tickets
+			: EED_Event_Single::EVENT_TICKETS_PRIORITY;
+		$CFG->EED_Event_Single->display_order_venue = $CFG->EED_Event_Single->use_sortable_display_order
+			? $display_order_venue
+			: EED_Event_Single::EVENT_VENUES_PRIORITY;
+		do_action('AHEE__EED_Event_Single__update_template_settings__after_update', $CFG, $REQ);
+		return $CFG;
+	}
+
+
+	/**
+	 * update_event_single_order
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function update_event_single_order()
+	{
+		$config_saved = false;
+		$template_parts = sanitize_text_field($_POST['elements']);
+		if (! empty($template_parts)) {
+			$template_parts = explode(',', trim($template_parts, ','));
+			foreach ($template_parts as $key => $template_part) {
+				$template_part = "display_order_$template_part";
+				$priority = ($key * 10) + EED_Event_Single::EVENT_DETAILS_PRIORITY;
+				EE_Registry::instance()->CFG->template_settings->EED_Event_Single->{$template_part} = $priority;
+				do_action("AHEE__EED_Event_Single__update_event_single_order__$template_part", $priority);
+			}
+			$config_saved = EE_Registry::instance()->CFG->update_espresso_config(false, false);
+		}
+		if ($config_saved) {
+			EE_Error::add_success(__('Display Order has been successfully updated.', 'event_espresso'));
+		} else {
+			EE_Error::add_error(
+				__('Display Order was not updated.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		echo wp_json_encode(EE_Error::get_notices(false));
+		exit();
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -92,14 +92,14 @@ 
     {
         wp_register_style(
             'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.css',
+            EVENT_SINGLE_CAFF_ASSETS_URL.'eed_event_single_sortable.css',
             array(),
             EVENT_ESPRESSO_VERSION
         );
         wp_enqueue_style('eed-event-single-sortable');
         wp_register_script(
             'eed-event-single-sortable',
-            EVENT_SINGLE_CAFF_ASSETS_URL . 'eed_event_single_sortable.js',
+            EVENT_SINGLE_CAFF_ASSETS_URL.'eed_event_single_sortable.js',
             array('espresso_core', 'jquery-ui-sortable'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -113,9 +113,9 @@ 
      */
     public static function setDefinitions()
     {
-        if (! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
-            define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__) . 'templates/');
-            define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+        if ( ! defined('EVENT_SINGLE_CAFF_TEMPLATES_PATH')) {
+            define('EVENT_SINGLE_CAFF_TEMPLATES_PATH', plugin_dir_path(__FILE__).'templates/');
+            define('EVENT_SINGLE_CAFF_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
         }
     }
 
@@ -137,10 +137,10 @@ 
         $config = apply_filters('FHEE__EED_Event_Single__template_settings_form__event_list_config', $config);
 
         $event_single_order_array = array();
-        $event_single_order_array[ $config->display_order_tickets ] = 'tickets';
-        $event_single_order_array[ $config->display_order_datetimes ] = 'datetimes';
-        $event_single_order_array[ $config->display_order_event ] = 'event';
-        $event_single_order_array[ $config->display_order_venue ] = 'venue';
+        $event_single_order_array[$config->display_order_tickets] = 'tickets';
+        $event_single_order_array[$config->display_order_datetimes] = 'datetimes';
+        $event_single_order_array[$config->display_order_event] = 'event';
+        $event_single_order_array[$config->display_order_venue] = 'venue';
         // get template parts
         $template_parts = EED_Event_Single::instance()->initialize_template_parts($config);
         // convert to array so that we can add more properties
@@ -151,7 +151,7 @@ 
             'single-sortable-li single-sortable-js'
         );
         EEH_Template::display_template(
-            EVENT_SINGLE_CAFF_TEMPLATES_PATH . 'admin-event-single-settings.template.php',
+            EVENT_SINGLE_CAFF_TEMPLATES_PATH.'admin-event-single-settings.template.php',
             $config
         );
     }
@@ -166,7 +166,7 @@ 
      */
     public static function update_template_settings(EE_Template_Config $CFG, $REQ)
     {
-        if (! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
+        if ( ! $CFG->EED_Event_Single instanceof EE_Event_Single_Config) {
             $CFG->EED_Event_Single = new EE_Event_Single_Config();
         }
         $display_order_event = $CFG->EED_Event_Single->display_order_event !== null
@@ -215,7 +215,7 @@ 
     {
         $config_saved = false;
         $template_parts = sanitize_text_field($_POST['elements']);
-        if (! empty($template_parts)) {
+        if ( ! empty($template_parts)) {
             $template_parts = explode(',', trim($template_parts, ','));
             foreach ($template_parts as $key => $template_part) {
                 $template_part = "display_order_$template_part";