eventespresso / event-espresso-core

caffeinated/payment_methods/Aim/EE_PMT_Aim.pm.php

Indentation +252 added lines, -252 removed lines

@@ -12,275 +12,275 @@
 {
 
 
-    /**
-     * @param EE_Payment_Method $pm_instance
-     * @return EE_PMT_Aim
-     * @throws \EE_Error
-     */
-    public function __construct($pm_instance = null)
-    {
-        $this->_setup_properties();
-        parent::__construct($pm_instance);
-    }
+	/**
+	 * @param EE_Payment_Method $pm_instance
+	 * @return EE_PMT_Aim
+	 * @throws \EE_Error
+	 */
+	public function __construct($pm_instance = null)
+	{
+		$this->_setup_properties();
+		parent::__construct($pm_instance);
+	}
     
-    /**
-     * Sets up payment method type properties for this gateway, which is normally
-     * done in the constructor, but we want this to be easy for similar gateways to override
-     * while still calling the parent constructor.
-     * So children should override this method instead of __construct
-     */
-    protected function _setup_properties()
-    {
-        require_once($this->file_folder().'EEG_Aim.gateway.php');
-        $this->_gateway = new EEG_Aim();
-        $this->_pretty_name = __("Authorize.net AIM", 'event_espresso');
-        $this->_default_description = __('Please provide the following billing information.', 'event_espresso');
-        $this->_requires_https = true;
-    }
+	/**
+	 * Sets up payment method type properties for this gateway, which is normally
+	 * done in the constructor, but we want this to be easy for similar gateways to override
+	 * while still calling the parent constructor.
+	 * So children should override this method instead of __construct
+	 */
+	protected function _setup_properties()
+	{
+		require_once($this->file_folder().'EEG_Aim.gateway.php');
+		$this->_gateway = new EEG_Aim();
+		$this->_pretty_name = __("Authorize.net AIM", 'event_espresso');
+		$this->_default_description = __('Please provide the following billing information.', 'event_espresso');
+		$this->_requires_https = true;
+	}
 
 
 
-    /**
-     * Creates the billing form for this payment method type
-     *
-     * @param \EE_Transaction $transaction
-     * @return EE_Billing_Info_Form
-     * @throws \EE_Error
-     */
-    public function generate_new_billing_form(EE_Transaction $transaction = null)
-    {
-        $billing_form = new EE_Billing_Attendee_Info_Form($this->_pm_instance, array(
-            'name'=>'AIM_Form',
-            'subsections'=>array(
-                'credit_card'=>new EE_Credit_Card_Input(array(
-                    'required'=>true,
-                    'html_label_text' => __('Card Number', 'event_espresso')
-                )),
-                'exp_month'=>new EE_Credit_Card_Month_Input(true, array(
-                    'required'=>true,
-                    'html_label_text' => __('Expiry Month', 'event_espresso')
-                )),
-                'exp_year'=>new EE_Credit_Card_Year_Input(array(
-                    'required'=>true,
-                    'html_label_text' => __('Expiry Year', 'event_espresso')
-                )),
-                'cvv'=>new EE_CVV_Input(array(
-                    'required'=>true,
-                    'html_label_text' => __('CVV', 'event_espresso') )),
-            )
-        ));
-        $billing_form->add_subsections(array(
-            'company' => new EE_Text_Input(array(
-                'html_label_text' => __('Company', 'event_espresso')
-            ))
-        ), 'email', false);
-        $billing_form->add_subsections(
-            array(
-                    'fax' => new EE_Text_Input(array(
-                        'html_label_text' => __('Fax', 'event_espresso')
-                    ))
-                ),
-            'phone',
-            false
-        );
-        $settings_form = $this->settings_form();
-        if ($settings_form->get_input('excluded_billing_inputs') instanceof EE_Checkbox_Multi_Input) {
-                $billing_form->exclude($settings_form->get_input('excluded_billing_inputs')->normalized_value());
-        }
-        if ($settings_form->get_input('required_billing_inputs') instanceof EE_Checkbox_Multi_Input) {
-            $required_inputs = $settings_form->get_input('required_billing_inputs')->normalized_value();
-            // only change the requirement of inputs which are allowed to be changed
-            /** @var EE_Form_Input_Base[] $inputs_to_evaluate */
-            $inputs_to_evaluate = array_intersect_key(
-                $billing_form->inputs(),
-                $this->billing_input_names()
-            );
-            foreach ($inputs_to_evaluate as $input_name => $input) {
-                if (in_array($input_name, $required_inputs)) {
-                    $input->set_required(true);
-                } else {
-                    $input->set_required(false);
-                }
-            }
-        }
-        return $this->apply_billing_form_debug_settings($billing_form);
-    }
+	/**
+	 * Creates the billing form for this payment method type
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return EE_Billing_Info_Form
+	 * @throws \EE_Error
+	 */
+	public function generate_new_billing_form(EE_Transaction $transaction = null)
+	{
+		$billing_form = new EE_Billing_Attendee_Info_Form($this->_pm_instance, array(
+			'name'=>'AIM_Form',
+			'subsections'=>array(
+				'credit_card'=>new EE_Credit_Card_Input(array(
+					'required'=>true,
+					'html_label_text' => __('Card Number', 'event_espresso')
+				)),
+				'exp_month'=>new EE_Credit_Card_Month_Input(true, array(
+					'required'=>true,
+					'html_label_text' => __('Expiry Month', 'event_espresso')
+				)),
+				'exp_year'=>new EE_Credit_Card_Year_Input(array(
+					'required'=>true,
+					'html_label_text' => __('Expiry Year', 'event_espresso')
+				)),
+				'cvv'=>new EE_CVV_Input(array(
+					'required'=>true,
+					'html_label_text' => __('CVV', 'event_espresso') )),
+			)
+		));
+		$billing_form->add_subsections(array(
+			'company' => new EE_Text_Input(array(
+				'html_label_text' => __('Company', 'event_espresso')
+			))
+		), 'email', false);
+		$billing_form->add_subsections(
+			array(
+					'fax' => new EE_Text_Input(array(
+						'html_label_text' => __('Fax', 'event_espresso')
+					))
+				),
+			'phone',
+			false
+		);
+		$settings_form = $this->settings_form();
+		if ($settings_form->get_input('excluded_billing_inputs') instanceof EE_Checkbox_Multi_Input) {
+				$billing_form->exclude($settings_form->get_input('excluded_billing_inputs')->normalized_value());
+		}
+		if ($settings_form->get_input('required_billing_inputs') instanceof EE_Checkbox_Multi_Input) {
+			$required_inputs = $settings_form->get_input('required_billing_inputs')->normalized_value();
+			// only change the requirement of inputs which are allowed to be changed
+			/** @var EE_Form_Input_Base[] $inputs_to_evaluate */
+			$inputs_to_evaluate = array_intersect_key(
+				$billing_form->inputs(),
+				$this->billing_input_names()
+			);
+			foreach ($inputs_to_evaluate as $input_name => $input) {
+				if (in_array($input_name, $required_inputs)) {
+					$input->set_required(true);
+				} else {
+					$input->set_required(false);
+				}
+			}
+		}
+		return $this->apply_billing_form_debug_settings($billing_form);
+	}
 
 
 
-    /**
-     * apply_billing_form_debug_settings
-     * applies debug data to the form
-     *
-     * @param \EE_Billing_Info_Form $billing_form
-     * @return \EE_Billing_Info_Form
-     * @throws \EE_Error
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        if ($this->_pm_instance->debug_mode()
-            || $this->_pm_instance->get_extra_meta('test_transactions', true, false)
-        ) {
-            $billing_form->get_input('credit_card')->set_default('4007000000027');
-            $billing_form->get_input('exp_year')->set_default('2020');
-            if ($billing_form->get_subsection('cvv') instanceof EE_Form_Input_Base) {
-                $billing_form->get_input('cvv')->set_default('123');
-            }
-            $billing_form->add_subsections(
-                array( 'fyi_about_autofill' => $billing_form->payment_fields_autofilled_notice_html() ),
-                'credit_card'
-            );
-            $billing_form->add_subsections(
-                array(
-                    'debug_content' => new EE_Form_Section_HTML_From_Template(
-                        __DIR__.DS.'templates'.DS.'authorize_net_aim_debug_info.template.php'
-                    )
-                ),
-                'first_name'
-            );
-        }
-        return $billing_form;
-    }
+	/**
+	 * apply_billing_form_debug_settings
+	 * applies debug data to the form
+	 *
+	 * @param \EE_Billing_Info_Form $billing_form
+	 * @return \EE_Billing_Info_Form
+	 * @throws \EE_Error
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		if ($this->_pm_instance->debug_mode()
+			|| $this->_pm_instance->get_extra_meta('test_transactions', true, false)
+		) {
+			$billing_form->get_input('credit_card')->set_default('4007000000027');
+			$billing_form->get_input('exp_year')->set_default('2020');
+			if ($billing_form->get_subsection('cvv') instanceof EE_Form_Input_Base) {
+				$billing_form->get_input('cvv')->set_default('123');
+			}
+			$billing_form->add_subsections(
+				array( 'fyi_about_autofill' => $billing_form->payment_fields_autofilled_notice_html() ),
+				'credit_card'
+			);
+			$billing_form->add_subsections(
+				array(
+					'debug_content' => new EE_Form_Section_HTML_From_Template(
+						__DIR__.DS.'templates'.DS.'authorize_net_aim_debug_info.template.php'
+					)
+				),
+				'first_name'
+			);
+		}
+		return $billing_form;
+	}
 
 
 
-    /**
-     * Gets the form for all the settings related to this payment method type
-     * @return EE_Payment_Method_Form
-     */
-    public function generate_new_settings_form()
-    {
-        $billing_input_names = $this->billing_input_names();
-        return new EE_Payment_Method_Form(
-            array(
-                'extra_meta_inputs'=>array(
-                    'login_id'=>new EE_Text_Input(
-                        array(
-                            'html_label_text'=>  sprintf(__("Authorize.net API Login ID %s", "event_espresso"), $this->get_help_tab_link()),
-                            'required' => true )
-                    ),
-                    'transaction_key'=>new EE_Text_Input(
-                        array(
-                            'html_label_text'=> sprintf(__("Authorize.net Transaction Key %s", "event_espresso"), $this->get_help_tab_link()),
-                            'required' => true )
-                    ),
-                    'test_transactions'=>new EE_Yes_No_Input(
-                        array(
-                            'html_label_text'=>  sprintf(__("Send test transactions? %s", 'event_espresso'), $this->get_help_tab_link()),
-                            'html_help_text'=>  __("Send test transactions, even to live server", 'event_espresso'),
-                            'default' => false,
-                            'required' => true
-                        )
-                    ),
-                    'excluded_billing_inputs' => new EE_Checkbox_Multi_Input(
-                        $billing_input_names,
-                        array(
-                        'html_label_text' => sprintf(__("Excluded Payment Form Fields %s", 'event_espresso'), $this->get_help_tab_link()),
-                        'default' => array(
-                            'company',
-                            'fax',
-                        )
-                        )
-                    ),
-                    'required_billing_inputs' => new EE_Checkbox_Multi_Input(
-                        $billing_input_names,
-                        array(
-                            'html_label_text' => sprintf(__("Required Payment Form Fields %s", 'event_espresso'), $this->get_help_tab_link()),
-                            'default' => array_diff(
-                                array_keys($billing_input_names),
-                                array( 'address2', 'phone', 'company', 'fax' )
-                            ),
-                            'html_help_text' => __('Note: if fields are excluded they cannot be required.', 'event_espresso')
-                        )
-                    ),
-                    'server' => new EE_Select_Input(
-                        apply_filters(
-                            'FHEE__EE_PMT_Aim__generate_new_settings_form__server_select_input__options',
-                            array(
-                                'akamai' => __('Authorize.net/Akamai (default)', 'event_espresso'),
-                                'authorize.net' => __('Authorize.net (deprecated)', 'event_espresso'),
-                            ),
-                            $this
-                        ),
-                        array(
-                            'html_label_text' => __('Server', 'event_espresso'),
-                            'html_help_text' => __('The Gateway Server where payment requests will be sent', 'event_espresso')
-                        )
-                    )
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 * @return EE_Payment_Method_Form
+	 */
+	public function generate_new_settings_form()
+	{
+		$billing_input_names = $this->billing_input_names();
+		return new EE_Payment_Method_Form(
+			array(
+				'extra_meta_inputs'=>array(
+					'login_id'=>new EE_Text_Input(
+						array(
+							'html_label_text'=>  sprintf(__("Authorize.net API Login ID %s", "event_espresso"), $this->get_help_tab_link()),
+							'required' => true )
+					),
+					'transaction_key'=>new EE_Text_Input(
+						array(
+							'html_label_text'=> sprintf(__("Authorize.net Transaction Key %s", "event_espresso"), $this->get_help_tab_link()),
+							'required' => true )
+					),
+					'test_transactions'=>new EE_Yes_No_Input(
+						array(
+							'html_label_text'=>  sprintf(__("Send test transactions? %s", 'event_espresso'), $this->get_help_tab_link()),
+							'html_help_text'=>  __("Send test transactions, even to live server", 'event_espresso'),
+							'default' => false,
+							'required' => true
+						)
+					),
+					'excluded_billing_inputs' => new EE_Checkbox_Multi_Input(
+						$billing_input_names,
+						array(
+						'html_label_text' => sprintf(__("Excluded Payment Form Fields %s", 'event_espresso'), $this->get_help_tab_link()),
+						'default' => array(
+							'company',
+							'fax',
+						)
+						)
+					),
+					'required_billing_inputs' => new EE_Checkbox_Multi_Input(
+						$billing_input_names,
+						array(
+							'html_label_text' => sprintf(__("Required Payment Form Fields %s", 'event_espresso'), $this->get_help_tab_link()),
+							'default' => array_diff(
+								array_keys($billing_input_names),
+								array( 'address2', 'phone', 'company', 'fax' )
+							),
+							'html_help_text' => __('Note: if fields are excluded they cannot be required.', 'event_espresso')
+						)
+					),
+					'server' => new EE_Select_Input(
+						apply_filters(
+							'FHEE__EE_PMT_Aim__generate_new_settings_form__server_select_input__options',
+							array(
+								'akamai' => __('Authorize.net/Akamai (default)', 'event_espresso'),
+								'authorize.net' => __('Authorize.net (deprecated)', 'event_espresso'),
+							),
+							$this
+						),
+						array(
+							'html_label_text' => __('Server', 'event_espresso'),
+							'html_help_text' => __('The Gateway Server where payment requests will be sent', 'event_espresso')
+						)
+					)
                         
-                )
-            )
-        );
-    }
+				)
+			)
+		);
+	}
     
-    /**
-     * Returns an array where keys are the slugs for billing inputs, and values
-     * are their i18n names
-     * @return array
-     */
-    public function billing_input_names()
-    {
-        return array(
-            'first_name' => __('First Name', 'event_espresso'),
-            'last_name' => __('Last Name', 'event_espresso'),
-            'email' => __('Email', 'event_espresso'),
-            'company' => __('Company', 'event_espresso'),
-            'address' => __('Address', 'event_espresso'),
-            'address2' => __('Address2', 'event_espresso'),
-            'city' => __('City', 'event_espresso'),
-            'state' => __('State', 'event_espresso'),
-            'country' => __('Country', 'event_espresso'),
-            'zip' =>  __('Zip', 'event_espresso'),
-            'phone' => __('Phone', 'event_espresso'),
-            'fax' => __('Fax', 'event_espresso'),
-            'cvv' => __('CVV', 'event_espresso')
-        );
-    }
+	/**
+	 * Returns an array where keys are the slugs for billing inputs, and values
+	 * are their i18n names
+	 * @return array
+	 */
+	public function billing_input_names()
+	{
+		return array(
+			'first_name' => __('First Name', 'event_espresso'),
+			'last_name' => __('Last Name', 'event_espresso'),
+			'email' => __('Email', 'event_espresso'),
+			'company' => __('Company', 'event_espresso'),
+			'address' => __('Address', 'event_espresso'),
+			'address2' => __('Address2', 'event_espresso'),
+			'city' => __('City', 'event_espresso'),
+			'state' => __('State', 'event_espresso'),
+			'country' => __('Country', 'event_espresso'),
+			'zip' =>  __('Zip', 'event_espresso'),
+			'phone' => __('Phone', 'event_espresso'),
+			'fax' => __('Fax', 'event_espresso'),
+			'cvv' => __('CVV', 'event_espresso')
+		);
+	}
     
-    /**
-     * Overrides parent so we always have all billing inputs in the returned array,
-     * not just the ones included at the time. This helps simplify the gateway code
-     *
-     * @param EE_Billing_Info_Form $billing_form
-     * @return array
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        $all_billing_values_empty = array();
-        foreach (array_keys($this->billing_input_names()) as $input_name) {
-            $all_billing_values_empty[ $input_name ] = '';
-        }
-        return array_merge(
-            $all_billing_values_empty,
-            parent::_get_billing_values_from_form($billing_form)
-        );
-    }
+	/**
+	 * Overrides parent so we always have all billing inputs in the returned array,
+	 * not just the ones included at the time. This helps simplify the gateway code
+	 *
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return array
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		$all_billing_values_empty = array();
+		foreach (array_keys($this->billing_input_names()) as $input_name) {
+			$all_billing_values_empty[ $input_name ] = '';
+		}
+		return array_merge(
+			$all_billing_values_empty,
+			parent::_get_billing_values_from_form($billing_form)
+		);
+	}
 
 
 
-    /**
-     * Adds the help tab
-     * @see EE_PMT_Base::help_tabs_config()
-     * @return array
-     */
-    public function help_tabs_config()
-    {
-        return array(
-            $this->get_help_tab_name() => array(
-                'title' => __('Authorize.net AIM Settings', 'event_espresso'),
-                'filename' => 'payment_methods_overview_aim'
-            ),
-        );
-    }
+	/**
+	 * Adds the help tab
+	 * @see EE_PMT_Base::help_tabs_config()
+	 * @return array
+	 */
+	public function help_tabs_config()
+	{
+		return array(
+			$this->get_help_tab_name() => array(
+				'title' => __('Authorize.net AIM Settings', 'event_espresso'),
+				'filename' => 'payment_methods_overview_aim'
+			),
+		);
+	}
 
 
 
-    /**
-     * Gets a list of instructions and/or information regarding how the payment is to be completed
-     * @return string
-     */
-    public function payment_information()
-    {
-        // TODO: Implement payment_information() method.
-    }
+	/**
+	 * Gets a list of instructions and/or information regarding how the payment is to be completed
+	 * @return string
+	 */
+	public function payment_information()
+	{
+		// TODO: Implement payment_information() method.
+	}
 }

core/db_models/EEM_Question.model.php

Indentation +425 added lines, -425 removed lines

@@ -10,429 +10,429 @@
 class EEM_Question extends EEM_Soft_Delete_Base
 {
 
-    // constant used to indicate that the question type is COUNTRY
-    const QST_type_country = 'COUNTRY';
-
-    // constant used to indicate that the question type is DATE
-    const QST_type_date = 'DATE';
-
-    // constant used to indicate that the question type is DROPDOWN
-    const QST_type_dropdown = 'DROPDOWN';
-
-    // constant used to indicate that the question type is CHECKBOX
-    const QST_type_checkbox = 'CHECKBOX';
-
-    // constant used to indicate that the question type is RADIO_BTN
-    const QST_type_radio = 'RADIO_BTN';
-
-    // constant used to indicate that the question type is STATE
-    const QST_type_state = 'STATE';
-
-    // constant used to indicate that the question type is TEXT
-    const QST_type_text = 'TEXT';
-
-    // constant used to indicate that the question type is TEXTAREA
-    const QST_type_textarea = 'TEXTAREA';
-
-    // constant used to indicate that the question type is a TEXTAREA that allows simple html
-    const QST_type_html_textarea = 'HTML_TEXTAREA';
-
-    // constant used to indicate that the question type is an email input
-    const QST_type_email = 'EMAIL';
-
-    // constant used to indicate that the question type is a US-formatted phone number
-    const QST_type_us_phone = 'US_PHONE';
-
-    // constant used to indicate that the question type is an integer (whole number)
-    const QST_type_int = 'INTEGER';
-
-    // constant used to indicate that the question type is a decimal (float)
-    const QST_type_decimal = 'DECIMAL';
-
-    // constant used to indicate that the question type is a valid URL
-    const QST_type_url = 'URL';
-
-    // constant used to indicate that the question type is a YEAR
-    const QST_type_year = 'YEAR';
-
-    // constant used to indicate that the question type is a multi-select
-    const QST_type_multi_select = 'MULTI_SELECT';
-
-    /**
-     * Question types that are interchangeable, even after answers have been provided for them.
-     * Top-level keys are category slugs, next level is an array of question types. If question types
-     * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
-     *
-     * @access protected
-     * @var array $_question_type_categories {
-     * @type string $text
-     * @type string $single -answer-enum
-     * @type string $multi -answer-enum
-     *                    }
-     */
-    protected $_question_type_categories = array();
-
-    /**
-     * lists all the question types which should be allowed. Ideally, this will be extensible.
-     *
-     * @access protected
-     * @var array $_allowed_question_types
-     */
-    protected $_allowed_question_types = array();
-
-    /**
-     * brief descriptions for all the question types
-     *
-     * @access protected
-     * @var EEM_Question $_instance
-     */
-    protected $_question_descriptions;
-
-
-    /**
-     * Question types that should have an admin-defined max input length
-     * @var array
-     */
-    protected $question_types_with_max_lengh;
-
-
-    // private instance of the Attendee object
-    protected static $_instance = null;
-
-
-    /**
-     * EEM_Question constructor.
-     *
-     * @param null $timezone
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Question', 'event_espresso');
-        $this->plural_item = __('Questions', 'event_espresso');
-        $this->_allowed_question_types = apply_filters(
-            'FHEE__EEM_Question__construct__allowed_question_types',
-            array(
-                EEM_Question::QST_type_text => __('Text', 'event_espresso'),
-                EEM_Question::QST_type_textarea => __('Textarea', 'event_espresso'),
-                EEM_Question::QST_type_checkbox => __('Checkboxes', 'event_espresso'),
-                EEM_Question::QST_type_radio => __('Radio Buttons', 'event_espresso'),
-                EEM_Question::QST_type_dropdown => __('Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_state => __('State/Province Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_country => __('Country Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_date => __('Date Picker', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => __('HTML Textarea', 'event_espresso'),
-                EEM_Question::QST_type_email => __('Email', 'event_espresso'),
-                EEM_Question::QST_type_us_phone => __('USA - Format Phone', 'event_espresso'),
-                EEM_Question::QST_type_decimal => __('Number', 'event_espresso'),
-                EEM_Question::QST_type_int => __('Whole Number', 'event_espresso'),
-                EEM_Question::QST_type_url => __('URL', 'event_espresso'),
-                EEM_Question::QST_type_year => __('Year', 'event_espresso'),
-                EEM_Question::QST_type_multi_select => __('Multi Select', 'event_espresso')
-            )
-        );
-        $this->_question_descriptions = apply_filters(
-            'FHEE__EEM_Question__construct__question_descriptions',
-            array(
-                EEM_Question::QST_type_text => __('A single line text input field', 'event_espresso'),
-                EEM_Question::QST_type_textarea => __('A multi line text input field', 'event_espresso'),
-                EEM_Question::QST_type_checkbox => __('Allows multiple preset options to be selected', 'event_espresso'),
-                EEM_Question::QST_type_radio => __('Allows a single preset option to be selected', 'event_espresso'),
-                EEM_Question::QST_type_dropdown => __('A dropdown that allows a single selection', 'event_espresso'),
-                EEM_Question::QST_type_state => __('A dropdown that lists states/provinces', 'event_espresso'),
-                EEM_Question::QST_type_country => __('A dropdown that lists countries', 'event_espresso'),
-                EEM_Question::QST_type_date => __('A popup calendar that allows date selections', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => __('A multi line text input field that allows HTML', 'event_espresso'),
-                EEM_Question::QST_type_email => __('A text field that must contain a valid Email address', 'event_espresso'),
-                EEM_Question::QST_type_us_phone => __('A text field that must contain a valid US phone number', 'event_espresso'),
-                EEM_Question::QST_type_decimal => __('A text field that allows number values with decimals', 'event_espresso'),
-                EEM_Question::QST_type_int => __('A text field that only allows whole numbers (no decimals)', 'event_espresso'),
-                EEM_Question::QST_type_url => __('A text field that must contain a valid URL', 'event_espresso'),
-                EEM_Question::QST_type_year => __('A dropdown that lists the last 100 years', 'event_espresso'),
-                EEM_Question::QST_type_multi_select => __('A dropdown that allows multiple selections', 'event_espresso')
-            )
-        );
-        $this->_question_type_categories = (array) apply_filters(
-            'FHEE__EEM_Question__construct__question_type_categories',
-            array(
-                'text' => array(
-                    EEM_Question::QST_type_text,
-                    EEM_Question::QST_type_textarea,
-                    EEM_Question::QST_type_date,
-                    EEM_Question::QST_type_html_textarea,
-                    EEM_Question::QST_type_email,
-                    EEM_Question::QST_type_us_phone,
-                    EEM_Question::QST_type_decimal,
-                    EEM_Question::QST_type_int,
-                    EEM_Question::QST_type_url,
-                    EEM_Question::QST_type_year
-                ),
-                'single-answer-enum' => array(
-                    EEM_Question::QST_type_radio,
-                    EEM_Question::QST_type_dropdown
-                ),
-                'multi-answer-enum' => array(
-                    EEM_Question::QST_type_checkbox,
-                    EEM_Question::QST_type_multi_select
-                )
-            )
-        );
-        $this->question_types_with_max_lengh = apply_filters(
-            'FHEE__EEM_Question___construct__question_types_with_max_length',
-            array(
-                EEM_Question::QST_type_text,
-                EEM_Question::QST_type_textarea,
-                EEM_Question::QST_type_html_textarea
-            )
-        );
-
-        $this->_tables = array(
-            'Question' => new EE_Primary_Table('esp_question', 'QST_ID')
-        );
-        $this->_fields = array(
-            'Question' => array(
-                'QST_ID' => new EE_Primary_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso')),
-                'QST_display_text' => new EE_Post_Content_Field('QST_display_text', __('Question Text', 'event_espresso'), true, ''),
-                'QST_admin_label' => new EE_Plain_Text_Field('QST_admin_label', __('Question Label (admin-only)', 'event_espresso'), true, ''),
-                'QST_system' => new EE_Plain_Text_Field('QST_system', __('Internal string ID for question', 'event_espresso'), false, ''),
-                'QST_type' => new EE_Enum_Text_Field('QST_type', __('Question Type', 'event_espresso'), false, 'TEXT', $this->_allowed_question_types),
-                'QST_required' => new EE_Boolean_Field('QST_required', __('Required Question?', 'event_espresso'), false, false),
-                'QST_required_text' => new EE_Simple_HTML_Field('QST_required_text', __('Text to Display if Not Provided', 'event_espresso'), true, ''),
-                'QST_order' => new EE_Integer_Field('QST_order', __('Question Order', 'event_espresso'), false, 0),
-                'QST_admin_only' => new EE_Boolean_Field('QST_admin_only', __('Admin-Only Question?', 'event_espresso'), false, false),
-                'QST_max' => new EE_Infinite_Integer_Field('QST_max', __('Max Size', 'event_espresso'), false, EE_INF),
-                'QST_wp_user' => new EE_WP_User_Field('QST_wp_user', __('Question Creator ID', 'event_espresso'), false),
-                'QST_deleted' => new EE_Trashed_Flag_Field('QST_deleted', __('Flag Indicating question was deleted', 'event_espresso'), false, false)
-            )
-        );
-        $this->_model_relations = array(
-            'Question_Group' => new EE_HABTM_Relation('Question_Group_Question'),
-            'Question_Option' => new EE_Has_Many_Relation(),
-            'Answer' => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-            // for QST_order column
-            'Question_Group_Question' => new EE_Has_Many_Relation()
-        );
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QST_system');
-        parent::__construct($timezone);
-    }
-
-    /**
-     * Returns the list of allowed question types, which are normally: 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE'
-     * but they can be extended
-     * @return string[]
-     */
-    public function allowed_question_types()
-    {
-        return $this->_allowed_question_types;
-    }
-
-    /**
-     * Gets all the question types in the same category
-     * @param string $question_type one of EEM_Question::allowed_question_types(
-     * @return string[] like EEM_Question::allowed_question_types()
-     */
-    public function question_types_in_same_category($question_type)
-    {
-        $question_types = array($question_type);
-        foreach ($this->_question_type_categories as $category => $question_types_in_category) {
-            if (in_array($question_type, $question_types_in_category)) {
-                $question_types = $question_types_in_category;
-                break;
-            }
-        }
-
-        return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
-    }
-
-    /**
-     * Determines if the given question type is in the given question type category
-     * @param string $question_type one of EEM_Question::allowed_question_types()
-     * @param string $category one of the top-level keys of EEM_Question::question_type_categories()
-     * @return boolean
-     */
-    public function question_type_is_in_category($question_type, $category)
-    {
-        if (!isset($this->_question_type_categories[ $category ])) {
-            return false;
-        }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
-    }
-
-
-    /**
-     * Returns all the question types in the given category
-     * @param string $category
-     * @return array|mixed
-     */
-    public function question_types_in_category($category)
-    {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
-        }
-        return array();
-    }
-
-
-    /**
-     * Returns all the question types that should have question options
-     * @return array
-     */
-    public function question_types_with_options()
-    {
-        return array_merge(
-            $this->question_types_in_category('single-answer-enum'),
-            $this->question_types_in_category('multi-answer-enum')
-        );
-    }
-
-    /**
-     * Returns the question type categories 2d array
-     * @return array see EEM_Question::_question_type_categories
-     */
-    public function question_type_categories()
-    {
-        return $this->_question_type_categories;
-    }
-
-    /**
-     * Returns an array of all the QST_system values that can be allowed in the system question group
-     * identified by $system_question_group_id
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function allowed_system_questions_in_system_question_group($system_question_group_id)
-    {
-        $question_system_ids = array();
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_lname,
-                    EEM_Attendee::system_question_email,
-                    EEM_Attendee::system_question_phone
-                );
-                break;
-            case EEM_Question_Group::system_address:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_address,
-                    EEM_Attendee::system_question_address2,
-                    EEM_Attendee::system_question_city,
-                    EEM_Attendee::system_question_state,
-                    EEM_Attendee::system_question_country,
-                    EEM_Attendee::system_question_zip,
-                    EEM_Attendee::system_question_phone
-                );
-                break;
-        }
-        return apply_filters('FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return', $question_system_ids, $system_question_group_id);
-    }
-
-    /**
-     * Returns an array of all the QST_system values that are required in the system question group
-     * identified by $system_question_group_id
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function required_system_questions_in_system_question_group($system_question_group_id)
-    {
-        $question_system_ids = null;
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = array(
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_email,
-                );
-                break;
-            default:
-                $question_system_ids = array();
-        }
-        return apply_filters('FHEE__EEM_Question__system_questions_required_in_system_question_group', $question_system_ids, $system_question_group_id);
-    }
-
-
-    /**
-     * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
-     * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
-     * @param $QST_system
-     * @return int of QST_ID for the question that corresponds to that QST_system
-     */
-    public function get_Question_ID_from_system_string($QST_system)
-    {
-        return $this->get_var(array(array('QST_system' => $QST_system)));
-    }
-
-
-    /**
-     * searches the db for the question with the latest question order and returns that value.
-     * @access public
-     * @return int
-     */
-    public function get_latest_question_order()
-    {
-        $columns_to_select = array(
-            'max_order' => array("MAX(QST_order)", "%d")
-        );
-        $max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
-        return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
-    }
-
-    /**
-     * Returns an array where keys are system question QST_system values,
-     * and values are the highest question max the admin can set on the question
-     * (aka the "max max"; eg, a site admin can change the zip question to have a max
-     * of 5, but no larger than 12)
-     * @return array
-     */
-    public function system_question_maxes()
-    {
-        return array(
-            'fname' => 45,
-            'lname' => 45,
-            'address' => 255,
-            'address2' => 255,
-            'city' => 45,
-            'zip' => 12,
-            'email' => 255,
-            'phone' => 45,
-        );
-    }
-
-    /**
-     * Given a QST_system value, gets the question's largest allowable max input.
-     * @see Registration_Form_Admin_Page::system_question_maxes()
-     * @param string $system_question_value
-     * @return int|float
-     */
-    public function absolute_max_for_system_question($system_question_value)
-    {
-        $maxes = $this->system_question_maxes();
-        if (isset($maxes[ $system_question_value ])) {
-            return $maxes[ $system_question_value ];
-        } else {
-            return EE_INF;
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function question_descriptions()
-    {
-        return $this->_question_descriptions;
-    }
-
-
-    /**
-     * Returns all the question types that should have an admin-defined max input length
-     * @return array
-     */
-    public function questionTypesWithMaxLength()
-    {
-        return (array) $this->question_types_with_max_lengh;
-    }
+	// constant used to indicate that the question type is COUNTRY
+	const QST_type_country = 'COUNTRY';
+
+	// constant used to indicate that the question type is DATE
+	const QST_type_date = 'DATE';
+
+	// constant used to indicate that the question type is DROPDOWN
+	const QST_type_dropdown = 'DROPDOWN';
+
+	// constant used to indicate that the question type is CHECKBOX
+	const QST_type_checkbox = 'CHECKBOX';
+
+	// constant used to indicate that the question type is RADIO_BTN
+	const QST_type_radio = 'RADIO_BTN';
+
+	// constant used to indicate that the question type is STATE
+	const QST_type_state = 'STATE';
+
+	// constant used to indicate that the question type is TEXT
+	const QST_type_text = 'TEXT';
+
+	// constant used to indicate that the question type is TEXTAREA
+	const QST_type_textarea = 'TEXTAREA';
+
+	// constant used to indicate that the question type is a TEXTAREA that allows simple html
+	const QST_type_html_textarea = 'HTML_TEXTAREA';
+
+	// constant used to indicate that the question type is an email input
+	const QST_type_email = 'EMAIL';
+
+	// constant used to indicate that the question type is a US-formatted phone number
+	const QST_type_us_phone = 'US_PHONE';
+
+	// constant used to indicate that the question type is an integer (whole number)
+	const QST_type_int = 'INTEGER';
+
+	// constant used to indicate that the question type is a decimal (float)
+	const QST_type_decimal = 'DECIMAL';
+
+	// constant used to indicate that the question type is a valid URL
+	const QST_type_url = 'URL';
+
+	// constant used to indicate that the question type is a YEAR
+	const QST_type_year = 'YEAR';
+
+	// constant used to indicate that the question type is a multi-select
+	const QST_type_multi_select = 'MULTI_SELECT';
+
+	/**
+	 * Question types that are interchangeable, even after answers have been provided for them.
+	 * Top-level keys are category slugs, next level is an array of question types. If question types
+	 * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
+	 *
+	 * @access protected
+	 * @var array $_question_type_categories {
+	 * @type string $text
+	 * @type string $single -answer-enum
+	 * @type string $multi -answer-enum
+	 *                    }
+	 */
+	protected $_question_type_categories = array();
+
+	/**
+	 * lists all the question types which should be allowed. Ideally, this will be extensible.
+	 *
+	 * @access protected
+	 * @var array $_allowed_question_types
+	 */
+	protected $_allowed_question_types = array();
+
+	/**
+	 * brief descriptions for all the question types
+	 *
+	 * @access protected
+	 * @var EEM_Question $_instance
+	 */
+	protected $_question_descriptions;
+
+
+	/**
+	 * Question types that should have an admin-defined max input length
+	 * @var array
+	 */
+	protected $question_types_with_max_lengh;
+
+
+	// private instance of the Attendee object
+	protected static $_instance = null;
+
+
+	/**
+	 * EEM_Question constructor.
+	 *
+	 * @param null $timezone
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Question', 'event_espresso');
+		$this->plural_item = __('Questions', 'event_espresso');
+		$this->_allowed_question_types = apply_filters(
+			'FHEE__EEM_Question__construct__allowed_question_types',
+			array(
+				EEM_Question::QST_type_text => __('Text', 'event_espresso'),
+				EEM_Question::QST_type_textarea => __('Textarea', 'event_espresso'),
+				EEM_Question::QST_type_checkbox => __('Checkboxes', 'event_espresso'),
+				EEM_Question::QST_type_radio => __('Radio Buttons', 'event_espresso'),
+				EEM_Question::QST_type_dropdown => __('Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_state => __('State/Province Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_country => __('Country Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_date => __('Date Picker', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => __('HTML Textarea', 'event_espresso'),
+				EEM_Question::QST_type_email => __('Email', 'event_espresso'),
+				EEM_Question::QST_type_us_phone => __('USA - Format Phone', 'event_espresso'),
+				EEM_Question::QST_type_decimal => __('Number', 'event_espresso'),
+				EEM_Question::QST_type_int => __('Whole Number', 'event_espresso'),
+				EEM_Question::QST_type_url => __('URL', 'event_espresso'),
+				EEM_Question::QST_type_year => __('Year', 'event_espresso'),
+				EEM_Question::QST_type_multi_select => __('Multi Select', 'event_espresso')
+			)
+		);
+		$this->_question_descriptions = apply_filters(
+			'FHEE__EEM_Question__construct__question_descriptions',
+			array(
+				EEM_Question::QST_type_text => __('A single line text input field', 'event_espresso'),
+				EEM_Question::QST_type_textarea => __('A multi line text input field', 'event_espresso'),
+				EEM_Question::QST_type_checkbox => __('Allows multiple preset options to be selected', 'event_espresso'),
+				EEM_Question::QST_type_radio => __('Allows a single preset option to be selected', 'event_espresso'),
+				EEM_Question::QST_type_dropdown => __('A dropdown that allows a single selection', 'event_espresso'),
+				EEM_Question::QST_type_state => __('A dropdown that lists states/provinces', 'event_espresso'),
+				EEM_Question::QST_type_country => __('A dropdown that lists countries', 'event_espresso'),
+				EEM_Question::QST_type_date => __('A popup calendar that allows date selections', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => __('A multi line text input field that allows HTML', 'event_espresso'),
+				EEM_Question::QST_type_email => __('A text field that must contain a valid Email address', 'event_espresso'),
+				EEM_Question::QST_type_us_phone => __('A text field that must contain a valid US phone number', 'event_espresso'),
+				EEM_Question::QST_type_decimal => __('A text field that allows number values with decimals', 'event_espresso'),
+				EEM_Question::QST_type_int => __('A text field that only allows whole numbers (no decimals)', 'event_espresso'),
+				EEM_Question::QST_type_url => __('A text field that must contain a valid URL', 'event_espresso'),
+				EEM_Question::QST_type_year => __('A dropdown that lists the last 100 years', 'event_espresso'),
+				EEM_Question::QST_type_multi_select => __('A dropdown that allows multiple selections', 'event_espresso')
+			)
+		);
+		$this->_question_type_categories = (array) apply_filters(
+			'FHEE__EEM_Question__construct__question_type_categories',
+			array(
+				'text' => array(
+					EEM_Question::QST_type_text,
+					EEM_Question::QST_type_textarea,
+					EEM_Question::QST_type_date,
+					EEM_Question::QST_type_html_textarea,
+					EEM_Question::QST_type_email,
+					EEM_Question::QST_type_us_phone,
+					EEM_Question::QST_type_decimal,
+					EEM_Question::QST_type_int,
+					EEM_Question::QST_type_url,
+					EEM_Question::QST_type_year
+				),
+				'single-answer-enum' => array(
+					EEM_Question::QST_type_radio,
+					EEM_Question::QST_type_dropdown
+				),
+				'multi-answer-enum' => array(
+					EEM_Question::QST_type_checkbox,
+					EEM_Question::QST_type_multi_select
+				)
+			)
+		);
+		$this->question_types_with_max_lengh = apply_filters(
+			'FHEE__EEM_Question___construct__question_types_with_max_length',
+			array(
+				EEM_Question::QST_type_text,
+				EEM_Question::QST_type_textarea,
+				EEM_Question::QST_type_html_textarea
+			)
+		);
+
+		$this->_tables = array(
+			'Question' => new EE_Primary_Table('esp_question', 'QST_ID')
+		);
+		$this->_fields = array(
+			'Question' => array(
+				'QST_ID' => new EE_Primary_Key_Int_Field('QST_ID', __('Question ID', 'event_espresso')),
+				'QST_display_text' => new EE_Post_Content_Field('QST_display_text', __('Question Text', 'event_espresso'), true, ''),
+				'QST_admin_label' => new EE_Plain_Text_Field('QST_admin_label', __('Question Label (admin-only)', 'event_espresso'), true, ''),
+				'QST_system' => new EE_Plain_Text_Field('QST_system', __('Internal string ID for question', 'event_espresso'), false, ''),
+				'QST_type' => new EE_Enum_Text_Field('QST_type', __('Question Type', 'event_espresso'), false, 'TEXT', $this->_allowed_question_types),
+				'QST_required' => new EE_Boolean_Field('QST_required', __('Required Question?', 'event_espresso'), false, false),
+				'QST_required_text' => new EE_Simple_HTML_Field('QST_required_text', __('Text to Display if Not Provided', 'event_espresso'), true, ''),
+				'QST_order' => new EE_Integer_Field('QST_order', __('Question Order', 'event_espresso'), false, 0),
+				'QST_admin_only' => new EE_Boolean_Field('QST_admin_only', __('Admin-Only Question?', 'event_espresso'), false, false),
+				'QST_max' => new EE_Infinite_Integer_Field('QST_max', __('Max Size', 'event_espresso'), false, EE_INF),
+				'QST_wp_user' => new EE_WP_User_Field('QST_wp_user', __('Question Creator ID', 'event_espresso'), false),
+				'QST_deleted' => new EE_Trashed_Flag_Field('QST_deleted', __('Flag Indicating question was deleted', 'event_espresso'), false, false)
+			)
+		);
+		$this->_model_relations = array(
+			'Question_Group' => new EE_HABTM_Relation('Question_Group_Question'),
+			'Question_Option' => new EE_Has_Many_Relation(),
+			'Answer' => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+			// for QST_order column
+			'Question_Group_Question' => new EE_Has_Many_Relation()
+		);
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form('QST_system');
+		parent::__construct($timezone);
+	}
+
+	/**
+	 * Returns the list of allowed question types, which are normally: 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE'
+	 * but they can be extended
+	 * @return string[]
+	 */
+	public function allowed_question_types()
+	{
+		return $this->_allowed_question_types;
+	}
+
+	/**
+	 * Gets all the question types in the same category
+	 * @param string $question_type one of EEM_Question::allowed_question_types(
+	 * @return string[] like EEM_Question::allowed_question_types()
+	 */
+	public function question_types_in_same_category($question_type)
+	{
+		$question_types = array($question_type);
+		foreach ($this->_question_type_categories as $category => $question_types_in_category) {
+			if (in_array($question_type, $question_types_in_category)) {
+				$question_types = $question_types_in_category;
+				break;
+			}
+		}
+
+		return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
+	}
+
+	/**
+	 * Determines if the given question type is in the given question type category
+	 * @param string $question_type one of EEM_Question::allowed_question_types()
+	 * @param string $category one of the top-level keys of EEM_Question::question_type_categories()
+	 * @return boolean
+	 */
+	public function question_type_is_in_category($question_type, $category)
+	{
+		if (!isset($this->_question_type_categories[ $category ])) {
+			return false;
+		}
+		return in_array($question_type, $this->_question_type_categories[ $category ]);
+	}
+
+
+	/**
+	 * Returns all the question types in the given category
+	 * @param string $category
+	 * @return array|mixed
+	 */
+	public function question_types_in_category($category)
+	{
+		if (isset($this->_question_type_categories[ $category ])) {
+			return $this->_question_type_categories[ $category ];
+		}
+		return array();
+	}
+
+
+	/**
+	 * Returns all the question types that should have question options
+	 * @return array
+	 */
+	public function question_types_with_options()
+	{
+		return array_merge(
+			$this->question_types_in_category('single-answer-enum'),
+			$this->question_types_in_category('multi-answer-enum')
+		);
+	}
+
+	/**
+	 * Returns the question type categories 2d array
+	 * @return array see EEM_Question::_question_type_categories
+	 */
+	public function question_type_categories()
+	{
+		return $this->_question_type_categories;
+	}
+
+	/**
+	 * Returns an array of all the QST_system values that can be allowed in the system question group
+	 * identified by $system_question_group_id
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function allowed_system_questions_in_system_question_group($system_question_group_id)
+	{
+		$question_system_ids = array();
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_lname,
+					EEM_Attendee::system_question_email,
+					EEM_Attendee::system_question_phone
+				);
+				break;
+			case EEM_Question_Group::system_address:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_address,
+					EEM_Attendee::system_question_address2,
+					EEM_Attendee::system_question_city,
+					EEM_Attendee::system_question_state,
+					EEM_Attendee::system_question_country,
+					EEM_Attendee::system_question_zip,
+					EEM_Attendee::system_question_phone
+				);
+				break;
+		}
+		return apply_filters('FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return', $question_system_ids, $system_question_group_id);
+	}
+
+	/**
+	 * Returns an array of all the QST_system values that are required in the system question group
+	 * identified by $system_question_group_id
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function required_system_questions_in_system_question_group($system_question_group_id)
+	{
+		$question_system_ids = null;
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = array(
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_email,
+				);
+				break;
+			default:
+				$question_system_ids = array();
+		}
+		return apply_filters('FHEE__EEM_Question__system_questions_required_in_system_question_group', $question_system_ids, $system_question_group_id);
+	}
+
+
+	/**
+	 * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
+	 * which system question QST_ID corresponds to the QST_system 'city', use EEM_Question::instance()->get_Question_ID_from_system_string('city');
+	 * @param $QST_system
+	 * @return int of QST_ID for the question that corresponds to that QST_system
+	 */
+	public function get_Question_ID_from_system_string($QST_system)
+	{
+		return $this->get_var(array(array('QST_system' => $QST_system)));
+	}
+
+
+	/**
+	 * searches the db for the question with the latest question order and returns that value.
+	 * @access public
+	 * @return int
+	 */
+	public function get_latest_question_order()
+	{
+		$columns_to_select = array(
+			'max_order' => array("MAX(QST_order)", "%d")
+		);
+		$max = $this->_get_all_wpdb_results(array(), ARRAY_A, $columns_to_select);
+		return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
+	}
+
+	/**
+	 * Returns an array where keys are system question QST_system values,
+	 * and values are the highest question max the admin can set on the question
+	 * (aka the "max max"; eg, a site admin can change the zip question to have a max
+	 * of 5, but no larger than 12)
+	 * @return array
+	 */
+	public function system_question_maxes()
+	{
+		return array(
+			'fname' => 45,
+			'lname' => 45,
+			'address' => 255,
+			'address2' => 255,
+			'city' => 45,
+			'zip' => 12,
+			'email' => 255,
+			'phone' => 45,
+		);
+	}
+
+	/**
+	 * Given a QST_system value, gets the question's largest allowable max input.
+	 * @see Registration_Form_Admin_Page::system_question_maxes()
+	 * @param string $system_question_value
+	 * @return int|float
+	 */
+	public function absolute_max_for_system_question($system_question_value)
+	{
+		$maxes = $this->system_question_maxes();
+		if (isset($maxes[ $system_question_value ])) {
+			return $maxes[ $system_question_value ];
+		} else {
+			return EE_INF;
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function question_descriptions()
+	{
+		return $this->_question_descriptions;
+	}
+
+
+	/**
+	 * Returns all the question types that should have an admin-defined max input length
+	 * @return array
+	 */
+	public function questionTypesWithMaxLength()
+	{
+		return (array) $this->question_types_with_max_lengh;
+	}
 }

core/domain/services/assets/CoreAssetManager.php

Indentation +445 added lines, -445 removed lines

@@ -29,466 +29,466 @@
 class CoreAssetManager extends AssetManager
 {
 
-    // WordPress core / Third party JS asset handles
-    const JS_HANDLE_JQUERY = 'jquery';
+	// WordPress core / Third party JS asset handles
+	const JS_HANDLE_JQUERY = 'jquery';
 
-    const JS_HANDLE_JQUERY_VALIDATE = 'jquery-validate';
+	const JS_HANDLE_JQUERY_VALIDATE = 'jquery-validate';
 
-    const JS_HANDLE_JQUERY_VALIDATE_EXTRA = 'jquery-validate-extra-methods';
+	const JS_HANDLE_JQUERY_VALIDATE_EXTRA = 'jquery-validate-extra-methods';
 
-    const JS_HANDLE_UNDERSCORE = 'underscore';
+	const JS_HANDLE_UNDERSCORE = 'underscore';
 
-    const JS_HANDLE_ACCOUNTING_CORE = 'ee-accounting-core';
+	const JS_HANDLE_ACCOUNTING_CORE = 'ee-accounting-core';
 
-    // EE JS assets handles
-    const JS_HANDLE_EE_MANIFEST = 'ee-manifest';
+	// EE JS assets handles
+	const JS_HANDLE_EE_MANIFEST = 'ee-manifest';
 
-    const JS_HANDLE_EE_JS_CORE = 'eejs-core';
+	const JS_HANDLE_EE_JS_CORE = 'eejs-core';
 
-    const JS_HANDLE_EE_VENDOR = 'eventespresso-vendor';
+	const JS_HANDLE_EE_VENDOR = 'eventespresso-vendor';
 
-    const JS_HANDLE_EE_DATA_STORES = 'eventespresso-data-stores';
+	const JS_HANDLE_EE_DATA_STORES = 'eventespresso-data-stores';
 
-    const JS_HANDLE_EE_HELPERS = 'eventespresso-helpers';
+	const JS_HANDLE_EE_HELPERS = 'eventespresso-helpers';
 
-    const JS_HANDLE_EE_MODEL = 'eventespresso-model';
+	const JS_HANDLE_EE_MODEL = 'eventespresso-model';
 
-    const JS_HANDLE_EE_VALUE_OBJECTS = 'eventespresso-value-objects';
+	const JS_HANDLE_EE_VALUE_OBJECTS = 'eventespresso-value-objects';
 
-    const JS_HANDLE_EE_HOC_COMPONENTS = 'eventespresso-hoc-components';
+	const JS_HANDLE_EE_HOC_COMPONENTS = 'eventespresso-hoc-components';
 
-    const JS_HANDLE_EE_COMPONENTS = 'eventespresso-components';
+	const JS_HANDLE_EE_COMPONENTS = 'eventespresso-components';
 
-    const JS_HANDLE_EE_JS_API = 'eejs-api';
+	const JS_HANDLE_EE_JS_API = 'eejs-api';
 
-    const JS_HANDLE_EE_CORE = 'espresso_core';
+	const JS_HANDLE_EE_CORE = 'espresso_core';
 
-    const JS_HANDLE_EE_I18N = 'eei18n';
-
-    const JS_HANDLE_EE_ACCOUNTING = 'ee-accounting';
-
-    const JS_HANDLE_EE_WP_PLUGINS_PAGE = 'ee-wp-plugins-page';
-
-    // EE CSS assets handles
-    const CSS_HANDLE_EE_DEFAULT = 'espresso_default';
-
-    const CSS_HANDLE_EE_CUSTOM = 'espresso_custom_css';
-
-    const CSS_HANDLE_EE_COMPONENTS = 'eventespresso-components';
-
-    /**
-     * @var EE_Currency_Config $currency_config
-     */
-    protected $currency_config;
-
-    /**
-     * @var EE_Template_Config $template_config
-     */
-    protected $template_config;
-
-
-    /**
-     * CoreAssetRegister constructor.
-     *
-     * @param AssetCollection    $assets
-     * @param EE_Currency_Config $currency_config
-     * @param EE_Template_Config $template_config
-     * @param DomainInterface    $domain
-     * @param Registry           $registry
-     */
-    public function __construct(
-        AssetCollection $assets,
-        EE_Currency_Config $currency_config,
-        EE_Template_Config $template_config,
-        DomainInterface $domain,
-        Registry $registry
-    ) {
-        $this->currency_config = $currency_config;
-        $this->template_config = $template_config;
-        parent::__construct($domain, $assets, $registry);
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    public function addAssets()
-    {
-        $this->addJavascriptFiles();
-        $this->addStylesheetFiles();
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    public function addJavascriptFiles()
-    {
-        $this->loadCoreJs();
-        $this->loadJqueryValidate();
-        $this->loadAccountingJs();
-        add_action(
-            'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
-            array($this, 'loadQtipJs')
-        );
-        $this->registerAdminAssets();
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    public function addStylesheetFiles()
-    {
-        $this->loadCoreCss();
-    }
-
-
-    /**
-     * core default javascript
-     *
-     * @since 4.9.62.p
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function loadCoreJs()
-    {
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_MANIFEST,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'manifest')
-        );
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_JS_CORE,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'eejs'),
-            array(CoreAssetManager::JS_HANDLE_EE_MANIFEST)
-        )
-        ->setHasInlineData();
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_VENDOR,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'vendor'),
-            array(CoreAssetManager::JS_HANDLE_EE_JS_CORE)
-        );
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_DATA_STORES,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'data-stores'),
-            array(CoreAssetManager::JS_HANDLE_EE_VENDOR, 'wp-data', 'wp-api-request')
-        )
-        ->setRequiresTranslation();
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_HELPERS,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'helpers')
-        )->setRequiresTranslation();
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_MODEL,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'model'),
-            array(
-                CoreAssetManager::JS_HANDLE_EE_HELPERS
-            )
-        )->setRequiresTranslation();
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_VALUE_OBJECTS,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'valueObjects'),
-            array(
-                CoreAssetManager::JS_HANDLE_EE_MODEL
-            )
-        )->setRequiresTranslation();
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_HOC_COMPONENTS,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'hocComponents'),
-            array(
-                CoreAssetManager::JS_HANDLE_EE_DATA_STORES,
-                CoreAssetManager::JS_HANDLE_EE_VALUE_OBJECTS,
-                'wp-components',
-            )
-        )->setRequiresTranslation();
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_COMPONENTS,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'components'),
-            array(
-                CoreAssetManager::JS_HANDLE_EE_DATA_STORES,
-                CoreAssetManager::JS_HANDLE_EE_VALUE_OBJECTS,
-                'wp-components',
-            )
-        )
-        ->setRequiresTranslation();
-
-        global $wp_version;
-        if (version_compare($wp_version, '4.4.0', '>')) {
-            //js.api
-            $this->addJavascript(
-                CoreAssetManager::JS_HANDLE_EE_JS_API,
-                EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
-                array(
-                    CoreAssetManager::JS_HANDLE_UNDERSCORE,
-                    CoreAssetManager::JS_HANDLE_EE_JS_CORE
-                )
-            );
-            $this->registry->addData('eejs_api_nonce', wp_create_nonce('wp_rest'));
-            $this->registry->addData(
-                'paths',
-                array(
-                    'rest_route' => rest_url('ee/v4.8.36/'),
-                    'collection_endpoints' => EED_Core_Rest_Api::getCollectionRoutesIndexedByModelName(),
-                    'primary_keys' => EED_Core_Rest_Api::getPrimaryKeyNamesIndexedByModelName(),
+	const JS_HANDLE_EE_I18N = 'eei18n';
+
+	const JS_HANDLE_EE_ACCOUNTING = 'ee-accounting';
+
+	const JS_HANDLE_EE_WP_PLUGINS_PAGE = 'ee-wp-plugins-page';
+
+	// EE CSS assets handles
+	const CSS_HANDLE_EE_DEFAULT = 'espresso_default';
+
+	const CSS_HANDLE_EE_CUSTOM = 'espresso_custom_css';
+
+	const CSS_HANDLE_EE_COMPONENTS = 'eventespresso-components';
+
+	/**
+	 * @var EE_Currency_Config $currency_config
+	 */
+	protected $currency_config;
+
+	/**
+	 * @var EE_Template_Config $template_config
+	 */
+	protected $template_config;
+
+
+	/**
+	 * CoreAssetRegister constructor.
+	 *
+	 * @param AssetCollection    $assets
+	 * @param EE_Currency_Config $currency_config
+	 * @param EE_Template_Config $template_config
+	 * @param DomainInterface    $domain
+	 * @param Registry           $registry
+	 */
+	public function __construct(
+		AssetCollection $assets,
+		EE_Currency_Config $currency_config,
+		EE_Template_Config $template_config,
+		DomainInterface $domain,
+		Registry $registry
+	) {
+		$this->currency_config = $currency_config;
+		$this->template_config = $template_config;
+		parent::__construct($domain, $assets, $registry);
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	public function addAssets()
+	{
+		$this->addJavascriptFiles();
+		$this->addStylesheetFiles();
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	public function addJavascriptFiles()
+	{
+		$this->loadCoreJs();
+		$this->loadJqueryValidate();
+		$this->loadAccountingJs();
+		add_action(
+			'AHEE__EventEspresso_core_services_assets_Registry__registerScripts__before_script',
+			array($this, 'loadQtipJs')
+		);
+		$this->registerAdminAssets();
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	public function addStylesheetFiles()
+	{
+		$this->loadCoreCss();
+	}
+
+
+	/**
+	 * core default javascript
+	 *
+	 * @since 4.9.62.p
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function loadCoreJs()
+	{
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_MANIFEST,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'manifest')
+		);
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_JS_CORE,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'eejs'),
+			array(CoreAssetManager::JS_HANDLE_EE_MANIFEST)
+		)
+		->setHasInlineData();
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_VENDOR,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'vendor'),
+			array(CoreAssetManager::JS_HANDLE_EE_JS_CORE)
+		);
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_DATA_STORES,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'data-stores'),
+			array(CoreAssetManager::JS_HANDLE_EE_VENDOR, 'wp-data', 'wp-api-request')
+		)
+		->setRequiresTranslation();
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_HELPERS,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'helpers')
+		)->setRequiresTranslation();
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_MODEL,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'model'),
+			array(
+				CoreAssetManager::JS_HANDLE_EE_HELPERS
+			)
+		)->setRequiresTranslation();
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_VALUE_OBJECTS,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'valueObjects'),
+			array(
+				CoreAssetManager::JS_HANDLE_EE_MODEL
+			)
+		)->setRequiresTranslation();
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_HOC_COMPONENTS,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'hocComponents'),
+			array(
+				CoreAssetManager::JS_HANDLE_EE_DATA_STORES,
+				CoreAssetManager::JS_HANDLE_EE_VALUE_OBJECTS,
+				'wp-components',
+			)
+		)->setRequiresTranslation();
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_COMPONENTS,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'components'),
+			array(
+				CoreAssetManager::JS_HANDLE_EE_DATA_STORES,
+				CoreAssetManager::JS_HANDLE_EE_VALUE_OBJECTS,
+				'wp-components',
+			)
+		)
+		->setRequiresTranslation();
+
+		global $wp_version;
+		if (version_compare($wp_version, '4.4.0', '>')) {
+			//js.api
+			$this->addJavascript(
+				CoreAssetManager::JS_HANDLE_EE_JS_API,
+				EE_LIBRARIES_URL . 'rest_api/assets/js/eejs-api.min.js',
+				array(
+					CoreAssetManager::JS_HANDLE_UNDERSCORE,
+					CoreAssetManager::JS_HANDLE_EE_JS_CORE
+				)
+			);
+			$this->registry->addData('eejs_api_nonce', wp_create_nonce('wp_rest'));
+			$this->registry->addData(
+				'paths',
+				array(
+					'rest_route' => rest_url('ee/v4.8.36/'),
+					'collection_endpoints' => EED_Core_Rest_Api::getCollectionRoutesIndexedByModelName(),
+					'primary_keys' => EED_Core_Rest_Api::getPrimaryKeyNamesIndexedByModelName(),
 					'site_url' => site_url('/'),
-                    'admin_url' => admin_url('/'),
-                )
-            );
-            /** site formatting values **/
-            $this->registry->addData(
-                'site_formats',
-                array(
-                    'date_formats' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats()
-                )
-            );
-            /** currency data **/
-            $this->registry->addData(
-                'currency_config',
-                $this->getCurrencySettings()
-            );
-            /** site timezone */
-            $this->registry->addData(
-                'default_timezone',
-                array(
-                    'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
-                    'string' => get_option('timezone_string'),
-                    'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
-                )
-            );
-            /** site locale (user locale if user logged in) */
-            $this->registry->addData(
-                'locale',
-                array(
-                    'user' => get_user_locale(),
-                    'site' => get_locale()
-                )
-            );
-        }
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_CORE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            array(CoreAssetManager::JS_HANDLE_JQUERY)
-        )
-        ->setInlineDataCallback(
-            function () {
-                wp_localize_script(
-                    CoreAssetManager::JS_HANDLE_EE_CORE,
-                    CoreAssetManager::JS_HANDLE_EE_I18N,
-                    EE_Registry::$i18n_js_strings
-                );
-            }
-        );
-    }
-
-
-    /**
-     * Returns configuration data for the accounting-js library.
-     * @since $VID:$
-     * @return array
-     */
-    private function getAccountingSettings() {
-        return array(
-            'currency' => array(
-                'symbol'    => $this->currency_config->sign,
-                'format'    => array(
-                    'pos'  => $this->currency_config->sign_b4 ? '%s%v' : '%v%s',
-                    'neg'  => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s',
-                    'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s',
-                ),
-                'decimal'   => $this->currency_config->dec_mrk,
-                'thousand'  => $this->currency_config->thsnds,
-                'precision' => $this->currency_config->dec_plc,
-            ),
-            'number'   => array(
-                'precision' => $this->currency_config->dec_plc,
-                'thousand'  => $this->currency_config->thsnds,
-                'decimal'   => $this->currency_config->dec_mrk,
-            ),
-        );
-    }
-
-
-    /**
-     * Returns configuration data for the js Currency VO.
-     * @sinc $VID:$
-     * @return array
-     */
-    private function getCurrencySettings()
-    {
-        return array(
-            'code' => $this->currency_config->code,
-            'singularLabel' => $this->currency_config->name,
-            'pluralLabel' => $this->currency_config->plural,
-            'sign' => $this->currency_config->sign,
-            'signB4' => $this->currency_config->sign_b4,
-            'decimalPlaces' => $this->currency_config->dec_plc,
-            'decimalMark' => $this->currency_config->dec_mrk,
-            'thousandsSeparator' => $this->currency_config->thsnds,
-        );
-    }
-
-
-    /**
-     * @since 4.9.62.p
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function loadCoreCss()
-    {
-        if ($this->template_config->enable_default_style && ! is_admin()) {
-            $this->addStylesheet(
-                CoreAssetManager::CSS_HANDLE_EE_DEFAULT,
-                is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
-                    ? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
-                    : EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-                array('dashicons')
-            );
-            //Load custom style sheet if available
-            if ($this->template_config->custom_style_sheet !== null) {
-                $this->addStylesheet(
-                    CoreAssetManager::CSS_HANDLE_EE_CUSTOM,
-                    EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
-                    array(CoreAssetManager::CSS_HANDLE_EE_DEFAULT)
-                );
-            }
-        }
-        $this->addStylesheet(
-            CoreAssetManager::CSS_HANDLE_EE_COMPONENTS,
-            $this->registry->getCssUrl(
-                $this->domain->assetNamespace(),
-                'components'
-            )
-        );
-    }
-
-
-    /**
-     * jQuery Validate for form validation
-     *
-     * @since 4.9.62.p
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function loadJqueryValidate()
-    {
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE,
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
-            array(CoreAssetManager::JS_HANDLE_JQUERY)
-        )
-        ->setVersion('1.15.0');
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE_EXTRA,
-            EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
-            array(CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE)
-        )
-        ->setVersion('1.15.0');
-    }
-
-
-    /**
-     * accounting.js for performing client-side calculations
-     *
-     * @since 4.9.62.p
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function loadAccountingJs()
-    {
-        //accounting.js library
-        // @link http://josscrowcroft.github.io/accounting.js/
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE,
-            EE_THIRD_PARTY_URL . 'accounting/accounting.js',
-            array(CoreAssetManager::JS_HANDLE_UNDERSCORE)
-        )
-        ->setVersion('0.3.2');
-
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_ACCOUNTING,
-            EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
-            array(CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE)
-        )
-        ->setInlineDataCallback(
-            function () {
-                 wp_localize_script(
-                     CoreAssetManager::JS_HANDLE_EE_ACCOUNTING,
-                     'EE_ACCOUNTING_CFG',
-                     $this->getAccountingSettings()
-                 );
-            }
-        )
-        ->setVersion();
-    }
-
-
-    /**
-     * registers assets for cleaning your ears
-     *
-     * @param JavascriptAsset $script
-     */
-    public function loadQtipJs(JavascriptAsset $script)
-    {
-        // qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
-        // can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
-        if (
-            $script->handle() === CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE
-            && apply_filters('FHEE_load_qtip', false)
-        ) {
-            EEH_Qtip_Loader::instance()->register_and_enqueue();
-        }
-    }
-
-
-    /**
-     * assets that are used in the WordPress admin
-     *
-     * @since 4.9.62.p
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     */
-    private function registerAdminAssets()
-    {
-        $this->addJavascript(
-            CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE,
-            $this->registry->getJsUrl($this->domain->assetNamespace(), 'wp-plugins-page'),
-            array(
-                CoreAssetManager::JS_HANDLE_JQUERY,
-                CoreAssetManager::JS_HANDLE_EE_VENDOR,
-            )
-        )
-        ->setRequiresTranslation();
-
-        $this->addStylesheet(
-            CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE,
-            $this->registry->getCssUrl($this->domain->assetNamespace(), 'wp-plugins-page')
-        );
-    }
+					'admin_url' => admin_url('/'),
+				)
+			);
+			/** site formatting values **/
+			$this->registry->addData(
+				'site_formats',
+				array(
+					'date_formats' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats()
+				)
+			);
+			/** currency data **/
+			$this->registry->addData(
+				'currency_config',
+				$this->getCurrencySettings()
+			);
+			/** site timezone */
+			$this->registry->addData(
+				'default_timezone',
+				array(
+					'pretty' => EEH_DTT_Helper::get_timezone_string_for_display(),
+					'string' => get_option('timezone_string'),
+					'offset' => EEH_DTT_Helper::get_site_timezone_gmt_offset(),
+				)
+			);
+			/** site locale (user locale if user logged in) */
+			$this->registry->addData(
+				'locale',
+				array(
+					'user' => get_user_locale(),
+					'site' => get_locale()
+				)
+			);
+		}
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_CORE,
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			array(CoreAssetManager::JS_HANDLE_JQUERY)
+		)
+		->setInlineDataCallback(
+			function () {
+				wp_localize_script(
+					CoreAssetManager::JS_HANDLE_EE_CORE,
+					CoreAssetManager::JS_HANDLE_EE_I18N,
+					EE_Registry::$i18n_js_strings
+				);
+			}
+		);
+	}
+
+
+	/**
+	 * Returns configuration data for the accounting-js library.
+	 * @since $VID:$
+	 * @return array
+	 */
+	private function getAccountingSettings() {
+		return array(
+			'currency' => array(
+				'symbol'    => $this->currency_config->sign,
+				'format'    => array(
+					'pos'  => $this->currency_config->sign_b4 ? '%s%v' : '%v%s',
+					'neg'  => $this->currency_config->sign_b4 ? '- %s%v' : '- %v%s',
+					'zero' => $this->currency_config->sign_b4 ? '%s--' : '--%s',
+				),
+				'decimal'   => $this->currency_config->dec_mrk,
+				'thousand'  => $this->currency_config->thsnds,
+				'precision' => $this->currency_config->dec_plc,
+			),
+			'number'   => array(
+				'precision' => $this->currency_config->dec_plc,
+				'thousand'  => $this->currency_config->thsnds,
+				'decimal'   => $this->currency_config->dec_mrk,
+			),
+		);
+	}
+
+
+	/**
+	 * Returns configuration data for the js Currency VO.
+	 * @sinc $VID:$
+	 * @return array
+	 */
+	private function getCurrencySettings()
+	{
+		return array(
+			'code' => $this->currency_config->code,
+			'singularLabel' => $this->currency_config->name,
+			'pluralLabel' => $this->currency_config->plural,
+			'sign' => $this->currency_config->sign,
+			'signB4' => $this->currency_config->sign_b4,
+			'decimalPlaces' => $this->currency_config->dec_plc,
+			'decimalMark' => $this->currency_config->dec_mrk,
+			'thousandsSeparator' => $this->currency_config->thsnds,
+		);
+	}
+
+
+	/**
+	 * @since 4.9.62.p
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function loadCoreCss()
+	{
+		if ($this->template_config->enable_default_style && ! is_admin()) {
+			$this->addStylesheet(
+				CoreAssetManager::CSS_HANDLE_EE_DEFAULT,
+				is_readable(EVENT_ESPRESSO_UPLOAD_DIR . 'css/style.css')
+					? EVENT_ESPRESSO_UPLOAD_DIR . 'css/espresso_default.css'
+					: EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+				array('dashicons')
+			);
+			//Load custom style sheet if available
+			if ($this->template_config->custom_style_sheet !== null) {
+				$this->addStylesheet(
+					CoreAssetManager::CSS_HANDLE_EE_CUSTOM,
+					EVENT_ESPRESSO_UPLOAD_URL . 'css/' . $this->template_config->custom_style_sheet,
+					array(CoreAssetManager::CSS_HANDLE_EE_DEFAULT)
+				);
+			}
+		}
+		$this->addStylesheet(
+			CoreAssetManager::CSS_HANDLE_EE_COMPONENTS,
+			$this->registry->getCssUrl(
+				$this->domain->assetNamespace(),
+				'components'
+			)
+		);
+	}
+
+
+	/**
+	 * jQuery Validate for form validation
+	 *
+	 * @since 4.9.62.p
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function loadJqueryValidate()
+	{
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE,
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.min.js',
+			array(CoreAssetManager::JS_HANDLE_JQUERY)
+		)
+		->setVersion('1.15.0');
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE_EXTRA,
+			EE_GLOBAL_ASSETS_URL . 'scripts/jquery.validate.additional-methods.min.js',
+			array(CoreAssetManager::JS_HANDLE_JQUERY_VALIDATE)
+		)
+		->setVersion('1.15.0');
+	}
+
+
+	/**
+	 * accounting.js for performing client-side calculations
+	 *
+	 * @since 4.9.62.p
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function loadAccountingJs()
+	{
+		//accounting.js library
+		// @link http://josscrowcroft.github.io/accounting.js/
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE,
+			EE_THIRD_PARTY_URL . 'accounting/accounting.js',
+			array(CoreAssetManager::JS_HANDLE_UNDERSCORE)
+		)
+		->setVersion('0.3.2');
+
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_ACCOUNTING,
+			EE_GLOBAL_ASSETS_URL . 'scripts/ee-accounting-config.js',
+			array(CoreAssetManager::JS_HANDLE_ACCOUNTING_CORE)
+		)
+		->setInlineDataCallback(
+			function () {
+				 wp_localize_script(
+					 CoreAssetManager::JS_HANDLE_EE_ACCOUNTING,
+					 'EE_ACCOUNTING_CFG',
+					 $this->getAccountingSettings()
+				 );
+			}
+		)
+		->setVersion();
+	}
+
+
+	/**
+	 * registers assets for cleaning your ears
+	 *
+	 * @param JavascriptAsset $script
+	 */
+	public function loadQtipJs(JavascriptAsset $script)
+	{
+		// qtip is turned OFF by default, but prior to the wp_enqueue_scripts hook,
+		// can be turned back on again via: add_filter('FHEE_load_qtip', '__return_true' );
+		if (
+			$script->handle() === CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE
+			&& apply_filters('FHEE_load_qtip', false)
+		) {
+			EEH_Qtip_Loader::instance()->register_and_enqueue();
+		}
+	}
+
+
+	/**
+	 * assets that are used in the WordPress admin
+	 *
+	 * @since 4.9.62.p
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 */
+	private function registerAdminAssets()
+	{
+		$this->addJavascript(
+			CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE,
+			$this->registry->getJsUrl($this->domain->assetNamespace(), 'wp-plugins-page'),
+			array(
+				CoreAssetManager::JS_HANDLE_JQUERY,
+				CoreAssetManager::JS_HANDLE_EE_VENDOR,
+			)
+		)
+		->setRequiresTranslation();
+
+		$this->addStylesheet(
+			CoreAssetManager::JS_HANDLE_EE_WP_PLUGINS_PAGE,
+			$this->registry->getCssUrl($this->domain->assetNamespace(), 'wp-plugins-page')
+		);
+	}
 }

caffeinated/payment_methods/Aim/help_tabs/payment_methods_overview_aim.help_tab.php

Spacing +2 added lines, -2 removed lines

@@ -75,7 +75,7 @@
         <?php _e('Change the image that is used for this payment gateway.', 'event_espresso'); ?>
     </li>
     <li>
-        <strong><?php esc_html_e('Note About Special Characters', 'event_espresso');?></strong>
-        <?php esc_html_e('If your event name, ticket name or ticket description contain special characters (eg emojis, foreign language characters, or curly quotes) they will be removed when sent to Authorize.net. This is because Authorize.net doesn\'t support them.', 'event_espresso');?></li>
+        <strong><?php esc_html_e('Note About Special Characters', 'event_espresso'); ?></strong>
+        <?php esc_html_e('If your event name, ticket name or ticket description contain special characters (eg emojis, foreign language characters, or curly quotes) they will be removed when sent to Authorize.net. This is because Authorize.net doesn\'t support them.', 'event_espresso'); ?></li>
     </li>
 </ul>
\ No newline at end of file

core/data_migration_scripts/EE_DMS_Core_4_8_0.dms.php

Indentation +357 added lines, -357 removed lines

@@ -17,9 +17,9 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_8_0_stages/*');
 $class_to_filepath = array();
 foreach ($stages as $filepath) {
-    $matches = array();
-    preg_match('~4_8_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+	$matches = array();
+	preg_match('~4_8_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+	$class_to_filepath[ $matches[1] ] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_8_0__autoloaded_stages', $class_to_filepath);
@@ -38,71 +38,71 @@ 
 class EE_DMS_Core_4_8_0 extends EE_Data_Migration_Script_Base
 {
 
-    /**
-     * return EE_DMS_Core_4_8_0
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name = esc_html__("Data Update to Event Espresso 4.8.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-            new EE_DMS_4_8_0_pretax_totals(),
-            new EE_DMS_4_8_0_event_subtotals(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
+	/**
+	 * return EE_DMS_Core_4_8_0
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name = esc_html__("Data Update to Event Espresso 4.8.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+			new EE_DMS_4_8_0_pretax_totals(),
+			new EE_DMS_4_8_0_event_subtotals(),
+		);
+		parent::__construct($table_manager, $table_analysis);
+	}
 
 
 
-    /**
-     * Because this is being done at basically the same time as the MER-ready branch
-     * of core, it's possible people might have installed MEr-ready branch first,
-     * and then this one, in which case we still want to perform this migration,
-     * even though the version might not have increased
-     *
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.8.0', '<=') && version_compare($version_string, '4.7.0', '>=')) {
+	/**
+	 * Because this is being done at basically the same time as the MER-ready branch
+	 * of core, it's possible people might have installed MEr-ready branch first,
+	 * and then this one, in which case we still want to perform this migration,
+	 * even though the version might not have increased
+	 *
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.8.0', '<=') && version_compare($version_string, '4.7.0', '>=')) {
 //          echo "$version_string can be migrated from";
-            return true;
-        } elseif (! $version_string) {
+			return true;
+		} elseif (! $version_string) {
 //          echo "no version string provided: $version_string";
-            // no version string provided... this must be pre 4.3
-            return false;// changed mind. dont want people thinking they should migrate yet because they cant
-        } else {
+			// no version string provided... this must be pre 4.3
+			return false;// changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
 //          echo "$version_string doesnt apply";
-            return false;
-        }
-    }
+			return false;
+		}
+	}
 
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_before_migration()
-    {
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $now_in_mysql = current_time('mysql', true);
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $table_name = 'esp_answer';
-        $sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_before_migration()
+	{
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$now_in_mysql = current_time('mysql', true);
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$table_name = 'esp_answer';
+		$sql = " ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					ANS_value text NOT NULL,
 					PRIMARY KEY  (ANS_ID),
 					KEY REG_ID (REG_ID),
 					KEY QST_ID (QST_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $sql = "ATTM_ID int(10) unsigned NOT	NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$sql = "ATTM_ID int(10) unsigned NOT	NULL AUTO_INCREMENT,
 						ATT_ID bigint(20) unsigned NOT NULL,
 						ATT_fname varchar(45) NOT NULL,
 						ATT_lname varchar(45) NOT	NULL,
@@ -117,9 +117,9 @@ 
 							PRIMARY KEY  (ATTM_ID),
 								KEY ATT_ID (ATT_ID),
 								KEY ATT_email (ATT_email(191))";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO varchar(2) collate utf8_bin NOT NULL,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_country';
+		$sql = "CNT_ISO varchar(2) collate utf8_bin NOT NULL,
 					  CNT_ISO3 varchar(3) collate utf8_bin NOT NULL,
 					  RGN_ID tinyint(3) unsigned DEFAULT NULL,
 					  CNT_name varchar(45) collate utf8_bin NOT NULL,
@@ -135,25 +135,25 @@ 
 					  CNT_is_EU tinyint(1) DEFAULT '0',
 					  CNT_active tinyint(1) DEFAULT '0',
 					  PRIMARY KEY  (CNT_ISO)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency';
-        $sql = "CUR_code varchar(6) collate utf8_bin NOT NULL,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency';
+		$sql = "CUR_code varchar(6) collate utf8_bin NOT NULL,
 				CUR_single varchar(45) collate utf8_bin DEFAULT 'dollar',
 				CUR_plural varchar(45) collate utf8_bin DEFAULT 'dollars',
 				CUR_sign varchar(45) collate utf8_bin DEFAULT '$',
 				CUR_dec_plc varchar(1) collate utf8_bin NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency_payment_method';
-        $sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency_payment_method';
+		$sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) collate utf8_bin NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID),
 				KEY PMD_ID (PMD_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				  EVT_ID bigint(20) unsigned NOT NULL,
 				  DTT_name varchar(255) NOT NULL DEFAULT '',
 				  DTT_description text NOT NULL,
@@ -169,9 +169,9 @@ 
 						KEY DTT_EVT_start (DTT_EVT_start),
 						KEY EVT_ID (EVT_ID),
 						KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "
 			EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 			EVT_ID bigint(20) unsigned NOT NULL,
 			EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -187,34 +187,34 @@ 
 			EVT_donations tinyint(1) NULL,
 			PRIMARY KEY  (EVTM_ID),
 			KEY EVT_ID (EVT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					EVT_ID bigint(20) unsigned NOT NULL,
 					QSG_ID int(10) unsigned NOT NULL,
 					EQG_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EQG_ID),
 					KEY EVT_ID (EVT_ID),
 					KEY QSG_ID (QSG_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				VNU_ID bigint(20) unsigned NOT NULL,
 				EVV_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID int(11) DEFAULT NULL,
 				EXM_type varchar(45) DEFAULT NULL,
 				EXM_key varchar(45) DEFAULT NULL,
 				EXM_value text,
 				PRIMARY KEY  (EXM_ID),
 				KEY EXM_type (EXM_type,OBJ_ID,EXM_key)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_join';
-        $sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_join';
+		$sql = "EXJ_ID int(11) NOT NULL AUTO_INCREMENT,
 				EXJ_first_model_id varchar(6) NOT NULL,
 				EXJ_first_model_name varchar(20) NOT NULL,
 				EXJ_second_model_id varchar(6) NOT NULL,
@@ -222,9 +222,9 @@ 
 				PRIMARY KEY  (EXJ_ID),
 				KEY first_model (EXJ_first_model_name,EXJ_first_model_id),
 				KEY second_model (EXJ_second_model_name,EXJ_second_model_id)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(11) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -243,9 +243,9 @@ 
 				PRIMARY KEY  (LIN_ID),
 				KEY LIN_code (LIN_code(191)),
 				KEY TXN_ID (TXN_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_log';
-        $sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_log';
+		$sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
 				LOG_time datetime DEFAULT NULL,
 				OBJ_ID varchar(45) DEFAULT NULL,
 				OBJ_type varchar(45) DEFAULT NULL,
@@ -256,18 +256,18 @@ 
 				KEY LOG_time (LOG_time),
 				KEY OBJ (OBJ_type,OBJ_ID),
 				KEY LOG_type (LOG_type)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					GRP_ID int(10) unsigned NOT NULL,
 					MTP_context varchar(50) NOT NULL,
 					MTP_template_field varchar(30) NOT NULL,
 					MTP_content text NOT NULL,
 					PRIMARY KEY  (MTP_ID),
 					KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template_group';
+		$sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					MTP_user_id int(10) NOT NULL DEFAULT '1',
 					MTP_name varchar(245) NOT NULL DEFAULT '',
 					MTP_description varchar(245) NOT NULL DEFAULT '',
@@ -279,17 +279,17 @@ 
 					MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 					PRIMARY KEY  (GRP_ID),
 					KEY MTP_user_id (MTP_user_id)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_message_template';
-        $sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_message_template';
+		$sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 					EVT_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 					GRP_ID int(10) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EMT_ID),
 					KEY EVT_ID (EVT_ID),
 					KEY GRP_ID (GRP_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					TXN_ID int(10) unsigned DEFAULT NULL,
 					STS_ID varchar(3) collate utf8_bin DEFAULT NULL,
 					PAY_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -306,9 +306,9 @@ 
 					PRIMARY KEY  (PAY_ID),
 					KEY PAY_timestamp (PAY_timestamp),
 					KEY TXN_ID (TXN_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_payment_method';
-        $sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_payment_method';
+		$sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -324,32 +324,32 @@ 
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug),
 				KEY PMD_type (PMD_type)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket_price";
+		$sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TKT_ID int(10) unsigned NOT NULL,
 					  PRC_ID int(10) unsigned NOT NULL,
 					  PRIMARY KEY  (TKP_ID),
 					  KEY TKT_ID (TKT_ID),
 					  KEY PRC_ID (PRC_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  DTT_ID int(10) unsigned NOT NULL,
 					  TKT_ID int(10) unsigned NOT NULL,
 					  PRIMARY KEY  (DTK_ID),
 					  KEY DTT_ID (DTT_ID),
 					  KEY TKT_ID (TKT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TTM_name varchar(45) NOT NULL,
 					  TTM_description text,
 					  TTM_file varchar(45),
 					  PRIMARY KEY  (TTM_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QST_display_text text NOT NULL,
 					QST_admin_label varchar(255) NOT NULL,
 					QST_system varchar(25) NOT NULL DEFAULT "",
@@ -363,18 +363,18 @@ 
 					QST_deleted tinyint(2) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QST_ID),
 					KEY QST_order (QST_order)';
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QSG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					QGQ_order int(10) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QGQ_ID),
 					KEY QST_ID (QST_ID),
 					KEY QSG_ID_order (QSG_ID,QGQ_order)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QSO_value varchar(255) NOT NULL,
 					QSO_desc text NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
@@ -384,9 +384,9 @@ 
 					PRIMARY KEY  (QSO_ID),
 					KEY QST_ID (QST_ID),
 					KEY QSO_order (QSO_order)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  EVT_ID bigint(20) unsigned NOT NULL,
 					  ATT_ID bigint(20) unsigned NOT NULL,
 					  TXN_ID int(10) unsigned NOT NULL,
@@ -410,18 +410,18 @@ 
 					  KEY TKT_ID (TKT_ID),
 					  KEY EVT_ID (EVT_ID),
 					  KEY STS_ID (STS_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_registration_payment';
-        $sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_registration_payment';
+		$sql = "RPY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  REG_ID int(10) unsigned NOT NULL,
 					  PAY_ID int(10) unsigned NULL,
 					  RPY_amount decimal(10,3) NOT NULL DEFAULT '0.00',
 					  PRIMARY KEY  (RPY_ID),
 					  KEY REG_ID (REG_ID),
 					  KEY PAY_ID (PAY_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					DTT_ID int(10) unsigned NOT NULL,
 					CHK_in tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -429,9 +429,9 @@ 
 					PRIMARY KEY  (CHK_ID),
 					KEY REG_ID (REG_ID),
 					KEY DTT_ID (DTT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_state';
+		$sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
 					  CNT_ISO varchar(2) collate utf8_bin NOT NULL,
 					  STA_abbrev varchar(24) collate utf8_bin NOT NULL,
 					  STA_name varchar(100) collate utf8_bin NOT NULL,
@@ -439,9 +439,9 @@ 
 					  PRIMARY KEY  (STA_ID),
 					  KEY STA_abbrev (STA_abbrev),
 					  KEY CNT_ISO (CNT_ISO)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID varchar(3) NOT NULL,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "STS_ID varchar(3) NOT NULL,
 					  STS_code varchar(45) NOT NULL,
 					  STS_type varchar(45) NOT NULL,
 					  STS_can_edit tinyint(1) NOT NULL DEFAULT 0,
@@ -449,9 +449,9 @@ 
 					  STS_open tinyint(1) NOT NULL DEFAULT 1,
 					  UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 					  KEY STS_type (STS_type)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TXN_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
 					  TXN_total decimal(10,3) DEFAULT '0.00',
 					  TXN_paid decimal(10,3) NOT NULL DEFAULT '0.00',
@@ -463,9 +463,9 @@ 
 					  PRIMARY KEY  (TXN_ID),
 					  KEY TXN_timestamp (TXN_timestamp),
 					  KEY STS_ID (STS_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 			VNU_address varchar(255) DEFAULT NULL,
 			VNU_address2 varchar(255) DEFAULT NULL,
@@ -484,10 +484,10 @@ 
 			KEY VNU_ID (VNU_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        // modified tables
-        $table_name = "esp_price";
-        $sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		// modified tables
+		$table_name = "esp_price";
+		$sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  PRT_ID tinyint(3) unsigned NOT NULL,
 					  PRC_amount decimal(10,3) NOT NULL DEFAULT '0.00',
 					  PRC_name varchar(245) NOT NULL,
@@ -500,9 +500,9 @@ 
 					  PRC_parent int(10) unsigned DEFAULT 0,
 					  PRIMARY KEY  (PRC_ID),
 					  KEY PRT_ID (PRT_ID)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
 				  PRT_name varchar(45) NOT NULL,
 				  PBT_ID tinyint(3) unsigned NOT NULL DEFAULT '1',
 				  PRT_is_percent tinyint(1) NOT NULL DEFAULT '0',
@@ -511,9 +511,9 @@ 
 				  PRT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				  UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				  PRIMARY KEY  (PRT_ID)";
-        $this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_has_not_changed_since_previous($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TTM_ID int(10) unsigned NOT NULL,
 					  TKT_name varchar(245) NOT NULL DEFAULT '',
 					  TKT_description text NOT NULL,
@@ -535,9 +535,9 @@ 
 					  TKT_deleted tinyint(1) NOT NULL DEFAULT '0',
 					  PRIMARY KEY  (TKT_ID),
 					  KEY TKT_start_date (TKT_start_date)";
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group';
+		$sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QSG_name varchar(255) NOT NULL,
 					QSG_identifier varchar(100) NOT NULL,
 					QSG_desc text NULL,
@@ -550,223 +550,223 @@ 
 					PRIMARY KEY  (QSG_ID),
 					UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier),
 					KEY QSG_order (QSG_order)';
-        $this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        /** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
-        $script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
-        // (because many need to convert old string states to foreign keys into the states table)
-        $script_4_1_defaults->insert_default_states();
-        $script_4_1_defaults->insert_default_countries();
-        /** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
-        $script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
-        $script_4_5_defaults->insert_default_price_types();
-        $script_4_5_defaults->insert_default_prices();
-        $script_4_5_defaults->insert_default_tickets();
-        /** @var EE_DMS_Core_4_6_0 $script_4_6_defaults */
-        $script_4_6_defaults = EE_Registry::instance()->load_dms('Core_4_6_0');
-        $script_4_6_defaults->add_default_admin_only_payments();
-        $script_4_6_defaults->insert_default_currencies();
-        $this->verify_new_countries();
-        $this->verify_new_currencies();
-        return true;
-    }
+		$this->_table_is_changed_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		/** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
+		$script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
+		// (because many need to convert old string states to foreign keys into the states table)
+		$script_4_1_defaults->insert_default_states();
+		$script_4_1_defaults->insert_default_countries();
+		/** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
+		$script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
+		$script_4_5_defaults->insert_default_price_types();
+		$script_4_5_defaults->insert_default_prices();
+		$script_4_5_defaults->insert_default_tickets();
+		/** @var EE_DMS_Core_4_6_0 $script_4_6_defaults */
+		$script_4_6_defaults = EE_Registry::instance()->load_dms('Core_4_6_0');
+		$script_4_6_defaults->add_default_admin_only_payments();
+		$script_4_6_defaults->insert_default_currencies();
+		$this->verify_new_countries();
+		$this->verify_new_currencies();
+		return true;
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        $this->fix_non_default_taxes();
-        // this is actually the same as the last DMS
-        /** @var EE_DMS_Core_4_7_0 $script_4_7_defaults */
-        $script_4_7_defaults = EE_Registry::instance()->load_dms('Core_4_7_0');
-        return $script_4_7_defaults->schema_changes_after_migration();
-    }
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		$this->fix_non_default_taxes();
+		// this is actually the same as the last DMS
+		/** @var EE_DMS_Core_4_7_0 $script_4_7_defaults */
+		$script_4_7_defaults = EE_Registry::instance()->load_dms('Core_4_7_0');
+		return $script_4_7_defaults->schema_changes_after_migration();
+	}
 
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 
 
 
-    /**
-     * verifies each of the new countries exists that somehow we missed in 4.1
-     */
-    public function verify_new_countries()
-    {
-        // a list of countries (and specifically some which were missed in another list):https://gist.github.com/adhipg/1600028
-        // how many decimal places? https://en.wikipedia.org/wiki/ISO_4217
-        // currency symbols: http://www.xe.com/symbols.php
-        // CNT_ISO, CNT_ISO3, RGN_ID, CNT_name, CNT_cur_code, CNT_cur_single, CNT_cur_plural, CNT_cur_sign, CNT_cur_sign_b4, CNT_cur_dec_plc, CNT_tel_code, CNT_is_EU, CNT_active
-        // ('AD', 'AND', 0, 'Andorra', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+376', 0, 0),
-        $newer_countries = array(
-            array('AX', 'ALA', 0, 'Åland Islands', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+358', 1, 0),
-            array('BL', 'BLM', 0, 'Saint Barthelemy', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+590', 1, 0),
-            array('CW', 'CUW', 0, 'Curacao', 'ANG', 'Guilder', 'Guilders', 'ƒ', 1, 2, '+599', 1, 0),
-            array('GG', 'GGY', 0, 'Guernsey', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+44', 0, 0),
-            array('IM', 'IMN', 0, 'Isle of Man', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+44', 0, 0),
-            array('JE', 'JEY', 0, 'Jersey', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+44', 0, 0),
-            array('MF', 'MAF', 0, 'Saint Martin', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+590', 1, 0),
-            array('ME', 'MNE', 0, 'Montenegro', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+382', 0, 0),
-            array('RS', 'SRB', 0, 'Serbia', 'RSD', 'Dinar', 'Dinars', '', 0, 2, '+381', 1, 0),
-            array('SS', 'SSD', 0, 'South Sudan', 'SSP', 'Pound', 'Pounds', '£', 1, 2, '+211', 0, 0),
-            array('SX', 'SXM', 0, 'Sint Maarten', 'ANG', 'Guilder', 'Guilders', 'ƒ', 1, 2, '+1', 1, 0),
-            array('XK', 'XKX', 0, 'Kosovo', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+383', 0, 0),
-            array('YT', 'MYT', 0, 'Mayotte', 'EUR', 'Euro', 'Euros', '€', 0, 2, '+262', 1, 0),
-            array(
-                'BQ',
-                'BES',
-                0,
-                'Bonaire, Saint Eustatius and Saba',
-                'USD',
-                'Dollar',
-                'Dollars',
-                '$',
-                1,
-                2,
-                '+599',
-                0,
-                0,
-            ),
-            array('BV', 'BVT', 0, 'Bouvet Island', 'NOK', 'Krone', 'Krones', 'kr', 1, 2, '+47', 0, 0),
-            array('IO', 'IOT', 0, 'British Indian Ocean Territory', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+246', 0, 0),
-            array('CX', 'CXR', 0, 'Christmas Island', 'AUD', 'Dollar', 'Dollars', '$', 1, 2, '+61', 0, 0),
-            array('CC', 'CCK', 0, 'Cocos (Keeling) Islands', 'AUD', 'Dollar', 'Dollars', '$', 1, 2, '+891', 0, 0),
-            array(
-                'HM',
-                'HMD',
-                0,
-                'Heard Island and McDonald Islands',
-                'AUD',
-                'Dollar',
-                'Dollars',
-                '$',
-                1,
-                2,
-                '+891',
-                0,
-                0,
-            ),
-            array('PS', 'PSE', 0, 'Palestinian Territory', 'ILS', 'Shekel', 'Shekels', '₪', 1, 2, '+970', 0, 0),
-            array(
-                'GS',
-                'SGS',
-                0,
-                'South Georgia and the South Sandwich Islands',
-                'GBP',
-                'Pound',
-                'Pounds',
-                '£',
-                1,
-                2,
-                '+500',
-                0,
-                0,
-            ),
-            array('TL', 'TLS', 0, 'Timor-Leste', 'USD', 'Dollar', 'Dollars', '$', 1, 2, '+670', 0, 0),
-            array('TF', 'ATF', 0, 'French Southern Territories', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+262', 0, 0),
-            array(
-                'UM',
-                'UMI',
-                0,
-                'United States Minor Outlying Islands',
-                'USD',
-                'Dollar',
-                'Dollars',
-                '$',
-                1,
-                2,
-                '+1',
-                0,
-                0,
-            ),
-        );
-        global $wpdb;
-        $country_table = $wpdb->prefix . "esp_country";
-        $country_format = array(
-            "CNT_ISO"         => '%s',
-            "CNT_ISO3"        => '%s',
-            "RGN_ID"          => '%d',
-            "CNT_name"        => '%s',
-            "CNT_cur_code"    => '%s',
-            "CNT_cur_single"  => '%s',
-            "CNT_cur_plural"  => '%s',
-            "CNT_cur_sign"    => '%s',
-            "CNT_cur_sign_b4" => '%d',
-            "CNT_cur_dec_plc" => '%d',
-            "CNT_tel_code"    => '%s',
-            "CNT_is_EU"       => '%d',
-            "CNT_active"      => '%d',
-        );
-        if ($this->_get_table_analysis()->tableExists($country_table)) {
-            foreach ($newer_countries as $country) {
-                $SQL = "SELECT COUNT('CNT_ISO') FROM {$country_table} WHERE CNT_ISO='{$country[0]}' LIMIT 1";
-                $countries = $wpdb->get_var($SQL);
-                if (! $countries) {
-                    $wpdb->insert(
-                        $country_table,
-                        array_combine(array_keys($country_format), $country),
-                        $country_format
-                    );
-                }
-            }
-        }
-    }
+	/**
+	 * verifies each of the new countries exists that somehow we missed in 4.1
+	 */
+	public function verify_new_countries()
+	{
+		// a list of countries (and specifically some which were missed in another list):https://gist.github.com/adhipg/1600028
+		// how many decimal places? https://en.wikipedia.org/wiki/ISO_4217
+		// currency symbols: http://www.xe.com/symbols.php
+		// CNT_ISO, CNT_ISO3, RGN_ID, CNT_name, CNT_cur_code, CNT_cur_single, CNT_cur_plural, CNT_cur_sign, CNT_cur_sign_b4, CNT_cur_dec_plc, CNT_tel_code, CNT_is_EU, CNT_active
+		// ('AD', 'AND', 0, 'Andorra', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+376', 0, 0),
+		$newer_countries = array(
+			array('AX', 'ALA', 0, 'Åland Islands', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+358', 1, 0),
+			array('BL', 'BLM', 0, 'Saint Barthelemy', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+590', 1, 0),
+			array('CW', 'CUW', 0, 'Curacao', 'ANG', 'Guilder', 'Guilders', 'ƒ', 1, 2, '+599', 1, 0),
+			array('GG', 'GGY', 0, 'Guernsey', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+44', 0, 0),
+			array('IM', 'IMN', 0, 'Isle of Man', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+44', 0, 0),
+			array('JE', 'JEY', 0, 'Jersey', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+44', 0, 0),
+			array('MF', 'MAF', 0, 'Saint Martin', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+590', 1, 0),
+			array('ME', 'MNE', 0, 'Montenegro', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+382', 0, 0),
+			array('RS', 'SRB', 0, 'Serbia', 'RSD', 'Dinar', 'Dinars', '', 0, 2, '+381', 1, 0),
+			array('SS', 'SSD', 0, 'South Sudan', 'SSP', 'Pound', 'Pounds', '£', 1, 2, '+211', 0, 0),
+			array('SX', 'SXM', 0, 'Sint Maarten', 'ANG', 'Guilder', 'Guilders', 'ƒ', 1, 2, '+1', 1, 0),
+			array('XK', 'XKX', 0, 'Kosovo', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+383', 0, 0),
+			array('YT', 'MYT', 0, 'Mayotte', 'EUR', 'Euro', 'Euros', '€', 0, 2, '+262', 1, 0),
+			array(
+				'BQ',
+				'BES',
+				0,
+				'Bonaire, Saint Eustatius and Saba',
+				'USD',
+				'Dollar',
+				'Dollars',
+				'$',
+				1,
+				2,
+				'+599',
+				0,
+				0,
+			),
+			array('BV', 'BVT', 0, 'Bouvet Island', 'NOK', 'Krone', 'Krones', 'kr', 1, 2, '+47', 0, 0),
+			array('IO', 'IOT', 0, 'British Indian Ocean Territory', 'GBP', 'Pound', 'Pounds', '£', 1, 2, '+246', 0, 0),
+			array('CX', 'CXR', 0, 'Christmas Island', 'AUD', 'Dollar', 'Dollars', '$', 1, 2, '+61', 0, 0),
+			array('CC', 'CCK', 0, 'Cocos (Keeling) Islands', 'AUD', 'Dollar', 'Dollars', '$', 1, 2, '+891', 0, 0),
+			array(
+				'HM',
+				'HMD',
+				0,
+				'Heard Island and McDonald Islands',
+				'AUD',
+				'Dollar',
+				'Dollars',
+				'$',
+				1,
+				2,
+				'+891',
+				0,
+				0,
+			),
+			array('PS', 'PSE', 0, 'Palestinian Territory', 'ILS', 'Shekel', 'Shekels', '₪', 1, 2, '+970', 0, 0),
+			array(
+				'GS',
+				'SGS',
+				0,
+				'South Georgia and the South Sandwich Islands',
+				'GBP',
+				'Pound',
+				'Pounds',
+				'£',
+				1,
+				2,
+				'+500',
+				0,
+				0,
+			),
+			array('TL', 'TLS', 0, 'Timor-Leste', 'USD', 'Dollar', 'Dollars', '$', 1, 2, '+670', 0, 0),
+			array('TF', 'ATF', 0, 'French Southern Territories', 'EUR', 'Euro', 'Euros', '€', 1, 2, '+262', 0, 0),
+			array(
+				'UM',
+				'UMI',
+				0,
+				'United States Minor Outlying Islands',
+				'USD',
+				'Dollar',
+				'Dollars',
+				'$',
+				1,
+				2,
+				'+1',
+				0,
+				0,
+			),
+		);
+		global $wpdb;
+		$country_table = $wpdb->prefix . "esp_country";
+		$country_format = array(
+			"CNT_ISO"         => '%s',
+			"CNT_ISO3"        => '%s',
+			"RGN_ID"          => '%d',
+			"CNT_name"        => '%s',
+			"CNT_cur_code"    => '%s',
+			"CNT_cur_single"  => '%s',
+			"CNT_cur_plural"  => '%s',
+			"CNT_cur_sign"    => '%s',
+			"CNT_cur_sign_b4" => '%d',
+			"CNT_cur_dec_plc" => '%d',
+			"CNT_tel_code"    => '%s',
+			"CNT_is_EU"       => '%d',
+			"CNT_active"      => '%d',
+		);
+		if ($this->_get_table_analysis()->tableExists($country_table)) {
+			foreach ($newer_countries as $country) {
+				$SQL = "SELECT COUNT('CNT_ISO') FROM {$country_table} WHERE CNT_ISO='{$country[0]}' LIMIT 1";
+				$countries = $wpdb->get_var($SQL);
+				if (! $countries) {
+					$wpdb->insert(
+						$country_table,
+						array_combine(array_keys($country_format), $country),
+						$country_format
+					);
+				}
+			}
+		}
+	}
 
 
 
-    /**
-     * verifies each of the new currencies exists that somehow we missed in 4.6
-     */
-    public function verify_new_currencies()
-    {
-        // a list of countries (and specifically some which were missed in another list):https://gist.github.com/adhipg/1600028
-        // how many decimal places? https://en.wikipedia.org/wiki/ISO_4217
-        // currency symbols: http://www.xe.com/symbols.php
-        // CUR_code, CUR_single, CUR_plural, CUR_sign, CUR_dec_plc, CUR_active
-        // ( 'EUR',  'Euro',  'Euros',  '€',  2,1),
-        $newer_currencies = array(
-            array('RSD', 'Dinar', 'Dinars', '', 3, 1),
-        );
-        global $wpdb;
-        $currency_table = $wpdb->prefix . "esp_currency";
-        $currency_format = array(
-            "CUR_code"    => '%s',
-            "CUR_single"  => '%s',
-            "CUR_plural"  => '%s',
-            "CUR_sign"    => '%s',
-            "CUR_dec_plc" => '%d',
-            "CUR_active"  => '%d',
-        );
-        if ($this->_get_table_analysis()->tableExists($currency_table)) {
-            foreach ($newer_currencies as $currency) {
-                $SQL = "SELECT COUNT('CUR_code') FROM {$currency_table} WHERE CUR_code='{$currency[0]}' LIMIT 1";
-                $countries = $wpdb->get_var($SQL);
-                if (! $countries) {
-                    $wpdb->insert(
-                        $currency_table,
-                        array_combine(array_keys($currency_format), $currency),
-                        $currency_format
-                    );
-                }
-            }
-        }
-    }
+	/**
+	 * verifies each of the new currencies exists that somehow we missed in 4.6
+	 */
+	public function verify_new_currencies()
+	{
+		// a list of countries (and specifically some which were missed in another list):https://gist.github.com/adhipg/1600028
+		// how many decimal places? https://en.wikipedia.org/wiki/ISO_4217
+		// currency symbols: http://www.xe.com/symbols.php
+		// CUR_code, CUR_single, CUR_plural, CUR_sign, CUR_dec_plc, CUR_active
+		// ( 'EUR',  'Euro',  'Euros',  '€',  2,1),
+		$newer_currencies = array(
+			array('RSD', 'Dinar', 'Dinars', '', 3, 1),
+		);
+		global $wpdb;
+		$currency_table = $wpdb->prefix . "esp_currency";
+		$currency_format = array(
+			"CUR_code"    => '%s',
+			"CUR_single"  => '%s',
+			"CUR_plural"  => '%s',
+			"CUR_sign"    => '%s',
+			"CUR_dec_plc" => '%d',
+			"CUR_active"  => '%d',
+		);
+		if ($this->_get_table_analysis()->tableExists($currency_table)) {
+			foreach ($newer_currencies as $currency) {
+				$SQL = "SELECT COUNT('CUR_code') FROM {$currency_table} WHERE CUR_code='{$currency[0]}' LIMIT 1";
+				$countries = $wpdb->get_var($SQL);
+				if (! $countries) {
+					$wpdb->insert(
+						$currency_table,
+						array_combine(array_keys($currency_format), $currency),
+						$currency_format
+					);
+				}
+			}
+		}
+	}
 
 
 
-    /**
-     * addresses https://events.codebasehq.com/projects/event-espresso/tickets/8731
-     * which should just be a temporary issue for folks who installed 4.8.0-4.8.5;
-     * we should be able to stop doing this in 4.9
-     */
-    public function fix_non_default_taxes()
-    {
-        global $wpdb;
-        $query = $wpdb->prepare("UPDATE
+	/**
+	 * addresses https://events.codebasehq.com/projects/event-espresso/tickets/8731
+	 * which should just be a temporary issue for folks who installed 4.8.0-4.8.5;
+	 * we should be able to stop doing this in 4.9
+	 */
+	public function fix_non_default_taxes()
+	{
+		global $wpdb;
+		$query = $wpdb->prepare("UPDATE
 				{$wpdb->prefix}esp_price p INNER JOIN
 				{$wpdb->prefix}esp_price_type pt ON p.PRT_ID = pt.PRT_ID
 			SET
@@ -775,6 +775,6 @@ 
 				p.PRC_is_default = 0 AND
 				pt.PBT_ID = %d
 					", EEM_Price_Type::base_type_tax);
-        $wpdb->query($query);
-    }
+		$wpdb->query($query);
+	}
 }

admin_pages/general_settings/OrganizationSettings.php

Indentation +473 added lines, -473 removed lines

@@ -40,498 +40,498 @@
 class OrganizationSettings extends FormHandler
 {
 
-    /**
-     * @var EE_Organization_Config
-     */
-    protected $organization_config;
+	/**
+	 * @var EE_Organization_Config
+	 */
+	protected $organization_config;
 
-    /**
-     * @var EE_Core_Config
-     */
-    protected $core_config;
+	/**
+	 * @var EE_Core_Config
+	 */
+	protected $core_config;
 
 
-    /**
-     * @var EE_Network_Core_Config
-     */
-    protected $network_core_config;
+	/**
+	 * @var EE_Network_Core_Config
+	 */
+	protected $network_core_config;
 
-    /**
-     * Form constructor.
-     *
-     * @param EE_Registry             $registry
-     * @param EE_Organization_Config  $organization_config
-     * @param EE_Core_Config          $core_config
-     * @param EE_Network_Core_Config $network_core_config
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    public function __construct(
-        EE_Registry $registry,
-        EE_Organization_Config $organization_config,
-        EE_Core_Config $core_config,
-        EE_Network_Core_Config $network_core_config
-    ) {
-        $this->organization_config = $organization_config;
-        $this->core_config = $core_config;
-        $this->network_core_config = $network_core_config;
-        parent::__construct(
-            esc_html__('Your Organization Settings', 'event_espresso'),
-            esc_html__('Your Organization Settings', 'event_espresso'),
-            'organization_settings',
-            '',
-            FormHandler::DO_NOT_SETUP_FORM,
-            $registry
-        );
-    }
+	/**
+	 * Form constructor.
+	 *
+	 * @param EE_Registry             $registry
+	 * @param EE_Organization_Config  $organization_config
+	 * @param EE_Core_Config          $core_config
+	 * @param EE_Network_Core_Config $network_core_config
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	public function __construct(
+		EE_Registry $registry,
+		EE_Organization_Config $organization_config,
+		EE_Core_Config $core_config,
+		EE_Network_Core_Config $network_core_config
+	) {
+		$this->organization_config = $organization_config;
+		$this->core_config = $core_config;
+		$this->network_core_config = $network_core_config;
+		parent::__construct(
+			esc_html__('Your Organization Settings', 'event_espresso'),
+			esc_html__('Your Organization Settings', 'event_espresso'),
+			'organization_settings',
+			'',
+			FormHandler::DO_NOT_SETUP_FORM,
+			$registry
+		);
+	}
 
 
 
-    /**
-     * creates and returns the actual form
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function generate()
-    {
-        $form = new EE_Form_Section_Proper(
-            array(
-                'name'            => 'organization_settings',
-                'html_id'         => 'organization_settings',
-                'layout_strategy' => new EE_Admin_Two_Column_Layout(),
-                'subsections'     => array(
-                    'contact_information_hdr'        => new EE_Form_Section_HTML(
-                        EEH_HTML::h2(
-                            esc_html__('Contact Information', 'event_espresso')
-                            . ' '
-                            . EEH_HTML::span(EEH_Template::get_help_tab_link('contact_info_info')),
-                            '',
-                            'contact-information-hdr'
-                        )
-                    ),
-                    'organization_name'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_name',
-                            'html_label_text' => esc_html__('Organization Name', 'event_espresso'),
-                            'html_help_text'  => esc_html__(
-                                'Displayed on all emails and invoices.',
-                                'event_espresso'
-                            ),
-                            'default'         => $this->organization_config->get_pretty('name'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_address_1'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_address_1',
-                            'html_label_text' => esc_html__('Street Address', 'event_espresso'),
-                            'default'         => $this->organization_config->get_pretty('address_1'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_address_2'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_address_2',
-                            'html_label_text' => esc_html__('Street Address 2', 'event_espresso'),
-                            'default'         => $this->organization_config->get_pretty('address_2'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_city'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_city',
-                            'html_label_text' => esc_html__('City', 'event_espresso'),
-                            'default'         => $this->organization_config->get_pretty('city'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_state'      => new EE_State_Select_Input(
-                        null,
-                        array(
-                            'html_name' => 'organization_state',
-                            'html_label_text' => esc_html__('State/Province', 'event_espresso'),
-                            'default'         => $this->organization_config->STA_ID,
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_country'      => new EE_Country_Select_Input(
-                        null,
-                        array(
-                            'html_name' => 'organization_country',
-                            'html_label_text' => esc_html__('Country', 'event_espresso'),
-                            'default'         => $this->organization_config->CNT_ISO,
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_zip'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_zip',
-                            'html_label_text' => esc_html__('Zip/Postal Code', 'event_espresso'),
-                            'default'         => $this->organization_config->get_pretty('zip'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_email'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_email',
-                            'html_label_text' => esc_html__('Primary Contact Email', 'event_espresso'),
-                            'html_help_text'  => sprintf(
-                                esc_html__(
-                                    'This is where notifications go to when you use the %1$s and %2$s shortcodes in the message templates.',
-                                    'event_espresso'
-                                ),
-                                '<code>[CO_FORMATTED_EMAIL]</code>',
-                                '<code>[CO_EMAIL]</code>'
-                            ),
-                            'default'         => $this->organization_config->get_pretty('email'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_phone'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_phone',
-                            'html_label_text' => esc_html__('Phone Number', 'event_espresso'),
-                            'html_help_text'  => esc_html__(
-                                'The phone number for your organization.',
-                                'event_espresso'
-                            ),
-                            'default'         => $this->organization_config->get_pretty('phone'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_vat'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_vat',
-                            'html_label_text' => esc_html__('VAT/Tax Number', 'event_espresso'),
-                            'html_help_text'  => esc_html__(
-                                'The VAT/Tax Number may be displayed on invoices and receipts.',
-                                'event_espresso'
-                            ),
-                            'default'         => $this->organization_config->get_pretty('vat'),
-                            'required'        => false,
-                        )
-                    ),
-                    'company_logo_hdr'        => new EE_Form_Section_HTML(
-                        EEH_HTML::h2(
-                            esc_html__('Company Logo', 'event_espresso')
-                            . ' '
-                            . EEH_HTML::span(EEH_Template::get_help_tab_link('organization_logo_info')),
-                            '',
-                            'company-logo-hdr'
-                        )
-                    ),
-                    'organization_logo_url'      => new EE_Admin_File_Uploader_Input(
-                        array(
-                            'html_name' => 'organization_logo_url',
-                            'html_label_text' => esc_html__('Upload New Logo', 'event_espresso'),
-                            'html_help_text'  => esc_html__(
-                                'Your logo will be used on custom invoices, tickets, certificates, and payment templates.',
-                                'event_espresso'
-                            ),
-                            'default'         => $this->organization_config->get_pretty('logo_url'),
-                            'required'        => false,
-                        )
-                    ),
-                    'social_links_hdr'        => new EE_Form_Section_HTML(
-                        EEH_HTML::h2(
-                            esc_html__('Social Links', 'event_espresso')
-                            . ' '
-                            . EEH_HTML::span(EEH_Template::get_help_tab_link('social_links_info'))
-                            . EEH_HTML::br()
-                            . EEH_HTML::p(
-                                esc_html__(
-                                    'Enter any links to social accounts for your organization here',
-                                    'event_espresso'
-                                ),
-                                '',
-                                'description'
-                            ),
-                            '',
-                            'social-links-hdr'
-                        )
-                    ),
-                    'organization_facebook'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_facebook',
-                            'html_label_text' => esc_html__('Facebook', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="facebook.com/profile.name"',
-                            'default'         => $this->organization_config->get_pretty('facebook'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_twitter'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_twitter',
-                            'html_label_text' => esc_html__('Twitter', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="twitter.com/twitterhandle"',
-                            'default'         => $this->organization_config->get_pretty('twitter'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_linkedin'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_linkedin',
-                            'html_label_text' => esc_html__('LinkedIn', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="linkedin.com/in/profilename"',
-                            'default'         => $this->organization_config->get_pretty('linkedin'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_pinterest'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_pinterest',
-                            'html_label_text' => esc_html__('Pinterest', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="pinterest.com/profilename"',
-                            'default'         => $this->organization_config->get_pretty('pinterest'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_google'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_google',
-                            'html_label_text' => esc_html__('Google+', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="google.com/+profilename"',
-                            'default'         => $this->organization_config->get_pretty('google'),
-                            'required'        => false,
-                        )
-                    ),
-                    'organization_instagram'      => new EE_Text_Input(
-                        array(
-                            'html_name' => 'organization_instagram',
-                            'html_label_text' => esc_html__('Instagram', 'event_espresso'),
-                            'other_html_attributes' => ' placeholder="instagram.com/handle"',
-                            'default'         => $this->organization_config->get_pretty('instagram'),
-                            'required'        => false,
-                        )
-                    ),
-                ),
-            )
-        );
-        if (is_main_site()) {
-            $form->add_subsections(
-                array(
-                    'site_license_key_hdr' => new EE_Form_Section_HTML(
-                        EEH_HTML::h2(
-                            esc_html__('Your Event Espresso License Key', 'event_espresso')
-                            . ' '
-                            . EEH_HTML::span(
-                                EEH_Template::get_help_tab_link('site_license_key_info'),
-                                'help_tour_activation'
-                            ),
-                            '',
-                            'site-license-key-hdr'
-                        )
-                    ),
-                    'site_license_key' => $this->getSiteLicenseKeyField()
-                )
-            );
-            $form->add_subsections(
-                array(
-                    'uxip_optin_hdr' => new EE_Form_Section_HTML(
-                        $this->uxipOptinText()
-                    ),
-                    'ueip_optin' => new EE_Checkbox_Multi_Input(
-                        array(
-                            true => __('Yes! I want to help improve Event Espresso!', 'event_espresso')
-                        ),
-                        array(
-                            'html_name' => EE_Core_Config::OPTION_NAME_UXIP,
-                            'html_label_text' => esc_html__(
-                                'UXIP Opt In?',
-                                'event_espresso'
-                            ),
-                            'default'         => isset($this->core_config->ee_ueip_optin)
-                                ? filter_var($this->core_config->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN)
-                                : false,
-                            'required'        => false,
-                        )
-                    ),
-                ),
-                'organization_instagram',
-                false
-            );
-        }
-        return $form;
-    }
+	/**
+	 * creates and returns the actual form
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function generate()
+	{
+		$form = new EE_Form_Section_Proper(
+			array(
+				'name'            => 'organization_settings',
+				'html_id'         => 'organization_settings',
+				'layout_strategy' => new EE_Admin_Two_Column_Layout(),
+				'subsections'     => array(
+					'contact_information_hdr'        => new EE_Form_Section_HTML(
+						EEH_HTML::h2(
+							esc_html__('Contact Information', 'event_espresso')
+							. ' '
+							. EEH_HTML::span(EEH_Template::get_help_tab_link('contact_info_info')),
+							'',
+							'contact-information-hdr'
+						)
+					),
+					'organization_name'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_name',
+							'html_label_text' => esc_html__('Organization Name', 'event_espresso'),
+							'html_help_text'  => esc_html__(
+								'Displayed on all emails and invoices.',
+								'event_espresso'
+							),
+							'default'         => $this->organization_config->get_pretty('name'),
+							'required'        => false,
+						)
+					),
+					'organization_address_1'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_address_1',
+							'html_label_text' => esc_html__('Street Address', 'event_espresso'),
+							'default'         => $this->organization_config->get_pretty('address_1'),
+							'required'        => false,
+						)
+					),
+					'organization_address_2'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_address_2',
+							'html_label_text' => esc_html__('Street Address 2', 'event_espresso'),
+							'default'         => $this->organization_config->get_pretty('address_2'),
+							'required'        => false,
+						)
+					),
+					'organization_city'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_city',
+							'html_label_text' => esc_html__('City', 'event_espresso'),
+							'default'         => $this->organization_config->get_pretty('city'),
+							'required'        => false,
+						)
+					),
+					'organization_state'      => new EE_State_Select_Input(
+						null,
+						array(
+							'html_name' => 'organization_state',
+							'html_label_text' => esc_html__('State/Province', 'event_espresso'),
+							'default'         => $this->organization_config->STA_ID,
+							'required'        => false,
+						)
+					),
+					'organization_country'      => new EE_Country_Select_Input(
+						null,
+						array(
+							'html_name' => 'organization_country',
+							'html_label_text' => esc_html__('Country', 'event_espresso'),
+							'default'         => $this->organization_config->CNT_ISO,
+							'required'        => false,
+						)
+					),
+					'organization_zip'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_zip',
+							'html_label_text' => esc_html__('Zip/Postal Code', 'event_espresso'),
+							'default'         => $this->organization_config->get_pretty('zip'),
+							'required'        => false,
+						)
+					),
+					'organization_email'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_email',
+							'html_label_text' => esc_html__('Primary Contact Email', 'event_espresso'),
+							'html_help_text'  => sprintf(
+								esc_html__(
+									'This is where notifications go to when you use the %1$s and %2$s shortcodes in the message templates.',
+									'event_espresso'
+								),
+								'<code>[CO_FORMATTED_EMAIL]</code>',
+								'<code>[CO_EMAIL]</code>'
+							),
+							'default'         => $this->organization_config->get_pretty('email'),
+							'required'        => false,
+						)
+					),
+					'organization_phone'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_phone',
+							'html_label_text' => esc_html__('Phone Number', 'event_espresso'),
+							'html_help_text'  => esc_html__(
+								'The phone number for your organization.',
+								'event_espresso'
+							),
+							'default'         => $this->organization_config->get_pretty('phone'),
+							'required'        => false,
+						)
+					),
+					'organization_vat'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_vat',
+							'html_label_text' => esc_html__('VAT/Tax Number', 'event_espresso'),
+							'html_help_text'  => esc_html__(
+								'The VAT/Tax Number may be displayed on invoices and receipts.',
+								'event_espresso'
+							),
+							'default'         => $this->organization_config->get_pretty('vat'),
+							'required'        => false,
+						)
+					),
+					'company_logo_hdr'        => new EE_Form_Section_HTML(
+						EEH_HTML::h2(
+							esc_html__('Company Logo', 'event_espresso')
+							. ' '
+							. EEH_HTML::span(EEH_Template::get_help_tab_link('organization_logo_info')),
+							'',
+							'company-logo-hdr'
+						)
+					),
+					'organization_logo_url'      => new EE_Admin_File_Uploader_Input(
+						array(
+							'html_name' => 'organization_logo_url',
+							'html_label_text' => esc_html__('Upload New Logo', 'event_espresso'),
+							'html_help_text'  => esc_html__(
+								'Your logo will be used on custom invoices, tickets, certificates, and payment templates.',
+								'event_espresso'
+							),
+							'default'         => $this->organization_config->get_pretty('logo_url'),
+							'required'        => false,
+						)
+					),
+					'social_links_hdr'        => new EE_Form_Section_HTML(
+						EEH_HTML::h2(
+							esc_html__('Social Links', 'event_espresso')
+							. ' '
+							. EEH_HTML::span(EEH_Template::get_help_tab_link('social_links_info'))
+							. EEH_HTML::br()
+							. EEH_HTML::p(
+								esc_html__(
+									'Enter any links to social accounts for your organization here',
+									'event_espresso'
+								),
+								'',
+								'description'
+							),
+							'',
+							'social-links-hdr'
+						)
+					),
+					'organization_facebook'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_facebook',
+							'html_label_text' => esc_html__('Facebook', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="facebook.com/profile.name"',
+							'default'         => $this->organization_config->get_pretty('facebook'),
+							'required'        => false,
+						)
+					),
+					'organization_twitter'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_twitter',
+							'html_label_text' => esc_html__('Twitter', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="twitter.com/twitterhandle"',
+							'default'         => $this->organization_config->get_pretty('twitter'),
+							'required'        => false,
+						)
+					),
+					'organization_linkedin'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_linkedin',
+							'html_label_text' => esc_html__('LinkedIn', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="linkedin.com/in/profilename"',
+							'default'         => $this->organization_config->get_pretty('linkedin'),
+							'required'        => false,
+						)
+					),
+					'organization_pinterest'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_pinterest',
+							'html_label_text' => esc_html__('Pinterest', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="pinterest.com/profilename"',
+							'default'         => $this->organization_config->get_pretty('pinterest'),
+							'required'        => false,
+						)
+					),
+					'organization_google'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_google',
+							'html_label_text' => esc_html__('Google+', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="google.com/+profilename"',
+							'default'         => $this->organization_config->get_pretty('google'),
+							'required'        => false,
+						)
+					),
+					'organization_instagram'      => new EE_Text_Input(
+						array(
+							'html_name' => 'organization_instagram',
+							'html_label_text' => esc_html__('Instagram', 'event_espresso'),
+							'other_html_attributes' => ' placeholder="instagram.com/handle"',
+							'default'         => $this->organization_config->get_pretty('instagram'),
+							'required'        => false,
+						)
+					),
+				),
+			)
+		);
+		if (is_main_site()) {
+			$form->add_subsections(
+				array(
+					'site_license_key_hdr' => new EE_Form_Section_HTML(
+						EEH_HTML::h2(
+							esc_html__('Your Event Espresso License Key', 'event_espresso')
+							. ' '
+							. EEH_HTML::span(
+								EEH_Template::get_help_tab_link('site_license_key_info'),
+								'help_tour_activation'
+							),
+							'',
+							'site-license-key-hdr'
+						)
+					),
+					'site_license_key' => $this->getSiteLicenseKeyField()
+				)
+			);
+			$form->add_subsections(
+				array(
+					'uxip_optin_hdr' => new EE_Form_Section_HTML(
+						$this->uxipOptinText()
+					),
+					'ueip_optin' => new EE_Checkbox_Multi_Input(
+						array(
+							true => __('Yes! I want to help improve Event Espresso!', 'event_espresso')
+						),
+						array(
+							'html_name' => EE_Core_Config::OPTION_NAME_UXIP,
+							'html_label_text' => esc_html__(
+								'UXIP Opt In?',
+								'event_espresso'
+							),
+							'default'         => isset($this->core_config->ee_ueip_optin)
+								? filter_var($this->core_config->ee_ueip_optin, FILTER_VALIDATE_BOOLEAN)
+								: false,
+							'required'        => false,
+						)
+					),
+				),
+				'organization_instagram',
+				false
+			);
+		}
+		return $form;
+	}
 
 
-    /**
-     * takes the generated form and displays it along with ony other non-form HTML that may be required
-     * returns a string of HTML that can be directly echoed in a template
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws LogicException
-     */
-    public function display()
-    {
-        $this->form()->enqueue_js();
-        return parent::display();
-    }
+	/**
+	 * takes the generated form and displays it along with ony other non-form HTML that may be required
+	 * returns a string of HTML that can be directly echoed in a template
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws LogicException
+	 */
+	public function display()
+	{
+		$this->form()->enqueue_js();
+		return parent::display();
+	}
 
 
-    /**
-     * handles processing the form submission
-     * returns true or false depending on whether the form was processed successfully or not
-     *
-     * @param array $form_data
-     * @return bool
-     * @throws InvalidFormSubmissionException
-     * @throws EE_Error
-     * @throws LogicException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    public function process($form_data = array())
-    {
-        // process form
-        $valid_data = (array) parent::process($form_data);
-        if (empty($valid_data)) {
-            return false;
-        }
+	/**
+	 * handles processing the form submission
+	 * returns true or false depending on whether the form was processed successfully or not
+	 *
+	 * @param array $form_data
+	 * @return bool
+	 * @throws InvalidFormSubmissionException
+	 * @throws EE_Error
+	 * @throws LogicException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	public function process($form_data = array())
+	{
+		// process form
+		$valid_data = (array) parent::process($form_data);
+		if (empty($valid_data)) {
+			return false;
+		}
 
-        if (is_main_site()) {
-            $this->network_core_config->site_license_key = isset($form_data['ee_site_license_key'])
-                ? sanitize_text_field($form_data['ee_site_license_key'])
-                : $this->network_core_config->site_license_key;
-        }
-        $this->organization_config->name = isset($form_data['organization_name'])
-            ? sanitize_text_field($form_data['organization_name'])
-            : $this->organization_config->name;
-        $this->organization_config->address_1 = isset($form_data['organization_address_1'])
-            ? sanitize_text_field($form_data['organization_address_1'])
-            : $this->organization_config->address_1;
-        $this->organization_config->address_2 = isset($form_data['organization_address_2'])
-            ? sanitize_text_field($form_data['organization_address_2'])
-            : $this->organization_config->address_2;
-        $this->organization_config->city = isset($form_data['organization_city'])
-            ? sanitize_text_field($form_data['organization_city'])
-            : $this->organization_config->city;
-        $this->organization_config->STA_ID = isset($form_data['organization_state'])
-            ? absint($form_data['organization_state'])
-            : $this->organization_config->STA_ID;
-        $this->organization_config->CNT_ISO = isset($form_data['organization_country'])
-            ? sanitize_text_field($form_data['organization_country'])
-            : $this->organization_config->CNT_ISO;
-        $this->organization_config->zip = isset($form_data['organization_zip'])
-            ? sanitize_text_field($form_data['organization_zip'])
-            : $this->organization_config->zip;
-        $this->organization_config->email = isset($form_data['organization_email'])
-            ? sanitize_email($form_data['organization_email'])
-            : $this->organization_config->email;
-        $this->organization_config->vat = isset($form_data['organization_vat'])
-            ? sanitize_text_field($form_data['organization_vat'])
-            : $this->organization_config->vat;
-        $this->organization_config->phone = isset($form_data['organization_phone'])
-            ? sanitize_text_field($form_data['organization_phone'])
-            : $this->organization_config->phone;
-        $this->organization_config->logo_url = isset($form_data['organization_logo_url'])
-            ? esc_url_raw($form_data['organization_logo_url'])
-            : $this->organization_config->logo_url;
-        $this->organization_config->facebook = isset($form_data['organization_facebook'])
-            ? esc_url_raw($form_data['organization_facebook'])
-            : $this->organization_config->facebook;
-        $this->organization_config->twitter = isset($form_data['organization_twitter'])
-            ? esc_url_raw($form_data['organization_twitter'])
-            : $this->organization_config->twitter;
-        $this->organization_config->linkedin = isset($form_data['organization_linkedin'])
-            ? esc_url_raw($form_data['organization_linkedin'])
-            : $this->organization_config->linkedin;
-        $this->organization_config->pinterest = isset($form_data['organization_pinterest'])
-            ? esc_url_raw($form_data['organization_pinterest'])
-            : $this->organization_config->pinterest;
-        $this->organization_config->google = isset($form_data['organization_google'])
-            ? esc_url_raw($form_data['organization_google'])
-            : $this->organization_config->google;
-        $this->organization_config->instagram = isset($form_data['organization_instagram'])
-            ? esc_url_raw($form_data['organization_instagram'])
-            : $this->organization_config->instagram;
-        $this->core_config->ee_ueip_optin = isset($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0])
-            ? filter_var($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0], FILTER_VALIDATE_BOOLEAN)
-            : false;
-        $this->core_config->ee_ueip_has_notified = true;
+		if (is_main_site()) {
+			$this->network_core_config->site_license_key = isset($form_data['ee_site_license_key'])
+				? sanitize_text_field($form_data['ee_site_license_key'])
+				: $this->network_core_config->site_license_key;
+		}
+		$this->organization_config->name = isset($form_data['organization_name'])
+			? sanitize_text_field($form_data['organization_name'])
+			: $this->organization_config->name;
+		$this->organization_config->address_1 = isset($form_data['organization_address_1'])
+			? sanitize_text_field($form_data['organization_address_1'])
+			: $this->organization_config->address_1;
+		$this->organization_config->address_2 = isset($form_data['organization_address_2'])
+			? sanitize_text_field($form_data['organization_address_2'])
+			: $this->organization_config->address_2;
+		$this->organization_config->city = isset($form_data['organization_city'])
+			? sanitize_text_field($form_data['organization_city'])
+			: $this->organization_config->city;
+		$this->organization_config->STA_ID = isset($form_data['organization_state'])
+			? absint($form_data['organization_state'])
+			: $this->organization_config->STA_ID;
+		$this->organization_config->CNT_ISO = isset($form_data['organization_country'])
+			? sanitize_text_field($form_data['organization_country'])
+			: $this->organization_config->CNT_ISO;
+		$this->organization_config->zip = isset($form_data['organization_zip'])
+			? sanitize_text_field($form_data['organization_zip'])
+			: $this->organization_config->zip;
+		$this->organization_config->email = isset($form_data['organization_email'])
+			? sanitize_email($form_data['organization_email'])
+			: $this->organization_config->email;
+		$this->organization_config->vat = isset($form_data['organization_vat'])
+			? sanitize_text_field($form_data['organization_vat'])
+			: $this->organization_config->vat;
+		$this->organization_config->phone = isset($form_data['organization_phone'])
+			? sanitize_text_field($form_data['organization_phone'])
+			: $this->organization_config->phone;
+		$this->organization_config->logo_url = isset($form_data['organization_logo_url'])
+			? esc_url_raw($form_data['organization_logo_url'])
+			: $this->organization_config->logo_url;
+		$this->organization_config->facebook = isset($form_data['organization_facebook'])
+			? esc_url_raw($form_data['organization_facebook'])
+			: $this->organization_config->facebook;
+		$this->organization_config->twitter = isset($form_data['organization_twitter'])
+			? esc_url_raw($form_data['organization_twitter'])
+			: $this->organization_config->twitter;
+		$this->organization_config->linkedin = isset($form_data['organization_linkedin'])
+			? esc_url_raw($form_data['organization_linkedin'])
+			: $this->organization_config->linkedin;
+		$this->organization_config->pinterest = isset($form_data['organization_pinterest'])
+			? esc_url_raw($form_data['organization_pinterest'])
+			: $this->organization_config->pinterest;
+		$this->organization_config->google = isset($form_data['organization_google'])
+			? esc_url_raw($form_data['organization_google'])
+			: $this->organization_config->google;
+		$this->organization_config->instagram = isset($form_data['organization_instagram'])
+			? esc_url_raw($form_data['organization_instagram'])
+			: $this->organization_config->instagram;
+		$this->core_config->ee_ueip_optin = isset($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0])
+			? filter_var($form_data[ EE_Core_Config::OPTION_NAME_UXIP ][0], FILTER_VALIDATE_BOOLEAN)
+			: false;
+		$this->core_config->ee_ueip_has_notified = true;
 
-        $this->registry->CFG->currency = new EE_Currency_Config(
-            $this->organization_config->CNT_ISO
-        );
-        return true;
-    }
+		$this->registry->CFG->currency = new EE_Currency_Config(
+			$this->organization_config->CNT_ISO
+		);
+		return true;
+	}
 
 
-    /**
-     * @return string
-     */
-    private function uxipOptinText()
-    {
-        ob_start();
-        Stats::optinText(false);
-        return ob_get_clean();
-    }
+	/**
+	 * @return string
+	 */
+	private function uxipOptinText()
+	{
+		ob_start();
+		Stats::optinText(false);
+		return ob_get_clean();
+	}
 
 
-    /**
-     * Return whether the site license key has been verified or not.
-     * @return bool
-     */
-    private function licenseKeyVerified()
-    {
-        if (empty($this->network_core_config->site_license_key)) {
-            return false;
-        }
-        $ver_option_key = 'puvererr_' . basename(EE_PLUGIN_BASENAME);
-        $verify_fail = get_option($ver_option_key, false);
-        return $verify_fail === false
-                  || (! empty($this->network_core_config->site_license_key)
-                        && $verify_fail === false
-                  );
-    }
+	/**
+	 * Return whether the site license key has been verified or not.
+	 * @return bool
+	 */
+	private function licenseKeyVerified()
+	{
+		if (empty($this->network_core_config->site_license_key)) {
+			return false;
+		}
+		$ver_option_key = 'puvererr_' . basename(EE_PLUGIN_BASENAME);
+		$verify_fail = get_option($ver_option_key, false);
+		return $verify_fail === false
+				  || (! empty($this->network_core_config->site_license_key)
+						&& $verify_fail === false
+				  );
+	}
 
 
-    /**
-     * @return EE_Text_Input
-     */
-    private function getSiteLicenseKeyField()
-    {
-        $text_input = new EE_Text_Input(
-            array(
-                'html_name' => 'ee_site_license_key',
-                'html_id' => 'site_license_key',
-                'html_label_text' => esc_html__('Support License Key', 'event_espresso'),
-                /** phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText */
-                'html_help_text'  => sprintf(
-                    esc_html__(
-                        'Adding a valid Support License Key will enable automatic update notifications and backend updates for Event Espresso Core and any installed add-ons. If this is a Development or Test site, %sDO NOT%s enter your Support License Key.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>'
-                ),
-                /** phpcs:enable */
-                'default'         => isset($this->network_core_config->site_license_key)
-                    ? $this->network_core_config->site_license_key
-                    : '',
-                'required'        => false,
-                'form_html_filter' => new VsprintfFilter(
-                    '%2$s %1$s',
-                    array($this->getValidationIndicator())
-                )
-            )
-        );
-        return $text_input;
-    }
+	/**
+	 * @return EE_Text_Input
+	 */
+	private function getSiteLicenseKeyField()
+	{
+		$text_input = new EE_Text_Input(
+			array(
+				'html_name' => 'ee_site_license_key',
+				'html_id' => 'site_license_key',
+				'html_label_text' => esc_html__('Support License Key', 'event_espresso'),
+				/** phpcs:disable WordPress.WP.I18n.UnorderedPlaceholdersText */
+				'html_help_text'  => sprintf(
+					esc_html__(
+						'Adding a valid Support License Key will enable automatic update notifications and backend updates for Event Espresso Core and any installed add-ons. If this is a Development or Test site, %sDO NOT%s enter your Support License Key.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>'
+				),
+				/** phpcs:enable */
+				'default'         => isset($this->network_core_config->site_license_key)
+					? $this->network_core_config->site_license_key
+					: '',
+				'required'        => false,
+				'form_html_filter' => new VsprintfFilter(
+					'%2$s %1$s',
+					array($this->getValidationIndicator())
+				)
+			)
+		);
+		return $text_input;
+	}
 
 
-    /**
-     * @return string
-     */
-    private function getValidationIndicator()
-    {
-        $verified_class = $this->licenseKeyVerified() ? 'ee-icon-color-ee-green' : 'ee-icon-color-ee-red';
-        return '<span class="dashicons dashicons-admin-network ' . $verified_class . ' ee-icon-size-20"></span>';
-    }
+	/**
+	 * @return string
+	 */
+	private function getValidationIndicator()
+	{
+		$verified_class = $this->licenseKeyVerified() ? 'ee-icon-color-ee-green' : 'ee-icon-color-ee-red';
+		return '<span class="dashicons dashicons-admin-network ' . $verified_class . ' ee-icon-size-20"></span>';
+	}
 }

modules/messages/EED_Messages.module.php

Indentation +1322 added lines, -1322 removed lines

@@ -16,1335 +16,1335 @@
 class EED_Messages extends EED_Module
 {
 
-    /**
-     * This holds the EE_messages controller
-     *
-     * @deprecated 4.9.0
-     * @var EE_messages $_EEMSG
-     */
-    protected static $_EEMSG;
-
-    /**
-     * @type EE_Message_Resource_Manager $_message_resource_manager
-     */
-    protected static $_message_resource_manager;
-
-    /**
-     * This holds the EE_Messages_Processor business class.
-     *
-     * @type EE_Messages_Processor
-     */
-    protected static $_MSG_PROCESSOR;
-
-    /**
-     * holds all the paths for various messages components.
-     * Utilized by autoloader registry
-     *
-     * @var array
-     */
-    protected static $_MSG_PATHS;
-
-
-    /**
-     * This will hold an array of messages template packs that are registered in the messages system.
-     * Format is:
-     * array(
-     *    'template_pack_dbref' => EE_Messages_Template_Pack (instance)
-     * )
-     *
-     * @var EE_Messages_Template_Pack[]
-     */
-    protected static $_TMP_PACKS = array();
-
-
-    /**
-     * @return EED_Messages
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *  set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @since 4.5.0
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        // actions
-        add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
-        add_action(
-            'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-            array('EED_Messages', 'maybe_registration'),
-            10,
-            2
-        );
-        // filters
-        add_filter(
-            'FHEE__EE_Registration__receipt_url__receipt_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Registration__invoice_url__invoice_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-        // register routes
-        self::_register_routes();
-    }
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        // actions
-        add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
-        add_action(
-            'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
-            array('EED_Messages', 'payment_reminder'),
-            10
-        );
-        add_action(
-            'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-            array('EED_Messages', 'maybe_registration'),
-            10,
-            3
-        );
-        add_action(
-            'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
-            array('EED_Messages', 'send_newsletter_message'),
-            10,
-            2
-        );
-        add_action(
-            'AHEE__EES_Espresso_Cancelled__process_shortcode__transaction',
-            array('EED_Messages', 'cancelled_registration'),
-            10
-        );
-        add_action(
-            'AHEE__EE_Admin_Page___process_admin_payment_notification',
-            array('EED_Messages', 'process_admin_payment'),
-            10,
-            1
-        );
-        // filters
-        add_filter(
-            'FHEE__EE_Admin_Page___process_resend_registration__success',
-            array('EED_Messages', 'process_resend'),
-            10,
-            2
-        );
-        add_filter(
-            'FHEE__EE_Registration__receipt_url__receipt_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Registration__invoice_url__invoice_url',
-            array('EED_Messages', 'registration_message_trigger_url'),
-            10,
-            4
-        );
-    }
-
-
-    /**
-     * All the message triggers done by route go in here.
-     *
-     * @since 4.5.0
-     * @return void
-     */
-    protected static function _register_routes()
-    {
-        EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
-        EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
-        EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
-        EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
-        do_action('AHEE__EED_Messages___register_routes');
-    }
-
-
-    /**
-     * This is called when a browser display trigger is executed.
-     * The browser display trigger is typically used when a already generated message is displayed directly in the
-     * browser.
-     *
-     * @since 4.9.0
-     * @param WP $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function browser_trigger($WP)
-    {
-        // ensure controller is loaded
-        self::_load_controller();
-        $token = EE_Registry::instance()->REQ->get('token');
-        try {
-            $mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
-            self::$_MSG_PROCESSOR->generate_and_send_now($mtg);
-        } catch (EE_Error $e) {
-            $error_msg = __(
-                'Please note that a system message failed to send due to a technical issue.',
-                'event_espresso'
-            );
-            // add specific message for developers if WP_DEBUG in on
-            $error_msg .= '||' . $e->getMessage();
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     * This is called when a browser error trigger is executed.
-     * When triggered this will grab the EE_Message matching the token in the request and use that to get the error
-     * message and display it.
-     *
-     * @since 4.9.0
-     * @param $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function browser_error_trigger($WP)
-    {
-        $token = EE_Registry::instance()->REQ->get('token');
-        if ($token) {
-            $message = EEM_Message::instance()->get_one_by_token($token);
-            if ($message instanceof EE_Message) {
-                header('HTTP/1.1 200 OK');
-                $error_msg = nl2br($message->error_message());
-                ?>
+	/**
+	 * This holds the EE_messages controller
+	 *
+	 * @deprecated 4.9.0
+	 * @var EE_messages $_EEMSG
+	 */
+	protected static $_EEMSG;
+
+	/**
+	 * @type EE_Message_Resource_Manager $_message_resource_manager
+	 */
+	protected static $_message_resource_manager;
+
+	/**
+	 * This holds the EE_Messages_Processor business class.
+	 *
+	 * @type EE_Messages_Processor
+	 */
+	protected static $_MSG_PROCESSOR;
+
+	/**
+	 * holds all the paths for various messages components.
+	 * Utilized by autoloader registry
+	 *
+	 * @var array
+	 */
+	protected static $_MSG_PATHS;
+
+
+	/**
+	 * This will hold an array of messages template packs that are registered in the messages system.
+	 * Format is:
+	 * array(
+	 *    'template_pack_dbref' => EE_Messages_Template_Pack (instance)
+	 * )
+	 *
+	 * @var EE_Messages_Template_Pack[]
+	 */
+	protected static $_TMP_PACKS = array();
+
+
+	/**
+	 * @return EED_Messages
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *  set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @since 4.5.0
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		// actions
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
+		add_action(
+			'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+			array('EED_Messages', 'maybe_registration'),
+			10,
+			2
+		);
+		// filters
+		add_filter(
+			'FHEE__EE_Registration__receipt_url__receipt_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Registration__invoice_url__invoice_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+		// register routes
+		self::_register_routes();
+	}
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		// actions
+		add_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', array('EED_Messages', 'payment'), 10, 2);
+		add_action(
+			'AHEE__Transactions_Admin_Page___send_payment_reminder__process_admin_payment_reminder',
+			array('EED_Messages', 'payment_reminder'),
+			10
+		);
+		add_action(
+			'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+			array('EED_Messages', 'maybe_registration'),
+			10,
+			3
+		);
+		add_action(
+			'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
+			array('EED_Messages', 'send_newsletter_message'),
+			10,
+			2
+		);
+		add_action(
+			'AHEE__EES_Espresso_Cancelled__process_shortcode__transaction',
+			array('EED_Messages', 'cancelled_registration'),
+			10
+		);
+		add_action(
+			'AHEE__EE_Admin_Page___process_admin_payment_notification',
+			array('EED_Messages', 'process_admin_payment'),
+			10,
+			1
+		);
+		// filters
+		add_filter(
+			'FHEE__EE_Admin_Page___process_resend_registration__success',
+			array('EED_Messages', 'process_resend'),
+			10,
+			2
+		);
+		add_filter(
+			'FHEE__EE_Registration__receipt_url__receipt_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Registration__invoice_url__invoice_url',
+			array('EED_Messages', 'registration_message_trigger_url'),
+			10,
+			4
+		);
+	}
+
+
+	/**
+	 * All the message triggers done by route go in here.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 */
+	protected static function _register_routes()
+	{
+		EE_Config::register_route('msg_url_trigger', 'Messages', 'run');
+		EE_Config::register_route('msg_cron_trigger', 'Messages', 'execute_batch_request');
+		EE_Config::register_route('msg_browser_trigger', 'Messages', 'browser_trigger');
+		EE_Config::register_route('msg_browser_error_trigger', 'Messages', 'browser_error_trigger');
+		do_action('AHEE__EED_Messages___register_routes');
+	}
+
+
+	/**
+	 * This is called when a browser display trigger is executed.
+	 * The browser display trigger is typically used when a already generated message is displayed directly in the
+	 * browser.
+	 *
+	 * @since 4.9.0
+	 * @param WP $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function browser_trigger($WP)
+	{
+		// ensure controller is loaded
+		self::_load_controller();
+		$token = EE_Registry::instance()->REQ->get('token');
+		try {
+			$mtg = new EE_Message_Generated_From_Token($token, 'html', self::$_message_resource_manager);
+			self::$_MSG_PROCESSOR->generate_and_send_now($mtg);
+		} catch (EE_Error $e) {
+			$error_msg = __(
+				'Please note that a system message failed to send due to a technical issue.',
+				'event_espresso'
+			);
+			// add specific message for developers if WP_DEBUG in on
+			$error_msg .= '||' . $e->getMessage();
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * This is called when a browser error trigger is executed.
+	 * When triggered this will grab the EE_Message matching the token in the request and use that to get the error
+	 * message and display it.
+	 *
+	 * @since 4.9.0
+	 * @param $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function browser_error_trigger($WP)
+	{
+		$token = EE_Registry::instance()->REQ->get('token');
+		if ($token) {
+			$message = EEM_Message::instance()->get_one_by_token($token);
+			if ($message instanceof EE_Message) {
+				header('HTTP/1.1 200 OK');
+				$error_msg = nl2br($message->error_message());
+				?>
                 <!DOCTYPE html>
                 <html>
                 <head></head>
                 <body>
                 <?php echo empty($error_msg)
-                    ? esc_html__(
-                        'Unfortunately, we were unable to capture the error message for this message.',
-                        'event_espresso'
-                    )
-                    : wp_kses(
-                        $error_msg,
-                        array(
-                            'a'      => array(
-                                'href'  => array(),
-                                'title' => array(),
-                            ),
-                            'span'   => array(),
-                            'div'    => array(),
-                            'p'      => array(),
-                            'strong' => array(),
-                            'em'     => array(),
-                            'br'     => array(),
-                        )
-                    ); ?>
+					? esc_html__(
+						'Unfortunately, we were unable to capture the error message for this message.',
+						'event_espresso'
+					)
+					: wp_kses(
+						$error_msg,
+						array(
+							'a'      => array(
+								'href'  => array(),
+								'title' => array(),
+							),
+							'span'   => array(),
+							'div'    => array(),
+							'p'      => array(),
+							'strong' => array(),
+							'em'     => array(),
+							'br'     => array(),
+						)
+					); ?>
                 </body>
                 </html>
                 <?php
-                exit;
-            }
-        }
-        return;
-    }
-
-
-    /**
-     *  This runs when the msg_url_trigger route has initiated.
-     *
-     * @since 4.5.0
-     * @param WP $WP
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function run($WP)
-    {
-        // ensure controller is loaded
-        self::_load_controller();
-        // attempt to process message
-        try {
-            /** @type EE_Message_To_Generate_From_Request $message_to_generate */
-            $message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
-            self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
-        } catch (EE_Error $e) {
-            $error_msg = __(
-                'Please note that a system message failed to send due to a technical issue.',
-                'event_espresso'
-            );
-            // add specific message for developers if WP_DEBUG in on
-            $error_msg .= '||' . $e->getMessage();
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     * This is triggered by the 'msg_cron_trigger' route.
-     *
-     * @param WP $WP
-     */
-    public function execute_batch_request($WP)
-    {
-        $this->run_cron();
-        header('HTTP/1.1 200 OK');
-        exit();
-    }
-
-
-    /**
-     * This gets executed on wp_cron jobs or when a batch request is initiated on its own separate non regular wp
-     * request.
-     */
-    public function run_cron()
-    {
-        self::_load_controller();
-        // get required vars
-        $cron_type = EE_Registry::instance()->REQ->get('type');
-        $transient_key = EE_Registry::instance()->REQ->get('key');
-
-        // now let's verify transient, if not valid exit immediately
-        if (! get_transient($transient_key)) {
-            /**
-             * trigger error so this gets in the error logs.  This is important because it happens on a non-user
-             * request.
-             */
-            trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
-        }
-
-        // if made it here, lets' delete the transient to keep the db clean
-        delete_transient($transient_key);
-
-        if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
-            $method = 'batch_' . $cron_type . '_from_queue';
-            if (method_exists(self::$_MSG_PROCESSOR, $method)) {
-                self::$_MSG_PROCESSOR->$method();
-            } else {
-                // no matching task
-                /**
-                 * trigger error so this gets in the error logs.  This is important because it happens on a non user
-                 * request.
-                 */
-                trigger_error(
-                    esc_attr(
-                        sprintf(
-                            __('There is no task corresponding to this route %s', 'event_espresso'),
-                            $cron_type
-                        )
-                    )
-                );
-            }
-        }
-
-        do_action('FHEE__EED_Messages__run_cron__end');
-    }
-
-
-    /**
-     * This is used to retrieve the template pack for the given name.
-     * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then
-     * the default template pack is returned.
-     *
-     * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
-     * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used
-     *                                   in generating the Pack class name).
-     * @return EE_Messages_Template_Pack
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_template_pack($template_pack_name)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_template_pack($template_pack_name);
-    }
-
-
-    /**
-     * Retrieves an array of all template packs.
-     * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
-     *
-     * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
-     * @return EE_Messages_Template_Pack[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function get_template_packs()
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-
-        // for backward compat, let's make sure this returns in the same format as originally.
-        $template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
-        $template_pack_collection->rewind();
-        $template_packs = array();
-        while ($template_pack_collection->valid()) {
-            $template_packs[ $template_pack_collection->current()->dbref ] = $template_pack_collection->current();
-            $template_pack_collection->next();
-        }
-        return $template_packs;
-    }
-
-
-    /**
-     * This simply makes sure the autoloaders are registered for the EE_messages system.
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     */
-    public static function set_autoloaders()
-    {
-        if (empty(self::$_MSG_PATHS)) {
-            self::_set_messages_paths();
-            foreach (self::$_MSG_PATHS as $path) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
-            }
-            // add aliases
-            EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
-            EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
-        }
-    }
-
-
-    /**
-     * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
-     * for use by the Messages Autoloaders
-     *
-     * @since 4.5.0
-     * @return void.
-     */
-    protected static function _set_messages_paths()
-    {
-        $dir_ref = array(
-            'messages/message_type',
-            'messages/messenger',
-            'messages/defaults',
-            'messages/defaults/email',
-            'messages/data_class',
-            'messages/validators',
-            'messages/validators/email',
-            'messages/validators/html',
-            'shortcodes',
-        );
-        $paths = array();
-        foreach ($dir_ref as $index => $dir) {
-            $paths[ $index ] = EE_LIBRARIES . $dir;
-        }
-        self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
-    }
-
-
-    /**
-     * Takes care of loading dependencies
-     *
-     * @since 4.5.0
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _load_controller()
-    {
-        if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
-            EE_Registry::instance()->load_core('Request_Handler');
-            self::set_autoloaders();
-            self::$_EEMSG = EE_Registry::instance()->load_lib('messages');
-            self::$_MSG_PROCESSOR = EE_Registry::instance()->load_lib('Messages_Processor');
-            self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        }
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function payment_reminder(EE_Transaction $transaction)
-    {
-        self::_load_controller();
-        $data = array($transaction, null);
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
-    }
-
-
-    /**
-     * Any messages triggers for after successful gateway payments should go in here.
-     *
-     * @param EE_Transaction  $transaction object
-     * @param EE_Payment|null $payment     object
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function payment(EE_Transaction $transaction, EE_Payment $payment = null)
-    {
-        // if there's no payment object, then we cannot do a payment type message!
-        if (! $payment instanceof EE_Payment) {
-            return;
-        }
-        self::_load_controller();
-        $data = array($transaction, $payment);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        $message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
-        // if payment amount is less than 0 then switch to payment_refund message type.
-        $message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function cancelled_registration(EE_Transaction $transaction)
-    {
-        self::_load_controller();
-        $data = array($transaction, null);
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
-    }
-
-
-    /**
-     * Trigger for Registration messages
-     * Note that what registration message type is sent depends on what the reg status is for the registrations on the
-     * incoming transaction.
-     *
-     * @param EE_Registration $registration
-     * @param array           $extra_details
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     */
-    public static function maybe_registration(EE_Registration $registration, $extra_details = array())
-    {
-
-        if (! self::_verify_registration_notification_send($registration, $extra_details)) {
-            // no messages please
-            return;
-        }
-
-        // get all non-trashed registrations so we make sure we send messages for the right status.
-        $all_registrations = $registration->transaction()->registrations(
-            array(
-                array('REG_deleted' => false),
-                'order_by' => array(
-                    'Event.EVT_name'     => 'ASC',
-                    'Attendee.ATT_lname' => 'ASC',
-                    'Attendee.ATT_fname' => 'ASC',
-                ),
-            )
-        );
-        // cached array of statuses so we only trigger messages once per status.
-        $statuses_sent = array();
-        self::_load_controller();
-        $mtgs = array();
-
-        // loop through registrations and trigger messages once per status.
-        foreach ($all_registrations as $reg) {
-            // already triggered?
-            if (in_array($reg->status_ID(), $statuses_sent)) {
-                continue;
-            }
-
-            $message_type = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
-            $mtgs = array_merge(
-                $mtgs,
-                self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
-                    $message_type,
-                    array($registration->transaction(), null, $reg->status_ID())
-                )
-            );
-            $statuses_sent[] = $reg->status_ID();
-        }
-
-        if (count($statuses_sent) > 1) {
-            $mtgs = array_merge(
-                $mtgs,
-                self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
-                    'registration_summary',
-                    array($registration->transaction(), null)
-                )
-            );
-        }
-
-        // batch queue and initiate request
-        self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
-        self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
-    }
-
-
-    /**
-     * This is a helper method used to very whether a registration notification should be sent or
-     * not.  Prevents duplicate notifications going out for registration context notifications.
-     *
-     * @param EE_Registration $registration  [description]
-     * @param array           $extra_details [description]
-     * @return bool          true = send away, false = nope halt the presses.
-     */
-    protected static function _verify_registration_notification_send(
-        EE_Registration $registration,
-        $extra_details = array()
-    ) {
-        if (! $registration->is_primary_registrant()) {
-            return false;
-        }
-        // first we check if we're in admin and not doing front ajax
-        if (is_admin() && ! EE_FRONT_AJAX) {
-            // make sure appropriate admin params are set for sending messages
-            if (empty($_REQUEST['txn_reg_status_change']['send_notifications'])
-                || ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])
-            ) {
-                // no messages sent please.
-                return false;
-            }
-        } else {
-            // frontend request (either regular or via AJAX)
-            // TXN is NOT finalized ?
-            if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
-                return false;
-            }
-            // return visit but nothing changed ???
-            if (isset($extra_details['revisit'], $extra_details['status_updates']) &&
-                $extra_details['revisit'] && ! $extra_details['status_updates']
-            ) {
-                return false;
-            }
-            // NOT sending messages && reg status is something other than "Not-Approved"
-            if (! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
-                $registration->status_ID() !== EEM_Registration::status_id_not_approved
-            ) {
-                return false;
-            }
-        }
-        // release the kraken
-        return true;
-    }
-
-
-    /**
-     * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that
-     * status id.
-     *
-     * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
-     *                    or EEH_MSG_Template::convert_reg_status_to_message_type
-     * @param string $reg_status
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_reg_status_array($reg_status = '')
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
-            ? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
-            : EEH_MSG_Template::reg_status_to_message_type_array();
-    }
-
-
-    /**
-     * Simply returns the payment message type for the given payment status.
-     *
-     * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
-     *                   or EEH_MSG_Template::convert_payment_status_to_message_type
-     * @param string $payment_status The payment status being matched.
-     * @return bool|string The payment message type slug matching the status or false if no match.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected static function _get_payment_message_type($payment_status)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
-            ? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
-            : false;
-    }
-
-
-    /**
-     * Message triggers for a resending already sent message(s) (via EE_Message list table)
-     *
-     * @access public
-     * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function process_resend($req_data)
-    {
-        self::_load_controller();
-
-        // if $msgID in this request then skip to the new resend_message
-        if (EE_Registry::instance()->REQ->get('MSG_ID')) {
-            return self::resend_message();
-        }
-
-        // make sure any incoming request data is set on the REQ so that it gets picked up later.
-        $req_data = (array) $req_data;
-        foreach ($req_data as $request_key => $request_value) {
-            EE_Registry::instance()->REQ->set($request_key, $request_value);
-        }
-
-        if (! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request(
-        )) {
-            return false;
-        }
-
-        try {
-            self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
-            self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
-        } catch (EE_Error $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        EE_Error::add_success(
-            __('Messages have been successfully queued for generation and sending.', 'event_espresso')
-        );
-        return true; // everything got queued.
-    }
-
-
-    /**
-     * Message triggers for a resending already sent message(s) (via EE_Message list table)
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function resend_message()
-    {
-        self::_load_controller();
-
-        $msgID = EE_Registry::instance()->REQ->get('MSG_ID');
-        if (! $msgID) {
-            EE_Error::add_error(
-                __(
-                    'Something went wrong because there is no "MSG_ID" value in the request',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array) $msgID);
-
-        // setup success message.
-        $count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
-        EE_Error::add_success(
-            sprintf(
-                _n(
-                    'There was %d message queued for resending.',
-                    'There were %d messages queued for resending.',
-                    $count_ready_for_resend,
-                    'event_espresso'
-                ),
-                $count_ready_for_resend
-            )
-        );
-        return true;
-    }
-
-
-    /**
-     * Message triggers for manual payment applied by admin
-     *
-     * @param  EE_Payment $payment EE_payment object
-     * @return bool success/fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function process_admin_payment(EE_Payment $payment)
-    {
-        EE_Registry::instance()->load_helper('MSG_Template');
-        // we need to get the transaction object
-        $transaction = $payment->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            $data = array($transaction, $payment);
-            $message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
-
-            // if payment amount is less than 0 then switch to payment_refund message type.
-            $message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
-
-            // if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
-            $message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved
-                ? false : $message_type;
-
-            self::_load_controller();
-
-            self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
-
-            // get count of queued for generation
-            $count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
-                array(
-                    EEM_Message::status_incomplete,
-                    EEM_Message::status_idle,
-                )
-            );
-
-            if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
-                add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
-                return true;
-            } else {
-                $count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
-                    EEM_Message::instance()->stati_indicating_failed_sending()
-                );
-                /**
-                 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
-                 * IMMEDIATE generation.
-                 */
-                if ($count_failed > 0) {
-                    EE_Error::add_error(
-                        sprintf(
-                            _n(
-                                'The payment notification generation failed.',
-                                '%d payment notifications failed being sent.',
-                                $count_failed,
-                                'event_espresso'
-                            ),
-                            $count_failed
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-
-                    return false;
-                } else {
-                    add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
-                    return true;
-                }
-            }
-        } else {
-            EE_Error::add_error(
-                'Unable to generate the payment notification because the given value for the transaction is invalid.',
-                'event_espresso'
-            );
-            return false;
-        }
-    }
-
-
-    /**
-     * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
-     *
-     * @since   4.3.0
-     * @param  EE_Registration[] $registrations an array of EE_Registration objects
-     * @param  int               $grp_id        a specific message template group id.
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function send_newsletter_message($registrations, $grp_id)
-    {
-        // make sure mtp is id and set it in the EE_Request Handler later messages setup.
-        EE_Registry::instance()->REQ->set('GRP_ID', (int) $grp_id);
-        self::_load_controller();
-        self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
-    }
-
-
-    /**
-     * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
-     *
-     * @since   4.3.0
-     * @param    string          $registration_message_trigger_url
-     * @param    EE_Registration $registration
-     * @param string             $messenger
-     * @param string             $message_type
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function registration_message_trigger_url(
-        $registration_message_trigger_url,
-        EE_Registration $registration,
-        $messenger = 'html',
-        $message_type = 'invoice'
-    ) {
-        // whitelist $messenger
-        switch ($messenger) {
-            case 'pdf':
-                $sending_messenger = 'pdf';
-                $generating_messenger = 'html';
-                break;
-            case 'html':
-            default:
-                $sending_messenger = 'html';
-                $generating_messenger = 'html';
-                break;
-        }
-        // whitelist $message_type
-        switch ($message_type) {
-            case 'receipt':
-                $message_type = 'receipt';
-                break;
-            case 'invoice':
-            default:
-                $message_type = 'invoice';
-                break;
-        }
-        // verify that both the messenger AND the message type are active
-        if (EEH_MSG_Template::is_messenger_active($sending_messenger)
-            && EEH_MSG_Template::is_mt_active($message_type)
-        ) {
-            // need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
-            $template_query_params = array(
-                'MTP_is_active'    => true,
-                'MTP_messenger'    => $generating_messenger,
-                'MTP_message_type' => $message_type,
-                'Event.EVT_ID'     => $registration->event_ID(),
-            );
-            // get the message template group.
-            $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
-            // if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
-                // remove EVT_ID from query params so that global templates get picked up
-                unset($template_query_params['Event.EVT_ID']);
-                // get global template as the fallback
-                $msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
-            }
-            // if we don't have an EE_Message_Template_Group then return
-            if (! $msg_template_group instanceof EE_Message_Template_Group) {
-                return '';
-            }
-            // generate the URL
-            $registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
-                $sending_messenger,
-                $generating_messenger,
-                'purchaser',
-                $message_type,
-                $registration,
-                $msg_template_group->ID(),
-                $registration->transaction_ID()
-            );
-        }
-        return $registration_message_trigger_url;
-    }
-
-
-    /**
-     * Use to generate and return a message preview!
-     *
-     * @param  string $type      This should correspond with a valid message type
-     * @param  string $context   This should correspond with a valid context for the message type
-     * @param  string $messenger This should correspond with a valid messenger.
-     * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
-     *                           preview
-     * @return bool|string The body of the message or if send is requested, sends.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function preview_message($type, $context, $messenger, $send = false)
-    {
-        self::_load_controller();
-        $mtg = new EE_Message_To_Generate(
-            $messenger,
-            $type,
-            array(),
-            $context,
-            true
-        );
-        $generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
-        if ($generated_preview_queue instanceof EE_Messages_Queue) {
-            // loop through all content for the preview and remove any persisted records.
-            $content = '';
-            foreach ($generated_preview_queue->get_message_repository() as $message) {
-                $content = $message->content();
-                if ($message->ID() > 0 && $message->STS_ID() !== EEM_Message::status_failed) {
-                    $message->delete();
-                }
-            }
-            return $content;
-        } else {
-            return $generated_preview_queue;
-        }
-    }
-
-
-    /**
-     * This is a method that allows for sending a message using a messenger matching the string given and the provided
-     * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the
-     * content found in the EE_Message objects in the queue.
-     *
-     * @since 4.9.0
-     * @param string            $messenger            a string matching a valid active messenger in the system
-     * @param string            $message_type         Although it seems contrary to the name of the method, a message
-     *                                                type name is still required to send along the message type to the
-     *                                                messenger because this is used for determining what specific
-     *                                                variations might be loaded for the generated message.
-     * @param EE_Messages_Queue $queue
-     * @param string            $custom_subject       Can be used to set what the custom subject string will be on the
-     *                                                aggregate EE_Message object.
-     * @return bool success or fail.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function send_message_with_messenger_only(
-        $messenger,
-        $message_type,
-        EE_Messages_Queue $queue,
-        $custom_subject = ''
-    ) {
-        self::_load_controller();
-        /** @type EE_Message_To_Generate_From_Queue $message_to_generate */
-        $message_to_generate = EE_Registry::instance()->load_lib(
-            'Message_To_Generate_From_Queue',
-            array(
-                $messenger,
-                $message_type,
-                $queue,
-                $custom_subject,
-            )
-        );
-        return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
-    }
-
-
-    /**
-     * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
-     *
-     * @since 4.9.0
-     * @param array $message_ids An array of message ids
-     * @return bool|EE_Messages_Queue false if nothing was generated, EE_Messages_Queue containing generated
-     *                           messages.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function generate_now($message_ids)
-    {
-        self::_load_controller();
-        $messages = EEM_Message::instance()->get_all(
-            array(
-                0 => array(
-                    'MSG_ID' => array('IN', $message_ids),
-                    'STS_ID' => EEM_Message::status_incomplete,
-                ),
-            )
-        );
-        $generated_queue = false;
-        if ($messages) {
-            $generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
-        }
-
-        if (! $generated_queue instanceof EE_Messages_Queue) {
-            EE_Error::add_error(
-                __(
-                    'The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $generated_queue;
-    }
-
-
-    /**
-     * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
-     * EEM_Message::status_idle
-     *
-     * @since 4.9.0
-     * @param $message_ids
-     * @return bool|EE_Messages_Queue false if no messages sent.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function send_now($message_ids)
-    {
-        self::_load_controller();
-        $messages = EEM_Message::instance()->get_all(
-            array(
-                0 => array(
-                    'MSG_ID' => array('IN', $message_ids),
-                    'STS_ID' => array(
-                        'IN',
-                        array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry),
-                    ),
-                ),
-            )
-        );
-        $sent_queue = false;
-        if ($messages) {
-            $sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
-        }
-
-        if (! $sent_queue instanceof EE_Messages_Queue) {
-            EE_Error::add_error(
-                __(
-                    'The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            // can count how many sent by using the messages in the queue
-            $sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
-            if ($sent_count > 0) {
-                EE_Error::add_success(
-                    sprintf(
-                        _n(
-                            'There was %d message successfully sent.',
-                            'There were %d messages successfully sent.',
-                            $sent_count,
-                            'event_espresso'
-                        ),
-                        $sent_count
-                    )
-                );
-            } else {
-                EE_Error::overwrite_errors();
-                EE_Error::add_error(
-                    __(
-                        'No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
+				exit;
+			}
+		}
+		return;
+	}
+
+
+	/**
+	 *  This runs when the msg_url_trigger route has initiated.
+	 *
+	 * @since 4.5.0
+	 * @param WP $WP
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function run($WP)
+	{
+		// ensure controller is loaded
+		self::_load_controller();
+		// attempt to process message
+		try {
+			/** @type EE_Message_To_Generate_From_Request $message_to_generate */
+			$message_to_generate = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+			self::$_MSG_PROCESSOR->generate_and_send_now($message_to_generate);
+		} catch (EE_Error $e) {
+			$error_msg = __(
+				'Please note that a system message failed to send due to a technical issue.',
+				'event_espresso'
+			);
+			// add specific message for developers if WP_DEBUG in on
+			$error_msg .= '||' . $e->getMessage();
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * This is triggered by the 'msg_cron_trigger' route.
+	 *
+	 * @param WP $WP
+	 */
+	public function execute_batch_request($WP)
+	{
+		$this->run_cron();
+		header('HTTP/1.1 200 OK');
+		exit();
+	}
+
+
+	/**
+	 * This gets executed on wp_cron jobs or when a batch request is initiated on its own separate non regular wp
+	 * request.
+	 */
+	public function run_cron()
+	{
+		self::_load_controller();
+		// get required vars
+		$cron_type = EE_Registry::instance()->REQ->get('type');
+		$transient_key = EE_Registry::instance()->REQ->get('key');
+
+		// now let's verify transient, if not valid exit immediately
+		if (! get_transient($transient_key)) {
+			/**
+			 * trigger error so this gets in the error logs.  This is important because it happens on a non-user
+			 * request.
+			 */
+			trigger_error(esc_attr__('Invalid Request (Transient does not exist)', 'event_espresso'));
+		}
+
+		// if made it here, lets' delete the transient to keep the db clean
+		delete_transient($transient_key);
+
+		if (apply_filters('FHEE__EED_Messages__run_cron__use_wp_cron', true)) {
+			$method = 'batch_' . $cron_type . '_from_queue';
+			if (method_exists(self::$_MSG_PROCESSOR, $method)) {
+				self::$_MSG_PROCESSOR->$method();
+			} else {
+				// no matching task
+				/**
+				 * trigger error so this gets in the error logs.  This is important because it happens on a non user
+				 * request.
+				 */
+				trigger_error(
+					esc_attr(
+						sprintf(
+							__('There is no task corresponding to this route %s', 'event_espresso'),
+							$cron_type
+						)
+					)
+				);
+			}
+		}
+
+		do_action('FHEE__EED_Messages__run_cron__end');
+	}
+
+
+	/**
+	 * This is used to retrieve the template pack for the given name.
+	 * Retrieved packs are cached on the static $_TMP_PACKS array.  If there is no class matching the given name then
+	 * the default template pack is returned.
+	 *
+	 * @deprecated 4.9.0  @see EEH_MSG_Template::get_template_pack()
+	 * @param string $template_pack_name This should correspond to the dbref of the template pack (which is also used
+	 *                                   in generating the Pack class name).
+	 * @return EE_Messages_Template_Pack
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_template_pack($template_pack_name)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_template_pack($template_pack_name);
+	}
+
+
+	/**
+	 * Retrieves an array of all template packs.
+	 * Array is in the format array( 'dbref' => EE_Messages_Template_Pack )
+	 *
+	 * @deprecated 4.9.0  @see EEH_MSG_Template_Pack::get_template_pack_collection
+	 * @return EE_Messages_Template_Pack[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function get_template_packs()
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+
+		// for backward compat, let's make sure this returns in the same format as originally.
+		$template_pack_collection = EEH_MSG_Template::get_template_pack_collection();
+		$template_pack_collection->rewind();
+		$template_packs = array();
+		while ($template_pack_collection->valid()) {
+			$template_packs[ $template_pack_collection->current()->dbref ] = $template_pack_collection->current();
+			$template_pack_collection->next();
+		}
+		return $template_packs;
+	}
+
+
+	/**
+	 * This simply makes sure the autoloaders are registered for the EE_messages system.
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function set_autoloaders()
+	{
+		if (empty(self::$_MSG_PATHS)) {
+			self::_set_messages_paths();
+			foreach (self::$_MSG_PATHS as $path) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($path);
+			}
+			// add aliases
+			EEH_Autoloader::add_alias('EE_messages', 'EE_messages');
+			EEH_Autoloader::add_alias('EE_messenger', 'EE_messenger');
+		}
+	}
+
+
+	/**
+	 * Take care of adding all the paths for the messages components to the $_MSG_PATHS property
+	 * for use by the Messages Autoloaders
+	 *
+	 * @since 4.5.0
+	 * @return void.
+	 */
+	protected static function _set_messages_paths()
+	{
+		$dir_ref = array(
+			'messages/message_type',
+			'messages/messenger',
+			'messages/defaults',
+			'messages/defaults/email',
+			'messages/data_class',
+			'messages/validators',
+			'messages/validators/email',
+			'messages/validators/html',
+			'shortcodes',
+		);
+		$paths = array();
+		foreach ($dir_ref as $index => $dir) {
+			$paths[ $index ] = EE_LIBRARIES . $dir;
+		}
+		self::$_MSG_PATHS = apply_filters('FHEE__EED_Messages___set_messages_paths___MSG_PATHS', $paths);
+	}
+
+
+	/**
+	 * Takes care of loading dependencies
+	 *
+	 * @since 4.5.0
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _load_controller()
+	{
+		if (! self::$_MSG_PROCESSOR instanceof EE_Messages_Processor) {
+			EE_Registry::instance()->load_core('Request_Handler');
+			self::set_autoloaders();
+			self::$_EEMSG = EE_Registry::instance()->load_lib('messages');
+			self::$_MSG_PROCESSOR = EE_Registry::instance()->load_lib('Messages_Processor');
+			self::$_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		}
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function payment_reminder(EE_Transaction $transaction)
+	{
+		self::_load_controller();
+		$data = array($transaction, null);
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('payment_reminder', $data);
+	}
+
+
+	/**
+	 * Any messages triggers for after successful gateway payments should go in here.
+	 *
+	 * @param EE_Transaction  $transaction object
+	 * @param EE_Payment|null $payment     object
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function payment(EE_Transaction $transaction, EE_Payment $payment = null)
+	{
+		// if there's no payment object, then we cannot do a payment type message!
+		if (! $payment instanceof EE_Payment) {
+			return;
+		}
+		self::_load_controller();
+		$data = array($transaction, $payment);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
+		// if payment amount is less than 0 then switch to payment_refund message type.
+		$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function cancelled_registration(EE_Transaction $transaction)
+	{
+		self::_load_controller();
+		$data = array($transaction, null);
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('cancelled_registration', $data);
+	}
+
+
+	/**
+	 * Trigger for Registration messages
+	 * Note that what registration message type is sent depends on what the reg status is for the registrations on the
+	 * incoming transaction.
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $extra_details
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 */
+	public static function maybe_registration(EE_Registration $registration, $extra_details = array())
+	{
+
+		if (! self::_verify_registration_notification_send($registration, $extra_details)) {
+			// no messages please
+			return;
+		}
+
+		// get all non-trashed registrations so we make sure we send messages for the right status.
+		$all_registrations = $registration->transaction()->registrations(
+			array(
+				array('REG_deleted' => false),
+				'order_by' => array(
+					'Event.EVT_name'     => 'ASC',
+					'Attendee.ATT_lname' => 'ASC',
+					'Attendee.ATT_fname' => 'ASC',
+				),
+			)
+		);
+		// cached array of statuses so we only trigger messages once per status.
+		$statuses_sent = array();
+		self::_load_controller();
+		$mtgs = array();
+
+		// loop through registrations and trigger messages once per status.
+		foreach ($all_registrations as $reg) {
+			// already triggered?
+			if (in_array($reg->status_ID(), $statuses_sent)) {
+				continue;
+			}
+
+			$message_type = EEH_MSG_Template::convert_reg_status_to_message_type($reg->status_ID());
+			$mtgs = array_merge(
+				$mtgs,
+				self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
+					$message_type,
+					array($registration->transaction(), null, $reg->status_ID())
+				)
+			);
+			$statuses_sent[] = $reg->status_ID();
+		}
+
+		if (count($statuses_sent) > 1) {
+			$mtgs = array_merge(
+				$mtgs,
+				self::$_MSG_PROCESSOR->setup_mtgs_for_all_active_messengers(
+					'registration_summary',
+					array($registration->transaction(), null)
+				)
+			);
+		}
+
+		// batch queue and initiate request
+		self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($mtgs);
+		self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
+	}
+
+
+	/**
+	 * This is a helper method used to very whether a registration notification should be sent or
+	 * not.  Prevents duplicate notifications going out for registration context notifications.
+	 *
+	 * @param EE_Registration $registration  [description]
+	 * @param array           $extra_details [description]
+	 * @return bool          true = send away, false = nope halt the presses.
+	 */
+	protected static function _verify_registration_notification_send(
+		EE_Registration $registration,
+		$extra_details = array()
+	) {
+		if (! $registration->is_primary_registrant()) {
+			return false;
+		}
+		// first we check if we're in admin and not doing front ajax
+		if (is_admin() && ! EE_FRONT_AJAX) {
+			// make sure appropriate admin params are set for sending messages
+			if (empty($_REQUEST['txn_reg_status_change']['send_notifications'])
+				|| ! absint($_REQUEST['txn_reg_status_change']['send_notifications'])
+			) {
+				// no messages sent please.
+				return false;
+			}
+		} else {
+			// frontend request (either regular or via AJAX)
+			// TXN is NOT finalized ?
+			if (! isset($extra_details['finalized']) || $extra_details['finalized'] === false) {
+				return false;
+			}
+			// return visit but nothing changed ???
+			if (isset($extra_details['revisit'], $extra_details['status_updates']) &&
+				$extra_details['revisit'] && ! $extra_details['status_updates']
+			) {
+				return false;
+			}
+			// NOT sending messages && reg status is something other than "Not-Approved"
+			if (! apply_filters('FHEE__EED_Messages___maybe_registration__deliver_notifications', false) &&
+				$registration->status_ID() !== EEM_Registration::status_id_not_approved
+			) {
+				return false;
+			}
+		}
+		// release the kraken
+		return true;
+	}
+
+
+	/**
+	 * Simply returns an array indexed by Registration Status ID and the related message_type name associated with that
+	 * status id.
+	 *
+	 * @deprecated 4.9.0  Use EEH_MSG_Template::reg_status_to_message_type_array()
+	 *                    or EEH_MSG_Template::convert_reg_status_to_message_type
+	 * @param string $reg_status
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_reg_status_array($reg_status = '')
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
+			? EEH_MSG_Template::convert_reg_status_to_message_type($reg_status)
+			: EEH_MSG_Template::reg_status_to_message_type_array();
+	}
+
+
+	/**
+	 * Simply returns the payment message type for the given payment status.
+	 *
+	 * @deprecated 4.9.0 Use EEH_MSG_Template::payment_status_to_message_type_array
+	 *                   or EEH_MSG_Template::convert_payment_status_to_message_type
+	 * @param string $payment_status The payment status being matched.
+	 * @return bool|string The payment message type slug matching the status or false if no match.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected static function _get_payment_message_type($payment_status)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
+			? EEH_MSG_Template::convert_payment_status_to_message_type($payment_status)
+			: false;
+	}
+
+
+	/**
+	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
+	 *
+	 * @access public
+	 * @param array $req_data This is the $_POST & $_GET data sent from EE_Admin Pages
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function process_resend($req_data)
+	{
+		self::_load_controller();
+
+		// if $msgID in this request then skip to the new resend_message
+		if (EE_Registry::instance()->REQ->get('MSG_ID')) {
+			return self::resend_message();
+		}
+
+		// make sure any incoming request data is set on the REQ so that it gets picked up later.
+		$req_data = (array) $req_data;
+		foreach ($req_data as $request_key => $request_value) {
+			EE_Registry::instance()->REQ->set($request_key, $request_value);
+		}
+
+		if (! $messages_to_send = self::$_MSG_PROCESSOR->setup_messages_to_generate_from_registration_ids_in_request(
+		)) {
+			return false;
+		}
+
+		try {
+			self::$_MSG_PROCESSOR->batch_queue_for_generation_and_persist($messages_to_send);
+			self::$_MSG_PROCESSOR->get_queue()->initiate_request_by_priority();
+		} catch (EE_Error $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		EE_Error::add_success(
+			__('Messages have been successfully queued for generation and sending.', 'event_espresso')
+		);
+		return true; // everything got queued.
+	}
+
+
+	/**
+	 * Message triggers for a resending already sent message(s) (via EE_Message list table)
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function resend_message()
+	{
+		self::_load_controller();
+
+		$msgID = EE_Registry::instance()->REQ->get('MSG_ID');
+		if (! $msgID) {
+			EE_Error::add_error(
+				__(
+					'Something went wrong because there is no "MSG_ID" value in the request',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send((array) $msgID);
+
+		// setup success message.
+		$count_ready_for_resend = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
+		EE_Error::add_success(
+			sprintf(
+				_n(
+					'There was %d message queued for resending.',
+					'There were %d messages queued for resending.',
+					$count_ready_for_resend,
+					'event_espresso'
+				),
+				$count_ready_for_resend
+			)
+		);
+		return true;
+	}
+
+
+	/**
+	 * Message triggers for manual payment applied by admin
+	 *
+	 * @param  EE_Payment $payment EE_payment object
+	 * @return bool success/fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function process_admin_payment(EE_Payment $payment)
+	{
+		EE_Registry::instance()->load_helper('MSG_Template');
+		// we need to get the transaction object
+		$transaction = $payment->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			$data = array($transaction, $payment);
+			$message_type = EEH_MSG_Template::convert_payment_status_to_message_type($payment->STS_ID());
+
+			// if payment amount is less than 0 then switch to payment_refund message type.
+			$message_type = $payment->amount() < 0 ? 'payment_refund' : $message_type;
+
+			// if payment_refund is selected, but the status is NOT accepted.  Then change message type to false so NO message notification goes out.
+			$message_type = $message_type == 'payment_refund' && $payment->STS_ID() != EEM_Payment::status_id_approved
+				? false : $message_type;
+
+			self::_load_controller();
+
+			self::$_MSG_PROCESSOR->generate_for_all_active_messengers($message_type, $data);
+
+			// get count of queued for generation
+			$count_to_generate = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
+				array(
+					EEM_Message::status_incomplete,
+					EEM_Message::status_idle,
+				)
+			);
+
+			if ($count_to_generate > 0 && self::$_MSG_PROCESSOR->get_queue()->get_message_repository()->count() !== 0) {
+				add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
+				return true;
+			} else {
+				$count_failed = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(
+					EEM_Message::instance()->stati_indicating_failed_sending()
+				);
+				/**
+				 * Verify that there are actually errors.  If not then we return a success message because the queue might have been emptied due to successful
+				 * IMMEDIATE generation.
+				 */
+				if ($count_failed > 0) {
+					EE_Error::add_error(
+						sprintf(
+							_n(
+								'The payment notification generation failed.',
+								'%d payment notifications failed being sent.',
+								$count_failed,
+								'event_espresso'
+							),
+							$count_failed
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+
+					return false;
+				} else {
+					add_filter('FHEE__EE_Admin_Page___process_admin_payment_notification__success', '__return_true');
+					return true;
+				}
+			}
+		} else {
+			EE_Error::add_error(
+				'Unable to generate the payment notification because the given value for the transaction is invalid.',
+				'event_espresso'
+			);
+			return false;
+		}
+	}
+
+
+	/**
+	 * Callback for AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send_with_registrations trigger
+	 *
+	 * @since   4.3.0
+	 * @param  EE_Registration[] $registrations an array of EE_Registration objects
+	 * @param  int               $grp_id        a specific message template group id.
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function send_newsletter_message($registrations, $grp_id)
+	{
+		// make sure mtp is id and set it in the EE_Request Handler later messages setup.
+		EE_Registry::instance()->REQ->set('GRP_ID', (int) $grp_id);
+		self::_load_controller();
+		self::$_MSG_PROCESSOR->generate_for_all_active_messengers('newsletter', $registrations);
+	}
+
+
+	/**
+	 * Callback for FHEE__EE_Registration__invoice_url__invoice_url or FHEE__EE_Registration__receipt_url__receipt_url
+	 *
+	 * @since   4.3.0
+	 * @param    string          $registration_message_trigger_url
+	 * @param    EE_Registration $registration
+	 * @param string             $messenger
+	 * @param string             $message_type
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function registration_message_trigger_url(
+		$registration_message_trigger_url,
+		EE_Registration $registration,
+		$messenger = 'html',
+		$message_type = 'invoice'
+	) {
+		// whitelist $messenger
+		switch ($messenger) {
+			case 'pdf':
+				$sending_messenger = 'pdf';
+				$generating_messenger = 'html';
+				break;
+			case 'html':
+			default:
+				$sending_messenger = 'html';
+				$generating_messenger = 'html';
+				break;
+		}
+		// whitelist $message_type
+		switch ($message_type) {
+			case 'receipt':
+				$message_type = 'receipt';
+				break;
+			case 'invoice':
+			default:
+				$message_type = 'invoice';
+				break;
+		}
+		// verify that both the messenger AND the message type are active
+		if (EEH_MSG_Template::is_messenger_active($sending_messenger)
+			&& EEH_MSG_Template::is_mt_active($message_type)
+		) {
+			// need to get the correct message template group for this (i.e. is there a custom invoice for the event this registration is registered for?)
+			$template_query_params = array(
+				'MTP_is_active'    => true,
+				'MTP_messenger'    => $generating_messenger,
+				'MTP_message_type' => $message_type,
+				'Event.EVT_ID'     => $registration->event_ID(),
+			);
+			// get the message template group.
+			$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
+			// if we don't have an EE_Message_Template_Group then return
+			if (! $msg_template_group instanceof EE_Message_Template_Group) {
+				// remove EVT_ID from query params so that global templates get picked up
+				unset($template_query_params['Event.EVT_ID']);
+				// get global template as the fallback
+				$msg_template_group = EEM_Message_Template_Group::instance()->get_one(array($template_query_params));
+			}
+			// if we don't have an EE_Message_Template_Group then return
+			if (! $msg_template_group instanceof EE_Message_Template_Group) {
+				return '';
+			}
+			// generate the URL
+			$registration_message_trigger_url = EEH_MSG_Template::generate_url_trigger(
+				$sending_messenger,
+				$generating_messenger,
+				'purchaser',
+				$message_type,
+				$registration,
+				$msg_template_group->ID(),
+				$registration->transaction_ID()
+			);
+		}
+		return $registration_message_trigger_url;
+	}
+
+
+	/**
+	 * Use to generate and return a message preview!
+	 *
+	 * @param  string $type      This should correspond with a valid message type
+	 * @param  string $context   This should correspond with a valid context for the message type
+	 * @param  string $messenger This should correspond with a valid messenger.
+	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
+	 *                           preview
+	 * @return bool|string The body of the message or if send is requested, sends.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function preview_message($type, $context, $messenger, $send = false)
+	{
+		self::_load_controller();
+		$mtg = new EE_Message_To_Generate(
+			$messenger,
+			$type,
+			array(),
+			$context,
+			true
+		);
+		$generated_preview_queue = self::$_MSG_PROCESSOR->generate_for_preview($mtg, $send);
+		if ($generated_preview_queue instanceof EE_Messages_Queue) {
+			// loop through all content for the preview and remove any persisted records.
+			$content = '';
+			foreach ($generated_preview_queue->get_message_repository() as $message) {
+				$content = $message->content();
+				if ($message->ID() > 0 && $message->STS_ID() !== EEM_Message::status_failed) {
+					$message->delete();
+				}
+			}
+			return $content;
+		} else {
+			return $generated_preview_queue;
+		}
+	}
+
+
+	/**
+	 * This is a method that allows for sending a message using a messenger matching the string given and the provided
+	 * EE_Message_Queue object.  The EE_Message_Queue object is used to create a single aggregate EE_Message via the
+	 * content found in the EE_Message objects in the queue.
+	 *
+	 * @since 4.9.0
+	 * @param string            $messenger            a string matching a valid active messenger in the system
+	 * @param string            $message_type         Although it seems contrary to the name of the method, a message
+	 *                                                type name is still required to send along the message type to the
+	 *                                                messenger because this is used for determining what specific
+	 *                                                variations might be loaded for the generated message.
+	 * @param EE_Messages_Queue $queue
+	 * @param string            $custom_subject       Can be used to set what the custom subject string will be on the
+	 *                                                aggregate EE_Message object.
+	 * @return bool success or fail.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function send_message_with_messenger_only(
+		$messenger,
+		$message_type,
+		EE_Messages_Queue $queue,
+		$custom_subject = ''
+	) {
+		self::_load_controller();
+		/** @type EE_Message_To_Generate_From_Queue $message_to_generate */
+		$message_to_generate = EE_Registry::instance()->load_lib(
+			'Message_To_Generate_From_Queue',
+			array(
+				$messenger,
+				$message_type,
+				$queue,
+				$custom_subject,
+			)
+		);
+		return self::$_MSG_PROCESSOR->queue_for_sending($message_to_generate);
+	}
+
+
+	/**
+	 * Generates Messages immediately for EE_Message IDs (but only for the correct status for generation)
+	 *
+	 * @since 4.9.0
+	 * @param array $message_ids An array of message ids
+	 * @return bool|EE_Messages_Queue false if nothing was generated, EE_Messages_Queue containing generated
+	 *                           messages.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function generate_now($message_ids)
+	{
+		self::_load_controller();
+		$messages = EEM_Message::instance()->get_all(
+			array(
+				0 => array(
+					'MSG_ID' => array('IN', $message_ids),
+					'STS_ID' => EEM_Message::status_incomplete,
+				),
+			)
+		);
+		$generated_queue = false;
+		if ($messages) {
+			$generated_queue = self::$_MSG_PROCESSOR->batch_generate_from_queue($messages);
+		}
+
+		if (! $generated_queue instanceof EE_Messages_Queue) {
+			EE_Error::add_error(
+				__(
+					'The messages were not generated. This could mean there is already a batch being generated on a separate request, or because the selected messages are not ready for generation. Please wait a minute or two and try again.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $generated_queue;
+	}
+
+
+	/**
+	 * Sends messages immediately for the incoming message_ids that have the status of EEM_Message::status_resend or,
+	 * EEM_Message::status_idle
+	 *
+	 * @since 4.9.0
+	 * @param $message_ids
+	 * @return bool|EE_Messages_Queue false if no messages sent.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function send_now($message_ids)
+	{
+		self::_load_controller();
+		$messages = EEM_Message::instance()->get_all(
+			array(
+				0 => array(
+					'MSG_ID' => array('IN', $message_ids),
+					'STS_ID' => array(
+						'IN',
+						array(EEM_Message::status_idle, EEM_Message::status_resend, EEM_Message::status_retry),
+					),
+				),
+			)
+		);
+		$sent_queue = false;
+		if ($messages) {
+			$sent_queue = self::$_MSG_PROCESSOR->batch_send_from_queue($messages);
+		}
+
+		if (! $sent_queue instanceof EE_Messages_Queue) {
+			EE_Error::add_error(
+				__(
+					'The messages were not sent. This could mean there is already a batch being sent on a separate request, or because the selected messages are not sendable. Please wait a minute or two and try again.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			// can count how many sent by using the messages in the queue
+			$sent_count = $sent_queue->count_STS_in_queue(EEM_Message::instance()->stati_indicating_sent());
+			if ($sent_count > 0) {
+				EE_Error::add_success(
+					sprintf(
+						_n(
+							'There was %d message successfully sent.',
+							'There were %d messages successfully sent.',
+							$sent_count,
+							'event_espresso'
+						),
+						$sent_count
+					)
+				);
+			} else {
+				EE_Error::overwrite_errors();
+				EE_Error::add_error(
+					__(
+						'No message was sent because of problems with sending. Either all the messages you selected were not a sendable message, they were ALREADY sent on a different scheduled task, or there was an error.
 					If there was an error, you can look at the messages in the message activity list table for any error messages.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return $sent_queue;
-    }
-
-
-    /**
-     * Generate and send immediately from the given $message_ids
-     *
-     * @param array $message_ids EE_Message entity ids.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function generate_and_send_now(array $message_ids)
-    {
-        $generated_queue = self::generate_now($message_ids);
-        // now let's just trigger sending immediately from this queue.
-        $messages_sent = $generated_queue instanceof EE_Messages_Queue
-            ? $generated_queue->execute()
-            : 0;
-        if ($messages_sent) {
-            EE_Error::add_success(
-                esc_html(
-                    sprintf(
-                        _n(
-                            'There was %d message successfully generated and sent.',
-                            'There were %d messages successfully generated and sent.',
-                            $messages_sent,
-                            'event_espresso'
-                        ),
-                        $messages_sent
-                    )
-                )
-            );
-            // errors would be added via the generate_now method.
-        }
-    }
-
-
-    /**
-     * This will queue the incoming message ids for resending.
-     * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
-     *
-     * @since 4.9.0
-     * @param array $message_ids An array of EE_Message IDs
-     * @return bool true means messages were successfully queued for resending, false means none were queued for
-     *                           resending.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function queue_for_resending($message_ids)
-    {
-        self::_load_controller();
-        self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
-
-        // get queue and count
-        $queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
-
-        if ($queue_count > 0
-        ) {
-            EE_Error::add_success(
-                sprintf(
-                    _n(
-                        '%d message successfully queued for resending.',
-                        '%d messages successfully queued for resending.',
-                        $queue_count,
-                        'event_espresso'
-                    ),
-                    $queue_count
-                )
-            );
-            /**
-             * @see filter usage in EE_Messages_Queue::initiate_request_by_priority
-             */
-        } elseif (apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', true)
-            || EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
-        ) {
-            $queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_sent);
-            if ($queue_count > 0) {
-                EE_Error::add_success(
-                    sprintf(
-                        _n(
-                            '%d message successfully sent.',
-                            '%d messages successfully sent.',
-                            $queue_count,
-                            'event_espresso'
-                        ),
-                        $queue_count
-                    )
-                );
-            } else {
-                EE_Error::add_error(
-                    __(
-                        'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                __(
-                    'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return (bool) $queue_count;
-    }
-
-
-    /**
-     * debug
-     *
-     * @param string          $class
-     * @param string          $func
-     * @param string          $line
-     * @param \EE_Transaction $transaction
-     * @param array           $info
-     * @param bool            $display_request
-     * @throws EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-     */
-    protected static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        EE_Transaction $transaction,
-        $info = array(),
-        $display_request = false
-    ) {
-        if (defined('EE_DEBUG') && EE_DEBUG) {
-            if ($transaction instanceof EE_Transaction) {
-                // don't serialize objects
-                $info = EEH_Debug_Tools::strip_objects($info);
-                $info['TXN_status'] = $transaction->status_ID();
-                $info['TXN_reg_steps'] = $transaction->reg_steps();
-                if ($transaction->ID()) {
-                    $index = 'EE_Transaction: ' . $transaction->ID();
-                    EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
-                }
-            }
-        }
-    }
-
-
-    /**
-     *  Resets all the static properties in this class when called.
-     */
-    public static function reset()
-    {
-        self::$_EEMSG = null;
-        self::$_message_resource_manager = null;
-        self::$_MSG_PROCESSOR = null;
-        self::$_MSG_PATHS = null;
-        self::$_TMP_PACKS = array();
-    }
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return $sent_queue;
+	}
+
+
+	/**
+	 * Generate and send immediately from the given $message_ids
+	 *
+	 * @param array $message_ids EE_Message entity ids.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function generate_and_send_now(array $message_ids)
+	{
+		$generated_queue = self::generate_now($message_ids);
+		// now let's just trigger sending immediately from this queue.
+		$messages_sent = $generated_queue instanceof EE_Messages_Queue
+			? $generated_queue->execute()
+			: 0;
+		if ($messages_sent) {
+			EE_Error::add_success(
+				esc_html(
+					sprintf(
+						_n(
+							'There was %d message successfully generated and sent.',
+							'There were %d messages successfully generated and sent.',
+							$messages_sent,
+							'event_espresso'
+						),
+						$messages_sent
+					)
+				)
+			);
+			// errors would be added via the generate_now method.
+		}
+	}
+
+
+	/**
+	 * This will queue the incoming message ids for resending.
+	 * Note, only message_ids corresponding to messages with the status of EEM_Message::sent will be queued.
+	 *
+	 * @since 4.9.0
+	 * @param array $message_ids An array of EE_Message IDs
+	 * @return bool true means messages were successfully queued for resending, false means none were queued for
+	 *                           resending.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function queue_for_resending($message_ids)
+	{
+		self::_load_controller();
+		self::$_MSG_PROCESSOR->setup_messages_from_ids_and_send($message_ids);
+
+		// get queue and count
+		$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_resend);
+
+		if ($queue_count > 0
+		) {
+			EE_Error::add_success(
+				sprintf(
+					_n(
+						'%d message successfully queued for resending.',
+						'%d messages successfully queued for resending.',
+						$queue_count,
+						'event_espresso'
+					),
+					$queue_count
+				)
+			);
+			/**
+			 * @see filter usage in EE_Messages_Queue::initiate_request_by_priority
+			 */
+		} elseif (apply_filters('FHEE__EE_Messages_Processor__initiate_request_by_priority__do_immediate_processing', true)
+			|| EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request
+		) {
+			$queue_count = self::$_MSG_PROCESSOR->get_queue()->count_STS_in_queue(EEM_Message::status_sent);
+			if ($queue_count > 0) {
+				EE_Error::add_success(
+					sprintf(
+						_n(
+							'%d message successfully sent.',
+							'%d messages successfully sent.',
+							$queue_count,
+							'event_espresso'
+						),
+						$queue_count
+					)
+				);
+			} else {
+				EE_Error::add_error(
+					__(
+						'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				__(
+					'No messages were queued for resending. This usually only happens when all the messages flagged for resending are not a status that can be resent.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return (bool) $queue_count;
+	}
+
+
+	/**
+	 * debug
+	 *
+	 * @param string          $class
+	 * @param string          $func
+	 * @param string          $line
+	 * @param \EE_Transaction $transaction
+	 * @param array           $info
+	 * @param bool            $display_request
+	 * @throws EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	 */
+	protected static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		EE_Transaction $transaction,
+		$info = array(),
+		$display_request = false
+	) {
+		if (defined('EE_DEBUG') && EE_DEBUG) {
+			if ($transaction instanceof EE_Transaction) {
+				// don't serialize objects
+				$info = EEH_Debug_Tools::strip_objects($info);
+				$info['TXN_status'] = $transaction->status_ID();
+				$info['TXN_reg_steps'] = $transaction->reg_steps();
+				if ($transaction->ID()) {
+					$index = 'EE_Transaction: ' . $transaction->ID();
+					EEH_Debug_Tools::log($class, $func, $line, $info, $display_request, $index);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *  Resets all the static properties in this class when called.
+	 */
+	public static function reset()
+	{
+		self::$_EEMSG = null;
+		self::$_message_resource_manager = null;
+		self::$_MSG_PROCESSOR = null;
+		self::$_MSG_PATHS = null;
+		self::$_TMP_PACKS = array();
+	}
 }

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.68.rc.006');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.68.rc.006');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }