eventespresso / event-espresso-core

core/EE_Deprecated.core.php

Spacing +178 added lines, -178 removed lines

@@ -4,8 +4,8 @@ 
 use EventEspresso\core\interfaces\InterminableInterface;
 use EventEspresso\core\services\licensing\LicenseService;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 /**
  * ************************************************************************
@@ -48,8 +48,8 @@ 
 	$action_or_filter = 'action'
 ) {
 	$action_or_filter = $action_or_filter === 'action'
-		? esc_html__( 'action', 'event_espresso' )
-		: esc_html__( 'filter', 'event_espresso' );
+		? esc_html__('action', 'event_espresso')
+		: esc_html__('filter', 'event_espresso');
 	EE_Error::doing_it_wrong(
 		$deprecated_filter,
 		sprintf(
@@ -73,7 +73,7 @@ 
  * @param \EE_Checkout $checkout
  * @return string
  */
-function ee_deprecated__registration_checkout__button_text( $submit_button_text, EE_Checkout $checkout ) {
+function ee_deprecated__registration_checkout__button_text($submit_button_text, EE_Checkout $checkout) {
 	// list of old filters
 	$deprecated_filters = array(
 		'update_registration_details' => true,
@@ -83,16 +83,16 @@ 
 		'proceed_to' => true,
 	);
 	// loop thru and call doing_it_wrong() or remove any that aren't being used
-	foreach ( $deprecated_filters as $deprecated_filter => $on ) {
+	foreach ($deprecated_filters as $deprecated_filter => $on) {
 		// was this filter called ?
-		if ( has_action( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter )) {
+		if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter)) {
 			// only display doing_it_wrong() notice to Event Admins during non-AJAX requests
-			if ( EE_Registry::instance()->CAP->current_user_can( 'ee_read_ee', 'hide_doing_it_wrong_for_deprecated_SPCO_filter' ) && ! defined( 'DOING_AJAX' ) ) {
+			if (EE_Registry::instance()->CAP->current_user_can('ee_read_ee', 'hide_doing_it_wrong_for_deprecated_SPCO_filter') && ! defined('DOING_AJAX')) {
 				EE_Error::doing_it_wrong(
-					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter,
 					sprintf(
-						__( 'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', 'event_espresso' ),
-						'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+						__('The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"', 'event_espresso'),
+						'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__'.$deprecated_filter,
 						'<br />',
 						'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
 						'/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
@@ -101,24 +101,24 @@ 
 				);
 			}
 		} else {
-			unset( $deprecated_filters[ $deprecated_filter ] );
+			unset($deprecated_filters[$deprecated_filter]);
 		}
 	}
-	if ( ! empty( $deprecated_filters )) {
-
-		if ( $checkout->current_step->slug() == 'attendee_information' && $checkout->revisit && isset( $deprecated_filters[ 'update_registration_details' ] )) {
-			$submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details', $submit_button_text );
-		} else if ( $checkout->current_step->slug() == 'payment_options' && $checkout->revisit && isset( $deprecated_filters[ 'process_payment' ] ) ) {
-			$submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment', $submit_button_text );
-		} else if ( $checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug() == 'finalize_registration' && isset( $deprecated_filters[ 'finalize_registration' ] ) ) {
-			$submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration', $submit_button_text );
+	if ( ! empty($deprecated_filters)) {
+
+		if ($checkout->current_step->slug() == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
+			$submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details', $submit_button_text);
+		} else if ($checkout->current_step->slug() == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) {
+			$submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment', $submit_button_text);
+		} else if ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug() == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) {
+			$submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration', $submit_button_text);
 		}
-		if ( $checkout->next_step instanceof EE_SPCO_Reg_Step ) {
-			if ( $checkout->payment_required() && $checkout->next_step->slug() == 'payment_options' && isset( $deprecated_filters[ 'and_proceed_to_payment' ] ) ) {
-				$submit_button_text .= apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment', $submit_button_text );
+		if ($checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($checkout->payment_required() && $checkout->next_step->slug() == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) {
+				$submit_button_text .= apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment', $submit_button_text);
 			}
-			if ( $checkout->next_step->slug() != 'finalize_registration' && ! $checkout->revisit && isset( $deprecated_filters[ 'proceed_to' ] ) ) {
-				$submit_button_text = apply_filters( 'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', $submit_button_text ) . $checkout->next_step->name();
+			if ($checkout->next_step->slug() != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) {
+				$submit_button_text = apply_filters('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to', $submit_button_text).$checkout->next_step->name();
 			}
 		}
 
@@ -126,7 +126,7 @@ 
 	return $submit_button_text;
 
 }
-add_filter( 'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', 'ee_deprecated__registration_checkout__button_text', 10, 2 );
+add_filter('FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text', 'ee_deprecated__registration_checkout__button_text', 10, 2);
 
 
 
@@ -137,16 +137,16 @@ 
  * @param \EE_Checkout $checkout
  * @param boolean $status_updates
  */
-function ee_deprecated_finalize_transaction( EE_Checkout $checkout, $status_updates ) {
+function ee_deprecated_finalize_transaction(EE_Checkout $checkout, $status_updates) {
 	$action_ref = NULL;
-	$action_ref = has_action( 'AHEE__EE_Transaction__finalize__new_transaction' ) ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
-	$action_ref = has_action( 'AHEE__EE_Transaction__finalize__all_transaction' ) ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
-	if ( $action_ref ) {
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction') ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction') ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
+	if ($action_ref) {
 
 		EE_Error::doing_it_wrong(
 			$action_ref,
 			sprintf(
-				__( 'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"', 'event_espresso' ),
+				__('This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"', 'event_espresso'),
 				'<br />',
 				'/core/business/EE_Transaction_Processor.class.php',
 				'AHEE__EE_Transaction_Processor__finalize',
@@ -156,39 +156,39 @@ 
 			),
 			'4.6.0'
 		);
-		switch ( $action_ref ) {
+		switch ($action_ref) {
 			case 'AHEE__EE_Transaction__finalize__new_transaction' :
-				do_action( 'AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, $checkout->admin_request );
+				do_action('AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, $checkout->admin_request);
 				break;
 			case 'AHEE__EE_Transaction__finalize__all_transaction' :
-				do_action( 'AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, array( 'new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates ), $checkout->admin_request );
+				do_action('AHEE__EE_Transaction__finalize__new_transaction', $checkout->transaction, array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates), $checkout->admin_request);
 				break;
 		}
 	}
 }
-add_action( 'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', 'ee_deprecated_finalize_transaction', 10, 2 );
+add_action('AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed', 'ee_deprecated_finalize_transaction', 10, 2);
 /**
  * ee_deprecated_finalize_registration
  *
  * @param EE_Registration $registration
  */
-function ee_deprecated_finalize_registration( EE_Registration $registration ) {
-	$action_ref = has_action( 'AHEE__EE_Registration__finalize__update_and_new_reg' ) ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : NULL;
-	if ( $action_ref ) {
+function ee_deprecated_finalize_registration(EE_Registration $registration) {
+	$action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg') ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : NULL;
+	if ($action_ref) {
 		EE_Error::doing_it_wrong(
 			$action_ref,
 			sprintf(
-				__( 'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"', 'event_espresso' ),
+				__('This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"', 'event_espresso'),
 				'<br />',
 				'/core/business/EE_Registration_Processor.class.php',
 				'AHEE__EE_Registration_Processor__trigger_registration_status_changed_hook'
 			),
 			'4.6.0'
 		);
-		do_action( 'AHEE__EE_Registration__finalize__update_and_new_reg', $registration, ( is_admin() && ! ( defined( 'DOING_AJAX' ) && DOING_AJAX )));
+		do_action('AHEE__EE_Registration__finalize__update_and_new_reg', $registration, (is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX)));
 	}
 }
-add_action( 'AHEE__EE_Registration_Processor__trigger_registration_update_notifications', 'ee_deprecated_finalize_registration', 10, 1 );
+add_action('AHEE__EE_Registration_Processor__trigger_registration_update_notifications', 'ee_deprecated_finalize_registration', 10, 1);
 
 
 
@@ -196,7 +196,7 @@ 
  * Called after EED_Module::set_hooks() and EED_Module::set_admin_hooks() was called.
  * Checks if any deprecated hooks were hooked-into and provide doing_it_wrong messages appropriately.
  */
-function ee_deprecated_hooks(){
+function ee_deprecated_hooks() {
 	/**
 	 * @var $hooks array where keys are hook names, and their values are array{
 	 *			@type string $version  when deprecated
@@ -207,25 +207,25 @@ 
 	$hooks = array(
 		'AHEE__EE_System___do_setup_validations' => array(
 			'version' => '4.6.0',
-			'alternative' => __( 'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)', 'event_espresso' ),
+			'alternative' => __('Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)', 'event_espresso'),
 			'still_works' => FALSE
 		)
 	);
-	foreach( $hooks as $name => $deprecation_info ){
-		if( has_action( $name ) ){
+	foreach ($hooks as $name => $deprecation_info) {
+		if (has_action($name)) {
 			EE_Error::doing_it_wrong(
 				$name,
 				sprintf(
-					__('This filter is deprecated. %1$s%2$s','event_espresso'),
-					$deprecation_info[ 'still_works' ] ?  __('It *may* work as an attempt to build in backwards compatibility.', 'event_espresso') : __( 'It has been completely removed.', 'event_espresso' ),
-					isset( $deprecation_info[ 'alternative' ] ) ? $deprecation_info[ 'alternative' ] : __( 'Please read the current EE4 documentation further or contact Support.', 'event_espresso' )
+					__('This filter is deprecated. %1$s%2$s', 'event_espresso'),
+					$deprecation_info['still_works'] ?  __('It *may* work as an attempt to build in backwards compatibility.', 'event_espresso') : __('It has been completely removed.', 'event_espresso'),
+					isset($deprecation_info['alternative']) ? $deprecation_info['alternative'] : __('Please read the current EE4 documentation further or contact Support.', 'event_espresso')
 				),
-				isset( $deprecation_info[ 'version' ] ) ? $deprecation_info[ 'version' ] : __( 'recently', 'event_espresso' )
+				isset($deprecation_info['version']) ? $deprecation_info['version'] : __('recently', 'event_espresso')
 			);
 		}
 	}
 }
-add_action( 'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks' );
+add_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks');
 
 
 
@@ -236,9 +236,9 @@ 
  * @return boolean
  */
 function ee_deprecated_using_old_registration_admin_custom_questions_form_hooks() {
-	$in_use =  has_filter( 'FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns' )
-			|| has_action( 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save' );
-	if( $in_use ) {
+	$in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns')
+			|| has_action('AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save');
+	if ($in_use) {
 		$msg = __(
 			'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.'
 			. 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,'
@@ -247,18 +247,18 @@ 
 			'event_espresso' )
 		;
 		EE_Error::doing_it_wrong(
-			__CLASS__ . '::' . __FUNCTION__,
+			__CLASS__.'::'.__FUNCTION__,
 			$msg,
 			'4.8.32.rc.000'
 		);
 		//it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed
-		if ( is_admin() && ! defined( 'DOING_AJAX' ) ) {
-			EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ );
+		if (is_admin() && ! defined('DOING_AJAX')) {
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
 		}
 	}
 	return $in_use;
 }
-add_action( 'AHEE__Registrations_Admin_Page___registration_details_metabox__start', 'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks' );
+add_action('AHEE__Registrations_Admin_Page___registration_details_metabox__start', 'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks');
 
 /**
  * @deprecated since 4.8.32.rc.000 because it has issues on https://events.codebasehq.com/projects/event-espresso/tickets/9165
@@ -267,34 +267,34 @@ 
  * @param EE_Admin_Page $admin_page
  * @return void
  */
-function ee_deprecated_update_attendee_registration_form_old( $admin_page ) {
+function ee_deprecated_update_attendee_registration_form_old($admin_page) {
 	//check if the old hooks are in use. If not, do the default
-	if( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-		|| ! $admin_page instanceof EE_Admin_Page ) {
+	if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
 		return;
 	}
 	$req_data = $admin_page->get_request_data();
-	$qstns = isset( $req_data['qstn'] ) ? $req_data['qstn'] : FALSE;
-	$REG_ID = isset( $req_data['_REG_ID'] ) ? absint( $req_data['_REG_ID'] ) : FALSE;
-	$qstns = apply_filters( 'FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns );
-	if ( ! $REG_ID || ! $qstns ) {
-		EE_Error::add_error( __('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__ );
+	$qstns = isset($req_data['qstn']) ? $req_data['qstn'] : FALSE;
+	$REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : FALSE;
+	$qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
+	if ( ! $REG_ID || ! $qstns) {
+		EE_Error::add_error(__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 	}
 	$success = TRUE;
 
 	// allow others to get in on this awesome fun   :D
-	do_action( 'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save', $REG_ID, $qstns );
+	do_action('AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save', $REG_ID, $qstns);
 	// loop thru questions... FINALLY!!!
 
-	foreach ( $qstns as $QST_ID => $qstn ) {
+	foreach ($qstns as $QST_ID => $qstn) {
 		//if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
-		if ( !is_array($qstn) ) {
-			$success = $this->_save_new_answer( $REG_ID, $QST_ID, $qstn);
+		if ( ! is_array($qstn)) {
+			$success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn);
 			continue;
 		}
 
 
-		foreach ( $qstn as $ANS_ID => $ANS_value ) {
+		foreach ($qstn as $ANS_ID => $ANS_value) {
 			//get answer
 			$query_params = array(
 				0 => array(
@@ -305,7 +305,7 @@ 
 				);
 			$answer = EEM_Answer::instance()->get_one($query_params);
 			//this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
-			if ( ! $answer instanceof EE_Answer ) {
+			if ( ! $answer instanceof EE_Answer) {
 				$set_values = array(
 					'QST_ID' => $QST_ID,
 					'REG_ID' => $REG_ID,
@@ -320,11 +320,11 @@ 
 		}
 	}
 	$what = __('Registration Form', 'event_espresso');
-	$route = $REG_ID ? array( 'action' => 'view_registration', '_REG_ID' => $REG_ID ) : array( 'action' => 'default' );
-	$admin_page->redirect_after_action( $success, $what, __('updated', 'event_espresso'), $route );
+	$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default');
+	$admin_page->redirect_after_action($success, $what, __('updated', 'event_espresso'), $route);
 	exit;
 }
-add_action( 'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', 'ee_deprecated_update_attendee_registration_form_old', 10, 1 );
+add_action('AHEE__Registrations_Admin_Page___update_attendee_registration_form__start', 'ee_deprecated_update_attendee_registration_form_old', 10, 1);
 /**
  * Render the registration admin page's custom questions area in the old fashion
  * and firing the old hooks. When this method is removed, we can probably also
@@ -337,31 +337,31 @@ 
  * @return bool
  * @throws \EE_Error
  */
-function ee_deprecated_reg_questions_meta_box_old( $do_default_action, $admin_page, $registration ) {
+function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration) {
 	//check if the old hooks are in use. If not, do the default
-	if( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-		|| ! $admin_page instanceof EE_Admin_Page ) {
+	if ( ! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
 		return $do_default_action;
 	}
-	add_filter( 'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', array( $admin_page, 'form_before_question_group' ), 10, 1 );
-	add_filter( 'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', array( $admin_page, 'form_after_question_group' ), 10, 1 );
-	add_filter( 'FHEE__EEH_Form_Fields__label_html', array( $admin_page, 'form_form_field_label_wrap' ), 10, 1 );
-	add_filter( 'FHEE__EEH_Form_Fields__input_html', array( $admin_page, 'form_form_field_input__wrap' ), 10, 1 );
+	add_filter('FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions', array($admin_page, 'form_before_question_group'), 10, 1);
+	add_filter('FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions', array($admin_page, 'form_after_question_group'), 10, 1);
+	add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1);
+	add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1);
 
-	$question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options( $registration, $registration->get('EVT_ID') );
+	$question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options($registration, $registration->get('EVT_ID'));
 
-	EE_Registry::instance()->load_helper( 'Form_Fields' );
+	EE_Registry::instance()->load_helper('Form_Fields');
 	$template_args = array(
-		'att_questions' => EEH_Form_Fields::generate_question_groups_html( $question_groups ),
+		'att_questions' => EEH_Form_Fields::generate_question_groups_html($question_groups),
 		'reg_questions_form_action' => 'edit_registration',
 		'REG_ID' => $registration->ID()
 	);
-	$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-	echo EEH_Template::display_template( $template_path, $template_args, TRUE );
+	$template_path = REG_TEMPLATE_PATH.'reg_admin_details_main_meta_box_reg_questions.template.php';
+	echo EEH_Template::display_template($template_path, $template_args, TRUE);
 	//indicate that we should not do the default admin page code
 	return false;
 }
-add_action( 'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', 'ee_deprecated_reg_questions_meta_box_old', 10, 3 );
+add_action('FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default', 'ee_deprecated_reg_questions_meta_box_old', 10, 3);
 
 
 
@@ -402,9 +402,9 @@ 
 			'4.9.0'
 		);
 		/** @var EE_Message_Resource_Manager $message_resource_manager */
-		$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
-		$messenger = $message_resource_manager->get_messenger( $messenger_name );
-		$message_type = $message_resource_manager->get_message_type( $message_type_name );
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $message_resource_manager->get_messenger($messenger_name);
+		$message_type = $message_resource_manager->get_message_type($message_type_name);
 		return EE_Registry::instance()->load_lib(
 			'Messages_Template_Defaults',
 			array(
@@ -469,15 +469,15 @@ 
 	/**
 	 * @param string $method
 	 */
-	public function _class_is_deprecated( $method ) {
+	public function _class_is_deprecated($method) {
 		EE_Error::doing_it_wrong(
-			'EE_messages::' . $method,
-			__( 'EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.' ),
+			'EE_messages::'.$method,
+			__('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
 			'4.9.0',
 			'4.10.0.p'
 		);
 		// Please use EE_Message_Resource_Manager instead
-		$this->_message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 	}
 
 
@@ -487,10 +487,10 @@ 
 	 * @param string $messenger_name
 	 * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
 	 */
-	public function ensure_messenger_is_active( $messenger_name ) {
+	public function ensure_messenger_is_active($messenger_name) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->ensure_messenger_is_active( $messenger_name );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name);
 	}
 
 
@@ -502,10 +502,10 @@ 
 	 * @return bool true if it got activated (or was active) and false if not.
 	 * @throws \EE_Error
 	 */
-	public function ensure_message_type_is_active( $message_type, $messenger ) {
+	public function ensure_message_type_is_active($message_type, $messenger) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->ensure_message_type_is_active( $message_type, $messenger );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger);
 	}
 
 
@@ -518,10 +518,10 @@ 
 	 *                                            they are already setup.)
 	 * @return boolean an array of generated templates or false if nothing generated/activated.
 	 */
-	public function activate_messenger( $messenger_name, $mts_to_activate = array() ) {
+	public function activate_messenger($messenger_name, $mts_to_activate = array()) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->activate_messenger( $messenger_name, $mts_to_activate );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate);
 	}
 
 
@@ -533,10 +533,10 @@ 
 	 *
 	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
 	 */
-	public function is_generating_messenger_and_active( EE_messenger $messenger, EE_message_type $message_type ) {
+	public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->is_generating_messenger_and_active( $messenger, $message_type );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type);
 	}
 
 
@@ -546,10 +546,10 @@ 
 	 * @param string $messenger
 	 * @return EE_messenger | null
 	 */
-	public function get_messenger_if_active( $messenger ) {
+	public function get_messenger_if_active($messenger) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->get_active_messenger( $messenger );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_messenger($messenger);
 	}
 
 
@@ -570,9 +570,9 @@ 
 	 *                  'message_type' => null
 	 *                  )
 	 */
-	public function validate_for_use( EE_Message $message ) {
+	public function validate_for_use(EE_Message $message) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return array(
 			'messenger'    => $message->messenger_object(),
 			'message_type' => $message->message_type_object(),
@@ -600,41 +600,41 @@ 
 		$send = true
 	) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		/** @type EE_Messages_Processor $processor */
-		$processor = EE_Registry::instance()->load_lib( 'Messages_Processor' );
+		$processor = EE_Registry::instance()->load_lib('Messages_Processor');
 		$error = false;
 		//try to intelligently determine what method we'll call based on the incoming data.
 		//if generating and sending are different then generate and send immediately.
-		if ( ! empty( $sending_messenger ) && $sending_messenger != $generating_messenger && $send ) {
+		if ( ! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
 			//in the legacy system, when generating and sending were different, that means all the
 			//vars are already in the request object.  So let's just use that.
 			try {
 				/** @type EE_Message_To_Generate_From_Request $mtg */
-				$mtg = EE_Registry::instance()->load_lib( 'Message_To_Generate_From_Request' );
-				$processor->generate_and_send_now( $mtg );
-			} catch ( EE_Error $e ) {
+				$mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+				$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__ );
+				$error_msg .= '||'.$e->getMessage();
+				EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
 				$error = true;
 			}
 		} else {
-			$processor->generate_for_all_active_messengers( $type, $vars, $send );
+			$processor->generate_for_all_active_messengers($type, $vars, $send);
 			//let's find out if there were any errors and how many successfully were queued.
 			$count_errors = $processor->get_queue()->count_STS_in_queue(
-				array( EEM_Message::status_failed, EEM_Message::status_debug_only )
+				array(EEM_Message::status_failed, EEM_Message::status_debug_only)
 			);
-			$count_queued = $processor->get_queue()->count_STS_in_queue( EEM_Message::status_incomplete );
-			$count_retry = $processor->get_queue()->count_STS_in_queue( EEM_Message::status_retry );
+			$count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete);
+			$count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry);
 			$count_errors = $count_errors + $count_retry;
-			if ( $count_errors > 0 ) {
+			if ($count_errors > 0) {
 				$error = true;
-				if ( $count_errors > 1 && $count_retry > 1 && $count_queued > 1 ) {
+				if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) {
 					$message = sprintf(
 						__(
 							'There were %d errors and %d messages successfully queued for generation and sending',
@@ -643,7 +643,7 @@ 
 						$count_errors,
 						$count_queued
 					);
-				} elseif ( $count_errors > 1 && $count_queued === 1 ) {
+				} elseif ($count_errors > 1 && $count_queued === 1) {
 					$message = sprintf(
 						__(
 							'There were %d errors and %d message successfully queued for generation.',
@@ -652,7 +652,7 @@ 
 						$count_errors,
 						$count_queued
 					);
-				} elseif ( $count_errors === 1 && $count_queued > 1 ) {
+				} elseif ($count_errors === 1 && $count_queued > 1) {
 					$message = sprintf(
 						__(
 							'There was %d error and %d messages successfully queued for generation.',
@@ -670,9 +670,9 @@ 
 						$count_errors
 					);
 				}
-				EE_Error::add_error( $message, __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__);
 			} else {
-				if ( $count_queued === 1 ) {
+				if ($count_queued === 1) {
 					$message = sprintf(
 						__(
 							'%d message successfully queued for generation.',
@@ -689,18 +689,18 @@ 
 						$count_queued
 					);
 				}
-				EE_Error::add_success( $message );
+				EE_Error::add_success($message);
 			}
 		}
 		//if no error then return the generated message(s).
-		if ( ! $error && ! $send ) {
-			$generated_queue = $processor->generate_queue( false );
+		if ( ! $error && ! $send) {
+			$generated_queue = $processor->generate_queue(false);
 			//get message and return.
 			$generated_queue->get_message_repository()->rewind();
 			$messages = array();
-			while ( $generated_queue->get_message_repository()->valid() ) {
+			while ($generated_queue->get_message_repository()->valid()) {
 				$message = $generated_queue->get_message_repository()->current();
-				if ( $message instanceof EE_Message ) {
+				if ($message instanceof EE_Message) {
 					//set properties that might be expected by add-ons (backward compat)
 					$message->content = $message->content();
 					$message->template_pack = $message->get_template_pack();
@@ -725,10 +725,10 @@ 
 	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular preview
 	 * @return string          The body of the message.
 	 */
-	public function preview_message( $type, $context, $messenger, $send = false ) {
+	public function preview_message($type, $context, $messenger, $send = false) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return EED_Messages::preview_message( $type, $context, $messenger, $send );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return EED_Messages::preview_message($type, $context, $messenger, $send);
 	}
 
 
@@ -742,14 +742,14 @@ 
 	 *
 	 * @return bool          success or fail.
 	 */
-	public function send_message_with_messenger_only( $messenger, $message_type, $message ) {
+	public function send_message_with_messenger_only($messenger, $message_type, $message) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		//setup for sending to new method.
 		/** @type EE_Messages_Queue $queue */
-		$queue = EE_Registry::instance()->load_lib( 'Messages_Queue' );
+		$queue = EE_Registry::instance()->load_lib('Messages_Queue');
 		//make sure we have a proper message object
-		if ( ! $message instanceof EE_Message && is_object( $message ) && isset( $message->content ) ) {
+		if ( ! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
 			$msg = EE_Message_Factory::create(
 				array(
 					'MSG_messenger'    => $messenger,
@@ -761,15 +761,15 @@ 
 		} else {
 			$msg = $message;
 		}
-		if ( ! $msg instanceof EE_Message ) {
+		if ( ! $msg instanceof EE_Message) {
 			return false;
 		}
 		//make sure any content in a content property (if not empty) is set on the MSG_content.
-		if ( ! empty( $msg->content ) ) {
-			$msg->set( 'MSG_content', $msg->content );
+		if ( ! empty($msg->content)) {
+			$msg->set('MSG_content', $msg->content);
 		}
-		$queue->add( $msg );
-		return EED_Messages::send_message_with_messenger_only( $messenger, $message_type, $queue );
+		$queue->add($msg);
+		return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue);
 	}
 
 
@@ -783,11 +783,11 @@ 
 	 * @return array|object if creation is successful then we return an array of info, otherwise an error_object is returned.
 	 * @throws \EE_Error
 	 */
-	public function create_new_templates( $messenger, $message_type, $GRP_ID = 0, $is_global = false ) {
+	public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		return EEH_MSG_Template::create_new_templates( $messenger, $message_type, $GRP_ID, $is_global );
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global);
 	}
 
 
@@ -798,11 +798,11 @@ 
 	 * @param  string $message_type_name name of EE_message_type
 	 * @return array
 	 */
-	public function get_fields( $messenger_name, $message_type_name ) {
+	public function get_fields($messenger_name, $message_type_name) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		EE_Registry::instance()->load_helper( 'MSG_Template' );
-		return EEH_MSG_Template::get_fields( $messenger_name, $message_type_name );
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_fields($messenger_name, $message_type_name);
 	}
 
 
@@ -816,13 +816,13 @@ 
 	 * @return array                    multidimensional array of messenger and message_type objects
 	 *                                    (messengers index, and message_type index);
 	 */
-	public function get_installed( $type = 'all', $skip_cache = false ) {
+	public function get_installed($type = 'all', $skip_cache = false) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		if ( $skip_cache ) {
+		$this->_class_is_deprecated(__FUNCTION__);
+		if ($skip_cache) {
 			$this->_message_resource_manager->reset_active_messengers_and_message_types();
 		}
-		switch ( $type ) {
+		switch ($type) {
 			case 'messengers' :
 				return array(
 					'messenger' => $this->_message_resource_manager->installed_messengers(),
@@ -851,7 +851,7 @@ 
 	 */
 	public function get_active_messengers() {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return $this->_message_resource_manager->active_messengers();
 	}
 
@@ -863,7 +863,7 @@ 
 	 */
 	public function get_active_message_types() {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return $this->_message_resource_manager->list_of_active_message_types();
 	}
 
@@ -875,7 +875,7 @@ 
 	 */
 	public function get_active_message_type_objects() {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return $this->_message_resource_manager->get_active_message_type_objects();
 	}
 
@@ -887,10 +887,10 @@ 
 	 * @param string $messenger The messenger being checked
 	 * @return EE_message_type[]    (or empty array if none present)
 	 */
-	public function get_active_message_types_per_messenger( $messenger ) {
+	public function get_active_message_types_per_messenger($messenger) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->get_active_message_types_for_messenger( $messenger );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger);
 	}
 
 
@@ -901,10 +901,10 @@ 
 	 * @param string $message_type The string should correspond to a message type.
 	 * @return EE_message_type|null
 	 */
-	public function get_active_message_type( $messenger, $message_type ) {
+	public function get_active_message_type($messenger, $message_type) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->get_active_message_type_for_messenger( $messenger, $message_type );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type);
 	}
 
 
@@ -915,7 +915,7 @@ 
 	 */
 	public function get_installed_message_types() {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return $this->_message_resource_manager->installed_message_types();
 	}
 
@@ -927,7 +927,7 @@ 
 	 */
 	public function get_installed_messengers() {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
+		$this->_class_is_deprecated(__FUNCTION__);
 		return $this->_message_resource_manager->installed_messengers();
 	}
 
@@ -938,10 +938,10 @@ 
 	 * @param   bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by message type.
 	 * @return array
 	 */
-	public function get_all_contexts( $slugs_only = true ) {
+	public function get_all_contexts($slugs_only = true) {
 		// EE_messages has been deprecated
-		$this->_class_is_deprecated( __FUNCTION__ );
-		return $this->_message_resource_manager->get_all_contexts( $slugs_only );
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_all_contexts($slugs_only);
 	}
 
 
@@ -1000,7 +1000,7 @@ 
 add_filter(
 	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
 	function($event_list_iframe_css) {
-		if ( ! has_filter( 'FHEE__EventsArchiveIframe__event_list_iframe__css' )) {
+		if ( ! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
 			return $event_list_iframe_css;
 		}
 		deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1020,7 +1020,7 @@ 
 add_filter(
 	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
 	function($event_list_iframe_js) {
-		if ( ! has_filter( 'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js' )) {
+		if ( ! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
 			return $event_list_iframe_js;
 		}
 		deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1040,7 +1040,7 @@ 
 add_action(
 	'AHEE__EE_Capabilities__addCaps__complete',
 	function($capabilities_map) {
-		if ( ! has_action( 'AHEE__EE_Capabilities__init_role_caps__complete' )) {
+		if ( ! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
 			return;
 		}
 		deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1060,7 +1060,7 @@ 
 add_filter(
 	'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
 	function($existing_attendee, $registration, $attendee_data) {
-		if ( ! has_filter( 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee' )) {
+		if ( ! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) {
 			return $existing_attendee;
 		}
 		deprecated_espresso_action_or_filter_doing_it_wrong(
@@ -1076,7 +1076,7 @@ 
             $existing_attendee, $registration, $attendee_data
         );
 	},
-	10,3
+	10, 3
 );
 
 /**
@@ -1140,7 +1140,7 @@ 
      */
     public function event_list_title($event_list_title = '')
     {
-        if (! empty($this->title)) {
+        if ( ! empty($this->title)) {
             return $this->title;
         }
         return $event_list_title;

Indentation +149 added lines, -149 removed lines

@@ -1052,7 +1052,7 @@ 
 		);
 		do_action(
 			'AHEE__EE_Capabilities__init_role_caps__complete',
-            $capabilities_map
+			$capabilities_map
 		);
 	}
 );
@@ -1072,9 +1072,9 @@ 
 			'filter'
 		);
 		return apply_filters(
-            'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
-            $existing_attendee, $registration, $attendee_data
-        );
+			'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
+			$existing_attendee, $registration, $attendee_data
+		);
 	},
 	10,3
 );
@@ -1087,89 +1087,89 @@ 
 class EE_Event_List_Query extends WP_Query
 {
 
-    private $title;
-
-    private $css_class;
-
-    private $category_slug;
-
-    /**
-     * EE_Event_List_Query constructor.
-     *
-     * @param array $args
-     */
-    public function __construct($args = array())
-    {
-        \EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
-                'event_espresso'
-            ),
-            '4.9.27',
-            '5.0.0'
-        );
-        $this->title = isset($args['title']) ? $args['title'] : '';
-        $this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
-        $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
-        $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        $args = array_merge(
-            $args, array(
-            'post_type'              => 'espresso_events',
-            'posts_per_page'         => $limit,
-            'update_post_term_cache' => false,
-            'update_post_meta_cache' => false,
-            'paged'                  => $paged,
-            'offset'                 => ($paged - 1) * $limit
-        )
-        );
-        // run the query
-        parent::__construct($args);
-    }
-
-
-
-    /**
-     * event_list_title
-     *
-     * @param string $event_list_title
-     * @return string
-     */
-    public function event_list_title($event_list_title = '')
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-
-    /**
-     * event_list_css
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css($event_list_css = '')
-    {
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->css_class)
-            ? $this->css_class
-            : '';
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->category_slug)
-            ? $this->category_slug
-            : '';
-        return $event_list_css;
-    }
+	private $title;
+
+	private $css_class;
+
+	private $category_slug;
+
+	/**
+	 * EE_Event_List_Query constructor.
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = array())
+	{
+		\EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
+				'event_espresso'
+			),
+			'4.9.27',
+			'5.0.0'
+		);
+		$this->title = isset($args['title']) ? $args['title'] : '';
+		$this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
+		$this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
+		$limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		$args = array_merge(
+			$args, array(
+			'post_type'              => 'espresso_events',
+			'posts_per_page'         => $limit,
+			'update_post_term_cache' => false,
+			'update_post_meta_cache' => false,
+			'paged'                  => $paged,
+			'offset'                 => ($paged - 1) * $limit
+		)
+		);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+
+	/**
+	 * event_list_title
+	 *
+	 * @param string $event_list_title
+	 * @return string
+	 */
+	public function event_list_title($event_list_title = '')
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+
+	/**
+	 * event_list_css
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css($event_list_css = '')
+	{
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->css_class)
+			? $this->css_class
+			: '';
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->category_slug)
+			? $this->category_slug
+			: '';
+		return $event_list_css;
+	}
 
 }
 
@@ -1186,66 +1186,66 @@ 
 {
 
 
-    /**
-     *    class constructor
-     *
-     * @deprecated 4.9.59.p
-     */
-    public function __construct()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __CLASS__,
-                'EventEspresso\core\services\licensing\LicenseServices'
-            ),
-            '4.9.59.p'
-        );
-    }
-
-
-    /**
-     * The purpose of this function is to display information about Event Espresso data collection
-     * and a optin selection for extra data collecting by users.
-     *
-     * @param bool $extra
-     * @return string html.
-     * @deprecated 4.9.59.p
-     */
-    public static function espresso_data_collection_optin_text($extra = true)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __METHOD__,
-                'EventEspresso\core\domain\services\Stats::optinText'
-            ),
-            '4.9.59.p'
-        );
-        Stats::optinText($extra);
-    }
-
-    /**
-     * This is a handy helper method for retrieving whether there is an update available for the given plugin.
-     *
-     * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
-     *                          identify plugins. Defaults to core update
-     * @return boolean           True if update available, false if not.
-     * @deprecated 4.9.59.p
-     */
-    public static function is_update_available($basename = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __METHOD__,
-                'EventEspresso\core\services\licensing\LicenseService::isUpdateAvailable'
-            ),
-            '4.9.59.p'
-        );
-        return LicenseService::isUpdateAvailable($basename);
-    }
+	/**
+	 *    class constructor
+	 *
+	 * @deprecated 4.9.59.p
+	 */
+	public function __construct()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__CLASS__,
+				'EventEspresso\core\services\licensing\LicenseServices'
+			),
+			'4.9.59.p'
+		);
+	}
+
+
+	/**
+	 * The purpose of this function is to display information about Event Espresso data collection
+	 * and a optin selection for extra data collecting by users.
+	 *
+	 * @param bool $extra
+	 * @return string html.
+	 * @deprecated 4.9.59.p
+	 */
+	public static function espresso_data_collection_optin_text($extra = true)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__METHOD__,
+				'EventEspresso\core\domain\services\Stats::optinText'
+			),
+			'4.9.59.p'
+		);
+		Stats::optinText($extra);
+	}
+
+	/**
+	 * This is a handy helper method for retrieving whether there is an update available for the given plugin.
+	 *
+	 * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
+	 *                          identify plugins. Defaults to core update
+	 * @return boolean           True if update available, false if not.
+	 * @deprecated 4.9.59.p
+	 */
+	public static function is_update_available($basename = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__METHOD__,
+				'EventEspresso\core\services\licensing\LicenseService::isUpdateAvailable'
+			),
+			'4.9.59.p'
+		);
+		return LicenseService::isUpdateAvailable($basename);
+	}
 }
\ No newline at end of file

admin_pages/general_settings/templates/your_organization_settings.template.php

Indentation +1 added lines, -1 removed lines

@@ -6,7 +6,7 @@
 	<?php
 		//we'll only show site-license keys if this is main_site() (which works for both multi-site and single-site wp installations)
 
-    if ( is_main_site() ) { ?>
+	if ( is_main_site() ) { ?>
 		<h2 class="ee-admin-settings-hdr" style="width:300px;">
 			<?php _e('Your Event Espresso License Key', 'event_espresso'); ?>
 		</h2>

Spacing +15 added lines, -15 removed lines

@@ -6,7 +6,7 @@ 
 	<?php
 		//we'll only show site-license keys if this is main_site() (which works for both multi-site and single-site wp installations)
 
-    if ( is_main_site() ) { ?>
+    if (is_main_site()) { ?>
 		<h2 class="ee-admin-settings-hdr" style="width:300px;">
 			<?php _e('Your Event Espresso License Key', 'event_espresso'); ?>
 		</h2>
@@ -16,13 +16,13 @@ 
 				<tr <?php echo isset($_REQUEST['license_key']) && $_REQUEST['license_key'] == true ? 'class="yellow_alert"' : '' ?>>
 					<th>
 						<label for="site_license_key">
-							<?php _e('Support License Key', 'event_espresso'); ?> <?php echo EEH_Template::get_help_tab_link('site_license_key_info');?>
+							<?php _e('Support License Key', 'event_espresso'); ?> <?php echo EEH_Template::get_help_tab_link('site_license_key_info'); ?>
 						</label>
 					</th>
 					<td>
 						<input name="site_license_key" id="site_license_key" size="10" class="regular-text" type="text" value="<?php echo esc_attr($site_license_key); ?>" /><?php echo $site_license_key_verified; ?><br/>
 						<p class="description">
-							<?php printf( __('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>' ); ?>
+							<?php printf(__('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>'); ?>
 						</p>
 					</td>
 				</tr>
@@ -35,7 +35,7 @@ 
 
 
 	<h2 id="contact_info_h4" class="ee-admin-settings-hdr">
-		<?php _e('Contact Information', 'event_espresso'); ?> <?php echo EEH_Template::get_help_tab_link('contact_info_info');?>
+		<?php _e('Contact Information', 'event_espresso'); ?> <?php echo EEH_Template::get_help_tab_link('contact_info_info'); ?>
 	</h2>
 
 	<table class="form-table">
@@ -83,8 +83,8 @@ 
 					<input id="organization_city" class="regular-text" type="text" name="organization_city" value="<?php echo esc_textarea($organization_city); ?>" />
 				</td>
 			</tr>
-			<?php echo EEH_Form_Fields::generate_form_input( $states ); ?>
-			<?php echo EEH_Form_Fields::generate_form_input( $countries ); ?>
+			<?php echo EEH_Form_Fields::generate_form_input($states); ?>
+			<?php echo EEH_Form_Fields::generate_form_input($countries); ?>
 			<tr>
 				<th>
 					<label for="organization_zip">
@@ -104,7 +104,7 @@ 
 				<td>
 					<input class="regular-text" type="text" name="organization_email" value="<?php echo esc_textarea($organization_email); ?>" />
 					<p class="description">
-						<?php echo 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>' ); ?>
+						<?php echo 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>'); ?>
 					</p>
 				</td>
 			</tr>
@@ -138,7 +138,7 @@ 
 	</table>
 
 	<h2 class="ee-admin-settings-hdr">
-		<?php _e('Company Logo', 'event_espresso'); ?> <?php echo EEH_Template::get_help_tab_link('organization_logo_info');?>
+		<?php _e('Company Logo', 'event_espresso'); ?> <?php echo EEH_Template::get_help_tab_link('organization_logo_info'); ?>
 	</h2>
 
 	<table class="form-table">
@@ -166,7 +166,7 @@ 
 				</th>
 				<td>
 					<?php
-					if ( $organization_logo_url ) {
+					if ($organization_logo_url) {
 						?>
 						<p id="default-logo-thumb">
 							<img id="current-image-thumb" src="<?php echo esc_url($organization_logo_url) ?>" alt="" /><br />
@@ -184,7 +184,7 @@ 
 	<br/><br/>
 
 	<h2 class="ee-admin-settings-hdr">
-		<?php _e('Social Links', 'event_espresso'); ?> <?php echo EEH_Template::get_help_tab_link('social_links_info');?>
+		<?php _e('Social Links', 'event_espresso'); ?> <?php echo EEH_Template::get_help_tab_link('social_links_info'); ?>
 	</h2>
 	<p class="description"><?php _e('Enter any links to social accounts for your organization here', 'event_espresso'); ?></p>
 
@@ -261,7 +261,7 @@ 
 	<br/><br/>
 
 
-	<?php if ( is_main_site() ) : ?>
+	<?php if (is_main_site()) : ?>
 		<p>
 			<?php Stats::optinText(false); ?>
 		</p>
@@ -277,11 +277,11 @@ 
 					</th>
 					<td>
 						<?php
-							$values=array(
-								array('id'=>'yes','text'=> __('Yes! I want to help improve Event Espresso!','event_espresso')),
-								array('id'=>'no','text'=> __('Not at this time. Maybe later.','event_espresso'))
+							$values = array(
+								array('id'=>'yes', 'text'=> __('Yes! I want to help improve Event Espresso!', 'event_espresso')),
+								array('id'=>'no', 'text'=> __('Not at this time. Maybe later.', 'event_espresso'))
 							);
-							echo EEH_Form_Fields::select_input('ueip_optin', $values, !empty($ee_ueip_optin) ? $ee_ueip_optin : 'yes');
+							echo EEH_Form_Fields::select_input('ueip_optin', $values, ! empty($ee_ueip_optin) ? $ee_ueip_optin : 'yes');
 						?>
 					</td>
 				</tr>

admin_pages/general_settings/General_Settings_Admin_Page.core.php

Indentation +1371 added lines, -1371 removed lines

@@ -17,1386 +17,1386 @@
 {
 
 
-    /**
-     * _question_group
-     * holds the specific question group object for the question group details screen
-     *
-     * @var object
-     */
-    protected $_question_group;
-
-
-    /**
-     * Initialize basic properties.
-     */
-    protected function _init_page_props()
-    {
-        $this->page_slug        = GEN_SET_PG_SLUG;
-        $this->page_label       = GEN_SET_LABEL;
-        $this->_admin_base_url  = GEN_SET_ADMIN_URL;
-        $this->_admin_base_path = GEN_SET_ADMIN;
-    }
-
-
-    /**
-     * Set ajax hooks
-     */
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_espresso_display_country_settings', array($this, 'display_country_settings'));
-        add_action('wp_ajax_espresso_display_country_states', array($this, 'display_country_states'));
-        add_action('wp_ajax_espresso_delete_state', array($this, 'delete_state'), 10, 3);
-        add_action('wp_ajax_espresso_add_new_state', array($this, 'add_new_state'));
-    }
-
-
-    /**
-     * More page properties initialization.
-     */
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = GEN_SET_LABEL;
-        $this->_labels           = array(
-            'publishbox' => __('Update Settings', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * Set page routes property.
-     */
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = array(
-
-            'critical_pages'                => array(
-                'func'       => '_espresso_page_settings',
-                'capability' => 'manage_options',
-            ),
-            'update_espresso_page_settings' => array(
-                'func'       => '_update_espresso_page_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'default'                       => array(
-                'func'       => '_your_organization_settings',
-                'capability' => 'manage_options',
-            ),
-
-            'update_your_organization_settings' => array(
-                'func'       => '_update_your_organization_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-
-            'admin_option_settings' => array(
-                'func'       => '_admin_option_settings',
-                'capability' => 'manage_options',
-            ),
-
-            'update_admin_option_settings' => array(
-                'func'       => '_update_admin_option_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-
-            'country_settings' => array(
-                'func'       => '_country_settings',
-                'capability' => 'manage_options',
-            ),
-
-            'update_country_settings' => array(
-                'func'       => '_update_country_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-
-            'display_country_settings' => array(
-                'func'       => 'display_country_settings',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-
-            'add_new_state' => array(
-                'func'       => 'add_new_state',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-
-            'delete_state' => array(
-                'func'       => 'delete_state',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-        );
-    }
-
-
-    /**
-     * Set page configuration property
-     */
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'critical_pages'        => array(
-                'nav'           => array(
-                    'label' => __('Critical Pages', 'event_espresso'),
-                    'order' => 50,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'general_settings_critical_pages_help_tab' => array(
-                        'title'    => __('Critical Pages', 'event_espresso'),
-                        'filename' => 'general_settings_critical_pages',
-                    ),
-                ),
-                'help_tour'     => array('Critical_Pages_Help_Tour'),
-                'require_nonce' => false,
-            ),
-            'default'               => array(
-                'nav'           => array(
-                    'label' => __('Your Organization', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'help_tabs'     => array(
-                    'general_settings_your_organization_help_tab' => array(
-                        'title'    => __('Your Organization', 'event_espresso'),
-                        'filename' => 'general_settings_your_organization',
-                    ),
-                ),
-                'help_tour'     => array('Your_Organization_Help_Tour'),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'require_nonce' => false,
-            ),
-            'admin_option_settings' => array(
-                'nav'           => array(
-                    'label' => __('Admin Options', 'event_espresso'),
-                    'order' => 60,
-                ),
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
-                'help_tabs'     => array(
-                    'general_settings_admin_options_help_tab' => array(
-                        'title'    => __('Admin Options', 'event_espresso'),
-                        'filename' => 'general_settings_admin_options',
-                    ),
-                ),
-                'help_tour'     => array('Admin_Options_Help_Tour'),
-                'require_nonce' => false,
-            ),
-            'country_settings'      => array(
-                'nav'           => array(
-                    'label' => __('Countries', 'event_espresso'),
-                    'order' => 70,
-                ),
-                'help_tabs'     => array(
-                    'general_settings_countries_help_tab' => array(
-                        'title'    => __('Countries', 'event_espresso'),
-                        'filename' => 'general_settings_countries',
-                    ),
-                ),
-                'help_tour'     => array('Countries_Help_Tour'),
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-
-    protected function _add_screen_options()
-    {
-    }
-
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    /**
-     * Enqueue global scripts and styles for all routes in the General Settings Admin Pages.
-     */
-    public function load_scripts_styles()
-    {
-        //styles
-        wp_enqueue_style('espresso-ui-theme');
-        //scripts
-        wp_enqueue_script('ee_admin_js');
-    }
-
-
-    /**
-     * Execute logic running on `admin_init`
-     */
-    public function admin_init()
-    {
-        EE_Registry::$i18n_js_strings['invalid_server_response'] = __(
-            'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['error_occurred']          = __(
-            'An error occurred! Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['confirm_delete_state']    = __(
-            'Are you sure you want to delete this State / Province?',
-            'event_espresso'
-        );
-        $protocol                                                = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
-        EE_Registry::$i18n_js_strings['ajax_url']                = admin_url(
-            'admin-ajax.php?page=espresso_general_settings',
-            $protocol
-        );
-    }
-
-    public function admin_notices()
-    {
-    }
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the default route.
-     */
-    public function load_scripts_styles_default()
-    {
-        //styles
-        wp_enqueue_style('thickbox');
-        //scripts
-        wp_enqueue_script('media-upload');
-        wp_enqueue_script('thickbox');
-        wp_register_script(
-            'organization_settings',
-            GEN_SET_ASSETS_URL . 'your_organization_settings.js',
-            array('jquery', 'media-upload', 'thickbox'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_enqueue_script('organization_settings');
-        wp_enqueue_style('organization-css');
-        $confirm_image_delete = array(
-            'text' => __(
-                'Do you really want to delete this image? Please remember to save your settings to complete the removal.',
-                'event_espresso'
-            ),
-        );
-        wp_localize_script('organization_settings', 'confirm_image_delete', $confirm_image_delete);
-    }
-
-
-    /**
-     * Enqueue scripts and styles for the country settings route.
-     */
-    public function load_scripts_styles_country_settings()
-    {
-        //scripts
-        wp_register_script(
-            'gen_settings_countries',
-            GEN_SET_ASSETS_URL . 'gen_settings_countries.js',
-            array('ee_admin_js'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', array(), EVENT_ESPRESSO_VERSION);
-        wp_enqueue_script('gen_settings_countries');
-        wp_enqueue_style('organization-css');
-    }
-
-
-    /*************        Espresso Pages        *************/
-    /**
-     * _espresso_page_settings
-     *
-     * @throws \EE_Error
-     */
-    protected function _espresso_page_settings()
-    {
-        // Check to make sure all of the main pages are setup properly,
-        // if not create the default pages and display an admin notice
-        EEH_Activation::verify_default_pages_exist();
-        $this->_transient_garbage_collection();
-        $this->_template_args['values']             = $this->_yes_no_values;
-        $this->_template_args['reg_page_id']        = isset(EE_Registry::instance()->CFG->core->reg_page_id)
-            ? EE_Registry::instance()->CFG->core->reg_page_id
-            : null;
-        $this->_template_args['reg_page_obj']       = isset(EE_Registry::instance()->CFG->core->reg_page_id)
-            ? get_page(EE_Registry::instance()->CFG->core->reg_page_id)
-            : false;
-        $this->_template_args['txn_page_id']        = isset(EE_Registry::instance()->CFG->core->txn_page_id)
-            ? EE_Registry::instance()->CFG->core->txn_page_id
-            : null;
-        $this->_template_args['txn_page_obj']       = isset(EE_Registry::instance()->CFG->core->txn_page_id)
-            ? get_page(EE_Registry::instance()->CFG->core->txn_page_id)
-            : false;
-        $this->_template_args['thank_you_page_id']  = isset(EE_Registry::instance()->CFG->core->thank_you_page_id)
-            ? EE_Registry::instance()->CFG->core->thank_you_page_id
-            : null;
-        $this->_template_args['thank_you_page_obj'] = isset(EE_Registry::instance()->CFG->core->thank_you_page_id)
-            ? get_page(EE_Registry::instance()->CFG->core->thank_you_page_id)
-            : false;
-        $this->_template_args['cancel_page_id']     = isset(EE_Registry::instance()->CFG->core->cancel_page_id)
-            ? EE_Registry::instance()->CFG->core->cancel_page_id
-            : null;
-        $this->_template_args['cancel_page_obj']    = isset(EE_Registry::instance()->CFG->core->cancel_page_id)
-            ? get_page(EE_Registry::instance()->CFG->core->cancel_page_id)
-            : false;
-        $this->_set_add_edit_form_tags('update_espresso_page_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'espresso_page_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating espresso page settings.
-     */
-    protected function _update_espresso_page_settings()
-    {
-        // capture incoming request data && set page IDs
-        EE_Registry::instance()->CFG->core->reg_page_id       = isset($this->_req_data['reg_page_id'])
-            ? absint($this->_req_data['reg_page_id'])
-            : EE_Registry::instance()->CFG->core->reg_page_id;
-        EE_Registry::instance()->CFG->core->txn_page_id       = isset($this->_req_data['txn_page_id'])
-            ? absint($this->_req_data['txn_page_id'])
-            : EE_Registry::instance()->CFG->core->txn_page_id;
-        EE_Registry::instance()->CFG->core->thank_you_page_id = isset($this->_req_data['thank_you_page_id'])
-            ? absint($this->_req_data['thank_you_page_id'])
-            : EE_Registry::instance()->CFG->core->thank_you_page_id;
-        EE_Registry::instance()->CFG->core->cancel_page_id    = isset($this->_req_data['cancel_page_id'])
-            ? absint($this->_req_data['cancel_page_id'])
-            : EE_Registry::instance()->CFG->core->cancel_page_id;
-
-        EE_Registry::instance()->CFG->core = apply_filters(
-            'FHEE__General_Settings_Admin_Page___update_espresso_page_settings__CFG_core',
-            EE_Registry::instance()->CFG->core,
-            $this->_req_data
-        );
-        $what                              = __('Critical Pages & Shortcodes', 'event_espresso');
-        $this->_redirect_after_action(
-            $this->_update_espresso_configuration(
-                $what,
-                EE_Registry::instance()->CFG->core,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            ),
-            $what,
-            '',
-            array(
-                'action' => 'critical_pages',
-            ),
-            true
-        );
-    }
-
-
-    /*************        Your Organization        *************/
-
-
-    /**
-     * Output for the Your Organization settings route.
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _your_organization_settings()
-    {
-
-        $this->_template_args['site_license_key']       = isset(
-            EE_Registry::instance()->NET_CFG->core->site_license_key
-        )
-            ? EE_Registry::instance()->NET_CFG->core->get_pretty('site_license_key')
-            : '';
-        $this->_template_args['organization_name']      = isset(EE_Registry::instance()->CFG->organization->name)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('name')
-            : '';
-        $this->_template_args['organization_address_1'] = isset(EE_Registry::instance()->CFG->organization->address_1)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('address_1')
-            : '';
-        $this->_template_args['organization_address_2'] = isset(EE_Registry::instance()->CFG->organization->address_2)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('address_2')
-            : '';
-        $this->_template_args['organization_city']      = isset(EE_Registry::instance()->CFG->organization->city)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('city')
-            : '';
-        $this->_template_args['organization_zip']       = isset(EE_Registry::instance()->CFG->organization->zip)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('zip')
-            : '';
-        $this->_template_args['organization_email']     = isset(EE_Registry::instance()->CFG->organization->email)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('email')
-            : '';
-        $this->_template_args['organization_phone']     = isset(EE_Registry::instance()->CFG->organization->phone)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('phone')
-            : '';
-        $this->_template_args['organization_vat']       = isset(EE_Registry::instance()->CFG->organization->vat)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('vat')
-            : '';
-        $this->_template_args['currency_sign']          = isset(EE_Registry::instance()->CFG->currency->sign)
-            ? EE_Registry::instance()->CFG->currency->get_pretty('sign')
-            : '$';
-        $this->_template_args['organization_logo_url']  = isset(EE_Registry::instance()->CFG->organization->logo_url)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('logo_url')
-            : false;
-        $this->_template_args['organization_facebook']  = isset(EE_Registry::instance()->CFG->organization->facebook)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('facebook')
-            : '';
-        $this->_template_args['organization_twitter']   = isset(EE_Registry::instance()->CFG->organization->twitter)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('twitter')
-            : '';
-        $this->_template_args['organization_linkedin']  = isset(EE_Registry::instance()->CFG->organization->linkedin)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('linkedin')
-            : '';
-        $this->_template_args['organization_pinterest'] = isset(EE_Registry::instance()->CFG->organization->pinterest)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('pinterest')
-            : '';
-        $this->_template_args['organization_google']    = isset(EE_Registry::instance()->CFG->organization->google)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('google')
-            : '';
-        $this->_template_args['organization_instagram'] = isset(EE_Registry::instance()->CFG->organization->instagram)
-            ? EE_Registry::instance()->CFG->organization->get_pretty('instagram')
-            : '';
-        //UXIP settings
-        $this->_template_args['ee_ueip_optin'] = isset(EE_Registry::instance()->CFG->core->ee_ueip_optin)
-            ? EE_Registry::instance()->CFG->core->get_pretty('ee_ueip_optin')
-            : 'yes';
-
-        $STA_ID                         = isset(EE_Registry::instance()->CFG->organization->STA_ID)
-            ? EE_Registry::instance()->CFG->organization->STA_ID
-            : 4;
-        $this->_template_args['states'] = new EE_Question_Form_Input(
-            EE_Question::new_instance(array(
-                'QST_ID'           => 0,
-                'QST_display_text' => __('State/Province', 'event_espresso'),
-                'QST_system'       => 'admin-state',
-            )),
-            EE_Answer::new_instance(array(
-                'ANS_ID'    => 0,
-                'ANS_value' => $STA_ID,
-            )),
-            array(
-                'input_id'       => 'organization_state',
-                'input_name'     => 'organization_state',
-                'input_prefix'   => '',
-                'append_qstn_id' => false,
-            )
-        );
-
-        $CNT_ISO                           = isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : 'US';
-        $this->_template_args['countries'] = new EE_Question_Form_Input(
-            EE_Question::new_instance(array(
-                'QST_ID'           => 0,
-                'QST_display_text' => __('Country', 'event_espresso'),
-                'QST_system'       => 'admin-country',
-            )),
-            EE_Answer::new_instance(array(
-                'ANS_ID'    => 0,
-                'ANS_value' => $CNT_ISO,
-            )),
-            array(
-                'input_id'       => 'organization_country',
-                'input_name'     => 'organization_country',
-                'input_prefix'   => '',
-                'append_qstn_id' => false,
-            )
-        );
-
-        add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
-        add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
-
-        //PUE verification stuff
-        $ver_option_key                                    = 'puvererr_' . basename(EE_PLUGIN_BASENAME);
-        $verify_fail                                       = get_option($ver_option_key);
-        $this->_template_args['site_license_key_verified'] = $verify_fail
-                                                             || ! empty($verify_fail)
-                                                             || (empty($this->_template_args['site_license_key'])
-                                                                 && empty($verify_fail)
-                                                             )
-            ? '<span class="dashicons dashicons-admin-network ee-icon-color-ee-red ee-icon-size-20"></span>'
-            : '<span class="dashicons dashicons-admin-network ee-icon-color-ee-green ee-icon-size-20"></span>';
-
-        $this->_set_add_edit_form_tags('update_your_organization_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'your_organization_settings.template.php',
-            $this->_template_args,
-            true
-        );
-
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * Handler for updating organziation settings.
-     */
-    protected function _update_your_organization_settings()
-    {
-        if (is_main_site()) {
-            EE_Registry::instance()->NET_CFG->core->site_license_key = isset($this->_req_data['site_license_key'])
-                ? sanitize_text_field($this->_req_data['site_license_key'])
-                : EE_Registry::instance()->NET_CFG->core->site_license_key;
-        }
-        EE_Registry::instance()->CFG->organization->name      = isset($this->_req_data['organization_name'])
-            ? sanitize_text_field($this->_req_data['organization_name'])
-            : EE_Registry::instance()->CFG->organization->name;
-        EE_Registry::instance()->CFG->organization->address_1 = isset($this->_req_data['organization_address_1'])
-            ? sanitize_text_field($this->_req_data['organization_address_1'])
-            : EE_Registry::instance()->CFG->organization->address_1;
-        EE_Registry::instance()->CFG->organization->address_2 = isset($this->_req_data['organization_address_2'])
-            ? sanitize_text_field($this->_req_data['organization_address_2'])
-            : EE_Registry::instance()->CFG->organization->address_2;
-        EE_Registry::instance()->CFG->organization->city      = isset($this->_req_data['organization_city'])
-            ? sanitize_text_field($this->_req_data['organization_city'])
-            : EE_Registry::instance()->CFG->organization->city;
-        EE_Registry::instance()->CFG->organization->STA_ID    = isset($this->_req_data['organization_state'])
-            ? absint($this->_req_data['organization_state'])
-            : EE_Registry::instance()->CFG->organization->STA_ID;
-        EE_Registry::instance()->CFG->organization->CNT_ISO   = isset($this->_req_data['organization_country'])
-            ? sanitize_text_field($this->_req_data['organization_country'])
-            : EE_Registry::instance()->CFG->organization->CNT_ISO;
-        EE_Registry::instance()->CFG->organization->zip       = isset($this->_req_data['organization_zip'])
-            ? sanitize_text_field($this->_req_data['organization_zip'])
-            : EE_Registry::instance()->CFG->organization->zip;
-        EE_Registry::instance()->CFG->organization->email     = isset($this->_req_data['organization_email'])
-            ? sanitize_email($this->_req_data['organization_email'])
-            : EE_Registry::instance()->CFG->organization->email;
-        EE_Registry::instance()->CFG->organization->vat       = isset($this->_req_data['organization_vat'])
-            ? sanitize_text_field($this->_req_data['organization_vat'])
-            : EE_Registry::instance()->CFG->organization->vat;
-        EE_Registry::instance()->CFG->organization->phone     = isset($this->_req_data['organization_phone'])
-            ? sanitize_text_field($this->_req_data['organization_phone'])
-            : EE_Registry::instance()->CFG->organization->phone;
-        EE_Registry::instance()->CFG->organization->logo_url  = isset($this->_req_data['organization_logo_url'])
-            ? esc_url_raw($this->_req_data['organization_logo_url'])
-            : EE_Registry::instance()->CFG->organization->logo_url;
-        EE_Registry::instance()->CFG->organization->facebook  = isset($this->_req_data['organization_facebook'])
-            ? esc_url_raw($this->_req_data['organization_facebook'])
-            : EE_Registry::instance()->CFG->organization->facebook;
-        EE_Registry::instance()->CFG->organization->twitter   = isset($this->_req_data['organization_twitter'])
-            ? esc_url_raw($this->_req_data['organization_twitter'])
-            : EE_Registry::instance()->CFG->organization->twitter;
-        EE_Registry::instance()->CFG->organization->linkedin  = isset($this->_req_data['organization_linkedin'])
-            ? esc_url_raw($this->_req_data['organization_linkedin'])
-            : EE_Registry::instance()->CFG->organization->linkedin;
-        EE_Registry::instance()->CFG->organization->pinterest = isset($this->_req_data['organization_pinterest'])
-            ? esc_url_raw($this->_req_data['organization_pinterest'])
-            : EE_Registry::instance()->CFG->organization->pinterest;
-        EE_Registry::instance()->CFG->organization->google    = isset($this->_req_data['organization_google'])
-            ? esc_url_raw($this->_req_data['organization_google'])
-            : EE_Registry::instance()->CFG->organization->google;
-        EE_Registry::instance()->CFG->organization->instagram = isset($this->_req_data['organization_instagram'])
-            ? esc_url_raw($this->_req_data['organization_instagram'])
-            : EE_Registry::instance()->CFG->organization->instagram;
-        EE_Registry::instance()->CFG->core->ee_ueip_optin     = isset($this->_req_data['ueip_optin'])
-                                                                && ! empty($this->_req_data['ueip_optin'])
-            ? filter_var($this->_req_data['ueip_optin'], FILTER_VALIDATE_BOOLEAN)
-            : EE_Registry::instance()->CFG->core->ee_ueip_optin;
-
-        EE_Registry::instance()->CFG->currency = new EE_Currency_Config(
-            EE_Registry::instance()->CFG->organization->CNT_ISO
-        );
-
-        EE_Registry::instance()->CFG = apply_filters(
-            'FHEE__General_Settings_Admin_Page___update_your_organization_settings__CFG',
-            EE_Registry::instance()->CFG
-        );
-
-        $what    = 'Your Organization Settings';
-        $success = $this->_update_espresso_configuration(
-            $what,
-            EE_Registry::instance()->CFG,
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-
-        $this->_redirect_after_action($success, $what, 'updated', array('action' => 'default'));
-    }
-
-
-
-    /*************        Admin Options        *************/
-
-
-    /**
-     * _admin_option_settings
-     *
-     * @throws \EE_Error
-     * @throws \LogicException
-     */
-    protected function _admin_option_settings()
-    {
-        $this->_template_args['admin_page_content'] = '';
-        try {
-            $admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
-            // still need this for the old school form in Extend_General_Settings_Admin_Page
-            $this->_template_args['values'] = $this->_yes_no_values;
-            // also need to account for the do_action that was in the old template
-            $admin_options_settings_form->setTemplateArgs($this->_template_args);
-            $this->_template_args['admin_page_content'] = $admin_options_settings_form->display();
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        $this->_set_add_edit_form_tags('update_admin_option_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * _update_admin_option_settings
-     *
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidFormSubmissionException
-     * @throws \InvalidArgumentException
-     * @throws \LogicException
-     */
-    protected function _update_admin_option_settings()
-    {
-        try {
-            $admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
-            $admin_options_settings_form->process($this->_req_data[$admin_options_settings_form->slug()]);
-            EE_Registry::instance()->CFG->admin = apply_filters(
-                'FHEE__General_Settings_Admin_Page___update_admin_option_settings__CFG_admin',
-                EE_Registry::instance()->CFG->admin
-            );
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        $this->_redirect_after_action(
-            apply_filters(
-                'FHEE__General_Settings_Admin_Page___update_admin_option_settings__success',
-                $this->_update_espresso_configuration(
-                    'Admin Options',
-                    EE_Registry::instance()->CFG->admin,
-                    __FILE__, __FUNCTION__, __LINE__
-                )
-            ),
-            'Admin Options',
-            'updated',
-            array('action' => 'admin_option_settings')
-        );
-
-    }
-
-
-    /*************        Countries        *************/
-
-
-    /**
-     * Output Country Settings view.
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _country_settings()
-    {
-        $CNT_ISO = isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
-            ? EE_Registry::instance()->CFG->organization->CNT_ISO
-            : 'US';
-        $CNT_ISO = isset($this->_req_data['country'])
-            ? strtoupper(sanitize_text_field($this->_req_data['country']))
-            : $CNT_ISO;
-
-        //load field generator helper
-
-        $this->_template_args['values'] = $this->_yes_no_values;
-
-        $this->_template_args['countries'] = new EE_Question_Form_Input(
-            EE_Question::new_instance(array(
-                'QST_ID'           => 0,
-                'QST_display_text' => __('Select Country', 'event_espresso'),
-                'QST_system'       => 'admin-country',
-            )),
-            EE_Answer::new_instance(array(
-                'ANS_ID'    => 0,
-                'ANS_value' => $CNT_ISO,
-            )),
-            array(
-                'input_id'       => 'country',
-                'input_name'     => 'country',
-                'input_prefix'   => '',
-                'append_qstn_id' => false,
-            )
-        );
-
-        add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
-        add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
-        $this->_template_args['country_details_settings'] = $this->display_country_settings();
-        $this->_template_args['country_states_settings']  = $this->display_country_states();
-
-        $this->_set_add_edit_form_tags('update_country_settings');
-        $this->_set_publish_post_box_vars(null, false, false, null, false);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'countries_settings.template.php',
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_no_sidebar();
-    }
-
-
-    /**
-     *        display_country_settings
-     *
-     * @access    public
-     * @param    string $CNT_ISO
-     * @return mixed string | array
-     * @throws DomainException
-     */
-    public function display_country_settings($CNT_ISO = '')
-    {
-
-        $CNT_ISO = isset($this->_req_data['country'])
-            ? strtoupper(sanitize_text_field($this->_req_data['country']))
-            : $CNT_ISO;
-        if (! $CNT_ISO) {
-            return '';
-        }
-
-        // for ajax
-        remove_all_filters('FHEE__EEH_Form_Fields__label_html');
-        remove_all_filters('FHEE__EEH_Form_Fields__input_html');
-        add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
-        add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
-        $country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
-
-        $country_input_types            = array(
-            'CNT_active'      => array(
-                'type'             => 'RADIO_BTN',
-                'input_name'       => 'cntry[' . $CNT_ISO . ']',
-                'class'            => '',
-                'options'          => $this->_yes_no_values,
-                'use_desc_4_label' => true,
-            ),
-            'CNT_ISO'         => array(
-                'type'       => 'TEXT',
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
-                'class'      => 'small-text',
-            ),
-            'CNT_ISO3'        => array(
-                'type'       => 'TEXT',
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
-                'class'      => 'small-text',
-            ),
-            'RGN_ID'          => array(
-                'type'       => 'TEXT',
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
-                'class'      => 'small-text',
-            ),
-            'CNT_name'        => array(
-                'type'       => 'TEXT',
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
-                'class'      => 'regular-text',
-            ),
-            'CNT_cur_code'    => array(
-                'type'       => 'TEXT',
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
-                'class'      => 'small-text',
-            ),
-            'CNT_cur_single'  => array(
-                'type'       => 'TEXT',
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
-                'class'      => 'medium-text',
-            ),
-            'CNT_cur_plural'  => array(
-                'type'       => 'TEXT',
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
-                'class'      => 'medium-text',
-            ),
-            'CNT_cur_sign'    => array(
-                'type'         => 'TEXT',
-                'input_name'   => 'cntry[' . $CNT_ISO . ']',
-                'class'        => 'small-text',
-                'htmlentities' => false,
-            ),
-            'CNT_cur_sign_b4' => array(
-                'type'             => 'RADIO_BTN',
-                'input_name'       => 'cntry[' . $CNT_ISO . ']',
-                'class'            => '',
-                'options'          => $this->_yes_no_values,
-                'use_desc_4_label' => true,
-            ),
-            'CNT_cur_dec_plc' => array(
-                'type'       => 'RADIO_BTN',
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
-                'class'      => '',
-                'options'    => array(
-                    array('id' => 0, 'text' => ''),
-                    array('id' => 1, 'text' => ''),
-                    array('id' => 2, 'text' => ''),
-                    array('id' => 3, 'text' => ''),
-                ),
-            ),
-            'CNT_cur_dec_mrk' => array(
-                'type'             => 'RADIO_BTN',
-                'input_name'       => 'cntry[' . $CNT_ISO . ']',
-                'class'            => '',
-                'options'          => array(
-                    array(
-                        'id'   => ',',
-                        'text' => __(', (comma)', 'event_espresso'),
-                    ),
-                    array('id' => '.', 'text' => __('. (decimal)', 'event_espresso')),
-                ),
-                'use_desc_4_label' => true,
-            ),
-            'CNT_cur_thsnds'  => array(
-                'type'             => 'RADIO_BTN',
-                'input_name'       => 'cntry[' . $CNT_ISO . ']',
-                'class'            => '',
-                'options'          => array(
-                    array(
-                        'id'   => ',',
-                        'text' => __(', (comma)', 'event_espresso'),
-                    ),
-                    array('id' => '.', 'text' => __('. (decimal)', 'event_espresso')),
-                ),
-                'use_desc_4_label' => true,
-            ),
-            'CNT_tel_code'    => array(
-                'type'       => 'TEXT',
-                'input_name' => 'cntry[' . $CNT_ISO . ']',
-                'class'      => 'small-text',
-            ),
-            'CNT_is_EU'       => array(
-                'type'             => 'RADIO_BTN',
-                'input_name'       => 'cntry[' . $CNT_ISO . ']',
-                'class'            => '',
-                'options'          => $this->_yes_no_values,
-                'use_desc_4_label' => true,
-            ),
-        );
-        $this->_template_args['inputs'] = EE_Question_Form_Input::generate_question_form_inputs_for_object(
-            $country,
-            $country_input_types
-        );
-        $country_details_settings       = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'country_details_settings.template.php',
-            $this->_template_args,
-            true
-        );
-
-        if (defined('DOING_AJAX')) {
-            $notices = EE_Error::get_notices(false, false, false);
-            echo wp_json_encode(array(
-                'return_data' => $country_details_settings,
-                'success'     => $notices['success'],
-                'errors'      => $notices['errors'],
-            ));
-            die();
-        } else {
-            return $country_details_settings;
-        }
-    }
-
-
-    /**
-     *        display_country_states
-     *
-     * @access    public
-     * @param    string $CNT_ISO
-     * @return string
-     * @throws DomainException
-     */
-    public function display_country_states($CNT_ISO = '')
-    {
-
-        $CNT_ISO = isset($this->_req_data['country']) ? sanitize_text_field($this->_req_data['country']) : $CNT_ISO;
-
-        if (! $CNT_ISO) {
-            return '';
-        }
-        // for ajax
-        remove_all_filters('FHEE__EEH_Form_Fields__label_html');
-        remove_all_filters('FHEE__EEH_Form_Fields__input_html');
-        add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'state_form_field_label_wrap'), 10, 2);
-        add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'state_form_field_input__wrap'), 10, 2);
-        $states = EEM_State::instance()->get_all_states_for_these_countries(array($CNT_ISO => $CNT_ISO));
-
-        if ($states) {
-            foreach ($states as $STA_ID => $state) {
-                if ($state instanceof EE_State) {
-                    //STA_abbrev 	STA_name 	STA_active
-                    $state_input_types                                           = array(
-                        'STA_abbrev' => array(
-                            'type'       => 'TEXT',
-                            'input_name' => 'states[' . $STA_ID . ']',
-                            'class'      => 'mid-text',
-                        ),
-                        'STA_name'   => array(
-                            'type'       => 'TEXT',
-                            'input_name' => 'states[' . $STA_ID . ']',
-                            'class'      => 'regular-text',
-                        ),
-                        'STA_active' => array(
-                            'type'             => 'RADIO_BTN',
-                            'input_name'       => 'states[' . $STA_ID . ']',
-                            'options'          => $this->_yes_no_values,
-                            'use_desc_4_label' => true,
-                        ),
-                    );
-                    $this->_template_args['states'][$STA_ID]['inputs'] =
-                        EE_Question_Form_Input::generate_question_form_inputs_for_object(
-                            $state,
-                            $state_input_types
-                        );
-                    $query_args                                                  = array(
-                        'action'     => 'delete_state',
-                        'STA_ID'     => $STA_ID,
-                        'CNT_ISO'    => $CNT_ISO,
-                        'STA_abbrev' => $state->abbrev(),
-                    );
-                    $this->_template_args['states'][$STA_ID]['delete_state_url'] =
-                        EE_Admin_Page::add_query_args_and_nonce(
-                            $query_args,
-                            GEN_SET_ADMIN_URL
-                        );
-                }
-            }
-        } else {
-            $this->_template_args['states'] = false;
-        }
-
-        $this->_template_args['add_new_state_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'add_new_state'),
-            GEN_SET_ADMIN_URL
-        );
-
-        $state_details_settings = EEH_Template::display_template(
-            GEN_SET_TEMPLATE_PATH . 'state_details_settings.template.php',
-            $this->_template_args,
-            true
-        );
-
-        if (defined('DOING_AJAX')) {
-            $notices = EE_Error::get_notices(false, false, false);
-            echo wp_json_encode(array(
-                'return_data' => $state_details_settings,
-                'success'     => $notices['success'],
-                'errors'      => $notices['errors'],
-            ));
-            die();
-        } else {
-            return $state_details_settings;
-        }
-    }
-
-
-    /**
-     *        add_new_state
-     *
-     * @access    public
-     * @return void
-     * @throws EE_Error
-     */
-    public function add_new_state()
-    {
-
-        $success = true;
-
-        $CNT_ISO = isset($this->_req_data['CNT_ISO'])
-            ? strtoupper(sanitize_text_field($this->_req_data['CNT_ISO']))
-            : false;
-        if (! $CNT_ISO) {
-            EE_Error::add_error(
-                __('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        $STA_abbrev = isset($this->_req_data['STA_abbrev'])
-            ? sanitize_text_field($this->_req_data['STA_abbrev'])
-            : false;
-        if (! $STA_abbrev) {
-            EE_Error::add_error(
-                __('No State ISO code or an invalid State ISO code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        $STA_name = isset($this->_req_data['STA_name'])
-            ? sanitize_text_field($this->_req_data['STA_name'])
-            : false;
-        if (! $STA_name) {
-            EE_Error::add_error(
-                __('No State name or an invalid State name was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-
-        if ($success) {
-            $cols_n_values = array(
-                'CNT_ISO'    => $CNT_ISO,
-                'STA_abbrev' => $STA_abbrev,
-                'STA_name'   => $STA_name,
-                'STA_active' => true,
-            );
-            $success       = EEM_State::instance()->insert($cols_n_values);
-            EE_Error::add_success(__('The State was added successfully.', 'event_espresso'));
-        }
-
-        if (defined('DOING_AJAX')) {
-            $notices = EE_Error::get_notices(false, false, false);
-            echo wp_json_encode(array_merge($notices, array('return_data' => $CNT_ISO)));
-            die();
-        } else {
-            $this->_redirect_after_action($success, 'State', 'added', array('action' => 'country_settings'));
-        }
-    }
-
-
-    /**
-     *        delete_state
-     *
-     * @access    public
-     * @return        boolean
-     */
-    public function delete_state()
-    {
-        $CNT_ISO    = isset($this->_req_data['CNT_ISO'])
-            ? strtoupper(sanitize_text_field($this->_req_data['CNT_ISO']))
-            : false;
-        $STA_ID     = isset($this->_req_data['STA_ID'])
-            ? sanitize_text_field($this->_req_data['STA_ID'])
-            : false;
-        $STA_abbrev = isset($this->_req_data['STA_abbrev'])
-            ? sanitize_text_field($this->_req_data['STA_abbrev'])
-            : false;
-        if (! $STA_ID) {
-            EE_Error::add_error(
-                __('No State ID or an invalid State ID was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        $success = EEM_State::instance()->delete_by_ID($STA_ID);
-        if ($success !== false) {
-            do_action(
-                'AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
-                $CNT_ISO,
-                $STA_ID,
-                array('STA_abbrev' => $STA_abbrev)
-            );
-            EE_Error::add_success(__('The State was deleted successfully.', 'event_espresso'));
-        }
-        if (defined('DOING_AJAX')) {
-            $notices                = EE_Error::get_notices(false, false);
-            $notices['return_data'] = true;
-            echo wp_json_encode($notices);
-            die();
-        } else {
-            $this->_redirect_after_action(
-                $success,
-                'State',
-                'deleted',
-                array('action' => 'country_settings')
-            );
-        }
-    }
-
-
-    /**
-     *        _update_country_settings
-     *
-     * @access    protected
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _update_country_settings()
-    {
-        // grab the country ISO code
-        $CNT_ISO = isset($this->_req_data['country'])
-            ? strtoupper(sanitize_text_field($this->_req_data['country']))
-            : false;
-        if (! $CNT_ISO) {
-            EE_Error::add_error(
-                __('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-
-            return;
-        }
-        $cols_n_values                    = array();
-        $cols_n_values['CNT_ISO3']        = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_ISO3'])
-            ? strtoupper(sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_ISO3']))
-            : false;
-        $cols_n_values['RGN_ID']          = isset($this->_req_data['cntry'][$CNT_ISO]['RGN_ID'])
-            ? absint($this->_req_data['cntry'][$CNT_ISO]['RGN_ID'])
-            : null;
-        $cols_n_values['CNT_name']        = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_name'])
-            ? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_name'])
-            : null;
-        $cols_n_values['CNT_cur_code']    = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_code'])
-            ? strtoupper(sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_code']))
-            : 'USD';
-        $cols_n_values['CNT_cur_single']  = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_single'])
-            ? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_single'])
-            : 'dollar';
-        $cols_n_values['CNT_cur_plural']  = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_plural'])
-            ? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_plural'])
-            : 'dollars';
-        $cols_n_values['CNT_cur_sign']    = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_sign'])
-            ? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_sign'])
-            : '$';
-        $cols_n_values['CNT_cur_sign_b4'] = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_sign_b4'])
-            ? absint($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_sign_b4'])
-            : true;
-        $cols_n_values['CNT_cur_dec_plc'] = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_dec_plc'])
-            ? absint($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_dec_plc'])
-            : 2;
-        $cols_n_values['CNT_cur_dec_mrk'] = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_dec_mrk'])
-            ? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_dec_mrk'])
-            : '.';
-        $cols_n_values['CNT_cur_thsnds']  = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_thsnds'])
-            ? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_thsnds'])
-            : ',';
-        $cols_n_values['CNT_tel_code']    = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_tel_code'])
-            ? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_tel_code'])
-            : null;
-        $cols_n_values['CNT_is_EU']       = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_is_EU'])
-            ? absint($this->_req_data['cntry'][$CNT_ISO]['CNT_is_EU'])
-            : false;
-        $cols_n_values['CNT_active']      = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_active'])
-            ? absint($this->_req_data['cntry'][$CNT_ISO]['CNT_active'])
-            : false;
-        // allow filtering of country data
-        $cols_n_values = apply_filters(
-            'FHEE__General_Settings_Admin_Page___update_country_settings__cols_n_values',
-            $cols_n_values
-        );
-
-        // where values
-        $where_cols_n_values = array(array('CNT_ISO' => $CNT_ISO));
-        // run the update
-        $success = EEM_Country::instance()->update($cols_n_values, $where_cols_n_values);
-
-        if (isset($this->_req_data['states']) && is_array($this->_req_data['states']) && $success !== false) {
-            // allow filtering of states data
-            $states = apply_filters(
-                'FHEE__General_Settings_Admin_Page___update_country_settings__states',
-                $this->_req_data['states']
-            );
-
-            // loop thru state data ( looks like : states[75][STA_name] )
-            foreach ($states as $STA_ID => $state) {
-                $cols_n_values = array(
-                    'CNT_ISO'    => $CNT_ISO,
-                    'STA_abbrev' => sanitize_text_field($state['STA_abbrev']),
-                    'STA_name'   => sanitize_text_field($state['STA_name']),
-                    'STA_active' => (bool)absint($state['STA_active']),
-                );
-                // where values
-                $where_cols_n_values = array(array('STA_ID' => $STA_ID));
-                // run the update
-                $success = EEM_State::instance()->update($cols_n_values, $where_cols_n_values);
-                if ($success !== false) {
-                    do_action(
-                        'AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
-                        $CNT_ISO,
-                        $STA_ID,
-                        $cols_n_values
-                    );
-                }
-            }
-        }
-        // check if country being edited matches org option country, and if so, then  update EE_Config with new settings
-        if (isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
-            && $CNT_ISO == EE_Registry::instance()->CFG->organization->CNT_ISO
-        ) {
-            EE_Registry::instance()->CFG->currency = new EE_Currency_Config($CNT_ISO);
-            EE_Registry::instance()->CFG->update_espresso_config();
-        }
-
-        if ($success !== false) {
-            EE_Error::add_success(
-                esc_html__('Country Settings updated successfully.', 'event_espresso')
-            );
-        }
-        $this->_redirect_after_action(
-            $success,
-            '',
-            '',
-            array('action' => 'country_settings', 'country' => $CNT_ISO),
-            true
-        );
-    }
-
-
-    /**
-     *        form_form_field_label_wrap
-     *
-     * @access        public
-     * @param        string $label
-     * @return        string
-     */
-    public function country_form_field_label_wrap($label, $required_text)
-    {
-        return '
+	/**
+	 * _question_group
+	 * holds the specific question group object for the question group details screen
+	 *
+	 * @var object
+	 */
+	protected $_question_group;
+
+
+	/**
+	 * Initialize basic properties.
+	 */
+	protected function _init_page_props()
+	{
+		$this->page_slug        = GEN_SET_PG_SLUG;
+		$this->page_label       = GEN_SET_LABEL;
+		$this->_admin_base_url  = GEN_SET_ADMIN_URL;
+		$this->_admin_base_path = GEN_SET_ADMIN;
+	}
+
+
+	/**
+	 * Set ajax hooks
+	 */
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_espresso_display_country_settings', array($this, 'display_country_settings'));
+		add_action('wp_ajax_espresso_display_country_states', array($this, 'display_country_states'));
+		add_action('wp_ajax_espresso_delete_state', array($this, 'delete_state'), 10, 3);
+		add_action('wp_ajax_espresso_add_new_state', array($this, 'add_new_state'));
+	}
+
+
+	/**
+	 * More page properties initialization.
+	 */
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = GEN_SET_LABEL;
+		$this->_labels           = array(
+			'publishbox' => __('Update Settings', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * Set page routes property.
+	 */
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = array(
+
+			'critical_pages'                => array(
+				'func'       => '_espresso_page_settings',
+				'capability' => 'manage_options',
+			),
+			'update_espresso_page_settings' => array(
+				'func'       => '_update_espresso_page_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'default'                       => array(
+				'func'       => '_your_organization_settings',
+				'capability' => 'manage_options',
+			),
+
+			'update_your_organization_settings' => array(
+				'func'       => '_update_your_organization_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+
+			'admin_option_settings' => array(
+				'func'       => '_admin_option_settings',
+				'capability' => 'manage_options',
+			),
+
+			'update_admin_option_settings' => array(
+				'func'       => '_update_admin_option_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+
+			'country_settings' => array(
+				'func'       => '_country_settings',
+				'capability' => 'manage_options',
+			),
+
+			'update_country_settings' => array(
+				'func'       => '_update_country_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+
+			'display_country_settings' => array(
+				'func'       => 'display_country_settings',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+
+			'add_new_state' => array(
+				'func'       => 'add_new_state',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+
+			'delete_state' => array(
+				'func'       => 'delete_state',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+		);
+	}
+
+
+	/**
+	 * Set page configuration property
+	 */
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'critical_pages'        => array(
+				'nav'           => array(
+					'label' => __('Critical Pages', 'event_espresso'),
+					'order' => 50,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'general_settings_critical_pages_help_tab' => array(
+						'title'    => __('Critical Pages', 'event_espresso'),
+						'filename' => 'general_settings_critical_pages',
+					),
+				),
+				'help_tour'     => array('Critical_Pages_Help_Tour'),
+				'require_nonce' => false,
+			),
+			'default'               => array(
+				'nav'           => array(
+					'label' => __('Your Organization', 'event_espresso'),
+					'order' => 20,
+				),
+				'help_tabs'     => array(
+					'general_settings_your_organization_help_tab' => array(
+						'title'    => __('Your Organization', 'event_espresso'),
+						'filename' => 'general_settings_your_organization',
+					),
+				),
+				'help_tour'     => array('Your_Organization_Help_Tour'),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'require_nonce' => false,
+			),
+			'admin_option_settings' => array(
+				'nav'           => array(
+					'label' => __('Admin Options', 'event_espresso'),
+					'order' => 60,
+				),
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, array('_publish_post_box')),
+				'help_tabs'     => array(
+					'general_settings_admin_options_help_tab' => array(
+						'title'    => __('Admin Options', 'event_espresso'),
+						'filename' => 'general_settings_admin_options',
+					),
+				),
+				'help_tour'     => array('Admin_Options_Help_Tour'),
+				'require_nonce' => false,
+			),
+			'country_settings'      => array(
+				'nav'           => array(
+					'label' => __('Countries', 'event_espresso'),
+					'order' => 70,
+				),
+				'help_tabs'     => array(
+					'general_settings_countries_help_tab' => array(
+						'title'    => __('Countries', 'event_espresso'),
+						'filename' => 'general_settings_countries',
+					),
+				),
+				'help_tour'     => array('Countries_Help_Tour'),
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+
+	protected function _add_screen_options()
+	{
+	}
+
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	/**
+	 * Enqueue global scripts and styles for all routes in the General Settings Admin Pages.
+	 */
+	public function load_scripts_styles()
+	{
+		//styles
+		wp_enqueue_style('espresso-ui-theme');
+		//scripts
+		wp_enqueue_script('ee_admin_js');
+	}
+
+
+	/**
+	 * Execute logic running on `admin_init`
+	 */
+	public function admin_init()
+	{
+		EE_Registry::$i18n_js_strings['invalid_server_response'] = __(
+			'An error occurred! Your request may have been processed, but a valid response from the server was not received. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['error_occurred']          = __(
+			'An error occurred! Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['confirm_delete_state']    = __(
+			'Are you sure you want to delete this State / Province?',
+			'event_espresso'
+		);
+		$protocol                                                = isset($_SERVER['HTTPS']) ? 'https://' : 'http://';
+		EE_Registry::$i18n_js_strings['ajax_url']                = admin_url(
+			'admin-ajax.php?page=espresso_general_settings',
+			$protocol
+		);
+	}
+
+	public function admin_notices()
+	{
+	}
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the default route.
+	 */
+	public function load_scripts_styles_default()
+	{
+		//styles
+		wp_enqueue_style('thickbox');
+		//scripts
+		wp_enqueue_script('media-upload');
+		wp_enqueue_script('thickbox');
+		wp_register_script(
+			'organization_settings',
+			GEN_SET_ASSETS_URL . 'your_organization_settings.js',
+			array('jquery', 'media-upload', 'thickbox'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_script('organization_settings');
+		wp_enqueue_style('organization-css');
+		$confirm_image_delete = array(
+			'text' => __(
+				'Do you really want to delete this image? Please remember to save your settings to complete the removal.',
+				'event_espresso'
+			),
+		);
+		wp_localize_script('organization_settings', 'confirm_image_delete', $confirm_image_delete);
+	}
+
+
+	/**
+	 * Enqueue scripts and styles for the country settings route.
+	 */
+	public function load_scripts_styles_country_settings()
+	{
+		//scripts
+		wp_register_script(
+			'gen_settings_countries',
+			GEN_SET_ASSETS_URL . 'gen_settings_countries.js',
+			array('ee_admin_js'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_style('organization-css', GEN_SET_ASSETS_URL . 'organization.css', array(), EVENT_ESPRESSO_VERSION);
+		wp_enqueue_script('gen_settings_countries');
+		wp_enqueue_style('organization-css');
+	}
+
+
+	/*************        Espresso Pages        *************/
+	/**
+	 * _espresso_page_settings
+	 *
+	 * @throws \EE_Error
+	 */
+	protected function _espresso_page_settings()
+	{
+		// Check to make sure all of the main pages are setup properly,
+		// if not create the default pages and display an admin notice
+		EEH_Activation::verify_default_pages_exist();
+		$this->_transient_garbage_collection();
+		$this->_template_args['values']             = $this->_yes_no_values;
+		$this->_template_args['reg_page_id']        = isset(EE_Registry::instance()->CFG->core->reg_page_id)
+			? EE_Registry::instance()->CFG->core->reg_page_id
+			: null;
+		$this->_template_args['reg_page_obj']       = isset(EE_Registry::instance()->CFG->core->reg_page_id)
+			? get_page(EE_Registry::instance()->CFG->core->reg_page_id)
+			: false;
+		$this->_template_args['txn_page_id']        = isset(EE_Registry::instance()->CFG->core->txn_page_id)
+			? EE_Registry::instance()->CFG->core->txn_page_id
+			: null;
+		$this->_template_args['txn_page_obj']       = isset(EE_Registry::instance()->CFG->core->txn_page_id)
+			? get_page(EE_Registry::instance()->CFG->core->txn_page_id)
+			: false;
+		$this->_template_args['thank_you_page_id']  = isset(EE_Registry::instance()->CFG->core->thank_you_page_id)
+			? EE_Registry::instance()->CFG->core->thank_you_page_id
+			: null;
+		$this->_template_args['thank_you_page_obj'] = isset(EE_Registry::instance()->CFG->core->thank_you_page_id)
+			? get_page(EE_Registry::instance()->CFG->core->thank_you_page_id)
+			: false;
+		$this->_template_args['cancel_page_id']     = isset(EE_Registry::instance()->CFG->core->cancel_page_id)
+			? EE_Registry::instance()->CFG->core->cancel_page_id
+			: null;
+		$this->_template_args['cancel_page_obj']    = isset(EE_Registry::instance()->CFG->core->cancel_page_id)
+			? get_page(EE_Registry::instance()->CFG->core->cancel_page_id)
+			: false;
+		$this->_set_add_edit_form_tags('update_espresso_page_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'espresso_page_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating espresso page settings.
+	 */
+	protected function _update_espresso_page_settings()
+	{
+		// capture incoming request data && set page IDs
+		EE_Registry::instance()->CFG->core->reg_page_id       = isset($this->_req_data['reg_page_id'])
+			? absint($this->_req_data['reg_page_id'])
+			: EE_Registry::instance()->CFG->core->reg_page_id;
+		EE_Registry::instance()->CFG->core->txn_page_id       = isset($this->_req_data['txn_page_id'])
+			? absint($this->_req_data['txn_page_id'])
+			: EE_Registry::instance()->CFG->core->txn_page_id;
+		EE_Registry::instance()->CFG->core->thank_you_page_id = isset($this->_req_data['thank_you_page_id'])
+			? absint($this->_req_data['thank_you_page_id'])
+			: EE_Registry::instance()->CFG->core->thank_you_page_id;
+		EE_Registry::instance()->CFG->core->cancel_page_id    = isset($this->_req_data['cancel_page_id'])
+			? absint($this->_req_data['cancel_page_id'])
+			: EE_Registry::instance()->CFG->core->cancel_page_id;
+
+		EE_Registry::instance()->CFG->core = apply_filters(
+			'FHEE__General_Settings_Admin_Page___update_espresso_page_settings__CFG_core',
+			EE_Registry::instance()->CFG->core,
+			$this->_req_data
+		);
+		$what                              = __('Critical Pages & Shortcodes', 'event_espresso');
+		$this->_redirect_after_action(
+			$this->_update_espresso_configuration(
+				$what,
+				EE_Registry::instance()->CFG->core,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			),
+			$what,
+			'',
+			array(
+				'action' => 'critical_pages',
+			),
+			true
+		);
+	}
+
+
+	/*************        Your Organization        *************/
+
+
+	/**
+	 * Output for the Your Organization settings route.
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _your_organization_settings()
+	{
+
+		$this->_template_args['site_license_key']       = isset(
+			EE_Registry::instance()->NET_CFG->core->site_license_key
+		)
+			? EE_Registry::instance()->NET_CFG->core->get_pretty('site_license_key')
+			: '';
+		$this->_template_args['organization_name']      = isset(EE_Registry::instance()->CFG->organization->name)
+			? EE_Registry::instance()->CFG->organization->get_pretty('name')
+			: '';
+		$this->_template_args['organization_address_1'] = isset(EE_Registry::instance()->CFG->organization->address_1)
+			? EE_Registry::instance()->CFG->organization->get_pretty('address_1')
+			: '';
+		$this->_template_args['organization_address_2'] = isset(EE_Registry::instance()->CFG->organization->address_2)
+			? EE_Registry::instance()->CFG->organization->get_pretty('address_2')
+			: '';
+		$this->_template_args['organization_city']      = isset(EE_Registry::instance()->CFG->organization->city)
+			? EE_Registry::instance()->CFG->organization->get_pretty('city')
+			: '';
+		$this->_template_args['organization_zip']       = isset(EE_Registry::instance()->CFG->organization->zip)
+			? EE_Registry::instance()->CFG->organization->get_pretty('zip')
+			: '';
+		$this->_template_args['organization_email']     = isset(EE_Registry::instance()->CFG->organization->email)
+			? EE_Registry::instance()->CFG->organization->get_pretty('email')
+			: '';
+		$this->_template_args['organization_phone']     = isset(EE_Registry::instance()->CFG->organization->phone)
+			? EE_Registry::instance()->CFG->organization->get_pretty('phone')
+			: '';
+		$this->_template_args['organization_vat']       = isset(EE_Registry::instance()->CFG->organization->vat)
+			? EE_Registry::instance()->CFG->organization->get_pretty('vat')
+			: '';
+		$this->_template_args['currency_sign']          = isset(EE_Registry::instance()->CFG->currency->sign)
+			? EE_Registry::instance()->CFG->currency->get_pretty('sign')
+			: '$';
+		$this->_template_args['organization_logo_url']  = isset(EE_Registry::instance()->CFG->organization->logo_url)
+			? EE_Registry::instance()->CFG->organization->get_pretty('logo_url')
+			: false;
+		$this->_template_args['organization_facebook']  = isset(EE_Registry::instance()->CFG->organization->facebook)
+			? EE_Registry::instance()->CFG->organization->get_pretty('facebook')
+			: '';
+		$this->_template_args['organization_twitter']   = isset(EE_Registry::instance()->CFG->organization->twitter)
+			? EE_Registry::instance()->CFG->organization->get_pretty('twitter')
+			: '';
+		$this->_template_args['organization_linkedin']  = isset(EE_Registry::instance()->CFG->organization->linkedin)
+			? EE_Registry::instance()->CFG->organization->get_pretty('linkedin')
+			: '';
+		$this->_template_args['organization_pinterest'] = isset(EE_Registry::instance()->CFG->organization->pinterest)
+			? EE_Registry::instance()->CFG->organization->get_pretty('pinterest')
+			: '';
+		$this->_template_args['organization_google']    = isset(EE_Registry::instance()->CFG->organization->google)
+			? EE_Registry::instance()->CFG->organization->get_pretty('google')
+			: '';
+		$this->_template_args['organization_instagram'] = isset(EE_Registry::instance()->CFG->organization->instagram)
+			? EE_Registry::instance()->CFG->organization->get_pretty('instagram')
+			: '';
+		//UXIP settings
+		$this->_template_args['ee_ueip_optin'] = isset(EE_Registry::instance()->CFG->core->ee_ueip_optin)
+			? EE_Registry::instance()->CFG->core->get_pretty('ee_ueip_optin')
+			: 'yes';
+
+		$STA_ID                         = isset(EE_Registry::instance()->CFG->organization->STA_ID)
+			? EE_Registry::instance()->CFG->organization->STA_ID
+			: 4;
+		$this->_template_args['states'] = new EE_Question_Form_Input(
+			EE_Question::new_instance(array(
+				'QST_ID'           => 0,
+				'QST_display_text' => __('State/Province', 'event_espresso'),
+				'QST_system'       => 'admin-state',
+			)),
+			EE_Answer::new_instance(array(
+				'ANS_ID'    => 0,
+				'ANS_value' => $STA_ID,
+			)),
+			array(
+				'input_id'       => 'organization_state',
+				'input_name'     => 'organization_state',
+				'input_prefix'   => '',
+				'append_qstn_id' => false,
+			)
+		);
+
+		$CNT_ISO                           = isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: 'US';
+		$this->_template_args['countries'] = new EE_Question_Form_Input(
+			EE_Question::new_instance(array(
+				'QST_ID'           => 0,
+				'QST_display_text' => __('Country', 'event_espresso'),
+				'QST_system'       => 'admin-country',
+			)),
+			EE_Answer::new_instance(array(
+				'ANS_ID'    => 0,
+				'ANS_value' => $CNT_ISO,
+			)),
+			array(
+				'input_id'       => 'organization_country',
+				'input_name'     => 'organization_country',
+				'input_prefix'   => '',
+				'append_qstn_id' => false,
+			)
+		);
+
+		add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
+		add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
+
+		//PUE verification stuff
+		$ver_option_key                                    = 'puvererr_' . basename(EE_PLUGIN_BASENAME);
+		$verify_fail                                       = get_option($ver_option_key);
+		$this->_template_args['site_license_key_verified'] = $verify_fail
+															 || ! empty($verify_fail)
+															 || (empty($this->_template_args['site_license_key'])
+																 && empty($verify_fail)
+															 )
+			? '<span class="dashicons dashicons-admin-network ee-icon-color-ee-red ee-icon-size-20"></span>'
+			: '<span class="dashicons dashicons-admin-network ee-icon-color-ee-green ee-icon-size-20"></span>';
+
+		$this->_set_add_edit_form_tags('update_your_organization_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'your_organization_settings.template.php',
+			$this->_template_args,
+			true
+		);
+
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * Handler for updating organziation settings.
+	 */
+	protected function _update_your_organization_settings()
+	{
+		if (is_main_site()) {
+			EE_Registry::instance()->NET_CFG->core->site_license_key = isset($this->_req_data['site_license_key'])
+				? sanitize_text_field($this->_req_data['site_license_key'])
+				: EE_Registry::instance()->NET_CFG->core->site_license_key;
+		}
+		EE_Registry::instance()->CFG->organization->name      = isset($this->_req_data['organization_name'])
+			? sanitize_text_field($this->_req_data['organization_name'])
+			: EE_Registry::instance()->CFG->organization->name;
+		EE_Registry::instance()->CFG->organization->address_1 = isset($this->_req_data['organization_address_1'])
+			? sanitize_text_field($this->_req_data['organization_address_1'])
+			: EE_Registry::instance()->CFG->organization->address_1;
+		EE_Registry::instance()->CFG->organization->address_2 = isset($this->_req_data['organization_address_2'])
+			? sanitize_text_field($this->_req_data['organization_address_2'])
+			: EE_Registry::instance()->CFG->organization->address_2;
+		EE_Registry::instance()->CFG->organization->city      = isset($this->_req_data['organization_city'])
+			? sanitize_text_field($this->_req_data['organization_city'])
+			: EE_Registry::instance()->CFG->organization->city;
+		EE_Registry::instance()->CFG->organization->STA_ID    = isset($this->_req_data['organization_state'])
+			? absint($this->_req_data['organization_state'])
+			: EE_Registry::instance()->CFG->organization->STA_ID;
+		EE_Registry::instance()->CFG->organization->CNT_ISO   = isset($this->_req_data['organization_country'])
+			? sanitize_text_field($this->_req_data['organization_country'])
+			: EE_Registry::instance()->CFG->organization->CNT_ISO;
+		EE_Registry::instance()->CFG->organization->zip       = isset($this->_req_data['organization_zip'])
+			? sanitize_text_field($this->_req_data['organization_zip'])
+			: EE_Registry::instance()->CFG->organization->zip;
+		EE_Registry::instance()->CFG->organization->email     = isset($this->_req_data['organization_email'])
+			? sanitize_email($this->_req_data['organization_email'])
+			: EE_Registry::instance()->CFG->organization->email;
+		EE_Registry::instance()->CFG->organization->vat       = isset($this->_req_data['organization_vat'])
+			? sanitize_text_field($this->_req_data['organization_vat'])
+			: EE_Registry::instance()->CFG->organization->vat;
+		EE_Registry::instance()->CFG->organization->phone     = isset($this->_req_data['organization_phone'])
+			? sanitize_text_field($this->_req_data['organization_phone'])
+			: EE_Registry::instance()->CFG->organization->phone;
+		EE_Registry::instance()->CFG->organization->logo_url  = isset($this->_req_data['organization_logo_url'])
+			? esc_url_raw($this->_req_data['organization_logo_url'])
+			: EE_Registry::instance()->CFG->organization->logo_url;
+		EE_Registry::instance()->CFG->organization->facebook  = isset($this->_req_data['organization_facebook'])
+			? esc_url_raw($this->_req_data['organization_facebook'])
+			: EE_Registry::instance()->CFG->organization->facebook;
+		EE_Registry::instance()->CFG->organization->twitter   = isset($this->_req_data['organization_twitter'])
+			? esc_url_raw($this->_req_data['organization_twitter'])
+			: EE_Registry::instance()->CFG->organization->twitter;
+		EE_Registry::instance()->CFG->organization->linkedin  = isset($this->_req_data['organization_linkedin'])
+			? esc_url_raw($this->_req_data['organization_linkedin'])
+			: EE_Registry::instance()->CFG->organization->linkedin;
+		EE_Registry::instance()->CFG->organization->pinterest = isset($this->_req_data['organization_pinterest'])
+			? esc_url_raw($this->_req_data['organization_pinterest'])
+			: EE_Registry::instance()->CFG->organization->pinterest;
+		EE_Registry::instance()->CFG->organization->google    = isset($this->_req_data['organization_google'])
+			? esc_url_raw($this->_req_data['organization_google'])
+			: EE_Registry::instance()->CFG->organization->google;
+		EE_Registry::instance()->CFG->organization->instagram = isset($this->_req_data['organization_instagram'])
+			? esc_url_raw($this->_req_data['organization_instagram'])
+			: EE_Registry::instance()->CFG->organization->instagram;
+		EE_Registry::instance()->CFG->core->ee_ueip_optin     = isset($this->_req_data['ueip_optin'])
+																&& ! empty($this->_req_data['ueip_optin'])
+			? filter_var($this->_req_data['ueip_optin'], FILTER_VALIDATE_BOOLEAN)
+			: EE_Registry::instance()->CFG->core->ee_ueip_optin;
+
+		EE_Registry::instance()->CFG->currency = new EE_Currency_Config(
+			EE_Registry::instance()->CFG->organization->CNT_ISO
+		);
+
+		EE_Registry::instance()->CFG = apply_filters(
+			'FHEE__General_Settings_Admin_Page___update_your_organization_settings__CFG',
+			EE_Registry::instance()->CFG
+		);
+
+		$what    = 'Your Organization Settings';
+		$success = $this->_update_espresso_configuration(
+			$what,
+			EE_Registry::instance()->CFG,
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+
+		$this->_redirect_after_action($success, $what, 'updated', array('action' => 'default'));
+	}
+
+
+
+	/*************        Admin Options        *************/
+
+
+	/**
+	 * _admin_option_settings
+	 *
+	 * @throws \EE_Error
+	 * @throws \LogicException
+	 */
+	protected function _admin_option_settings()
+	{
+		$this->_template_args['admin_page_content'] = '';
+		try {
+			$admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
+			// still need this for the old school form in Extend_General_Settings_Admin_Page
+			$this->_template_args['values'] = $this->_yes_no_values;
+			// also need to account for the do_action that was in the old template
+			$admin_options_settings_form->setTemplateArgs($this->_template_args);
+			$this->_template_args['admin_page_content'] = $admin_options_settings_form->display();
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		$this->_set_add_edit_form_tags('update_admin_option_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * _update_admin_option_settings
+	 *
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidFormSubmissionException
+	 * @throws \InvalidArgumentException
+	 * @throws \LogicException
+	 */
+	protected function _update_admin_option_settings()
+	{
+		try {
+			$admin_options_settings_form = new AdminOptionsSettings(EE_Registry::instance());
+			$admin_options_settings_form->process($this->_req_data[$admin_options_settings_form->slug()]);
+			EE_Registry::instance()->CFG->admin = apply_filters(
+				'FHEE__General_Settings_Admin_Page___update_admin_option_settings__CFG_admin',
+				EE_Registry::instance()->CFG->admin
+			);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		$this->_redirect_after_action(
+			apply_filters(
+				'FHEE__General_Settings_Admin_Page___update_admin_option_settings__success',
+				$this->_update_espresso_configuration(
+					'Admin Options',
+					EE_Registry::instance()->CFG->admin,
+					__FILE__, __FUNCTION__, __LINE__
+				)
+			),
+			'Admin Options',
+			'updated',
+			array('action' => 'admin_option_settings')
+		);
+
+	}
+
+
+	/*************        Countries        *************/
+
+
+	/**
+	 * Output Country Settings view.
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _country_settings()
+	{
+		$CNT_ISO = isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
+			? EE_Registry::instance()->CFG->organization->CNT_ISO
+			: 'US';
+		$CNT_ISO = isset($this->_req_data['country'])
+			? strtoupper(sanitize_text_field($this->_req_data['country']))
+			: $CNT_ISO;
+
+		//load field generator helper
+
+		$this->_template_args['values'] = $this->_yes_no_values;
+
+		$this->_template_args['countries'] = new EE_Question_Form_Input(
+			EE_Question::new_instance(array(
+				'QST_ID'           => 0,
+				'QST_display_text' => __('Select Country', 'event_espresso'),
+				'QST_system'       => 'admin-country',
+			)),
+			EE_Answer::new_instance(array(
+				'ANS_ID'    => 0,
+				'ANS_value' => $CNT_ISO,
+			)),
+			array(
+				'input_id'       => 'country',
+				'input_name'     => 'country',
+				'input_prefix'   => '',
+				'append_qstn_id' => false,
+			)
+		);
+
+		add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
+		add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
+		$this->_template_args['country_details_settings'] = $this->display_country_settings();
+		$this->_template_args['country_states_settings']  = $this->display_country_states();
+
+		$this->_set_add_edit_form_tags('update_country_settings');
+		$this->_set_publish_post_box_vars(null, false, false, null, false);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'countries_settings.template.php',
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_no_sidebar();
+	}
+
+
+	/**
+	 *        display_country_settings
+	 *
+	 * @access    public
+	 * @param    string $CNT_ISO
+	 * @return mixed string | array
+	 * @throws DomainException
+	 */
+	public function display_country_settings($CNT_ISO = '')
+	{
+
+		$CNT_ISO = isset($this->_req_data['country'])
+			? strtoupper(sanitize_text_field($this->_req_data['country']))
+			: $CNT_ISO;
+		if (! $CNT_ISO) {
+			return '';
+		}
+
+		// for ajax
+		remove_all_filters('FHEE__EEH_Form_Fields__label_html');
+		remove_all_filters('FHEE__EEH_Form_Fields__input_html');
+		add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'country_form_field_label_wrap'), 10, 2);
+		add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'country_form_field_input__wrap'), 10, 2);
+		$country = EEM_Country::instance()->get_one_by_ID($CNT_ISO);
+
+		$country_input_types            = array(
+			'CNT_active'      => array(
+				'type'             => 'RADIO_BTN',
+				'input_name'       => 'cntry[' . $CNT_ISO . ']',
+				'class'            => '',
+				'options'          => $this->_yes_no_values,
+				'use_desc_4_label' => true,
+			),
+			'CNT_ISO'         => array(
+				'type'       => 'TEXT',
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
+				'class'      => 'small-text',
+			),
+			'CNT_ISO3'        => array(
+				'type'       => 'TEXT',
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
+				'class'      => 'small-text',
+			),
+			'RGN_ID'          => array(
+				'type'       => 'TEXT',
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
+				'class'      => 'small-text',
+			),
+			'CNT_name'        => array(
+				'type'       => 'TEXT',
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
+				'class'      => 'regular-text',
+			),
+			'CNT_cur_code'    => array(
+				'type'       => 'TEXT',
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
+				'class'      => 'small-text',
+			),
+			'CNT_cur_single'  => array(
+				'type'       => 'TEXT',
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
+				'class'      => 'medium-text',
+			),
+			'CNT_cur_plural'  => array(
+				'type'       => 'TEXT',
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
+				'class'      => 'medium-text',
+			),
+			'CNT_cur_sign'    => array(
+				'type'         => 'TEXT',
+				'input_name'   => 'cntry[' . $CNT_ISO . ']',
+				'class'        => 'small-text',
+				'htmlentities' => false,
+			),
+			'CNT_cur_sign_b4' => array(
+				'type'             => 'RADIO_BTN',
+				'input_name'       => 'cntry[' . $CNT_ISO . ']',
+				'class'            => '',
+				'options'          => $this->_yes_no_values,
+				'use_desc_4_label' => true,
+			),
+			'CNT_cur_dec_plc' => array(
+				'type'       => 'RADIO_BTN',
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
+				'class'      => '',
+				'options'    => array(
+					array('id' => 0, 'text' => ''),
+					array('id' => 1, 'text' => ''),
+					array('id' => 2, 'text' => ''),
+					array('id' => 3, 'text' => ''),
+				),
+			),
+			'CNT_cur_dec_mrk' => array(
+				'type'             => 'RADIO_BTN',
+				'input_name'       => 'cntry[' . $CNT_ISO . ']',
+				'class'            => '',
+				'options'          => array(
+					array(
+						'id'   => ',',
+						'text' => __(', (comma)', 'event_espresso'),
+					),
+					array('id' => '.', 'text' => __('. (decimal)', 'event_espresso')),
+				),
+				'use_desc_4_label' => true,
+			),
+			'CNT_cur_thsnds'  => array(
+				'type'             => 'RADIO_BTN',
+				'input_name'       => 'cntry[' . $CNT_ISO . ']',
+				'class'            => '',
+				'options'          => array(
+					array(
+						'id'   => ',',
+						'text' => __(', (comma)', 'event_espresso'),
+					),
+					array('id' => '.', 'text' => __('. (decimal)', 'event_espresso')),
+				),
+				'use_desc_4_label' => true,
+			),
+			'CNT_tel_code'    => array(
+				'type'       => 'TEXT',
+				'input_name' => 'cntry[' . $CNT_ISO . ']',
+				'class'      => 'small-text',
+			),
+			'CNT_is_EU'       => array(
+				'type'             => 'RADIO_BTN',
+				'input_name'       => 'cntry[' . $CNT_ISO . ']',
+				'class'            => '',
+				'options'          => $this->_yes_no_values,
+				'use_desc_4_label' => true,
+			),
+		);
+		$this->_template_args['inputs'] = EE_Question_Form_Input::generate_question_form_inputs_for_object(
+			$country,
+			$country_input_types
+		);
+		$country_details_settings       = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'country_details_settings.template.php',
+			$this->_template_args,
+			true
+		);
+
+		if (defined('DOING_AJAX')) {
+			$notices = EE_Error::get_notices(false, false, false);
+			echo wp_json_encode(array(
+				'return_data' => $country_details_settings,
+				'success'     => $notices['success'],
+				'errors'      => $notices['errors'],
+			));
+			die();
+		} else {
+			return $country_details_settings;
+		}
+	}
+
+
+	/**
+	 *        display_country_states
+	 *
+	 * @access    public
+	 * @param    string $CNT_ISO
+	 * @return string
+	 * @throws DomainException
+	 */
+	public function display_country_states($CNT_ISO = '')
+	{
+
+		$CNT_ISO = isset($this->_req_data['country']) ? sanitize_text_field($this->_req_data['country']) : $CNT_ISO;
+
+		if (! $CNT_ISO) {
+			return '';
+		}
+		// for ajax
+		remove_all_filters('FHEE__EEH_Form_Fields__label_html');
+		remove_all_filters('FHEE__EEH_Form_Fields__input_html');
+		add_filter('FHEE__EEH_Form_Fields__label_html', array($this, 'state_form_field_label_wrap'), 10, 2);
+		add_filter('FHEE__EEH_Form_Fields__input_html', array($this, 'state_form_field_input__wrap'), 10, 2);
+		$states = EEM_State::instance()->get_all_states_for_these_countries(array($CNT_ISO => $CNT_ISO));
+
+		if ($states) {
+			foreach ($states as $STA_ID => $state) {
+				if ($state instanceof EE_State) {
+					//STA_abbrev 	STA_name 	STA_active
+					$state_input_types                                           = array(
+						'STA_abbrev' => array(
+							'type'       => 'TEXT',
+							'input_name' => 'states[' . $STA_ID . ']',
+							'class'      => 'mid-text',
+						),
+						'STA_name'   => array(
+							'type'       => 'TEXT',
+							'input_name' => 'states[' . $STA_ID . ']',
+							'class'      => 'regular-text',
+						),
+						'STA_active' => array(
+							'type'             => 'RADIO_BTN',
+							'input_name'       => 'states[' . $STA_ID . ']',
+							'options'          => $this->_yes_no_values,
+							'use_desc_4_label' => true,
+						),
+					);
+					$this->_template_args['states'][$STA_ID]['inputs'] =
+						EE_Question_Form_Input::generate_question_form_inputs_for_object(
+							$state,
+							$state_input_types
+						);
+					$query_args                                                  = array(
+						'action'     => 'delete_state',
+						'STA_ID'     => $STA_ID,
+						'CNT_ISO'    => $CNT_ISO,
+						'STA_abbrev' => $state->abbrev(),
+					);
+					$this->_template_args['states'][$STA_ID]['delete_state_url'] =
+						EE_Admin_Page::add_query_args_and_nonce(
+							$query_args,
+							GEN_SET_ADMIN_URL
+						);
+				}
+			}
+		} else {
+			$this->_template_args['states'] = false;
+		}
+
+		$this->_template_args['add_new_state_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'add_new_state'),
+			GEN_SET_ADMIN_URL
+		);
+
+		$state_details_settings = EEH_Template::display_template(
+			GEN_SET_TEMPLATE_PATH . 'state_details_settings.template.php',
+			$this->_template_args,
+			true
+		);
+
+		if (defined('DOING_AJAX')) {
+			$notices = EE_Error::get_notices(false, false, false);
+			echo wp_json_encode(array(
+				'return_data' => $state_details_settings,
+				'success'     => $notices['success'],
+				'errors'      => $notices['errors'],
+			));
+			die();
+		} else {
+			return $state_details_settings;
+		}
+	}
+
+
+	/**
+	 *        add_new_state
+	 *
+	 * @access    public
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function add_new_state()
+	{
+
+		$success = true;
+
+		$CNT_ISO = isset($this->_req_data['CNT_ISO'])
+			? strtoupper(sanitize_text_field($this->_req_data['CNT_ISO']))
+			: false;
+		if (! $CNT_ISO) {
+			EE_Error::add_error(
+				__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		$STA_abbrev = isset($this->_req_data['STA_abbrev'])
+			? sanitize_text_field($this->_req_data['STA_abbrev'])
+			: false;
+		if (! $STA_abbrev) {
+			EE_Error::add_error(
+				__('No State ISO code or an invalid State ISO code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		$STA_name = isset($this->_req_data['STA_name'])
+			? sanitize_text_field($this->_req_data['STA_name'])
+			: false;
+		if (! $STA_name) {
+			EE_Error::add_error(
+				__('No State name or an invalid State name was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+
+		if ($success) {
+			$cols_n_values = array(
+				'CNT_ISO'    => $CNT_ISO,
+				'STA_abbrev' => $STA_abbrev,
+				'STA_name'   => $STA_name,
+				'STA_active' => true,
+			);
+			$success       = EEM_State::instance()->insert($cols_n_values);
+			EE_Error::add_success(__('The State was added successfully.', 'event_espresso'));
+		}
+
+		if (defined('DOING_AJAX')) {
+			$notices = EE_Error::get_notices(false, false, false);
+			echo wp_json_encode(array_merge($notices, array('return_data' => $CNT_ISO)));
+			die();
+		} else {
+			$this->_redirect_after_action($success, 'State', 'added', array('action' => 'country_settings'));
+		}
+	}
+
+
+	/**
+	 *        delete_state
+	 *
+	 * @access    public
+	 * @return        boolean
+	 */
+	public function delete_state()
+	{
+		$CNT_ISO    = isset($this->_req_data['CNT_ISO'])
+			? strtoupper(sanitize_text_field($this->_req_data['CNT_ISO']))
+			: false;
+		$STA_ID     = isset($this->_req_data['STA_ID'])
+			? sanitize_text_field($this->_req_data['STA_ID'])
+			: false;
+		$STA_abbrev = isset($this->_req_data['STA_abbrev'])
+			? sanitize_text_field($this->_req_data['STA_abbrev'])
+			: false;
+		if (! $STA_ID) {
+			EE_Error::add_error(
+				__('No State ID or an invalid State ID was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		$success = EEM_State::instance()->delete_by_ID($STA_ID);
+		if ($success !== false) {
+			do_action(
+				'AHEE__General_Settings_Admin_Page__delete_state__state_deleted',
+				$CNT_ISO,
+				$STA_ID,
+				array('STA_abbrev' => $STA_abbrev)
+			);
+			EE_Error::add_success(__('The State was deleted successfully.', 'event_espresso'));
+		}
+		if (defined('DOING_AJAX')) {
+			$notices                = EE_Error::get_notices(false, false);
+			$notices['return_data'] = true;
+			echo wp_json_encode($notices);
+			die();
+		} else {
+			$this->_redirect_after_action(
+				$success,
+				'State',
+				'deleted',
+				array('action' => 'country_settings')
+			);
+		}
+	}
+
+
+	/**
+	 *        _update_country_settings
+	 *
+	 * @access    protected
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _update_country_settings()
+	{
+		// grab the country ISO code
+		$CNT_ISO = isset($this->_req_data['country'])
+			? strtoupper(sanitize_text_field($this->_req_data['country']))
+			: false;
+		if (! $CNT_ISO) {
+			EE_Error::add_error(
+				__('No Country ISO code or an invalid Country ISO code was received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+
+			return;
+		}
+		$cols_n_values                    = array();
+		$cols_n_values['CNT_ISO3']        = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_ISO3'])
+			? strtoupper(sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_ISO3']))
+			: false;
+		$cols_n_values['RGN_ID']          = isset($this->_req_data['cntry'][$CNT_ISO]['RGN_ID'])
+			? absint($this->_req_data['cntry'][$CNT_ISO]['RGN_ID'])
+			: null;
+		$cols_n_values['CNT_name']        = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_name'])
+			? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_name'])
+			: null;
+		$cols_n_values['CNT_cur_code']    = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_code'])
+			? strtoupper(sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_code']))
+			: 'USD';
+		$cols_n_values['CNT_cur_single']  = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_single'])
+			? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_single'])
+			: 'dollar';
+		$cols_n_values['CNT_cur_plural']  = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_plural'])
+			? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_plural'])
+			: 'dollars';
+		$cols_n_values['CNT_cur_sign']    = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_sign'])
+			? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_sign'])
+			: '$';
+		$cols_n_values['CNT_cur_sign_b4'] = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_sign_b4'])
+			? absint($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_sign_b4'])
+			: true;
+		$cols_n_values['CNT_cur_dec_plc'] = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_dec_plc'])
+			? absint($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_dec_plc'])
+			: 2;
+		$cols_n_values['CNT_cur_dec_mrk'] = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_dec_mrk'])
+			? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_dec_mrk'])
+			: '.';
+		$cols_n_values['CNT_cur_thsnds']  = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_thsnds'])
+			? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_cur_thsnds'])
+			: ',';
+		$cols_n_values['CNT_tel_code']    = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_tel_code'])
+			? sanitize_text_field($this->_req_data['cntry'][$CNT_ISO]['CNT_tel_code'])
+			: null;
+		$cols_n_values['CNT_is_EU']       = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_is_EU'])
+			? absint($this->_req_data['cntry'][$CNT_ISO]['CNT_is_EU'])
+			: false;
+		$cols_n_values['CNT_active']      = isset($this->_req_data['cntry'][$CNT_ISO]['CNT_active'])
+			? absint($this->_req_data['cntry'][$CNT_ISO]['CNT_active'])
+			: false;
+		// allow filtering of country data
+		$cols_n_values = apply_filters(
+			'FHEE__General_Settings_Admin_Page___update_country_settings__cols_n_values',
+			$cols_n_values
+		);
+
+		// where values
+		$where_cols_n_values = array(array('CNT_ISO' => $CNT_ISO));
+		// run the update
+		$success = EEM_Country::instance()->update($cols_n_values, $where_cols_n_values);
+
+		if (isset($this->_req_data['states']) && is_array($this->_req_data['states']) && $success !== false) {
+			// allow filtering of states data
+			$states = apply_filters(
+				'FHEE__General_Settings_Admin_Page___update_country_settings__states',
+				$this->_req_data['states']
+			);
+
+			// loop thru state data ( looks like : states[75][STA_name] )
+			foreach ($states as $STA_ID => $state) {
+				$cols_n_values = array(
+					'CNT_ISO'    => $CNT_ISO,
+					'STA_abbrev' => sanitize_text_field($state['STA_abbrev']),
+					'STA_name'   => sanitize_text_field($state['STA_name']),
+					'STA_active' => (bool)absint($state['STA_active']),
+				);
+				// where values
+				$where_cols_n_values = array(array('STA_ID' => $STA_ID));
+				// run the update
+				$success = EEM_State::instance()->update($cols_n_values, $where_cols_n_values);
+				if ($success !== false) {
+					do_action(
+						'AHEE__General_Settings_Admin_Page__update_country_settings__state_saved',
+						$CNT_ISO,
+						$STA_ID,
+						$cols_n_values
+					);
+				}
+			}
+		}
+		// check if country being edited matches org option country, and if so, then  update EE_Config with new settings
+		if (isset(EE_Registry::instance()->CFG->organization->CNT_ISO)
+			&& $CNT_ISO == EE_Registry::instance()->CFG->organization->CNT_ISO
+		) {
+			EE_Registry::instance()->CFG->currency = new EE_Currency_Config($CNT_ISO);
+			EE_Registry::instance()->CFG->update_espresso_config();
+		}
+
+		if ($success !== false) {
+			EE_Error::add_success(
+				esc_html__('Country Settings updated successfully.', 'event_espresso')
+			);
+		}
+		$this->_redirect_after_action(
+			$success,
+			'',
+			'',
+			array('action' => 'country_settings', 'country' => $CNT_ISO),
+			true
+		);
+	}
+
+
+	/**
+	 *        form_form_field_label_wrap
+	 *
+	 * @access        public
+	 * @param        string $label
+	 * @return        string
+	 */
+	public function country_form_field_label_wrap($label, $required_text)
+	{
+		return '
 			<tr>
 				<th>
 					' . $label . '
 				</th>';
-    }
-
-
-    /**
-     *        form_form_field_input__wrap
-     *
-     * @access        public
-     * @param        string $label
-     * @return        string
-     */
-    public function country_form_field_input__wrap($input, $label)
-    {
-        return '
+	}
+
+
+	/**
+	 *        form_form_field_input__wrap
+	 *
+	 * @access        public
+	 * @param        string $label
+	 * @return        string
+	 */
+	public function country_form_field_input__wrap($input, $label)
+	{
+		return '
 				<td class="general-settings-country-input-td">
 					' . $input . '
 				</td>
 			</tr>';
-    }
-
-
-    /**
-     *        form_form_field_label_wrap
-     *
-     * @access        public
-     * @param        string $label
-     * @param        string $required_text
-     * @return        string
-     */
-    public function state_form_field_label_wrap($label, $required_text)
-    {
-        return $required_text;
-    }
-
-
-    /**
-     *        form_form_field_input__wrap
-     *
-     * @access        public
-     * @param        string $label
-     * @return        string
-     */
-    public function state_form_field_input__wrap($input, $label)
-    {
-        return '
+	}
+
+
+	/**
+	 *        form_form_field_label_wrap
+	 *
+	 * @access        public
+	 * @param        string $label
+	 * @param        string $required_text
+	 * @return        string
+	 */
+	public function state_form_field_label_wrap($label, $required_text)
+	{
+		return $required_text;
+	}
+
+
+	/**
+	 *        form_form_field_input__wrap
+	 *
+	 * @access        public
+	 * @param        string $label
+	 * @return        string
+	 */
+	public function state_form_field_input__wrap($input, $label)
+	{
+		return '
 				<td class="general-settings-country-state-input-td">
 					' . $input . '
 				</td>';
-    }
-
-
-    /***********/
-
-
-    /**
-     * displays edit and view links for critical EE pages
-     *
-     * @access public
-     * @param int $ee_page_id
-     * @return string
-     */
-    public static function edit_view_links($ee_page_id)
-    {
-        $links = '<a href="'
-                 . add_query_arg(
-                     array('post' => $ee_page_id, 'action' => 'edit'),
-                     admin_url('post.php')
-                 )
-                 . '" >'
-                 . __('Edit', 'event_espresso')
-                 . '</a>';
-        $links .= ' &nbsp;|&nbsp; ';
-        $links .= '<a href="' . get_permalink($ee_page_id) . '" >' . __('View', 'event_espresso') . '</a>';
-
-        return $links;
-    }
-
-
-    /**
-     * displays page and shortcode status for critical EE pages
-     *
-     * @param WP page object $ee_page
-     * @return string
-     */
-    public static function page_and_shortcode_status($ee_page, $shortcode)
-    {
-
-        // page status
-        if (isset($ee_page->post_status) && $ee_page->post_status == 'publish') {
-            $pg_colour = 'green';
-            $pg_status = sprintf(__('Page%sStatus%sOK', 'event_espresso'), '&nbsp;', '&nbsp;');
-        } else {
-            $pg_colour = 'red';
-            $pg_status = sprintf(__('Page%sVisibility%sProblem', 'event_espresso'), '&nbsp;', '&nbsp;');
-        }
-
-        // shortcode status
-        if (isset($ee_page->post_content) && strpos($ee_page->post_content, $shortcode) !== false) {
-            $sc_colour = 'green';
-            $sc_status = sprintf(__('Shortcode%sOK', 'event_espresso'), '&nbsp;');
-        } else {
-            $sc_colour = 'red';
-            $sc_status = sprintf(__('Shortcode%sProblem', 'event_espresso'), '&nbsp;');
-        }
-
-        return '<span style="color:' . $pg_colour . '; margin-right:2em;"><strong>'
-               . $pg_status
-               . '</strong></span><span style="color:' . $sc_colour . '"><strong>' . $sc_status . '</strong></span>';
-    }
-
-
-    /**
-     * generates a dropdown of all parent pages - copied from WP core
-     *
-     * @param int $default
-     * @param int $parent
-     * @param int $level
-     */
-    public static function page_settings_dropdown($default = 0, $parent = 0, $level = 0)
-    {
-        global $wpdb;
-        $items = $wpdb->get_results(
-            $wpdb->prepare(
-                "SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status != 'trash' ORDER BY menu_order",
-                $parent
-            )
-        );
-
-        if ($items) {
-            foreach ($items as $item) {
-                $pad = str_repeat('&nbsp;', $level * 3);
-                if ($item->ID == $default) {
-                    $current = ' selected="selected"';
-                } else {
-                    $current = '';
-                }
-
-                echo "\n\t<option class='level-$level' value='$item->ID'$current>$pad "
-                     . esc_html($item->post_title)
-                     . "</option>";
-                parent_dropdown($default, $item->ID, $level + 1);
-            }
-        }
-    }
+	}
+
+
+	/***********/
+
+
+	/**
+	 * displays edit and view links for critical EE pages
+	 *
+	 * @access public
+	 * @param int $ee_page_id
+	 * @return string
+	 */
+	public static function edit_view_links($ee_page_id)
+	{
+		$links = '<a href="'
+				 . add_query_arg(
+					 array('post' => $ee_page_id, 'action' => 'edit'),
+					 admin_url('post.php')
+				 )
+				 . '" >'
+				 . __('Edit', 'event_espresso')
+				 . '</a>';
+		$links .= ' &nbsp;|&nbsp; ';
+		$links .= '<a href="' . get_permalink($ee_page_id) . '" >' . __('View', 'event_espresso') . '</a>';
+
+		return $links;
+	}
+
+
+	/**
+	 * displays page and shortcode status for critical EE pages
+	 *
+	 * @param WP page object $ee_page
+	 * @return string
+	 */
+	public static function page_and_shortcode_status($ee_page, $shortcode)
+	{
+
+		// page status
+		if (isset($ee_page->post_status) && $ee_page->post_status == 'publish') {
+			$pg_colour = 'green';
+			$pg_status = sprintf(__('Page%sStatus%sOK', 'event_espresso'), '&nbsp;', '&nbsp;');
+		} else {
+			$pg_colour = 'red';
+			$pg_status = sprintf(__('Page%sVisibility%sProblem', 'event_espresso'), '&nbsp;', '&nbsp;');
+		}
+
+		// shortcode status
+		if (isset($ee_page->post_content) && strpos($ee_page->post_content, $shortcode) !== false) {
+			$sc_colour = 'green';
+			$sc_status = sprintf(__('Shortcode%sOK', 'event_espresso'), '&nbsp;');
+		} else {
+			$sc_colour = 'red';
+			$sc_status = sprintf(__('Shortcode%sProblem', 'event_espresso'), '&nbsp;');
+		}
+
+		return '<span style="color:' . $pg_colour . '; margin-right:2em;"><strong>'
+			   . $pg_status
+			   . '</strong></span><span style="color:' . $sc_colour . '"><strong>' . $sc_status . '</strong></span>';
+	}
+
+
+	/**
+	 * generates a dropdown of all parent pages - copied from WP core
+	 *
+	 * @param int $default
+	 * @param int $parent
+	 * @param int $level
+	 */
+	public static function page_settings_dropdown($default = 0, $parent = 0, $level = 0)
+	{
+		global $wpdb;
+		$items = $wpdb->get_results(
+			$wpdb->prepare(
+				"SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' AND post_status != 'trash' ORDER BY menu_order",
+				$parent
+			)
+		);
+
+		if ($items) {
+			foreach ($items as $item) {
+				$pad = str_repeat('&nbsp;', $level * 3);
+				if ($item->ID == $default) {
+					$current = ' selected="selected"';
+				} else {
+					$current = '';
+				}
+
+				echo "\n\t<option class='level-$level' value='$item->ID'$current>$pad "
+					 . esc_html($item->post_title)
+					 . "</option>";
+				parent_dropdown($default, $item->ID, $level + 1);
+			}
+		}
+	}
 }

core/EE_Session.core.php

Doc Comments +3 added lines, -3 removed lines

@@ -542,7 +542,7 @@ 
     /**
      * @initiate session
      * @access   private
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException
@@ -778,7 +778,7 @@ 
      * @update session data  prior to saving to the db
      * @access public
      * @param bool $new_session
-     * @return TRUE on success, FALSE on fail
+     * @return boolean on success, FALSE on fail
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException
@@ -879,7 +879,7 @@ 
      * _save_session_to_db
      *
      * @param bool $clear_session
-     * @return string
+     * @return boolean
      * @throws EE_Error
      * @throws InvalidArgumentException
      * @throws InvalidDataTypeException

Indentation +1226 added lines, -1226 removed lines

@@ -22,1229 +22,1229 @@ 
 class EE_Session implements SessionIdentifierInterface
 {
 
-    const session_id_prefix    = 'ee_ssn_';
-
-    const hash_check_prefix    = 'ee_shc_';
-
-    const OPTION_NAME_SETTINGS = 'ee_session_settings';
-
-    const STATUS_CLOSED        = 0;
-
-    const STATUS_OPEN          = 1;
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @var EE_Session
-     */
-    private static $_instance;
-
-    /**
-     * @var CacheStorageInterface $cache_storage
-     */
-    protected $cache_storage;
-
-    /**
-     * EE_Encryption object
-     *
-     * @var EE_Encryption
-     */
-    protected $encryption;
-
-    /**
-     * the session id
-     *
-     * @var string
-     */
-    private $_sid;
-
-    /**
-     * session id salt
-     *
-     * @var string
-     */
-    private $_sid_salt;
-
-    /**
-     * session data
-     *
-     * @var array
-     */
-    private $_session_data = array();
-
-    /**
-     * how long an EE session lasts
-     * default session lifespan of 1 hour (for not so instant IPNs)
-     *
-     * @var SessionLifespan $session_lifespan
-     */
-    private $session_lifespan;
-
-    /**
-     * session expiration time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_expiration;
-
-    /**
-     * whether or not session has expired at some point
-     *
-     * @var boolean
-     */
-    private $_expired = false;
-
-    /**
-     * current time as Unix timestamp in GMT
-     *
-     * @var int
-     */
-    private $_time;
-
-    /**
-     * whether to encrypt session data
-     *
-     * @var bool
-     */
-    private $_use_encryption;
-
-    /**
-     * well... according to the server...
-     *
-     * @var null
-     */
-    private $_user_agent;
-
-    /**
-     * do you really trust the server ?
-     *
-     * @var null
-     */
-    private $_ip_address;
-
-    /**
-     * current WP user_id
-     *
-     * @var null
-     */
-    private $_wp_user_id;
-
-    /**
-     * array for defining default session vars
-     *
-     * @var array
-     */
-    private $_default_session_vars = array(
-        'id'            => null,
-        'user_id'       => null,
-        'ip_address'    => null,
-        'user_agent'    => null,
-        'init_access'   => null,
-        'last_access'   => null,
-        'expiration'    => null,
-        'pages_visited' => array(),
-    );
-
-    /**
-     * timestamp for when last garbage collection cycle was performed
-     *
-     * @var int $_last_gc
-     */
-    private $_last_gc;
-
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
-
-    /**
-     * whether session is active or not
-     *
-     * @var int $status
-     */
-    private $status = EE_Session::STATUS_CLOSED;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan|null  $lifespan
-     * @param RequestInterface      $request
-     * @param EE_Encryption         $encryption
-     * @return EE_Session
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instance(
-        CacheStorageInterface $cache_storage = null,
-        SessionLifespan $lifespan = null,
-        RequestInterface $request = null,
-        EE_Encryption $encryption = null
-    ) {
-        // check if class object is instantiated
-        // session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
-        // add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
-            self::$_instance = new self(
-                $cache_storage,
-                $lifespan,
-                $request,
-                $encryption
-            );
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param CacheStorageInterface $cache_storage
-     * @param SessionLifespan       $lifespan
-     * @param RequestInterface      $request
-     * @param EE_Encryption         $encryption
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function __construct(
-        CacheStorageInterface $cache_storage,
-        SessionLifespan $lifespan,
-        RequestInterface $request,
-        EE_Encryption $encryption = null
-    ) {
-        // session loading is turned ON by default,
-        // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
-        // (which currently fires on the init hook at priority 9),
-        // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
-            return;
-        }
-        $this->session_lifespan = $lifespan;
-        $this->request          = $request;
-        if (! defined('ESPRESSO_SESSION')) {
-            define('ESPRESSO_SESSION', true);
-        }
-        // retrieve session options from db
-        $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
-            // cycle though existing session options
-            foreach ($session_settings as $var_name => $session_setting) {
-                // set values for class properties
-                $var_name          = '_' . $var_name;
-                $this->{$var_name} = $session_setting;
-            }
-        }
-        $this->cache_storage = $cache_storage;
-        // are we using encryption?
-        $this->_use_encryption = $encryption instanceof EE_Encryption
-                                 && EE_Registry::instance()->CFG->admin->encode_session_data();
-        // encrypt data via: $this->encryption->encrypt();
-        $this->encryption = $encryption;
-        // filter hook allows outside functions/classes/plugins to change default empty cart
-        $extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
-        array_merge($this->_default_session_vars, $extra_default_session_vars);
-        // apply default session vars
-        $this->_set_defaults();
-        add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
-        // check request for 'clear_session' param
-        add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
-        // once everything is all said and done,
-        add_action('shutdown', array($this, 'update'), 100);
-        add_action('shutdown', array($this, 'garbageCollection'), 1000);
-        $this->configure_garbage_collection_filters();
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function isLoadedAndActive()
-    {
-        return did_action('AHEE__EE_System__core_loaded_and_ready')
-               && EE_Session::instance() instanceof EE_Session
-               && EE_Session::instance()->isActive();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActive()
-    {
-        return $this->status === EE_Session::STATUS_OPEN;
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     */
-    public function open_session()
-    {
-        // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
-            // or just start a new one
-            $this->_create_espresso_session();
-        }
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function expired()
-    {
-        return $this->_expired;
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function reset_expired()
-    {
-        $this->_expired = false;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function expiration()
-    {
-        return $this->_expiration;
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function extension()
-    {
-        return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
-    }
-
-
-
-    /**
-     * @param int $time number of seconds to add to session expiration
-     */
-    public function extend_expiration($time = 0)
-    {
-        $time              = $time ? $time : $this->extension();
-        $this->_expiration += absint($time);
-    }
-
-
-
-    /**
-     * @return int
-     */
-    public function lifespan()
-    {
-        return $this->session_lifespan->inSeconds();
-    }
-
-
-
-    /**
-     * This just sets some defaults for the _session data property
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_defaults()
-    {
-        // set some defaults
-        foreach ($this->_default_session_vars as $key => $default_var) {
-            if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
-            } else {
-                $this->_session_data[ $key ] = '';
-            }
-        }
-    }
+	const session_id_prefix    = 'ee_ssn_';
+
+	const hash_check_prefix    = 'ee_shc_';
+
+	const OPTION_NAME_SETTINGS = 'ee_session_settings';
+
+	const STATUS_CLOSED        = 0;
+
+	const STATUS_OPEN          = 1;
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @var EE_Session
+	 */
+	private static $_instance;
+
+	/**
+	 * @var CacheStorageInterface $cache_storage
+	 */
+	protected $cache_storage;
+
+	/**
+	 * EE_Encryption object
+	 *
+	 * @var EE_Encryption
+	 */
+	protected $encryption;
+
+	/**
+	 * the session id
+	 *
+	 * @var string
+	 */
+	private $_sid;
+
+	/**
+	 * session id salt
+	 *
+	 * @var string
+	 */
+	private $_sid_salt;
+
+	/**
+	 * session data
+	 *
+	 * @var array
+	 */
+	private $_session_data = array();
+
+	/**
+	 * how long an EE session lasts
+	 * default session lifespan of 1 hour (for not so instant IPNs)
+	 *
+	 * @var SessionLifespan $session_lifespan
+	 */
+	private $session_lifespan;
+
+	/**
+	 * session expiration time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_expiration;
+
+	/**
+	 * whether or not session has expired at some point
+	 *
+	 * @var boolean
+	 */
+	private $_expired = false;
+
+	/**
+	 * current time as Unix timestamp in GMT
+	 *
+	 * @var int
+	 */
+	private $_time;
+
+	/**
+	 * whether to encrypt session data
+	 *
+	 * @var bool
+	 */
+	private $_use_encryption;
+
+	/**
+	 * well... according to the server...
+	 *
+	 * @var null
+	 */
+	private $_user_agent;
+
+	/**
+	 * do you really trust the server ?
+	 *
+	 * @var null
+	 */
+	private $_ip_address;
+
+	/**
+	 * current WP user_id
+	 *
+	 * @var null
+	 */
+	private $_wp_user_id;
+
+	/**
+	 * array for defining default session vars
+	 *
+	 * @var array
+	 */
+	private $_default_session_vars = array(
+		'id'            => null,
+		'user_id'       => null,
+		'ip_address'    => null,
+		'user_agent'    => null,
+		'init_access'   => null,
+		'last_access'   => null,
+		'expiration'    => null,
+		'pages_visited' => array(),
+	);
+
+	/**
+	 * timestamp for when last garbage collection cycle was performed
+	 *
+	 * @var int $_last_gc
+	 */
+	private $_last_gc;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
+
+	/**
+	 * whether session is active or not
+	 *
+	 * @var int $status
+	 */
+	private $status = EE_Session::STATUS_CLOSED;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan|null  $lifespan
+	 * @param RequestInterface      $request
+	 * @param EE_Encryption         $encryption
+	 * @return EE_Session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function instance(
+		CacheStorageInterface $cache_storage = null,
+		SessionLifespan $lifespan = null,
+		RequestInterface $request = null,
+		EE_Encryption $encryption = null
+	) {
+		// check if class object is instantiated
+		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
+		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
+			self::$_instance = new self(
+				$cache_storage,
+				$lifespan,
+				$request,
+				$encryption
+			);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param CacheStorageInterface $cache_storage
+	 * @param SessionLifespan       $lifespan
+	 * @param RequestInterface      $request
+	 * @param EE_Encryption         $encryption
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function __construct(
+		CacheStorageInterface $cache_storage,
+		SessionLifespan $lifespan,
+		RequestInterface $request,
+		EE_Encryption $encryption = null
+	) {
+		// session loading is turned ON by default,
+		// but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
+		// (which currently fires on the init hook at priority 9),
+		// can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
+		if (! apply_filters('FHEE_load_EE_Session', true)) {
+			return;
+		}
+		$this->session_lifespan = $lifespan;
+		$this->request          = $request;
+		if (! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
+		}
+		// retrieve session options from db
+		$session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		if (! empty($session_settings)) {
+			// cycle though existing session options
+			foreach ($session_settings as $var_name => $session_setting) {
+				// set values for class properties
+				$var_name          = '_' . $var_name;
+				$this->{$var_name} = $session_setting;
+			}
+		}
+		$this->cache_storage = $cache_storage;
+		// are we using encryption?
+		$this->_use_encryption = $encryption instanceof EE_Encryption
+								 && EE_Registry::instance()->CFG->admin->encode_session_data();
+		// encrypt data via: $this->encryption->encrypt();
+		$this->encryption = $encryption;
+		// filter hook allows outside functions/classes/plugins to change default empty cart
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
+		// apply default session vars
+		$this->_set_defaults();
+		add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
+		// check request for 'clear_session' param
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
+		// once everything is all said and done,
+		add_action('shutdown', array($this, 'update'), 100);
+		add_action('shutdown', array($this, 'garbageCollection'), 1000);
+		$this->configure_garbage_collection_filters();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function isLoadedAndActive()
+	{
+		return did_action('AHEE__EE_System__core_loaded_and_ready')
+			   && EE_Session::instance() instanceof EE_Session
+			   && EE_Session::instance()->isActive();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActive()
+	{
+		return $this->status === EE_Session::STATUS_OPEN;
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 */
+	public function open_session()
+	{
+		// check for existing session and retrieve it from db
+		if (! $this->_espresso_session()) {
+			// or just start a new one
+			$this->_create_espresso_session();
+		}
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function expired()
+	{
+		return $this->_expired;
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function reset_expired()
+	{
+		$this->_expired = false;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function expiration()
+	{
+		return $this->_expiration;
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function extension()
+	{
+		return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS);
+	}
+
+
+
+	/**
+	 * @param int $time number of seconds to add to session expiration
+	 */
+	public function extend_expiration($time = 0)
+	{
+		$time              = $time ? $time : $this->extension();
+		$this->_expiration += absint($time);
+	}
+
+
+
+	/**
+	 * @return int
+	 */
+	public function lifespan()
+	{
+		return $this->session_lifespan->inSeconds();
+	}
+
+
+
+	/**
+	 * This just sets some defaults for the _session data property
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_defaults()
+	{
+		// set some defaults
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[ $key ] = array();
+			} else {
+				$this->_session_data[ $key ] = '';
+			}
+		}
+	}
 
 
-
-    /**
-     * @retrieve  session data
-     * @access    public
-     * @return    string
-     */
-    public function id()
-    {
-        return $this->_sid;
-    }
+
+	/**
+	 * @retrieve  session data
+	 * @access    public
+	 * @return    string
+	 */
+	public function id()
+	{
+		return $this->_sid;
+	}
 
 
 
-    /**
-     * @param \EE_Cart $cart
-     * @return bool
-     */
-    public function set_cart(EE_Cart $cart)
-    {
-        $this->_session_data['cart'] = $cart;
-        return true;
-    }
-
-
-
-    /**
-     * reset_cart
-     */
-    public function reset_cart()
-    {
-        do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
-        $this->_session_data['cart'] = null;
-    }
-
-
-
-    /**
-     * @return \EE_Cart
-     */
-    public function cart()
-    {
-        return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
-            ? $this->_session_data['cart']
-            : null;
-    }
-
-
-
-    /**
-     * @param \EE_Checkout $checkout
-     * @return bool
-     */
-    public function set_checkout(EE_Checkout $checkout)
-    {
-        $this->_session_data['checkout'] = $checkout;
-        return true;
-    }
-
-
-
-    /**
-     * reset_checkout
-     */
-    public function reset_checkout()
-    {
-        do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
-        $this->_session_data['checkout'] = null;
-    }
-
-
-
-    /**
-     * @return \EE_Checkout
-     */
-    public function checkout()
-    {
-        return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
-            ? $this->_session_data['checkout']
-            : null;
-    }
-
-
-
-    /**
-     * @param \EE_Transaction $transaction
-     * @return bool
-     * @throws EE_Error
-     */
-    public function set_transaction(EE_Transaction $transaction)
-    {
-        // first remove the session from the transaction before we save the transaction in the session
-        $transaction->set_txn_session_data(null);
-        $this->_session_data['transaction'] = $transaction;
-        return true;
-    }
-
-
-
-    /**
-     * reset_transaction
-     */
-    public function reset_transaction()
-    {
-        do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
-        $this->_session_data['transaction'] = null;
-    }
-
-
-
-    /**
-     * @return \EE_Transaction
-     */
-    public function transaction()
-    {
-        return isset($this->_session_data['transaction'])
-               && $this->_session_data['transaction'] instanceof EE_Transaction
-            ? $this->_session_data['transaction']
-            : null;
-    }
-
-
-    /**
-     * retrieve session data
-     *
-     * @param null $key
-     * @param bool $reset_cache
-     * @return array
-     */
-    public function get_session_data($key = null, $reset_cache = false)
-    {
-        if ($reset_cache) {
-            $this->reset_cart();
-            $this->reset_checkout();
-            $this->reset_transaction();
-        }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
-        }
-        return $this->_session_data;
-    }
-
-
-    /**
-     * Returns TRUE on success, FALSE on fail
-     *
-     * @param array $data
-     * @return bool
-     */
-    public function set_session_data($data)
-    {
-        // nothing ??? bad data ??? go home!
-        if (empty($data) || ! is_array($data)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'No session data or invalid session data was provided.',
-                    'event_espresso'
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-            return false;
-        }
-        foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Sorry! %s is a default session datum and can not be reset.',
-                            'event_espresso'
-                        ),
-                        $key
-                    ),
-                    __FILE__, __FUNCTION__, __LINE__
-                );
-                return false;
-            }
-            $this->_session_data[ $key ] = $value;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * @initiate session
-     * @access   private
-     * @return TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidSessionDataException
-     */
-    private function _espresso_session()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // check that session has started
-        if (session_id() === '') {
-            //starts a new session if one doesn't already exist, or re-initiates an existing one
-            session_start();
-        }
-        $this->status = EE_Session::STATUS_OPEN;
-        // get our modified session ID
-        $this->_sid = $this->_generate_session_id();
-        // and the visitors IP
-        $this->_ip_address = $this->request->ipAddress();
-        // set the "user agent"
-        $this->_user_agent = $this->request->userAgent();
-        // now let's retrieve what's in the db
-        $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
-            // get the current time in UTC
-            $this->_time = $this->_time !== null ? $this->_time : time();
-            // and reset the session expiration
-            $this->_expiration = isset($session_data['expiration'])
-                ? $session_data['expiration']
-                : $this->_time + $this->session_lifespan->inSeconds();
-        } else {
-            // set initial site access time and the session expiration
-            $this->_set_init_access_and_expiration();
-            // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = isset($_SERVER['HTTP_REFERER'])
-                ? esc_attr($_SERVER['HTTP_REFERER'])
-                : '';
-            // no previous session = go back and create one (on top of the data above)
-            return false;
-        }
-        // now the user agent
-        if ($session_data['user_agent'] !== $this->_user_agent) {
-            return false;
-        }
-        // wait a minute... how old are you?
-        if ($this->_time > $this->_expiration) {
-            // yer too old fer me!
-            $this->_expired = true;
-            // wipe out everything that isn't a default session datum
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-        // make event espresso session data available to plugin
-        $this->_session_data = array_merge($this->_session_data, $session_data);
-        return true;
-    }
-
-
-
-    /**
-     * _get_session_data
-     * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
-     * databases
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidSessionDataException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _retrieve_session_data()
-    {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
-        try {
-            // we're using WP's Transient API to store session data using the PHP session ID as the option name
-            $session_data = $this->cache_storage->get($ssn_key, false);
-            if (empty($session_data)) {
-                return array();
-            }
-            if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-                $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
-                    false
-                );
-                if ($hash_check && $hash_check !== md5($session_data)) {
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
-                                'event_espresso'
-                            ),
-                            EE_Session::session_id_prefix . $this->_sid
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                }
-            }
-        } catch (Exception $e) {
-            // let's just eat that error for now and attempt to correct any corrupted data
-            global $wpdb;
-            $row          = $wpdb->get_row(
-                $wpdb->prepare(
-                    "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
-                )
-            );
-            $session_data = is_object($row) ? $row->option_value : null;
-            if ($session_data) {
-                $session_data = preg_replace_callback(
-                    '!s:(d+):"(.*?)";!',
-                    function ($match)
-                    {
-                        return $match[1] === strlen($match[2])
-                            ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
-                    },
-                    $session_data
-                );
-            }
-            $session_data = maybe_unserialize($session_data);
-        }
-        // in case the data is encoded... try to decode it
-        $session_data = $this->encryption instanceof EE_Encryption
-            ? $this->encryption->base64_string_decode($session_data)
-            : $session_data;
-        if (! is_array($session_data)) {
-            try {
-                $session_data = maybe_unserialize($session_data);
-            } catch (Exception $e) {
-                $msg = esc_html__(
-                    'An error occurred while attempting to unserialize the session data.',
-                    'event_espresso'
-                );
-                $msg .= WP_DEBUG
-                    ? '<br><pre>'
-                      . print_r($session_data, true)
-                      . '</pre><br>'
-                      . $this->find_serialize_error($session_data)
-                    : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-                throw new InvalidSessionDataException($msg, 0, $e);
-            }
-        }
-        // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
-            // no?!?! then something is wrong
-            $msg = esc_html__(
-                'The session data is missing, invalid, or corrupted.',
-                'event_espresso'
-            );
-            $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
-                : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
-            throw new InvalidSessionDataException($msg);
-        }
-        if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
-            $session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
-                $session_data['transaction']
-            );
-        }
-        return $session_data;
-    }
-
-
-
-    /**
-     * _generate_session_id
-     * Retrieves the PHP session id either directly from the PHP session,
-     * or from the $_REQUEST array if it was passed in from an AJAX request.
-     * The session id is then salted and hashed (mmm sounds tasty)
-     * so that it can be safely used as a $_REQUEST param
-     *
-     * @return string
-     */
-    protected function _generate_session_id()
-    {
-        // check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
-        if (isset($_REQUEST['EESID'])) {
-            $session_id = sanitize_text_field($_REQUEST['EESID']);
-        } else {
-            $session_id = md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
-        }
-        return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
-    }
-
-
-
-    /**
-     * _get_sid_salt
-     *
-     * @return string
-     */
-    protected function _get_sid_salt()
-    {
-        // was session id salt already saved to db ?
-        if (empty($this->_sid_salt)) {
-            // no?  then maybe use WP defined constant
-            if (defined('AUTH_SALT')) {
-                $this->_sid_salt = AUTH_SALT;
-            }
-            // if salt doesn't exist or is too short
-            if (strlen($this->_sid_salt) < 32) {
-                // create a new one
-                $this->_sid_salt = wp_generate_password(64);
-            }
-            // and save it as a permanent session setting
-            $this->updateSessionSettings(array('sid_salt' => $this->_sid_salt));
-        }
-        return $this->_sid_salt;
-    }
-
-
-
-    /**
-     * _set_init_access_and_expiration
-     *
-     * @return void
-     */
-    protected function _set_init_access_and_expiration()
-    {
-        $this->_time       = time();
-        $this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
-        // set initial site access time
-        $this->_session_data['init_access'] = $this->_time;
-        // and the session expiration
-        $this->_session_data['expiration'] = $this->_expiration;
-    }
-
-
-
-    /**
-     * @update session data  prior to saving to the db
-     * @access public
-     * @param bool $new_session
-     * @return TRUE on success, FALSE on fail
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update($new_session = false)
-    {
-        $this->_session_data = $this->_session_data !== null
-                               && is_array($this->_session_data)
-                               && isset($this->_session_data['id'])
-            ? $this->_session_data
-            : array();
-        if (empty($this->_session_data)) {
-            $this->_set_defaults();
-        }
-        $session_data = array();
-        foreach ($this->_session_data as $key => $value) {
-
-            switch ($key) {
-
-                case 'id' :
-                    // session ID
-                    $session_data['id'] = $this->_sid;
-                    break;
-                case 'ip_address' :
-                    // visitor ip address
-                    $session_data['ip_address'] = $this->request->ipAddress();
-                    break;
-                case 'user_agent' :
-                    // visitor user_agent
-                    $session_data['user_agent'] = $this->_user_agent;
-                    break;
-                case 'init_access' :
-                    $session_data['init_access'] = absint($value);
-                    break;
-                case 'last_access' :
-                    // current access time
-                    $session_data['last_access'] = $this->_time;
-                    break;
-                case 'expiration' :
-                    // when the session expires
-                    $session_data['expiration'] = ! empty($this->_expiration)
-                        ? $this->_expiration
-                        : $session_data['init_access'] + $this->session_lifespan->inSeconds();
-                    break;
-                case 'user_id' :
-                    // current user if logged in
-                    $session_data['user_id'] = $this->_wp_user_id();
-                    break;
-                case 'pages_visited' :
-                    $page_visit = $this->_get_page_visit();
-                    if ($page_visit) {
-                        // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
-                        // we'll only save the last 10 page visits.
-                        $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
-                    }
-                    break;
-                default :
-                    // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
-            }
-        }
-        $this->_session_data = $session_data;
-        // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
-            // ready? let's save
-            if ($this->_save_session_to_db()) {
-                return true;
-            }
-            return false;
-        }
-        // meh, why not?
-        return true;
-    }
-
-
-
-    /**
-     * @create session data array
-     * @access public
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _create_espresso_session()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
-        // use the update function for now with $new_session arg set to TRUE
-        return $this->update(true) ? true : false;
-    }
-
-
-
-    /**
-     * _save_session_to_db
-     *
-     * @param bool $clear_session
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _save_session_to_db($clear_session = false)
-    {
-        // don't save sessions for crawlers
-        // and unless we're deleting the session data, don't save anything if there isn't a cart
-        if ($this->request->isBot() || (! $clear_session && ! $this->cart() instanceof EE_Cart)) {
-            return false;
-        }
-        $transaction = $this->transaction();
-        if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
-                $transaction->save();
-            }
-            $this->_session_data['transaction'] = $transaction->ID();
-        }
-        // then serialize all of our session data
-        $session_data = serialize($this->_session_data);
-        // do we need to also encode it to avoid corrupted data when saved to the db?
-        $session_data = $this->_use_encryption
-            ? $this->encryption->base64_string_encode($session_data)
-            : $session_data;
-        // maybe save hash check
-        if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-            $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
-                md5($session_data),
-                $this->session_lifespan->inSeconds()
-            );
-        }
-        // we're using the Transient API for storing session data,
-        return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
-            $session_data,
-            $this->session_lifespan->inSeconds()
-        );
-    }
-
-
-    /**
-     * @get    the full page request the visitor is accessing
-     * @access public
-     * @return string
-     */
-    public function _get_page_visit()
-    {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
-        // check for request url
-        if (isset($_SERVER['REQUEST_URI'])) {
-            $http_host   = '';
-            $page_id     = '?';
-            $e_reg       = '';
-            $request_uri = esc_url($_SERVER['REQUEST_URI']);
-            $ru_bits     = explode('?', $request_uri);
-            $request_uri = $ru_bits[0];
-            // check for and grab host as well
-            if (isset($_SERVER['HTTP_HOST'])) {
-                $http_host = esc_url($_SERVER['HTTP_HOST']);
-            }
-            // check for page_id in SERVER REQUEST
-            if (isset($_REQUEST['page_id'])) {
-                // rebuild $e_reg without any of the extra parameters
-                $page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
-            }
-            // check for $e_reg in SERVER REQUEST
-            if (isset($_REQUEST['ee'])) {
-                // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
-            }
-            $page_visit = rtrim($http_host . $request_uri . $page_id . $e_reg, '?');
-        }
-        return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
-    }
-
-
-
-    /**
-     * @the    current wp user id
-     * @access public
-     * @return int
-     */
-    public function _wp_user_id()
-    {
-        // if I need to explain the following lines of code, then you shouldn't be looking at this!
-        $this->_wp_user_id = get_current_user_id();
-        return $this->_wp_user_id;
-    }
-
-
-
-    /**
-     * Clear EE_Session data
-     *
-     * @access public
-     * @param string $class
-     * @param string $function
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function clear_session($class = '', $function = '')
-    {
+	/**
+	 * @param \EE_Cart $cart
+	 * @return bool
+	 */
+	public function set_cart(EE_Cart $cart)
+	{
+		$this->_session_data['cart'] = $cart;
+		return true;
+	}
+
+
+
+	/**
+	 * reset_cart
+	 */
+	public function reset_cart()
+	{
+		do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
+		$this->_session_data['cart'] = null;
+	}
+
+
+
+	/**
+	 * @return \EE_Cart
+	 */
+	public function cart()
+	{
+		return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
+			? $this->_session_data['cart']
+			: null;
+	}
+
+
+
+	/**
+	 * @param \EE_Checkout $checkout
+	 * @return bool
+	 */
+	public function set_checkout(EE_Checkout $checkout)
+	{
+		$this->_session_data['checkout'] = $checkout;
+		return true;
+	}
+
+
+
+	/**
+	 * reset_checkout
+	 */
+	public function reset_checkout()
+	{
+		do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
+		$this->_session_data['checkout'] = null;
+	}
+
+
+
+	/**
+	 * @return \EE_Checkout
+	 */
+	public function checkout()
+	{
+		return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
+			? $this->_session_data['checkout']
+			: null;
+	}
+
+
+
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function set_transaction(EE_Transaction $transaction)
+	{
+		// first remove the session from the transaction before we save the transaction in the session
+		$transaction->set_txn_session_data(null);
+		$this->_session_data['transaction'] = $transaction;
+		return true;
+	}
+
+
+
+	/**
+	 * reset_transaction
+	 */
+	public function reset_transaction()
+	{
+		do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
+		$this->_session_data['transaction'] = null;
+	}
+
+
+
+	/**
+	 * @return \EE_Transaction
+	 */
+	public function transaction()
+	{
+		return isset($this->_session_data['transaction'])
+			   && $this->_session_data['transaction'] instanceof EE_Transaction
+			? $this->_session_data['transaction']
+			: null;
+	}
+
+
+	/**
+	 * retrieve session data
+	 *
+	 * @param null $key
+	 * @param bool $reset_cache
+	 * @return array
+	 */
+	public function get_session_data($key = null, $reset_cache = false)
+	{
+		if ($reset_cache) {
+			$this->reset_cart();
+			$this->reset_checkout();
+			$this->reset_transaction();
+		}
+		if (! empty($key)) {
+			return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+		}
+		return $this->_session_data;
+	}
+
+
+	/**
+	 * Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array $data
+	 * @return bool
+	 */
+	public function set_session_data($data)
+	{
+		// nothing ??? bad data ??? go home!
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(
+				esc_html__(
+					'No session data or invalid session data was provided.',
+					'event_espresso'
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+			return false;
+		}
+		foreach ($data as $key => $value) {
+			if (isset($this->_default_session_vars[ $key ])) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Sorry! %s is a default session datum and can not be reset.',
+							'event_espresso'
+						),
+						$key
+					),
+					__FILE__, __FUNCTION__, __LINE__
+				);
+				return false;
+			}
+			$this->_session_data[ $key ] = $value;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * @initiate session
+	 * @access   private
+	 * @return TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidSessionDataException
+	 */
+	private function _espresso_session()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// check that session has started
+		if (session_id() === '') {
+			//starts a new session if one doesn't already exist, or re-initiates an existing one
+			session_start();
+		}
+		$this->status = EE_Session::STATUS_OPEN;
+		// get our modified session ID
+		$this->_sid = $this->_generate_session_id();
+		// and the visitors IP
+		$this->_ip_address = $this->request->ipAddress();
+		// set the "user agent"
+		$this->_user_agent = $this->request->userAgent();
+		// now let's retrieve what's in the db
+		$session_data = $this->_retrieve_session_data();
+		if (! empty($session_data)) {
+			// get the current time in UTC
+			$this->_time = $this->_time !== null ? $this->_time : time();
+			// and reset the session expiration
+			$this->_expiration = isset($session_data['expiration'])
+				? $session_data['expiration']
+				: $this->_time + $this->session_lifespan->inSeconds();
+		} else {
+			// set initial site access time and the session expiration
+			$this->_set_init_access_and_expiration();
+			// set referer
+			$this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = isset($_SERVER['HTTP_REFERER'])
+				? esc_attr($_SERVER['HTTP_REFERER'])
+				: '';
+			// no previous session = go back and create one (on top of the data above)
+			return false;
+		}
+		// now the user agent
+		if ($session_data['user_agent'] !== $this->_user_agent) {
+			return false;
+		}
+		// wait a minute... how old are you?
+		if ($this->_time > $this->_expiration) {
+			// yer too old fer me!
+			$this->_expired = true;
+			// wipe out everything that isn't a default session datum
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+		// make event espresso session data available to plugin
+		$this->_session_data = array_merge($this->_session_data, $session_data);
+		return true;
+	}
+
+
+
+	/**
+	 * _get_session_data
+	 * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup
+	 * databases
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidSessionDataException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _retrieve_session_data()
+	{
+		$ssn_key = EE_Session::session_id_prefix . $this->_sid;
+		try {
+			// we're using WP's Transient API to store session data using the PHP session ID as the option name
+			$session_data = $this->cache_storage->get($ssn_key, false);
+			if (empty($session_data)) {
+				return array();
+			}
+			if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+				$hash_check = $this->cache_storage->get(
+					EE_Session::hash_check_prefix . $this->_sid,
+					false
+				);
+				if ($hash_check && $hash_check !== md5($session_data)) {
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
+								'event_espresso'
+							),
+							EE_Session::session_id_prefix . $this->_sid
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+				}
+			}
+		} catch (Exception $e) {
+			// let's just eat that error for now and attempt to correct any corrupted data
+			global $wpdb;
+			$row          = $wpdb->get_row(
+				$wpdb->prepare(
+					"SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
+					'_transient_' . $ssn_key
+				)
+			);
+			$session_data = is_object($row) ? $row->option_value : null;
+			if ($session_data) {
+				$session_data = preg_replace_callback(
+					'!s:(d+):"(.*?)";!',
+					function ($match)
+					{
+						return $match[1] === strlen($match[2])
+							? $match[0]
+							: 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+					},
+					$session_data
+				);
+			}
+			$session_data = maybe_unserialize($session_data);
+		}
+		// in case the data is encoded... try to decode it
+		$session_data = $this->encryption instanceof EE_Encryption
+			? $this->encryption->base64_string_decode($session_data)
+			: $session_data;
+		if (! is_array($session_data)) {
+			try {
+				$session_data = maybe_unserialize($session_data);
+			} catch (Exception $e) {
+				$msg = esc_html__(
+					'An error occurred while attempting to unserialize the session data.',
+					'event_espresso'
+				);
+				$msg .= WP_DEBUG
+					? '<br><pre>'
+					  . print_r($session_data, true)
+					  . '</pre><br>'
+					  . $this->find_serialize_error($session_data)
+					: '';
+				$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+				throw new InvalidSessionDataException($msg, 0, $e);
+			}
+		}
+		// just a check to make sure the session array is indeed an array
+		if (! is_array($session_data)) {
+			// no?!?! then something is wrong
+			$msg = esc_html__(
+				'The session data is missing, invalid, or corrupted.',
+				'event_espresso'
+			);
+			$msg .= WP_DEBUG
+				? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+				: '';
+			$this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+			throw new InvalidSessionDataException($msg);
+		}
+		if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
+			$session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
+				$session_data['transaction']
+			);
+		}
+		return $session_data;
+	}
+
+
+
+	/**
+	 * _generate_session_id
+	 * Retrieves the PHP session id either directly from the PHP session,
+	 * or from the $_REQUEST array if it was passed in from an AJAX request.
+	 * The session id is then salted and hashed (mmm sounds tasty)
+	 * so that it can be safely used as a $_REQUEST param
+	 *
+	 * @return string
+	 */
+	protected function _generate_session_id()
+	{
+		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
+		if (isset($_REQUEST['EESID'])) {
+			$session_id = sanitize_text_field($_REQUEST['EESID']);
+		} else {
+			$session_id = md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+		}
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
+	}
+
+
+
+	/**
+	 * _get_sid_salt
+	 *
+	 * @return string
+	 */
+	protected function _get_sid_salt()
+	{
+		// was session id salt already saved to db ?
+		if (empty($this->_sid_salt)) {
+			// no?  then maybe use WP defined constant
+			if (defined('AUTH_SALT')) {
+				$this->_sid_salt = AUTH_SALT;
+			}
+			// if salt doesn't exist or is too short
+			if (strlen($this->_sid_salt) < 32) {
+				// create a new one
+				$this->_sid_salt = wp_generate_password(64);
+			}
+			// and save it as a permanent session setting
+			$this->updateSessionSettings(array('sid_salt' => $this->_sid_salt));
+		}
+		return $this->_sid_salt;
+	}
+
+
+
+	/**
+	 * _set_init_access_and_expiration
+	 *
+	 * @return void
+	 */
+	protected function _set_init_access_and_expiration()
+	{
+		$this->_time       = time();
+		$this->_expiration = $this->_time + $this->session_lifespan->inSeconds();
+		// set initial site access time
+		$this->_session_data['init_access'] = $this->_time;
+		// and the session expiration
+		$this->_session_data['expiration'] = $this->_expiration;
+	}
+
+
+
+	/**
+	 * @update session data  prior to saving to the db
+	 * @access public
+	 * @param bool $new_session
+	 * @return TRUE on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update($new_session = false)
+	{
+		$this->_session_data = $this->_session_data !== null
+							   && is_array($this->_session_data)
+							   && isset($this->_session_data['id'])
+			? $this->_session_data
+			: array();
+		if (empty($this->_session_data)) {
+			$this->_set_defaults();
+		}
+		$session_data = array();
+		foreach ($this->_session_data as $key => $value) {
+
+			switch ($key) {
+
+				case 'id' :
+					// session ID
+					$session_data['id'] = $this->_sid;
+					break;
+				case 'ip_address' :
+					// visitor ip address
+					$session_data['ip_address'] = $this->request->ipAddress();
+					break;
+				case 'user_agent' :
+					// visitor user_agent
+					$session_data['user_agent'] = $this->_user_agent;
+					break;
+				case 'init_access' :
+					$session_data['init_access'] = absint($value);
+					break;
+				case 'last_access' :
+					// current access time
+					$session_data['last_access'] = $this->_time;
+					break;
+				case 'expiration' :
+					// when the session expires
+					$session_data['expiration'] = ! empty($this->_expiration)
+						? $this->_expiration
+						: $session_data['init_access'] + $this->session_lifespan->inSeconds();
+					break;
+				case 'user_id' :
+					// current user if logged in
+					$session_data['user_id'] = $this->_wp_user_id();
+					break;
+				case 'pages_visited' :
+					$page_visit = $this->_get_page_visit();
+					if ($page_visit) {
+						// set pages visited where the first will be the http referrer
+						$this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+						// we'll only save the last 10 page visits.
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
+					}
+					break;
+				default :
+					// carry any other data over
+					$session_data[ $key ] = $this->_session_data[ $key ];
+			}
+		}
+		$this->_session_data = $session_data;
+		// creating a new session does not require saving to the db just yet
+		if (! $new_session) {
+			// ready? let's save
+			if ($this->_save_session_to_db()) {
+				return true;
+			}
+			return false;
+		}
+		// meh, why not?
+		return true;
+	}
+
+
+
+	/**
+	 * @create session data array
+	 * @access public
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _create_espresso_session()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
+		// use the update function for now with $new_session arg set to TRUE
+		return $this->update(true) ? true : false;
+	}
+
+
+
+	/**
+	 * _save_session_to_db
+	 *
+	 * @param bool $clear_session
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _save_session_to_db($clear_session = false)
+	{
+		// don't save sessions for crawlers
+		// and unless we're deleting the session data, don't save anything if there isn't a cart
+		if ($this->request->isBot() || (! $clear_session && ! $this->cart() instanceof EE_Cart)) {
+			return false;
+		}
+		$transaction = $this->transaction();
+		if ($transaction instanceof EE_Transaction) {
+			if (! $transaction->ID()) {
+				$transaction->save();
+			}
+			$this->_session_data['transaction'] = $transaction->ID();
+		}
+		// then serialize all of our session data
+		$session_data = serialize($this->_session_data);
+		// do we need to also encode it to avoid corrupted data when saved to the db?
+		$session_data = $this->_use_encryption
+			? $this->encryption->base64_string_encode($session_data)
+			: $session_data;
+		// maybe save hash check
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+			$this->cache_storage->add(
+				EE_Session::hash_check_prefix . $this->_sid,
+				md5($session_data),
+				$this->session_lifespan->inSeconds()
+			);
+		}
+		// we're using the Transient API for storing session data,
+		return $this->cache_storage->add(
+			EE_Session::session_id_prefix . $this->_sid,
+			$session_data,
+			$this->session_lifespan->inSeconds()
+		);
+	}
+
+
+	/**
+	 * @get    the full page request the visitor is accessing
+	 * @access public
+	 * @return string
+	 */
+	public function _get_page_visit()
+	{
+		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		// check for request url
+		if (isset($_SERVER['REQUEST_URI'])) {
+			$http_host   = '';
+			$page_id     = '?';
+			$e_reg       = '';
+			$request_uri = esc_url($_SERVER['REQUEST_URI']);
+			$ru_bits     = explode('?', $request_uri);
+			$request_uri = $ru_bits[0];
+			// check for and grab host as well
+			if (isset($_SERVER['HTTP_HOST'])) {
+				$http_host = esc_url($_SERVER['HTTP_HOST']);
+			}
+			// check for page_id in SERVER REQUEST
+			if (isset($_REQUEST['page_id'])) {
+				// rebuild $e_reg without any of the extra parameters
+				$page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
+			}
+			// check for $e_reg in SERVER REQUEST
+			if (isset($_REQUEST['ee'])) {
+				// rebuild $e_reg without any of the extra parameters
+				$e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
+			}
+			$page_visit = rtrim($http_host . $request_uri . $page_id . $e_reg, '?');
+		}
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
+	}
+
+
+
+	/**
+	 * @the    current wp user id
+	 * @access public
+	 * @return int
+	 */
+	public function _wp_user_id()
+	{
+		// if I need to explain the following lines of code, then you shouldn't be looking at this!
+		$this->_wp_user_id = get_current_user_id();
+		return $this->_wp_user_id;
+	}
+
+
+
+	/**
+	 * Clear EE_Session data
+	 *
+	 * @access public
+	 * @param string $class
+	 * @param string $function
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function clear_session($class = '', $function = '')
+	{
 //         echo '
 // <h3 style="color:#999;line-height:.9em;">
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
-        $this->reset_cart();
-        $this->reset_checkout();
-        $this->reset_transaction();
-        // wipe out everything that isn't a default session datum
-        $this->reset_data(array_keys($this->_session_data));
-        // reset initial site access time and the session expiration
-        $this->_set_init_access_and_expiration();
-        $this->_save_session_to_db(true);
-    }
-
-
-    /**
-     * resets all non-default session vars. Returns TRUE on success, FALSE on fail
-     *
-     * @param array|mixed $data_to_reset
-     * @param bool        $show_all_notices
-     * @return bool
-     */
-    public function reset_data($data_to_reset = array(), $show_all_notices = false)
-    {
-        // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
-            $data_to_reset = array($data_to_reset);
-        }
-        // nothing ??? go home!
-        if (empty($data_to_reset)) {
-            EE_Error::add_error(__('No session data could be reset, because no session var name was provided.',
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $return_value = true;
-        // since $data_to_reset is an array, cycle through the values
-        foreach ($data_to_reset as $reset) {
-
-            // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
-                // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
-                    // remove session var
-                    unset($this->_session_data[ $reset ]);
-                    if ($show_all_notices) {
-                        EE_Error::add_success(sprintf(__('The session variable %s was removed.', 'event_espresso'),
-                            $reset), __FILE__, __FUNCTION__, __LINE__);
-                    }
-                } else {
-                    // yeeeeeeeeerrrrrrrrrrr OUT !!!!
-                    if ($show_all_notices) {
-                        EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.',
-                            'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
-                    }
-                    $return_value = false;
-                }
-            } elseif ($show_all_notices) {
-                // oops! that session var does not exist!
-                EE_Error::add_error(sprintf(__('The session item provided, %s, is invalid or does not exist.',
-                    'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
-                $return_value = false;
-            }
-        } // end of foreach
-        return $return_value;
-    }
-
-
-
-    /**
-     *   wp_loaded
-     *
-     * @access public
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function wp_loaded()
-    {
-        if ($this->request->requestParamIsSet('clear_session')) {
-            $this->clear_session(__CLASS__, __FUNCTION__);
-        }
-    }
-
-
-
-    /**
-     * Used to reset the entire object (for tests).
-     *
-     * @since 4.3.0
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function reset_instance()
-    {
-        $this->clear_session();
-        self::$_instance = null;
-    }
-
-
-
-    public function configure_garbage_collection_filters()
-    {
-        // run old filter we had for controlling session cleanup
-        $expired_session_transient_delete_query_limit = absint(
-            apply_filters(
-                'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                50
-            )
-        );
-        // is there a value? or one that is different than the default 50 records?
-        if ($expired_session_transient_delete_query_limit === 0) {
-            // hook into TransientCacheStorage in case Session cleanup was turned off
-            add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
-        } elseif ($expired_session_transient_delete_query_limit !== 50) {
-            // or use that for the new transient cleanup query limit
-            add_filter(
-                'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit)
-                {
-                    return $expired_session_transient_delete_query_limit;
-                }
-            );
-        }
-    }
-
-
-
-    /**
-     * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
-     * @param $data1
-     * @return string
-     */
-    private function find_serialize_error($data1)
-    {
-        $error = '<pre>';
-        $data2 = preg_replace_callback(
-            '!s:(\d+):"(.*?)";!',
-            function ($match)
-            {
-                return ($match[1] === strlen($match[2]))
-                    ? $match[0]
-                    : 's:'
-                      . strlen($match[2])
-                      . ':"'
-                      . $match[2]
-                      . '";';
-            },
-            $data1
-        );
-        $max   = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
-        for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error  .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error  .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error  .= "\t-> Line Number = $i" . PHP_EOL;
-                $start  = ($i - 20);
-                $start  = ($start < 0) ? 0 : $start;
-                $length = 40;
-                $point  = $max - $i;
-                if ($point < 20) {
-                    $rlength = 1;
-                    $rpoint  = -$point;
-                } else {
-                    $rpoint  = $length - 20;
-                    $rlength = 1;
-                }
-                $error .= "\t-> Section Data1  = ";
-                $error .= substr_replace(
-                    substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-                $error .= "\t-> Section Data2  = ";
-                $error .= substr_replace(
-                    substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
-                    $rpoint,
-                    $rlength
-                );
-                $error .= PHP_EOL;
-            }
-        }
-        $error .= '</pre>';
-        return $error;
-    }
-
-
-    /**
-     * Saves an  array of settings used for configuring aspects of session behaviour
-     *
-     * @param array $updated_settings
-     */
-    private function updateSessionSettings(array $updated_settings = array())
-    {
-        // add existing settings, but only if not included in incoming $updated_settings array
-        $updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
-    }
-
-
-    /**
-     * garbage_collection
-     */
-    public function garbageCollection()
-    {
-        // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
-            $this->_last_gc = time();
-            $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
-            /** @type WPDB $wpdb */
-            global $wpdb;
-            // filter the query limit. Set to 0 to turn off garbage collection
-            $expired_session_transient_delete_query_limit = absint(
-                apply_filters(
-                    'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
-                    50
-                )
-            );
-            // non-zero LIMIT means take out the trash
-            if ($expired_session_transient_delete_query_limit) {
-                $session_key    = str_replace('_', '\_', EE_Session::session_id_prefix);
-                $hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
-                // since transient expiration timestamps are set in the future, we can compare against NOW
-                // but we only want to pick up any trash that's been around for more than a day
-                $expiration = time() - DAY_IN_SECONDS;
-                $SQL        = "
+		do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+		$this->reset_cart();
+		$this->reset_checkout();
+		$this->reset_transaction();
+		// wipe out everything that isn't a default session datum
+		$this->reset_data(array_keys($this->_session_data));
+		// reset initial site access time and the session expiration
+		$this->_set_init_access_and_expiration();
+		$this->_save_session_to_db(true);
+	}
+
+
+	/**
+	 * resets all non-default session vars. Returns TRUE on success, FALSE on fail
+	 *
+	 * @param array|mixed $data_to_reset
+	 * @param bool        $show_all_notices
+	 * @return bool
+	 */
+	public function reset_data($data_to_reset = array(), $show_all_notices = false)
+	{
+		// if $data_to_reset is not in an array, then put it in one
+		if (! is_array($data_to_reset)) {
+			$data_to_reset = array($data_to_reset);
+		}
+		// nothing ??? go home!
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(__('No session data could be reset, because no session var name was provided.',
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$return_value = true;
+		// since $data_to_reset is an array, cycle through the values
+		foreach ($data_to_reset as $reset) {
+
+			// first check to make sure it is a valid session var
+			if (isset($this->_session_data[ $reset ])) {
+				// then check to make sure it is not a default var
+				if (! array_key_exists($reset, $this->_default_session_vars)) {
+					// remove session var
+					unset($this->_session_data[ $reset ]);
+					if ($show_all_notices) {
+						EE_Error::add_success(sprintf(__('The session variable %s was removed.', 'event_espresso'),
+							$reset), __FILE__, __FUNCTION__, __LINE__);
+					}
+				} else {
+					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
+					if ($show_all_notices) {
+						EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.',
+							'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
+					}
+					$return_value = false;
+				}
+			} elseif ($show_all_notices) {
+				// oops! that session var does not exist!
+				EE_Error::add_error(sprintf(__('The session item provided, %s, is invalid or does not exist.',
+					'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
+				$return_value = false;
+			}
+		} // end of foreach
+		return $return_value;
+	}
+
+
+
+	/**
+	 *   wp_loaded
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function wp_loaded()
+	{
+		if ($this->request->requestParamIsSet('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
+		}
+	}
+
+
+
+	/**
+	 * Used to reset the entire object (for tests).
+	 *
+	 * @since 4.3.0
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function reset_instance()
+	{
+		$this->clear_session();
+		self::$_instance = null;
+	}
+
+
+
+	public function configure_garbage_collection_filters()
+	{
+		// run old filter we had for controlling session cleanup
+		$expired_session_transient_delete_query_limit = absint(
+			apply_filters(
+				'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+				50
+			)
+		);
+		// is there a value? or one that is different than the default 50 records?
+		if ($expired_session_transient_delete_query_limit === 0) {
+			// hook into TransientCacheStorage in case Session cleanup was turned off
+			add_filter('FHEE__TransientCacheStorage__transient_cleanup_schedule', '__return_zero');
+		} elseif ($expired_session_transient_delete_query_limit !== 50) {
+			// or use that for the new transient cleanup query limit
+			add_filter(
+				'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
+				function () use ($expired_session_transient_delete_query_limit)
+				{
+					return $expired_session_transient_delete_query_limit;
+				}
+			);
+		}
+	}
+
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/10152904/unserialize-function-unserialize-error-at-offset/21389439#10152996
+	 * @param $data1
+	 * @return string
+	 */
+	private function find_serialize_error($data1)
+	{
+		$error = '<pre>';
+		$data2 = preg_replace_callback(
+			'!s:(\d+):"(.*?)";!',
+			function ($match)
+			{
+				return ($match[1] === strlen($match[2]))
+					? $match[0]
+					: 's:'
+					  . strlen($match[2])
+					  . ':"'
+					  . $match[2]
+					  . '";';
+			},
+			$data1
+		);
+		$max   = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+		$error .= $data1 . PHP_EOL;
+		$error .= $data2 . PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[ $i ] !== @$data2[ $i ]) {
+				$error  .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
+				$error  .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
+				$error  .= "\t-> Line Number = $i" . PHP_EOL;
+				$start  = ($i - 20);
+				$start  = ($start < 0) ? 0 : $start;
+				$length = 40;
+				$point  = $max - $i;
+				if ($point < 20) {
+					$rlength = 1;
+					$rpoint  = -$point;
+				} else {
+					$rpoint  = $length - 20;
+					$rlength = 1;
+				}
+				$error .= "\t-> Section Data1  = ";
+				$error .= substr_replace(
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+				$error .= "\t-> Section Data2  = ";
+				$error .= substr_replace(
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					$rpoint,
+					$rlength
+				);
+				$error .= PHP_EOL;
+			}
+		}
+		$error .= '</pre>';
+		return $error;
+	}
+
+
+	/**
+	 * Saves an  array of settings used for configuring aspects of session behaviour
+	 *
+	 * @param array $updated_settings
+	 */
+	private function updateSessionSettings(array $updated_settings = array())
+	{
+		// add existing settings, but only if not included in incoming $updated_settings array
+		$updated_settings += get_option(EE_Session::OPTION_NAME_SETTINGS, array());
+		update_option(EE_Session::OPTION_NAME_SETTINGS, $updated_settings);
+	}
+
+
+	/**
+	 * garbage_collection
+	 */
+	public function garbageCollection()
+	{
+		// only perform during regular requests if last garbage collection was over an hour ago
+		if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+			$this->_last_gc = time();
+			$this->updateSessionSettings(array('last_gc' => $this->_last_gc));
+			/** @type WPDB $wpdb */
+			global $wpdb;
+			// filter the query limit. Set to 0 to turn off garbage collection
+			$expired_session_transient_delete_query_limit = absint(
+				apply_filters(
+					'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit',
+					50
+				)
+			);
+			// non-zero LIMIT means take out the trash
+			if ($expired_session_transient_delete_query_limit) {
+				$session_key    = str_replace('_', '\_', EE_Session::session_id_prefix);
+				$hash_check_key = str_replace('_', '\_', EE_Session::hash_check_prefix);
+				// since transient expiration timestamps are set in the future, we can compare against NOW
+				// but we only want to pick up any trash that's been around for more than a day
+				$expiration = time() - DAY_IN_SECONDS;
+				$SQL        = "
                     SELECT option_name
                     FROM {$wpdb->options}
                     WHERE
@@ -1253,19 +1253,19 @@ 
                     AND option_value < {$expiration}
                     LIMIT {$expired_session_transient_delete_query_limit}
                 ";
-                // produces something like:
-                // SELECT option_name FROM wp_options
-                // WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
-                // OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
-                // AND option_value < 1508368198 LIMIT 50
-                $expired_sessions = $wpdb->get_col($SQL);
-                // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
-                    $this->cache_storage->deleteMany($expired_sessions, true);
-                }
-            }
-        }
-    }
+				// produces something like:
+				// SELECT option_name FROM wp_options
+				// WHERE ( option_name LIKE '\_transient\_timeout\_ee\_ssn\_%'
+				// OR option_name LIKE '\_transient\_timeout\_ee\_shc\_%' )
+				// AND option_value < 1508368198 LIMIT 50
+				$expired_sessions = $wpdb->get_col($SQL);
+				// valid results?
+				if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+					$this->cache_storage->deleteMany($expired_sessions, true);
+				}
+			}
+		}
+	}
 
 
 

Spacing +57 added lines, -57 removed lines

@@ -186,7 +186,7 @@ 
         // check if class object is instantiated
         // session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
         // add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
             self::$_instance = new self(
                 $cache_storage,
                 $lifespan,
@@ -219,21 +219,21 @@ 
         // but prior to the 'AHEE__EE_System__core_loaded_and_ready' hook
         // (which currently fires on the init hook at priority 9),
         // can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-        if (! apply_filters('FHEE_load_EE_Session', true)) {
+        if ( ! apply_filters('FHEE_load_EE_Session', true)) {
             return;
         }
         $this->session_lifespan = $lifespan;
         $this->request          = $request;
-        if (! defined('ESPRESSO_SESSION')) {
+        if ( ! defined('ESPRESSO_SESSION')) {
             define('ESPRESSO_SESSION', true);
         }
         // retrieve session options from db
         $session_settings = (array) get_option(EE_Session::OPTION_NAME_SETTINGS, array());
-        if (! empty($session_settings)) {
+        if ( ! empty($session_settings)) {
             // cycle though existing session options
             foreach ($session_settings as $var_name => $session_setting) {
                 // set values for class properties
-                $var_name          = '_' . $var_name;
+                $var_name          = '_'.$var_name;
                 $this->{$var_name} = $session_setting;
             }
         }
@@ -293,7 +293,7 @@ 
     public function open_session()
     {
         // check for existing session and retrieve it from db
-        if (! $this->_espresso_session()) {
+        if ( ! $this->_espresso_session()) {
             // or just start a new one
             $this->_create_espresso_session();
         }
@@ -345,7 +345,7 @@ 
      */
     public function extend_expiration($time = 0)
     {
-        $time              = $time ? $time : $this->extension();
+        $time = $time ? $time : $this->extension();
         $this->_expiration += absint($time);
     }
 
@@ -372,9 +372,9 @@ 
         // set some defaults
         foreach ($this->_default_session_vars as $key => $default_var) {
             if (is_array($default_var)) {
-                $this->_session_data[ $key ] = array();
+                $this->_session_data[$key] = array();
             } else {
-                $this->_session_data[ $key ] = '';
+                $this->_session_data[$key] = '';
             }
         }
     }
@@ -515,8 +515,8 @@ 
             $this->reset_checkout();
             $this->reset_transaction();
         }
-        if (! empty($key)) {
-            return isset($this->_session_data[ $key ]) ? $this->_session_data[ $key ] : null;
+        if ( ! empty($key)) {
+            return isset($this->_session_data[$key]) ? $this->_session_data[$key] : null;
         }
         return $this->_session_data;
     }
@@ -542,7 +542,7 @@ 
             return false;
         }
         foreach ($data as $key => $value) {
-            if (isset($this->_default_session_vars[ $key ])) {
+            if (isset($this->_default_session_vars[$key])) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -555,7 +555,7 @@ 
                 );
                 return false;
             }
-            $this->_session_data[ $key ] = $value;
+            $this->_session_data[$key] = $value;
         }
         return true;
     }
@@ -589,7 +589,7 @@ 
         $this->_user_agent = $this->request->userAgent();
         // now let's retrieve what's in the db
         $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
+        if ( ! empty($session_data)) {
             // get the current time in UTC
             $this->_time = $this->_time !== null ? $this->_time : time();
             // and reset the session expiration
@@ -600,7 +600,7 @@ 
             // set initial site access time and the session expiration
             $this->_set_init_access_and_expiration();
             // set referer
-            $this->_session_data['pages_visited'][ $this->_session_data['init_access'] ] = isset($_SERVER['HTTP_REFERER'])
+            $this->_session_data['pages_visited'][$this->_session_data['init_access']] = isset($_SERVER['HTTP_REFERER'])
                 ? esc_attr($_SERVER['HTTP_REFERER'])
                 : '';
             // no previous session = go back and create one (on top of the data above)
@@ -638,7 +638,7 @@ 
      */
     protected function _retrieve_session_data()
     {
-        $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+        $ssn_key = EE_Session::session_id_prefix.$this->_sid;
         try {
             // we're using WP's Transient API to store session data using the PHP session ID as the option name
             $session_data = $this->cache_storage->get($ssn_key, false);
@@ -647,7 +647,7 @@ 
             }
             if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
                 $hash_check = $this->cache_storage->get(
-                    EE_Session::hash_check_prefix . $this->_sid,
+                    EE_Session::hash_check_prefix.$this->_sid,
                     false
                 );
                 if ($hash_check && $hash_check !== md5($session_data)) {
@@ -657,7 +657,7 @@ 
                                 'The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.',
                                 'event_espresso'
                             ),
-                            EE_Session::session_id_prefix . $this->_sid
+                            EE_Session::session_id_prefix.$this->_sid
                         ),
                         __FILE__, __FUNCTION__, __LINE__
                     );
@@ -666,21 +666,21 @@ 
         } catch (Exception $e) {
             // let's just eat that error for now and attempt to correct any corrupted data
             global $wpdb;
-            $row          = $wpdb->get_row(
+            $row = $wpdb->get_row(
                 $wpdb->prepare(
                     "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                    '_transient_' . $ssn_key
+                    '_transient_'.$ssn_key
                 )
             );
             $session_data = is_object($row) ? $row->option_value : null;
             if ($session_data) {
                 $session_data = preg_replace_callback(
                     '!s:(d+):"(.*?)";!',
-                    function ($match)
+                    function($match)
                     {
                         return $match[1] === strlen($match[2])
                             ? $match[0]
-                            : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                            : 's:'.strlen($match[2]).':"'.$match[2].'";';
                     },
                     $session_data
                 );
@@ -691,7 +691,7 @@ 
         $session_data = $this->encryption instanceof EE_Encryption
             ? $this->encryption->base64_string_decode($session_data)
             : $session_data;
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             try {
                 $session_data = maybe_unserialize($session_data);
             } catch (Exception $e) {
@@ -705,21 +705,21 @@ 
                       . '</pre><br>'
                       . $this->find_serialize_error($session_data)
                     : '';
-                $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+                $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
                 throw new InvalidSessionDataException($msg, 0, $e);
             }
         }
         // just a check to make sure the session array is indeed an array
-        if (! is_array($session_data)) {
+        if ( ! is_array($session_data)) {
             // no?!?! then something is wrong
             $msg = esc_html__(
                 'The session data is missing, invalid, or corrupted.',
                 'event_espresso'
             );
             $msg .= WP_DEBUG
-                ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                 : '';
-            $this->cache_storage->delete(EE_Session::session_id_prefix . $this->_sid);
+            $this->cache_storage->delete(EE_Session::session_id_prefix.$this->_sid);
             throw new InvalidSessionDataException($msg);
         }
         if (isset($session_data['transaction']) && absint($session_data['transaction']) !== 0) {
@@ -747,7 +747,7 @@ 
         if (isset($_REQUEST['EESID'])) {
             $session_id = sanitize_text_field($_REQUEST['EESID']);
         } else {
-            $session_id = md5(session_id() . get_current_blog_id() . $this->_get_sid_salt());
+            $session_id = md5(session_id().get_current_blog_id().$this->_get_sid_salt());
         }
         return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
     }
@@ -855,19 +855,19 @@ 
                     $page_visit = $this->_get_page_visit();
                     if ($page_visit) {
                         // set pages visited where the first will be the http referrer
-                        $this->_session_data['pages_visited'][ $this->_time ] = $page_visit;
+                        $this->_session_data['pages_visited'][$this->_time] = $page_visit;
                         // we'll only save the last 10 page visits.
                         $session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
                     }
                     break;
                 default :
                     // carry any other data over
-                    $session_data[ $key ] = $this->_session_data[ $key ];
+                    $session_data[$key] = $this->_session_data[$key];
             }
         }
         $this->_session_data = $session_data;
         // creating a new session does not require saving to the db just yet
-        if (! $new_session) {
+        if ( ! $new_session) {
             // ready? let's save
             if ($this->_save_session_to_db()) {
                 return true;
@@ -912,12 +912,12 @@ 
     {
         // don't save sessions for crawlers
         // and unless we're deleting the session data, don't save anything if there isn't a cart
-        if ($this->request->isBot() || (! $clear_session && ! $this->cart() instanceof EE_Cart)) {
+        if ($this->request->isBot() || ( ! $clear_session && ! $this->cart() instanceof EE_Cart)) {
             return false;
         }
         $transaction = $this->transaction();
         if ($transaction instanceof EE_Transaction) {
-            if (! $transaction->ID()) {
+            if ( ! $transaction->ID()) {
                 $transaction->save();
             }
             $this->_session_data['transaction'] = $transaction->ID();
@@ -931,14 +931,14 @@ 
         // maybe save hash check
         if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
             $this->cache_storage->add(
-                EE_Session::hash_check_prefix . $this->_sid,
+                EE_Session::hash_check_prefix.$this->_sid,
                 md5($session_data),
                 $this->session_lifespan->inSeconds()
             );
         }
         // we're using the Transient API for storing session data,
         return $this->cache_storage->add(
-            EE_Session::session_id_prefix . $this->_sid,
+            EE_Session::session_id_prefix.$this->_sid,
             $session_data,
             $this->session_lifespan->inSeconds()
         );
@@ -952,7 +952,7 @@ 
      */
     public function _get_page_visit()
     {
-        $page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+        $page_visit = home_url('/').'wp-admin/admin-ajax.php';
         // check for request url
         if (isset($_SERVER['REQUEST_URI'])) {
             $http_host   = '';
@@ -968,14 +968,14 @@ 
             // check for page_id in SERVER REQUEST
             if (isset($_REQUEST['page_id'])) {
                 // rebuild $e_reg without any of the extra parameters
-                $page_id = '?page_id=' . esc_attr($_REQUEST['page_id']) . '&amp;';
+                $page_id = '?page_id='.esc_attr($_REQUEST['page_id']).'&amp;';
             }
             // check for $e_reg in SERVER REQUEST
             if (isset($_REQUEST['ee'])) {
                 // rebuild $e_reg without any of the extra parameters
-                $e_reg = 'ee=' . esc_attr($_REQUEST['ee']);
+                $e_reg = 'ee='.esc_attr($_REQUEST['ee']);
             }
-            $page_visit = rtrim($http_host . $request_uri . $page_id . $e_reg, '?');
+            $page_visit = rtrim($http_host.$request_uri.$page_id.$e_reg, '?');
         }
         return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
     }
@@ -1015,7 +1015,7 @@ 
 // <span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/>
 // <span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b>
 // </h3>';
-        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' . $function . '()');
+        do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
         $this->reset_cart();
         $this->reset_checkout();
         $this->reset_transaction();
@@ -1037,7 +1037,7 @@ 
     public function reset_data($data_to_reset = array(), $show_all_notices = false)
     {
         // if $data_to_reset is not in an array, then put it in one
-        if (! is_array($data_to_reset)) {
+        if ( ! is_array($data_to_reset)) {
             $data_to_reset = array($data_to_reset);
         }
         // nothing ??? go home!
@@ -1051,11 +1051,11 @@ 
         foreach ($data_to_reset as $reset) {
 
             // first check to make sure it is a valid session var
-            if (isset($this->_session_data[ $reset ])) {
+            if (isset($this->_session_data[$reset])) {
                 // then check to make sure it is not a default var
-                if (! array_key_exists($reset, $this->_default_session_vars)) {
+                if ( ! array_key_exists($reset, $this->_default_session_vars)) {
                     // remove session var
-                    unset($this->_session_data[ $reset ]);
+                    unset($this->_session_data[$reset]);
                     if ($show_all_notices) {
                         EE_Error::add_success(sprintf(__('The session variable %s was removed.', 'event_espresso'),
                             $reset), __FILE__, __FUNCTION__, __LINE__);
@@ -1132,7 +1132,7 @@ 
             // or use that for the new transient cleanup query limit
             add_filter(
                 'FHEE__TransientCacheStorage__clearExpiredTransients__limit',
-                function () use ($expired_session_transient_delete_query_limit)
+                function() use ($expired_session_transient_delete_query_limit)
                 {
                     return $expired_session_transient_delete_query_limit;
                 }
@@ -1152,7 +1152,7 @@ 
         $error = '<pre>';
         $data2 = preg_replace_callback(
             '!s:(\d+):"(.*?)";!',
-            function ($match)
+            function($match)
             {
                 return ($match[1] === strlen($match[2]))
                     ? $match[0]
@@ -1164,14 +1164,14 @@ 
             },
             $data1
         );
-        $max   = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
-        $error .= $data1 . PHP_EOL;
-        $error .= $data2 . PHP_EOL;
+        $max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+        $error .= $data1.PHP_EOL;
+        $error .= $data2.PHP_EOL;
         for ($i = 0; $i < $max; $i++) {
-            if (@$data1[ $i ] !== @$data2[ $i ]) {
-                $error  .= 'Difference ' . @$data1[ $i ] . ' != ' . @$data2[ $i ] . PHP_EOL;
-                $error  .= "\t-> ORD number " . ord(@$data1[ $i ]) . ' != ' . ord(@$data2[ $i ]) . PHP_EOL;
-                $error  .= "\t-> Line Number = $i" . PHP_EOL;
+            if (@$data1[$i] !== @$data2[$i]) {
+                $error  .= 'Difference '.@$data1[$i].' != '.@$data2[$i].PHP_EOL;
+                $error  .= "\t-> ORD number ".ord(@$data1[$i]).' != '.ord(@$data2[$i]).PHP_EOL;
+                $error  .= "\t-> Line Number = $i".PHP_EOL;
                 $start  = ($i - 20);
                 $start  = ($start < 0) ? 0 : $start;
                 $length = 40;
@@ -1186,7 +1186,7 @@ 
                 $error .= "\t-> Section Data1  = ";
                 $error .= substr_replace(
                     substr($data1, $start, $length),
-                    "<b style=\"color:green\">{$data1[ $i ]}</b>",
+                    "<b style=\"color:green\">{$data1[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1194,7 +1194,7 @@ 
                 $error .= "\t-> Section Data2  = ";
                 $error .= substr_replace(
                     substr($data2, $start, $length),
-                    "<b style=\"color:red\">{$data2[ $i ]}</b>",
+                    "<b style=\"color:red\">{$data2[$i]}</b>",
                     $rpoint,
                     $rlength
                 );
@@ -1225,7 +1225,7 @@ 
     public function garbageCollection()
     {
         // only perform during regular requests if last garbage collection was over an hour ago
-        if (! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX) && (time() - HOUR_IN_SECONDS) >= $this->_last_gc) {
             $this->_last_gc = time();
             $this->updateSessionSettings(array('last_gc' => $this->_last_gc));
             /** @type WPDB $wpdb */
@@ -1260,7 +1260,7 @@ 
                 // AND option_value < 1508368198 LIMIT 50
                 $expired_sessions = $wpdb->get_col($SQL);
                 // valid results?
-                if (! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+                if ( ! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
                     $this->cache_storage->deleteMany($expired_sessions, true);
                 }
             }

modules/single_page_checkout/inc/EE_SPCO_JSON_Response.php

Indentation +21 added lines, -21 removed lines

@@ -1,16 +1,16 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) { exit('No direct script access allowed'); }
  /**
- *
- * Class EE_SPCO_JSON_Response
- *
- * Description
- *
- * @package         Event Espresso
- * @subpackage    core
- * @author				Brent Christensen
- *
- *
- */
+  *
+  * Class EE_SPCO_JSON_Response
+  *
+  * Description
+  *
+  * @package         Event Espresso
+  * @subpackage    core
+  * @author				Brent Christensen
+  *
+  *
+  */
 class EE_SPCO_JSON_Response {
 
 	/**
@@ -84,7 +84,7 @@ 
 
 	/**
 	 *    class constructor
-   */
+	 */
 	public function __construct(  ) {
 	}
 
@@ -271,10 +271,10 @@ 
 	}
 
 
-    /**
-     * @param float $payment_amount
-     * @throws EE_Error
-     */
+	/**
+	 * @param float $payment_amount
+	 * @throws EE_Error
+	 */
 	public function set_payment_amount( $payment_amount ) {
 		$this->_payment_amount = (float)$payment_amount;
 	}
@@ -408,11 +408,11 @@ 
 	}
 
 
-    public function echoAndExit()
-    {
-        echo $this;
-        exit();
-    }
+	public function echoAndExit()
+	{
+		echo $this;
+		exit();
+	}
 
 }
 // End of file EE_SPCO_JSON_Response.php

Spacing +39 added lines, -39 removed lines

@@ -104,71 +104,71 @@ 
 	public function __toString() {
 		$JSON_response = array();
 		// grab notices
-		$notices = EE_Error::get_notices( FALSE );
-		$this->set_attention( isset( $notices['attention'] ) ? $notices['attention'] : '' );
-		$this->set_errors( isset( $notices['errors'] ) ? $notices['errors'] : '' );
-		$this->set_success( isset( $notices['success'] ) ? $notices['success'] : '' );
+		$notices = EE_Error::get_notices(FALSE);
+		$this->set_attention(isset($notices['attention']) ? $notices['attention'] : '');
+		$this->set_errors(isset($notices['errors']) ? $notices['errors'] : '');
+		$this->set_success(isset($notices['success']) ? $notices['success'] : '');
 		// add notices to JSON response, but only if they exist
-		if ( $this->attention() ) {
+		if ($this->attention()) {
 			$JSON_response['attention'] = $this->attention();
 		}
-		if ( $this->errors() ) {
+		if ($this->errors()) {
 			$JSON_response['errors'] = $this->errors();
 		}
-		if ( $this->unexpected_errors() ) {
+		if ($this->unexpected_errors()) {
 			$JSON_response['unexpected_errors'] = $this->unexpected_errors();
 		}
-		if ( $this->success() ) {
+		if ($this->success()) {
 			$JSON_response['success'] = $this->success();
 		}
 		// but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
-		if ( ! isset( $JSON_response[ 'attention' ] ) && ! isset( $JSON_response[ 'errors' ] ) && ! isset( $JSON_response[ 'success' ] ) ) {
+		if ( ! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
 			$JSON_response['success'] = null;
 		}
 		// set redirect_url, IF it exists
-		if ( $this->redirect_url() ) {
+		if ($this->redirect_url()) {
 			$JSON_response['redirect_url'] = $this->redirect_url();
 		}
 		// set registration_time_limit, IF it exists
-		if ( $this->registration_time_limit() ) {
+		if ($this->registration_time_limit()) {
 			$JSON_response['registration_time_limit'] = $this->registration_time_limit();
 		}
 		// set payment_amount, IF it exists
-		if ( $this->payment_amount() !== null ) {
-			$JSON_response[ 'payment_amount' ] = $this->payment_amount();
+		if ($this->payment_amount() !== null) {
+			$JSON_response['payment_amount'] = $this->payment_amount();
 		}
 		// grab generic return data
 		$return_data = $this->return_data();
 		// add billing form validation rules
-		if ( $this->validation_rules() ) {
+		if ($this->validation_rules()) {
 			$return_data['validation_rules'] = $this->validation_rules();
 		}
 		// set reg_step_html, IF it exists
-		if ( $this->reg_step_html() ) {
+		if ($this->reg_step_html()) {
 			$return_data['reg_step_html'] = $this->reg_step_html();
 		}
 		// set method of payment, IF it exists
-		if ( $this->method_of_payment() ) {
+		if ($this->method_of_payment()) {
 			$return_data['method_of_payment'] = $this->method_of_payment();
 		}
 		// set "plz_select_method_of_payment" message, IF it exists
-		if ( $this->plz_select_method_of_payment() ) {
+		if ($this->plz_select_method_of_payment()) {
 			$return_data['plz_select_method_of_payment'] = $this->plz_select_method_of_payment();
 		}
 		// set redirect_form, IF it exists
-		if ( $this->redirect_form() ) {
+		if ($this->redirect_form()) {
 			$return_data['redirect_form'] = $this->redirect_form();
 		}
 		// and finally, add return_data array to main JSON response array, IF it contains anything
 		// why did we add some of the above properties to the return data array?
 		// because it is easier and cleaner in the Javascript to deal with this way
-		if ( ! empty( $return_data )) {
+		if ( ! empty($return_data)) {
 			$JSON_response['return_data'] = $return_data;
 		}
 		// filter final array
-		$JSON_response = apply_filters( 'FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response );
+		$JSON_response = apply_filters('FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response);
 		// return encoded array
-		return (string) wp_json_encode( $JSON_response );
+		return (string) wp_json_encode($JSON_response);
 	}
 
 
@@ -176,7 +176,7 @@ 
 	/**
 	 * @param string $attention
 	 */
-	public function set_attention( $attention ) {
+	public function set_attention($attention) {
 		$this->_attention = $attention;
 	}
 
@@ -194,7 +194,7 @@ 
 	/**
 	 * @param string $errors
 	 */
-	public function set_errors( $errors ) {
+	public function set_errors($errors) {
 		$this->_errors = $errors;
 	}
 
@@ -221,7 +221,7 @@ 
 	/**
 	 * @param string $unexpected_errors
 	 */
-	public function set_unexpected_errors( $unexpected_errors ) {
+	public function set_unexpected_errors($unexpected_errors) {
 		$this->_unexpected_errors = $unexpected_errors;
 	}
 
@@ -230,7 +230,7 @@ 
 	/**
 	 * @param string $success
 	 */
-	public function set_success( $success ) {
+	public function set_success($success) {
 		$this->_success = $success;
 	}
 
@@ -248,7 +248,7 @@ 
 	/**
 	 * @param string $method_of_payment
 	 */
-	public function set_method_of_payment( $method_of_payment ) {
+	public function set_method_of_payment($method_of_payment) {
 		$this->_method_of_payment = $method_of_payment;
 	}
 
@@ -275,8 +275,8 @@ 
      * @param float $payment_amount
      * @throws EE_Error
      */
-	public function set_payment_amount( $payment_amount ) {
-		$this->_payment_amount = (float)$payment_amount;
+	public function set_payment_amount($payment_amount) {
+		$this->_payment_amount = (float) $payment_amount;
 	}
 
 
@@ -284,7 +284,7 @@ 
 	/**
 	 * @param string $next_step_html
 	 */
-	public function set_reg_step_html( $next_step_html ) {
+	public function set_reg_step_html($next_step_html) {
 		$this->_reg_step_html = $next_step_html;
 	}
 
@@ -302,7 +302,7 @@ 
 	/**
 	 * @param string $redirect_form
 	 */
-	public function set_redirect_form( $redirect_form ) {
+	public function set_redirect_form($redirect_form) {
 		$this->_redirect_form = $redirect_form;
 	}
 
@@ -312,7 +312,7 @@ 
 	 * @return string
 	 */
 	public function redirect_form() {
-		return ! empty( $this->_redirect_form ) ? $this->_redirect_form : FALSE;
+		return ! empty($this->_redirect_form) ? $this->_redirect_form : FALSE;
 	}
 
 
@@ -320,7 +320,7 @@ 
 	/**
 	 * @param string $plz_select_method_of_payment
 	 */
-	public function set_plz_select_method_of_payment( $plz_select_method_of_payment ) {
+	public function set_plz_select_method_of_payment($plz_select_method_of_payment) {
 		$this->_plz_select_method_of_payment = $plz_select_method_of_payment;
 	}
 
@@ -338,7 +338,7 @@ 
 	/**
 	 * @param string $redirect_url
 	 */
-	public function set_redirect_url( $redirect_url ) {
+	public function set_redirect_url($redirect_url) {
 		$this->_redirect_url = $redirect_url;
 	}
 
@@ -365,7 +365,7 @@ 
 	/**
 	 * @param string $registration_time_limit
 	 */
-	public function set_registration_time_limit( $registration_time_limit ) {
+	public function set_registration_time_limit($registration_time_limit) {
 		$this->_registration_time_limit = $registration_time_limit;
 	}
 
@@ -374,8 +374,8 @@ 
 	/**
 	 * @param array $return_data
 	 */
-	public function set_return_data( $return_data ) {
-		$this->_return_data = array_merge( $this->_return_data, $return_data );
+	public function set_return_data($return_data) {
+		$this->_return_data = array_merge($this->_return_data, $return_data);
 	}
 
 
@@ -393,8 +393,8 @@ 
 	 * @param array $validation_rules
 	 */
 	public function add_validation_rules(array $validation_rules = array()) {
-		if ( is_array( $validation_rules ) && ! empty( $validation_rules )) {
-			$this->_validation_rules = array_merge( $this->_validation_rules, $validation_rules );
+		if (is_array($validation_rules) && ! empty($validation_rules)) {
+			$this->_validation_rules = array_merge($this->_validation_rules, $validation_rules);
 		}
 	}
 
@@ -404,7 +404,7 @@ 
 	 * @return array | bool
 	 */
 	public function validation_rules() {
-		return ! empty( $this->_validation_rules ) ? $this->_validation_rules : FALSE;
+		return ! empty($this->_validation_rules) ? $this->_validation_rules : FALSE;
 	}
 
 

core/libraries/form_sections/base/EE_Form_Section_Proper.form.php

Spacing +42 added lines, -42 removed lines

@@ -111,8 +111,8 @@ 
             //AND we are going to make sure they're in that specified order
             $reordered_subsections = array();
             foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[ $input_name ])) {
-                    $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
+                if (isset($this->_subsections[$input_name])) {
+                    $reordered_subsections[$input_name] = $this->_subsections[$input_name];
                 }
             }
             $this->_subsections = $reordered_subsections;
@@ -124,7 +124,7 @@ 
         if (isset($options_array['layout_strategy'])) {
             $this->_layout_strategy = $options_array['layout_strategy'];
         }
-        if (! $this->_layout_strategy) {
+        if ( ! $this->_layout_strategy) {
             $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
         }
         $this->_layout_strategy->_construct_finalize($this);
@@ -277,7 +277,7 @@ 
                 $req_data,
                 $this
             );
-            $this->cached_request_data = (array)$req_data;
+            $this->cached_request_data = (array) $req_data;
         }
         return $this->cached_request_data;
     }
@@ -313,7 +313,7 @@ 
         if ($validate) {
             $this->_validate();
             //if it's invalid, we're going to want to re-display so remember what they submitted
-            if (! $this->is_valid()) {
+            if ( ! $this->is_valid()) {
                 $this->store_submitted_form_data_in_session();
             }
         }
@@ -426,11 +426,11 @@ 
     public function populate_defaults($default_data)
     {
         foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[ $subsection_name ])) {
+            if (isset($default_data[$subsection_name])) {
                 if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[ $subsection_name ]);
+                    $subsection->set_default($default_data[$subsection_name]);
                 } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[ $subsection_name ]);
+                    $subsection->populate_defaults($default_data[$subsection_name]);
                 }
             }
         }
@@ -445,7 +445,7 @@ 
      */
     public function subsection_exists($name)
     {
-        return isset($this->_subsections[ $name ]) ? true : false;
+        return isset($this->_subsections[$name]) ? true : false;
     }
 
 
@@ -467,7 +467,7 @@ 
         if ($require_construction_to_be_finalized) {
             $this->ensure_construct_finalized_called();
         }
-        return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
+        return $this->subsection_exists($name) ? $this->_subsections[$name] : null;
     }
 
 
@@ -482,7 +482,7 @@ 
         $validatable_subsections = array();
         foreach ($this->subsections() as $name => $obj) {
             if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[ $name ] = $obj;
+                $validatable_subsections[$name] = $obj;
             }
         }
         return $validatable_subsections;
@@ -509,7 +509,7 @@ 
             $name,
             $require_construction_to_be_finalized
         );
-        if (! $subsection instanceof EE_Form_Input_Base) {
+        if ( ! $subsection instanceof EE_Form_Input_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -546,7 +546,7 @@ 
             $name,
             $require_construction_to_be_finalized
         );
-        if (! $subsection instanceof EE_Form_Section_Proper) {
+        if ( ! $subsection instanceof EE_Form_Section_Proper) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -585,8 +585,8 @@ 
      */
     public function is_valid()
     {
-        if($this->is_valid === null) {
-            if (! $this->has_received_submission()) {
+        if ($this->is_valid === null) {
+            if ( ! $this->has_received_submission()) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -596,14 +596,14 @@ 
                     )
                 );
             }
-            if (! parent::is_valid()) {
+            if ( ! parent::is_valid()) {
                 $this->is_valid = false;
             } else {
                 // ok so no general errors to this entire form section.
                 // so let's check the subsections, but only set errors if that hasn't been done yet
                 $this->is_valid = true;
                 foreach ($this->get_validatable_subsections() as $subsection) {
-                    if (! $subsection->is_valid()) {
+                    if ( ! $subsection->is_valid()) {
                         $this->is_valid = false;
                     }
                 }
@@ -620,7 +620,7 @@ 
      */
     protected function _set_default_name_if_empty()
     {
-        if (! $this->_name) {
+        if ( ! $this->_name) {
             $classname    = get_class($this);
             $default_name = str_replace('EE_', '', $classname);
             $this->_name  = $default_name;
@@ -710,7 +710,7 @@ 
     {
         wp_register_script(
             'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
+            EE_GLOBAL_ASSETS_URL.'scripts'.DS.'form_section_validation.js',
             array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -754,13 +754,13 @@ 
         // we only want to localize vars ONCE for the entire form,
         // so if the form section doesn't have a parent, then it must be the top dog
         if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
+            EE_Form_Section_Proper::$_js_localization['form_data'][$this->html_id()] = array(
                 'form_section_id'  => $this->html_id(true),
                 'validation_rules' => $this->get_jquery_validation_rules(),
                 'other_data'       => $this->get_other_js_data(),
                 'errors'           => $this->subsection_validation_errors_by_html_name(),
             );
-            EE_Form_Section_Proper::$_scripts_localized                                = true;
+            EE_Form_Section_Proper::$_scripts_localized = true;
         }
     }
 
@@ -795,7 +795,7 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection->html_name() ] = $subsection;
+                $inputs[$subsection->html_name()] = $subsection;
             } elseif ($subsection instanceof EE_Form_Section_Proper) {
                 $inputs += $subsection->inputs_in_subsections();
             }
@@ -818,7 +818,7 @@ 
         $errors = array();
         foreach ($inputs as $form_input) {
             if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+                $errors[$form_input->html_name()] = $form_input->get_validation_error_string();
             }
         }
         return $errors;
@@ -841,7 +841,7 @@ 
         $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
             ? EE_Registry::instance()->CFG->registration->email_validation_level
             : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
+        EE_Form_Section_Proper::$_js_localization['email_validation_level'] = $email_validation_level;
         wp_enqueue_script('ee_form_section_validation');
         wp_localize_script(
             'ee_form_section_validation',
@@ -858,7 +858,7 @@ 
      */
     public function ensure_scripts_localized()
     {
-        if (! EE_Form_Section_Proper::$_scripts_localized) {
+        if ( ! EE_Form_Section_Proper::$_scripts_localized) {
             $this->_enqueue_and_localize_form_js();
         }
     }
@@ -954,8 +954,8 @@ 
         //reset the cache of whether this form is valid or not- we're re-validating it now
         $this->is_valid = null;
         foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+            if (method_exists($this, '_validate_'.$subsection_name)) {
+                call_user_func_array(array($this, '_validate_'.$subsection_name), array($subsection));
             }
             $subsection->_validate();
         }
@@ -973,9 +973,9 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[ $subsection_name ] = $subsection->valid_data();
+                $inputs[$subsection_name] = $subsection->valid_data();
             } elseif ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection->normalized_value();
+                $inputs[$subsection_name] = $subsection->normalized_value();
             }
         }
         return $inputs;
@@ -993,7 +993,7 @@ 
         $inputs = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection;
+                $inputs[$subsection_name] = $subsection;
             }
         }
         return $inputs;
@@ -1011,7 +1011,7 @@ 
         $form_sections = array();
         foreach ($this->subsections() as $name => $obj) {
             if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[ $name ] = $obj;
+                $form_sections[$name] = $obj;
             }
         }
         return $form_sections;
@@ -1118,7 +1118,7 @@ 
         $input_values = array();
         foreach ($this->subsections() as $subsection_name => $subsection) {
             if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[ $subsection_name ] = $pretty
+                $input_values[$subsection_name] = $pretty
                     ? $subsection->pretty_value()
                     : $subsection->normalized_value();
             } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
@@ -1130,7 +1130,7 @@ 
                 if ($flatten) {
                     $input_values = array_merge($input_values, $subform_input_values);
                 } else {
-                    $input_values[ $subsection_name ] = $subform_input_values;
+                    $input_values[$subsection_name] = $subform_input_values;
                 }
             }
         }
@@ -1158,7 +1158,7 @@ 
             if ($subsection instanceof EE_Form_Input_Base) {
                 // is this input part of an array of inputs?
                 if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name  = EEH_Array::convert_array_values_to_keys(
+                    $full_input_name = EEH_Array::convert_array_values_to_keys(
                         explode(
                             '[',
                             str_replace(']', '', $subsection->html_name())
@@ -1167,7 +1167,7 @@ 
                     );
                     $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
                 } else {
-                    $submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
+                    $submitted_values[$subsection->html_name()] = $subsection->raw_value();
                 }
             } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
                 $subform_input_values = $subsection->submitted_values($include_subforms);
@@ -1202,7 +1202,7 @@ 
     public function exclude(array $inputs_to_exclude = array())
     {
         foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[ $input_to_exclude_name ]);
+            unset($this->_subsections[$input_to_exclude_name]);
         }
     }
 
@@ -1244,7 +1244,7 @@ 
     public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
     {
         foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
+            if ( ! $subsection instanceof EE_Form_Section_Base) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -1256,7 +1256,7 @@ 
                         $this->name()
                     )
                 );
-                unset($new_subsections[ $subsection_name ]);
+                unset($new_subsections[$subsection_name]);
             }
         }
         $this->_subsections = EEH_Array::insert_into_array(
@@ -1280,7 +1280,7 @@ 
      */
     public function has_subsection($subsection_name, $recursive = false)
     {
-        foreach ($this->_subsections as $name => $subsection) {if(
+        foreach ($this->_subsections as $name => $subsection) {if (
                 $name === $subsection_name
                 || (
                     $recursive
@@ -1371,7 +1371,7 @@ 
     public function html_name_prefix()
     {
         if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+            return $this->parent_section()->html_name_prefix().'['.$this->name().']';
         }
         return $this->name();
     }
@@ -1411,7 +1411,7 @@ 
      */
     public function ensure_construct_finalized_called()
     {
-        if (! $this->_construction_finalized) {
+        if ( ! $this->_construction_finalized) {
             $this->_construct_finalize($this->_parent_section, $this->_name);
         }
     }
@@ -1484,7 +1484,7 @@ 
                 $form_section = $validation_error->get_form_section();
                 if ($form_section instanceof EE_Form_Input_Base) {
                    $label = $validation_error->get_form_section()->html_label_text();
-                } elseif($form_section instanceof EE_Form_Section_Validatable) {
+                } elseif ($form_section instanceof EE_Form_Section_Validatable) {
                     $label = $validation_error->get_form_section()->name();
                 } else {
                     $label = esc_html__('Unknown', 'event_espresso');

Indentation +1524 added lines, -1524 removed lines

@@ -14,1529 +14,1529 @@
 class EE_Form_Section_Proper extends EE_Form_Section_Validatable
 {
 
-    const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
-
-    /**
-     * Subsections
-     *
-     * @var EE_Form_Section_Validatable[]
-     */
-    protected $_subsections = array();
-
-    /**
-     * Strategy for laying out the form
-     *
-     * @var EE_Form_Section_Layout_Base
-     */
-    protected $_layout_strategy;
-
-    /**
-     * Whether or not this form has received and validated a form submission yet
-     *
-     * @var boolean
-     */
-    protected $_received_submission = false;
-
-    /**
-     * message displayed to users upon successful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_success_message = '';
-
-    /**
-     * message displayed to users upon unsuccessful form submission
-     *
-     * @var string
-     */
-    protected $_form_submission_error_message = '';
-
-    /**
-     * @var array like $_REQUEST
-     */
-    protected $cached_request_data;
-
-    /**
-     * Stores whether this form (and its sub-sections) were found to be valid or not.
-     * Starts off as null, but once the form is validated, it set to either true or false
-     * @var boolean|null
-     */
-    protected $is_valid;
-
-    /**
-     * Stores all the data that will localized for form validation
-     *
-     * @var array
-     */
-    static protected $_js_localization = array();
-
-    /**
-     * whether or not the form's localized validation JS vars have been set
-     *
-     * @type boolean
-     */
-    static protected $_scripts_localized = false;
-
-
-    /**
-     * when constructing a proper form section, calls _construct_finalize on children
-     * so that they know who their parent is, and what name they've been given.
-     *
-     * @param array[] $options_array   {
-     * @type          $subsections     EE_Form_Section_Validatable[] where keys are the section's name
-     * @type          $include         string[] numerically-indexed where values are section names to be included,
-     *                                 and in that order. This is handy if you want
-     *                                 the subsections to be ordered differently than the default, and if you override
-     *                                 which fields are shown
-     * @type          $exclude         string[] values are subsections to be excluded. This is handy if you want
-     *                                 to remove certain default subsections (note: if you specify BOTH 'include' AND
-     *                                 'exclude', the inclusions will be applied first, and the exclusions will exclude
-     *                                 items from that list of inclusions)
-     * @type          $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
-     *                                 } @see EE_Form_Section_Validatable::__construct()
-     * @throws EE_Error
-     */
-    public function __construct($options_array = array())
-    {
-        $options_array = (array) apply_filters(
-            'FHEE__EE_Form_Section_Proper___construct__options_array',
-            $options_array,
-            $this
-        );
-        //call parent first, as it may be setting the name
-        parent::__construct($options_array);
-        //if they've included subsections in the constructor, add them now
-        if (isset($options_array['include'])) {
-            //we are going to make sure we ONLY have those subsections to include
-            //AND we are going to make sure they're in that specified order
-            $reordered_subsections = array();
-            foreach ($options_array['include'] as $input_name) {
-                if (isset($this->_subsections[ $input_name ])) {
-                    $reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
-                }
-            }
-            $this->_subsections = $reordered_subsections;
-        }
-        if (isset($options_array['exclude'])) {
-            $exclude            = $options_array['exclude'];
-            $this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
-        }
-        if (isset($options_array['layout_strategy'])) {
-            $this->_layout_strategy = $options_array['layout_strategy'];
-        }
-        if (! $this->_layout_strategy) {
-            $this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
-        }
-        $this->_layout_strategy->_construct_finalize($this);
-        //ok so we are definitely going to want the forms JS,
-        //so enqueue it or remember to enqueue it during wp_enqueue_scripts
-        if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
-            //ok so they've constructed this object after when they should have.
-            //just enqueue the generic form scripts and initialize the form immediately in the JS
-            EE_Form_Section_Proper::wp_enqueue_scripts(true);
-        } else {
-            add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-            add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
-        }
-        add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
-        /**
-         * Gives other plugins a chance to hook in before construct finalize is called.
-         * The form probably doesn't yet have a parent form section.
-         * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form,
-         * assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
-         * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
-         *
-         * @since 4.9.32
-         * @param EE_Form_Section_Proper $this          before __construct is done, but all of its logic,
-         *                                              except maybe calling _construct_finalize has been done
-         * @param array                  $options_array options passed into the constructor
-         */
-        do_action(
-            'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called',
-            $this,
-            $options_array
-        );
-        if (isset($options_array['name'])) {
-            $this->_construct_finalize(null, $options_array['name']);
-        }
-    }
-
-
-    /**
-     * Finishes construction given the parent form section and this form section's name
-     *
-     * @param EE_Form_Section_Proper $parent_form_section
-     * @param string                 $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        $this->_set_default_name_if_empty();
-        $this->_set_default_html_id_if_empty();
-        foreach ($this->_subsections as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Base) {
-                $subsection->_construct_finalize($this, $subsection_name);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
-                            'event_espresso'
-                        ),
-                        $subsection_name,
-                        get_class($this),
-                        $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
-                    )
-                );
-            }
-        }
-        /**
-         * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
-         * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID
-         * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done.
-         * This might only happen just before displaying the form, or just before it receives form submission data.
-         * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
-         * ensured it has a name, HTML IDs, etc
-         *
-         * @param EE_Form_Section_Proper      $this
-         * @param EE_Form_Section_Proper|null $parent_form_section
-         * @param string                      $name
-         */
-        do_action(
-            'AHEE__EE_Form_Section_Proper___construct_finalize__end',
-            $this,
-            $parent_form_section,
-            $name
-        );
-    }
-
-
-    /**
-     * Gets the layout strategy for this form section
-     *
-     * @return EE_Form_Section_Layout_Base
-     */
-    public function get_layout_strategy()
-    {
-        return $this->_layout_strategy;
-    }
-
-
-    /**
-     * Gets the HTML for a single input for this form section according
-     * to the layout strategy
-     *
-     * @param EE_Form_Input_Base $input
-     * @return string
-     */
-    public function get_html_for_input($input)
-    {
-        return $this->_layout_strategy->layout_input($input);
-    }
-
-
-    /**
-     * was_submitted - checks if form inputs are present in request data
-     * Basically an alias for form_data_present_in() (which is used by both
-     * proper form sections and form inputs)
-     *
-     * @param null $form_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function was_submitted($form_data = null)
-    {
-        return $this->form_data_present_in($form_data);
-    }
-
-    /**
-     * Gets the cached request data; but if there is none, or $req_data was set with
-     * something different, refresh the cache, and then return it
-     * @param null $req_data
-     * @return array
-     */
-    protected function getCachedRequest($req_data = null)
-    {
-        if ($this->cached_request_data === null
-            || (
-                $req_data !== null &&
-                $req_data !== $this->cached_request_data
-            )
-        ) {
-            $req_data = apply_filters(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
-                $req_data,
-                $this
-            );
-            if ($req_data === null) {
-                $req_data = array_merge($_GET, $_POST);
-            }
-            $req_data = apply_filters(
-                'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
-                $req_data,
-                $this
-            );
-            $this->cached_request_data = (array)$req_data;
-        }
-        return $this->cached_request_data;
-    }
-
-
-    /**
-     * After the form section is initially created, call this to sanitize the data in the submission
-     * which relates to this form section, validate it, and set it as properties on the form.
-     *
-     * @param array|null $req_data should usually be $_POST (the default).
-     *                             However, you CAN supply a different array.
-     *                             Consider using set_defaults() instead however.
-     *                             (If you rendered the form in the page using echo $form_x->get_html()
-     *                             the inputs will have the correct name in the request data for this function
-     *                             to find them and populate the form with them.
-     *                             If you have a flat form (with only input subsections),
-     *                             you can supply a flat array where keys
-     *                             are the form input names and values are their values)
-     * @param boolean    $validate whether or not to perform validation on this data. Default is,
-     *                             of course, to validate that data, and set errors on the invalid values.
-     *                             But if the data has already been validated
-     *                             (eg you validated the data then stored it in the DB)
-     *                             you may want to skip this step.
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function receive_form_submission($req_data = null, $validate = true)
-    {
-        $req_data = $this->getCachedRequest($req_data);
-        $this->_normalize($req_data);
-        if ($validate) {
-            $this->_validate();
-            //if it's invalid, we're going to want to re-display so remember what they submitted
-            if (! $this->is_valid()) {
-                $this->store_submitted_form_data_in_session();
-            }
-        }
-        if ($this->submission_error_message() === '' && ! $this->is_valid()) {
-            $this->set_submission_error_message();
-        }
-        do_action(
-            'AHEE__EE_Form_Section_Proper__receive_form_submission__end',
-            $req_data,
-            $this,
-            $validate
-        );
-    }
-
-
-    /**
-     * caches the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return boolean whether or not the data was successfully stored in the session
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function store_submitted_form_data_in_session()
-    {
-        return EE_Registry::instance()->SSN->set_session_data(
-            array(
-                EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
-            )
-        );
-    }
-
-
-    /**
-     * retrieves the originally submitted input values in the session
-     * so that they can be used to repopulate the form if it failed validation
-     *
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function get_submitted_form_data_from_session()
-    {
-        $session = EE_Registry::instance()->SSN;
-        if ($session instanceof EE_Session) {
-            return $session->get_session_data(
-                EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
-            );
-        }
-        return array();
-    }
-
-
-    /**
-     * flushed the originally submitted input values from the session
-     *
-     * @return boolean whether or not the data was successfully removed from the session
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function flush_submitted_form_data_from_session()
-    {
-        return EE_Registry::instance()->SSN->reset_data(
-            array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
-        );
-    }
-
-
-    /**
-     * Populates this form and its subsections with data from the session.
-     * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
-     * validation errors when displaying too)
-     * Returns true if the form was populated from the session, false otherwise
-     *
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function populate_from_session()
-    {
-        $form_data_in_session = $this->get_submitted_form_data_from_session();
-        if (empty($form_data_in_session)) {
-            return false;
-        }
-        $this->receive_form_submission($form_data_in_session);
-        $this->flush_submitted_form_data_from_session();
-        if ($this->form_data_present_in($form_data_in_session)) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Populates the default data for the form, given an array where keys are
-     * the input names, and values are their values (preferably normalized to be their
-     * proper PHP types, not all strings... although that should be ok too).
-     * Proper subsections are sub-arrays, the key being the subsection's name, and
-     * the value being an array formatted in teh same way
-     *
-     * @param array $default_data
-     * @throws EE_Error
-     */
-    public function populate_defaults($default_data)
-    {
-        foreach ($this->subsections(false) as $subsection_name => $subsection) {
-            if (isset($default_data[ $subsection_name ])) {
-                if ($subsection instanceof EE_Form_Input_Base) {
-                    $subsection->set_default($default_data[ $subsection_name ]);
-                } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                    $subsection->populate_defaults($default_data[ $subsection_name ]);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * returns true if subsection exists
-     *
-     * @param string $name
-     * @return boolean
-     */
-    public function subsection_exists($name)
-    {
-        return isset($this->_subsections[ $name ]) ? true : false;
-    }
-
-
-    /**
-     * Gets the subsection specified by its name
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
-     *                                                      so that the inputs will be properly configured.
-     *                                                      However, some client code may be ok
-     *                                                      with construction finalize being called later
-     *                                                      (realizing that the subsections' html names
-     *                                                      might not be set yet, etc.)
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     */
-    public function get_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
-    }
-
-
-    /**
-     * Gets all the validatable subsections of this form section
-     *
-     * @return EE_Form_Section_Validatable[]
-     * @throws EE_Error
-     */
-    public function get_validatable_subsections()
-    {
-        $validatable_subsections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Validatable) {
-                $validatable_subsections[ $name ] = $obj;
-            }
-        }
-        return $validatable_subsections;
-    }
-
-
-    /**
-     * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
-     * throw an EE_Error.
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function get_input($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection(
-            $name,
-            $require_construction_to_be_finalized
-        );
-        if (! $subsection instanceof EE_Form_Input_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this),
-                    $subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-    /**
-     * Like get_input(), gets the proper subsection of the form given the name,
-     * otherwise throws an EE_Error
-     *
-     * @param string  $name
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
-    {
-        $subsection = $this->get_subsection(
-            $name,
-            $require_construction_to_be_finalized
-        );
-        if (! $subsection instanceof EE_Form_Section_Proper) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'",
-                        'event_espresso'
-                    ),
-                    $name,
-                    get_class($this)
-                )
-            );
-        }
-        return $subsection;
-    }
-
-
-    /**
-     * Gets the value of the specified input. Should be called after receive_form_submission()
-     * or populate_defaults() on the form, where the normalized value on the input is set.
-     *
-     * @param string $name
-     * @return mixed depending on the input's type and its normalization strategy
-     * @throws EE_Error
-     */
-    public function get_input_value($name)
-    {
-        $input = $this->get_input($name);
-        return $input->normalized_value();
-    }
-
-
-    /**
-     * Checks if this form section itself is valid, and then checks its subsections
-     *
-     * @throws EE_Error
-     * @return boolean
-     */
-    public function is_valid()
-    {
-        if($this->is_valid === null) {
-            if (! $this->has_received_submission()) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'You cannot check if a form is valid before receiving the form submission using receive_form_submission',
-                            'event_espresso'
-                        )
-                    )
-                );
-            }
-            if (! parent::is_valid()) {
-                $this->is_valid = false;
-            } else {
-                // ok so no general errors to this entire form section.
-                // so let's check the subsections, but only set errors if that hasn't been done yet
-                $this->is_valid = true;
-                foreach ($this->get_validatable_subsections() as $subsection) {
-                    if (! $subsection->is_valid()) {
-                        $this->is_valid = false;
-                    }
-                }
-            }
-        }
-        return $this->is_valid;
-    }
-
-
-    /**
-     * gets the default name of this form section if none is specified
-     *
-     * @return void
-     */
-    protected function _set_default_name_if_empty()
-    {
-        if (! $this->_name) {
-            $classname    = get_class($this);
-            $default_name = str_replace('EE_', '', $classname);
-            $this->_name  = $default_name;
-        }
-    }
-
-
-    /**
-     * Returns the HTML for the form, except for the form opening and closing tags
-     * (as the form section doesn't know where you necessarily want to send the information to),
-     * and except for a submit button. Enqueues JS and CSS; if called early enough we will
-     * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
-     * Not doing_it_wrong because theoretically this CAN be used properly,
-     * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
-     * any CSS.
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_html_and_js()
-    {
-        $this->enqueue_js();
-        return $this->get_html();
-    }
-
-
-    /**
-     * returns HTML for displaying this form section. recursively calls display_section() on all subsections
-     *
-     * @param bool $display_previously_submitted_data
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function get_html($display_previously_submitted_data = true)
-    {
-        $this->ensure_construct_finalized_called();
-        if ($display_previously_submitted_data) {
-            $this->populate_from_session();
-        }
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
-            : $this->_layout_strategy->layout_form();
-    }
-
-
-    /**
-     * enqueues JS and CSS for the form.
-     * It is preferred to call this before wp_enqueue_scripts so the
-     * scripts and styles can be put in the header, but if called later
-     * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
-     * only be in the header; but in HTML5 its ok in the body.
-     * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
-     * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function enqueue_js()
-    {
-        $this->_enqueue_and_localize_form_js();
-        foreach ($this->subsections() as $subsection) {
-            $subsection->enqueue_js();
-        }
-    }
-
-
-    /**
-     * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
-     * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
-     * the wp_enqueue_scripts hook.
-     * However, registering the form js and localizing it can happen when we
-     * actually output the form (which is preferred, seeing how teh form's fields
-     * could change until it's actually outputted)
-     *
-     * @param boolean $init_form_validation_automatically whether or not we want the form validation
-     *                                                    to be triggered automatically or not
-     * @return void
-     */
-    public static function wp_enqueue_scripts($init_form_validation_automatically = true)
-    {
-        wp_register_script(
-            'ee_form_section_validation',
-            EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
-            array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_validation_init',
-            array('init' => $init_form_validation_automatically ? '1' : '0')
-        );
-    }
-
-
-    /**
-     * gets the variables used by form_section_validation.js.
-     * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
-     * but before the wordpress hook wp_loaded
-     *
-     * @throws EE_Error
-     */
-    public function _enqueue_and_localize_form_js()
-    {
-        $this->ensure_construct_finalized_called();
-        //actually, we don't want to localize just yet. There may be other forms on the page.
-        //so we need to add our form section data to a static variable accessible by all form sections
-        //and localize it just before the footer
-        $this->localize_validation_rules();
-        add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
-        add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
-    }
-
-
-    /**
-     * add our form section data to a static variable accessible by all form sections
-     *
-     * @param bool $return_for_subsection
-     * @return void
-     * @throws EE_Error
-     */
-    public function localize_validation_rules($return_for_subsection = false)
-    {
-        // we only want to localize vars ONCE for the entire form,
-        // so if the form section doesn't have a parent, then it must be the top dog
-        if ($return_for_subsection || ! $this->parent_section()) {
-            EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
-                'form_section_id'  => $this->html_id(true),
-                'validation_rules' => $this->get_jquery_validation_rules(),
-                'other_data'       => $this->get_other_js_data(),
-                'errors'           => $this->subsection_validation_errors_by_html_name(),
-            );
-            EE_Form_Section_Proper::$_scripts_localized                                = true;
-        }
-    }
-
-
-    /**
-     * Gets an array of extra data that will be useful for client-side javascript.
-     * This is primarily data added by inputs and forms in addition to any
-     * scripts they might enqueue
-     *
-     * @param array $form_other_js_data
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        foreach ($this->subsections() as $subsection) {
-            $form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-    /**
-     * Gets a flat array of inputs for this form section and its subsections.
-     * Keys are their form names, and values are the inputs themselves
-     *
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    public function inputs_in_subsections()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection->html_name() ] = $subsection;
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs += $subsection->inputs_in_subsections();
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets a flat array of all the validation errors.
-     * Keys are html names (because those should be unique)
-     * and values are a string of all their validation errors
-     *
-     * @return string[]
-     * @throws EE_Error
-     */
-    public function subsection_validation_errors_by_html_name()
-    {
-        $inputs = $this->inputs();
-        $errors = array();
-        foreach ($inputs as $form_input) {
-            if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
-                $errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
-            }
-        }
-        return $errors;
-    }
-
-
-    /**
-     * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
-     * Should be setup by each form during the _enqueues_and_localize_form_js
-     *
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function localize_script_for_all_forms()
-    {
-        //allow inputs and stuff to hook in their JS and stuff here
-        do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
-        EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
-        $email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
-            ? EE_Registry::instance()->CFG->registration->email_validation_level
-            : 'wp_default';
-        EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
-        wp_enqueue_script('ee_form_section_validation');
-        wp_localize_script(
-            'ee_form_section_validation',
-            'ee_form_section_vars',
-            EE_Form_Section_Proper::$_js_localization
-        );
-    }
-
-
-    /**
-     * ensure_scripts_localized
-     *
-     * @throws EE_Error
-     */
-    public function ensure_scripts_localized()
-    {
-        if (! EE_Form_Section_Proper::$_scripts_localized) {
-            $this->_enqueue_and_localize_form_js();
-        }
-    }
-
-
-    /**
-     * Gets the hard-coded validation error messages to be used in the JS. The convention
-     * is that the key here should be the same as the custom validation rule put in the JS file
-     *
-     * @return array keys are custom validation rules, and values are internationalized strings
-     */
-    private static function _get_localized_error_messages()
-    {
-        return array(
-            'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'),
-            'regex'    => esc_html__('Please check your input', 'event_espresso'),
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function js_localization()
-    {
-        return self::$_js_localization;
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function reset_js_localization()
-    {
-        self::$_js_localization = array();
-    }
-
-
-    /**
-     * Gets the JS to put inside the jquery validation rules for subsection of this form section.
-     * See parent function for more...
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_jquery_validation_rules()
-    {
-        $jquery_validation_rules = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $jquery_validation_rules = array_merge(
-                $jquery_validation_rules,
-                $subsection->get_jquery_validation_rules()
-            );
-        }
-        return $jquery_validation_rules;
-    }
-
-
-    /**
-     * Sanitizes all the data and sets the sanitized value of each field
-     *
-     * @param array $req_data like $_POST
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _normalize($req_data)
-    {
-        $this->_received_submission = true;
-        $this->_validation_errors   = array();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            try {
-                $subsection->_normalize($req_data);
-            } catch (EE_Validation_Error $e) {
-                $subsection->add_validation_error($e);
-            }
-        }
-    }
-
-
-    /**
-     * Performs validation on this form section and its subsections.
-     * For each subsection,
-     * calls _validate_{subsection_name} on THIS form (if the function exists)
-     * and passes it the subsection, then calls _validate on that subsection.
-     * If you need to perform validation on the form as a whole (considering multiple)
-     * you would be best to override this _validate method,
-     * calling parent::_validate() first.
-     *
-     * @throws EE_Error
-     */
-    protected function _validate()
-    {
-        //reset the cache of whether this form is valid or not- we're re-validating it now
-        $this->is_valid = null;
-        foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
-            if (method_exists($this, '_validate_' . $subsection_name)) {
-                call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
-            }
-            $subsection->_validate();
-        }
-    }
-
-
-    /**
-     * Gets all the validated inputs for the form section
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    public function valid_data()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $inputs[ $subsection_name ] = $subsection->valid_data();
-            } elseif ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection->normalized_value();
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets all the inputs on this form section
-     *
-     * @return EE_Form_Input_Base[]
-     * @throws EE_Error
-     */
-    public function inputs()
-    {
-        $inputs = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $inputs[ $subsection_name ] = $subsection;
-            }
-        }
-        return $inputs;
-    }
-
-
-    /**
-     * Gets all the subsections which are a proper form
-     *
-     * @return EE_Form_Section_Proper[]
-     * @throws EE_Error
-     */
-    public function subforms()
-    {
-        $form_sections = array();
-        foreach ($this->subsections() as $name => $obj) {
-            if ($obj instanceof EE_Form_Section_Proper) {
-                $form_sections[ $name ] = $obj;
-            }
-        }
-        return $form_sections;
-    }
-
-
-    /**
-     * Gets all the subsections (inputs, proper subsections, or html-only sections).
-     * Consider using inputs() or subforms()
-     * if you only want form inputs or proper form sections.
-     *
-     * @param boolean $require_construction_to_be_finalized most client code should
-     *                                                      leave this as TRUE so that the inputs will be properly
-     *                                                      configured. However, some client code may be ok with
-     *                                                      construction finalize being called later
-     *                                                      (realizing that the subsections' html names might not be
-     *                                                      set yet, etc.)
-     * @return EE_Form_Section_Proper[]
-     * @throws EE_Error
-     */
-    public function subsections($require_construction_to_be_finalized = true)
-    {
-        if ($require_construction_to_be_finalized) {
-            $this->ensure_construct_finalized_called();
-        }
-        return $this->_subsections;
-    }
-
-
-    /**
-     * Returns whether this form has any subforms or inputs
-     * @return bool
-     */
-    public function hasSubsections()
-    {
-        return ! empty($this->_subsections);
-    }
-
-
-    /**
-     * Returns a simple array where keys are input names, and values are their normalized
-     * values. (Similar to calling get_input_value on inputs)
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function input_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(false, $include_subform_inputs, $flatten);
-    }
-
-
-    /**
-     * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
-     * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
-     * is not necessarily the value we want to display to users. This creates an array
-     * where keys are the input names, and values are their display values
-     *
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array
-     *                                        with array keys being input names
-     *                                        (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function input_pretty_values($include_subform_inputs = false, $flatten = false)
-    {
-        return $this->_input_values(true, $include_subform_inputs, $flatten);
-    }
-
-
-    /**
-     * Gets the input values from the form
-     *
-     * @param boolean $pretty                 Whether to retrieve the pretty value,
-     *                                        or just the normalized value
-     * @param boolean $include_subform_inputs Whether to include inputs from subforms,
-     *                                        or just this forms' direct children inputs
-     * @param boolean $flatten                Whether to force the results into 1-dimensional array,
-     *                                        or allow multidimensional array
-     * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
-     *                                        input names (regardless of whether they are from a subsection or not),
-     *                                        and if $flatten is FALSE it can be a multidimensional array
-     *                                        where keys are always subsection names and values are either
-     *                                        the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
-    {
-        $input_values = array();
-        foreach ($this->subsections() as $subsection_name => $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                $input_values[ $subsection_name ] = $pretty
-                    ? $subsection->pretty_value()
-                    : $subsection->normalized_value();
-            } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
-                $subform_input_values = $subsection->_input_values(
-                    $pretty,
-                    $include_subform_inputs,
-                    $flatten
-                );
-                if ($flatten) {
-                    $input_values = array_merge($input_values, $subform_input_values);
-                } else {
-                    $input_values[ $subsection_name ] = $subform_input_values;
-                }
-            }
-        }
-        return $input_values;
-    }
-
-
-    /**
-     * Gets the originally submitted input values from the form
-     *
-     * @param boolean $include_subforms  Whether to include inputs from subforms,
-     *                                   or just this forms' direct children inputs
-     * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
-     *                                   with array keys being input names
-     *                                   (regardless of whether they are from a subsection or not),
-     *                                   and if $flatten is FALSE it can be a multidimensional array
-     *                                   where keys are always subsection names and values are either
-     *                                   the input's normalized value, or an array like the top-level array
-     * @throws EE_Error
-     */
-    public function submitted_values($include_subforms = false)
-    {
-        $submitted_values = array();
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                // is this input part of an array of inputs?
-                if (strpos($subsection->html_name(), '[') !== false) {
-                    $full_input_name  = EEH_Array::convert_array_values_to_keys(
-                        explode(
-                            '[',
-                            str_replace(']', '', $subsection->html_name())
-                        ),
-                        $subsection->raw_value()
-                    );
-                    $submitted_values = array_replace_recursive($submitted_values, $full_input_name);
-                } else {
-                    $submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
-                $subform_input_values = $subsection->submitted_values($include_subforms);
-                $submitted_values     = array_replace_recursive($submitted_values, $subform_input_values);
-            }
-        }
-        return $submitted_values;
-    }
-
-
-    /**
-     * Indicates whether or not this form has received a submission yet
-     * (ie, had receive_form_submission called on it yet)
-     *
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function has_received_submission()
-    {
-        $this->ensure_construct_finalized_called();
-        return $this->_received_submission;
-    }
-
-
-    /**
-     * Equivalent to passing 'exclude' in the constructor's options array.
-     * Removes the listed inputs from the form
-     *
-     * @param array $inputs_to_exclude values are the input names
-     * @return void
-     */
-    public function exclude(array $inputs_to_exclude = array())
-    {
-        foreach ($inputs_to_exclude as $input_to_exclude_name) {
-            unset($this->_subsections[ $input_to_exclude_name ]);
-        }
-    }
-
-
-    /**
-     * Changes these inputs' display strategy to be EE_Hidden_Display_Strategy.
-     * @param array $inputs_to_hide
-     * @throws EE_Error
-     */
-    public function hide(array $inputs_to_hide = array())
-    {
-        foreach ($inputs_to_hide as $input_to_hide) {
-            $input = $this->get_input($input_to_hide);
-            $input->set_display_strategy(new EE_Hidden_Display_Strategy());
-        }
-    }
-
-
-    /**
-     * add_subsections
-     * Adds the listed subsections to the form section.
-     * If $subsection_name_to_target is provided,
-     * then new subsections are added before or after that subsection,
-     * otherwise to the start or end of the entire subsections array.
-     *
-     * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
-     *                                                          where keys are their names
-     * @param string                 $subsection_name_to_target an existing for section that $new_subsections
-     *                                                          should be added before or after
-     *                                                          IF $subsection_name_to_target is null,
-     *                                                          then $new_subsections will be added to
-     *                                                          the beginning or end of the entire subsections array
-     * @param boolean                $add_before                whether to add $new_subsections, before or after
-     *                                                          $subsection_name_to_target,
-     *                                                          or if $subsection_name_to_target is null,
-     *                                                          before or after entire subsections array
-     * @return void
-     * @throws EE_Error
-     */
-    public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
-    {
-        foreach ($new_subsections as $subsection_name => $subsection) {
-            if (! $subsection instanceof EE_Form_Section_Base) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            "Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
-                            'event_espresso'
-                        ),
-                        get_class($subsection),
-                        $subsection_name,
-                        $this->name()
-                    )
-                );
-                unset($new_subsections[ $subsection_name ]);
-            }
-        }
-        $this->_subsections = EEH_Array::insert_into_array(
-            $this->_subsections,
-            $new_subsections,
-            $subsection_name_to_target,
-            $add_before
-        );
-        if ($this->_construction_finalized) {
-            foreach ($this->_subsections as $name => $subsection) {
-                $subsection->_construct_finalize($this, $name);
-            }
-        }
-    }
-
-
-    /**
-     * @param string $subsection_name
-     * @param bool   $recursive
-     * @return bool
-     */
-    public function has_subsection($subsection_name, $recursive = false)
-    {
-        foreach ($this->_subsections as $name => $subsection) {if(
-                $name === $subsection_name
-                || (
-                    $recursive
-                    && $subsection instanceof EE_Form_Section_Proper
-                    && $subsection->has_subsection($subsection_name, $recursive)
-                )
-            ) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Just gets all validatable subsections to clean their sensitive data
-     *
-     * @throws EE_Error
-     */
-    public function clean_sensitive_data()
-    {
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            $subsection->clean_sensitive_data();
-        }
-    }
-
-
-    /**
-     * Sets the submission error message (aka validation error message for this form section and all sub-sections)
-     * @param string                           $form_submission_error_message
-     * @param EE_Form_Section_Validatable $form_section unused
-     * @throws EE_Error
-     */
-    public function set_submission_error_message(
-        $form_submission_error_message = ''
-    ) {
-        $this->_form_submission_error_message = ! empty($form_submission_error_message)
-            ? $form_submission_error_message
-            : $this->getAllValidationErrorsString();
-    }
-
-
-    /**
-     * Returns the cached error message. A default value is set for this during _validate(),
-     * (called during receive_form_submission) but it can be explicitly set using
-     * set_submission_error_message
-     *
-     * @return string
-     */
-    public function submission_error_message()
-    {
-        return $this->_form_submission_error_message;
-    }
-
-
-    /**
-     * Sets a message to display if the data submitted to the form was valid.
-     * @param string $form_submission_success_message
-     */
-    public function set_submission_success_message($form_submission_success_message = '')
-    {
-        $this->_form_submission_success_message = ! empty($form_submission_success_message)
-            ? $form_submission_success_message
-            : esc_html__('Form submitted successfully', 'event_espresso');
-    }
-
-
-    /**
-     * Gets a message appropriate for display when the form is correctly submitted
-     * @return string
-     */
-    public function submission_success_message()
-    {
-        return $this->_form_submission_success_message;
-    }
-
-
-    /**
-     * Returns the prefix that should be used on child of this form section for
-     * their html names. If this form section itself has a parent, prepends ITS
-     * prefix onto this form section's prefix. Used primarily by
-     * EE_Form_Input_Base::_set_default_html_name_if_empty
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_name_prefix()
-    {
-        if ($this->parent_section() instanceof EE_Form_Section_Proper) {
-            return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
-        }
-        return $this->name();
-    }
-
-
-    /**
-     * Gets the name, but first checks _construct_finalize has been called. If not,
-     * calls it (assumes there is no parent and that we want the name to be whatever
-     * was set, which is probably nothing, or the classname)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::name();
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    public function parent_section()
-    {
-        $this->ensure_construct_finalized_called();
-        return parent::parent_section();
-    }
-
-
-    /**
-     * make sure construction finalized was called, otherwise children might not be ready
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function ensure_construct_finalized_called()
-    {
-        if (! $this->_construction_finalized) {
-            $this->_construct_finalize($this->_parent_section, $this->_name);
-        }
-    }
-
-
-    /**
-     * Checks if any of this form section's inputs, or any of its children's inputs,
-     * are in teh form data. If any are found, returns true. Else false
-     *
-     * @param array $req_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        $req_data = $this->getCachedRequest($req_data);
-        foreach ($this->subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Input_Base) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            } elseif ($subsection instanceof EE_Form_Section_Proper) {
-                if ($subsection->form_data_present_in($req_data)) {
-                    return true;
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets validation errors for this form section and subsections
-     * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
-     * gets the validation errors for ALL subsection
-     *
-     * @return EE_Validation_Error[]
-     * @throws EE_Error
-     */
-    public function get_validation_errors_accumulated()
-    {
-        $validation_errors = $this->get_validation_errors();
-        foreach ($this->get_validatable_subsections() as $subsection) {
-            if ($subsection instanceof EE_Form_Section_Proper) {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
-            } else {
-                $validation_errors_on_this_subsection = $subsection->get_validation_errors();
-            }
-            if ($validation_errors_on_this_subsection) {
-                $validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
-            }
-        }
-        return $validation_errors;
-    }
-
-    /**
-     * Fetch validation errors from children and grandchildren and puts them in a single string.
-     * This traverses the form section tree to generate this, but you probably want to instead use
-     * get_form_submission_error_message() which is usually this message cached (or a custom validation error message)
-     *
-     * @return string
-     * @since 4.9.59.p
-     */
-    protected function getAllValidationErrorsString()
-    {
-        $submission_error_messages = array();
-        // bad, bad, bad registrant
-        foreach ($this->get_validation_errors_accumulated() as $validation_error) {
-            if ($validation_error instanceof EE_Validation_Error) {
-                $form_section = $validation_error->get_form_section();
-                if ($form_section instanceof EE_Form_Input_Base) {
-                   $label = $validation_error->get_form_section()->html_label_text();
-                } elseif($form_section instanceof EE_Form_Section_Validatable) {
-                    $label = $validation_error->get_form_section()->name();
-                } else {
-                    $label = esc_html__('Unknown', 'event_espresso');
-                }
-                $submission_error_messages[] = sprintf(
-                    __('%s : %s', 'event_espresso'),
-                    $label,
-                    $validation_error->getMessage()
-                );
-            }
-        }
-        return implode('<br', $submission_error_messages);
-    }
-
-
-    /**
-     * This isn't just the name of an input, it's a path pointing to an input. The
-     * path is similar to a folder path: slash (/) means to descend into a subsection,
-     * dot-dot-slash (../) means to ascend into the parent section.
-     * After a series of slashes and dot-dot-slashes, there should be the name of an input,
-     * which will be returned.
-     * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
-     * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
-     * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
-     * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
-     * Etc
-     *
-     * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     */
-    public function find_section_from_path($form_section_path)
-    {
-        //check if we can find the input from purely going straight up the tree
-        $input = parent::find_section_from_path($form_section_path);
-        if ($input instanceof EE_Form_Section_Base) {
-            return $input;
-        }
-        $next_slash_pos = strpos($form_section_path, '/');
-        if ($next_slash_pos !== false) {
-            $child_section_name = substr($form_section_path, 0, $next_slash_pos);
-            $subpath            = substr($form_section_path, $next_slash_pos + 1);
-        } else {
-            $child_section_name = $form_section_path;
-            $subpath            = '';
-        }
-        $child_section = $this->get_subsection($child_section_name);
-        if ($child_section instanceof EE_Form_Section_Base) {
-            return $child_section->find_section_from_path($subpath);
-        }
-        return null;
-    }
+	const SUBMITTED_FORM_DATA_SSN_KEY = 'submitted_form_data';
+
+	/**
+	 * Subsections
+	 *
+	 * @var EE_Form_Section_Validatable[]
+	 */
+	protected $_subsections = array();
+
+	/**
+	 * Strategy for laying out the form
+	 *
+	 * @var EE_Form_Section_Layout_Base
+	 */
+	protected $_layout_strategy;
+
+	/**
+	 * Whether or not this form has received and validated a form submission yet
+	 *
+	 * @var boolean
+	 */
+	protected $_received_submission = false;
+
+	/**
+	 * message displayed to users upon successful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_success_message = '';
+
+	/**
+	 * message displayed to users upon unsuccessful form submission
+	 *
+	 * @var string
+	 */
+	protected $_form_submission_error_message = '';
+
+	/**
+	 * @var array like $_REQUEST
+	 */
+	protected $cached_request_data;
+
+	/**
+	 * Stores whether this form (and its sub-sections) were found to be valid or not.
+	 * Starts off as null, but once the form is validated, it set to either true or false
+	 * @var boolean|null
+	 */
+	protected $is_valid;
+
+	/**
+	 * Stores all the data that will localized for form validation
+	 *
+	 * @var array
+	 */
+	static protected $_js_localization = array();
+
+	/**
+	 * whether or not the form's localized validation JS vars have been set
+	 *
+	 * @type boolean
+	 */
+	static protected $_scripts_localized = false;
+
+
+	/**
+	 * when constructing a proper form section, calls _construct_finalize on children
+	 * so that they know who their parent is, and what name they've been given.
+	 *
+	 * @param array[] $options_array   {
+	 * @type          $subsections     EE_Form_Section_Validatable[] where keys are the section's name
+	 * @type          $include         string[] numerically-indexed where values are section names to be included,
+	 *                                 and in that order. This is handy if you want
+	 *                                 the subsections to be ordered differently than the default, and if you override
+	 *                                 which fields are shown
+	 * @type          $exclude         string[] values are subsections to be excluded. This is handy if you want
+	 *                                 to remove certain default subsections (note: if you specify BOTH 'include' AND
+	 *                                 'exclude', the inclusions will be applied first, and the exclusions will exclude
+	 *                                 items from that list of inclusions)
+	 * @type          $layout_strategy EE_Form_Section_Layout_Base strategy for laying out the form
+	 *                                 } @see EE_Form_Section_Validatable::__construct()
+	 * @throws EE_Error
+	 */
+	public function __construct($options_array = array())
+	{
+		$options_array = (array) apply_filters(
+			'FHEE__EE_Form_Section_Proper___construct__options_array',
+			$options_array,
+			$this
+		);
+		//call parent first, as it may be setting the name
+		parent::__construct($options_array);
+		//if they've included subsections in the constructor, add them now
+		if (isset($options_array['include'])) {
+			//we are going to make sure we ONLY have those subsections to include
+			//AND we are going to make sure they're in that specified order
+			$reordered_subsections = array();
+			foreach ($options_array['include'] as $input_name) {
+				if (isset($this->_subsections[ $input_name ])) {
+					$reordered_subsections[ $input_name ] = $this->_subsections[ $input_name ];
+				}
+			}
+			$this->_subsections = $reordered_subsections;
+		}
+		if (isset($options_array['exclude'])) {
+			$exclude            = $options_array['exclude'];
+			$this->_subsections = array_diff_key($this->_subsections, array_flip($exclude));
+		}
+		if (isset($options_array['layout_strategy'])) {
+			$this->_layout_strategy = $options_array['layout_strategy'];
+		}
+		if (! $this->_layout_strategy) {
+			$this->_layout_strategy = is_admin() ? new EE_Admin_Two_Column_Layout() : new EE_Two_Column_Layout();
+		}
+		$this->_layout_strategy->_construct_finalize($this);
+		//ok so we are definitely going to want the forms JS,
+		//so enqueue it or remember to enqueue it during wp_enqueue_scripts
+		if (did_action('wp_enqueue_scripts') || did_action('admin_enqueue_scripts')) {
+			//ok so they've constructed this object after when they should have.
+			//just enqueue the generic form scripts and initialize the form immediately in the JS
+			EE_Form_Section_Proper::wp_enqueue_scripts(true);
+		} else {
+			add_action('wp_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+			add_action('admin_enqueue_scripts', array('EE_Form_Section_Proper', 'wp_enqueue_scripts'));
+		}
+		add_action('wp_footer', array($this, 'ensure_scripts_localized'), 1);
+		/**
+		 * Gives other plugins a chance to hook in before construct finalize is called.
+		 * The form probably doesn't yet have a parent form section.
+		 * Since 4.9.32, when this action was introduced, this is the best place to add a subsection onto a form,
+		 * assuming you don't care what the form section's name, HTML ID, or HTML name etc are.
+		 * Also see AHEE__EE_Form_Section_Proper___construct_finalize__end
+		 *
+		 * @since 4.9.32
+		 * @param EE_Form_Section_Proper $this          before __construct is done, but all of its logic,
+		 *                                              except maybe calling _construct_finalize has been done
+		 * @param array                  $options_array options passed into the constructor
+		 */
+		do_action(
+			'AHEE__EE_Form_Input_Base___construct__before_construct_finalize_called',
+			$this,
+			$options_array
+		);
+		if (isset($options_array['name'])) {
+			$this->_construct_finalize(null, $options_array['name']);
+		}
+	}
+
+
+	/**
+	 * Finishes construction given the parent form section and this form section's name
+	 *
+	 * @param EE_Form_Section_Proper $parent_form_section
+	 * @param string                 $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		$this->_set_default_name_if_empty();
+		$this->_set_default_html_id_if_empty();
+		foreach ($this->_subsections as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Base) {
+				$subsection->_construct_finalize($this, $subsection_name);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Subsection "%s" is not an instanceof EE_Form_Section_Base on form "%s". It is a "%s"',
+							'event_espresso'
+						),
+						$subsection_name,
+						get_class($this),
+						$subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
+					)
+				);
+			}
+		}
+		/**
+		 * Action performed just after form has been given a name (and HTML ID etc) and is fully constructed.
+		 * If you have code that should modify the form and needs it and its subsections to have a name, HTML ID
+		 * (or other attributes derived from the name like the HTML label id, etc), this is where it should be done.
+		 * This might only happen just before displaying the form, or just before it receives form submission data.
+		 * If you need to modify the form or its subsections before _construct_finalize is called on it (and we've
+		 * ensured it has a name, HTML IDs, etc
+		 *
+		 * @param EE_Form_Section_Proper      $this
+		 * @param EE_Form_Section_Proper|null $parent_form_section
+		 * @param string                      $name
+		 */
+		do_action(
+			'AHEE__EE_Form_Section_Proper___construct_finalize__end',
+			$this,
+			$parent_form_section,
+			$name
+		);
+	}
+
+
+	/**
+	 * Gets the layout strategy for this form section
+	 *
+	 * @return EE_Form_Section_Layout_Base
+	 */
+	public function get_layout_strategy()
+	{
+		return $this->_layout_strategy;
+	}
+
+
+	/**
+	 * Gets the HTML for a single input for this form section according
+	 * to the layout strategy
+	 *
+	 * @param EE_Form_Input_Base $input
+	 * @return string
+	 */
+	public function get_html_for_input($input)
+	{
+		return $this->_layout_strategy->layout_input($input);
+	}
+
+
+	/**
+	 * was_submitted - checks if form inputs are present in request data
+	 * Basically an alias for form_data_present_in() (which is used by both
+	 * proper form sections and form inputs)
+	 *
+	 * @param null $form_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function was_submitted($form_data = null)
+	{
+		return $this->form_data_present_in($form_data);
+	}
+
+	/**
+	 * Gets the cached request data; but if there is none, or $req_data was set with
+	 * something different, refresh the cache, and then return it
+	 * @param null $req_data
+	 * @return array
+	 */
+	protected function getCachedRequest($req_data = null)
+	{
+		if ($this->cached_request_data === null
+			|| (
+				$req_data !== null &&
+				$req_data !== $this->cached_request_data
+			)
+		) {
+			$req_data = apply_filters(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__req_data',
+				$req_data,
+				$this
+			);
+			if ($req_data === null) {
+				$req_data = array_merge($_GET, $_POST);
+			}
+			$req_data = apply_filters(
+				'FHEE__EE_Form_Section_Proper__receive_form_submission__request_data',
+				$req_data,
+				$this
+			);
+			$this->cached_request_data = (array)$req_data;
+		}
+		return $this->cached_request_data;
+	}
+
+
+	/**
+	 * After the form section is initially created, call this to sanitize the data in the submission
+	 * which relates to this form section, validate it, and set it as properties on the form.
+	 *
+	 * @param array|null $req_data should usually be $_POST (the default).
+	 *                             However, you CAN supply a different array.
+	 *                             Consider using set_defaults() instead however.
+	 *                             (If you rendered the form in the page using echo $form_x->get_html()
+	 *                             the inputs will have the correct name in the request data for this function
+	 *                             to find them and populate the form with them.
+	 *                             If you have a flat form (with only input subsections),
+	 *                             you can supply a flat array where keys
+	 *                             are the form input names and values are their values)
+	 * @param boolean    $validate whether or not to perform validation on this data. Default is,
+	 *                             of course, to validate that data, and set errors on the invalid values.
+	 *                             But if the data has already been validated
+	 *                             (eg you validated the data then stored it in the DB)
+	 *                             you may want to skip this step.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function receive_form_submission($req_data = null, $validate = true)
+	{
+		$req_data = $this->getCachedRequest($req_data);
+		$this->_normalize($req_data);
+		if ($validate) {
+			$this->_validate();
+			//if it's invalid, we're going to want to re-display so remember what they submitted
+			if (! $this->is_valid()) {
+				$this->store_submitted_form_data_in_session();
+			}
+		}
+		if ($this->submission_error_message() === '' && ! $this->is_valid()) {
+			$this->set_submission_error_message();
+		}
+		do_action(
+			'AHEE__EE_Form_Section_Proper__receive_form_submission__end',
+			$req_data,
+			$this,
+			$validate
+		);
+	}
+
+
+	/**
+	 * caches the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return boolean whether or not the data was successfully stored in the session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function store_submitted_form_data_in_session()
+	{
+		return EE_Registry::instance()->SSN->set_session_data(
+			array(
+				EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY => $this->submitted_values(true),
+			)
+		);
+	}
+
+
+	/**
+	 * retrieves the originally submitted input values in the session
+	 * so that they can be used to repopulate the form if it failed validation
+	 *
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function get_submitted_form_data_from_session()
+	{
+		$session = EE_Registry::instance()->SSN;
+		if ($session instanceof EE_Session) {
+			return $session->get_session_data(
+				EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY
+			);
+		}
+		return array();
+	}
+
+
+	/**
+	 * flushed the originally submitted input values from the session
+	 *
+	 * @return boolean whether or not the data was successfully removed from the session
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function flush_submitted_form_data_from_session()
+	{
+		return EE_Registry::instance()->SSN->reset_data(
+			array(EE_Form_Section_Proper::SUBMITTED_FORM_DATA_SSN_KEY)
+		);
+	}
+
+
+	/**
+	 * Populates this form and its subsections with data from the session.
+	 * (Wrapper for EE_Form_Section_Proper::receive_form_submission, so it shows
+	 * validation errors when displaying too)
+	 * Returns true if the form was populated from the session, false otherwise
+	 *
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function populate_from_session()
+	{
+		$form_data_in_session = $this->get_submitted_form_data_from_session();
+		if (empty($form_data_in_session)) {
+			return false;
+		}
+		$this->receive_form_submission($form_data_in_session);
+		$this->flush_submitted_form_data_from_session();
+		if ($this->form_data_present_in($form_data_in_session)) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Populates the default data for the form, given an array where keys are
+	 * the input names, and values are their values (preferably normalized to be their
+	 * proper PHP types, not all strings... although that should be ok too).
+	 * Proper subsections are sub-arrays, the key being the subsection's name, and
+	 * the value being an array formatted in teh same way
+	 *
+	 * @param array $default_data
+	 * @throws EE_Error
+	 */
+	public function populate_defaults($default_data)
+	{
+		foreach ($this->subsections(false) as $subsection_name => $subsection) {
+			if (isset($default_data[ $subsection_name ])) {
+				if ($subsection instanceof EE_Form_Input_Base) {
+					$subsection->set_default($default_data[ $subsection_name ]);
+				} elseif ($subsection instanceof EE_Form_Section_Proper) {
+					$subsection->populate_defaults($default_data[ $subsection_name ]);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * returns true if subsection exists
+	 *
+	 * @param string $name
+	 * @return boolean
+	 */
+	public function subsection_exists($name)
+	{
+		return isset($this->_subsections[ $name ]) ? true : false;
+	}
+
+
+	/**
+	 * Gets the subsection specified by its name
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should leave this as TRUE
+	 *                                                      so that the inputs will be properly configured.
+	 *                                                      However, some client code may be ok
+	 *                                                      with construction finalize being called later
+	 *                                                      (realizing that the subsections' html names
+	 *                                                      might not be set yet, etc.)
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 */
+	public function get_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->subsection_exists($name) ? $this->_subsections[ $name ] : null;
+	}
+
+
+	/**
+	 * Gets all the validatable subsections of this form section
+	 *
+	 * @return EE_Form_Section_Validatable[]
+	 * @throws EE_Error
+	 */
+	public function get_validatable_subsections()
+	{
+		$validatable_subsections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Validatable) {
+				$validatable_subsections[ $name ] = $obj;
+			}
+		}
+		return $validatable_subsections;
+	}
+
+
+	/**
+	 * Gets an input by the given name. If not found, or if its not an EE_FOrm_Input_Base child,
+	 * throw an EE_Error.
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function get_input($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection(
+			$name,
+			$require_construction_to_be_finalized
+		);
+		if (! $subsection instanceof EE_Form_Input_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Subsection '%s' is not an instanceof EE_Form_Input_Base on form '%s'. It is a '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this),
+					$subsection ? get_class($subsection) : esc_html__('NULL', 'event_espresso')
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+	/**
+	 * Like get_input(), gets the proper subsection of the form given the name,
+	 * otherwise throws an EE_Error
+	 *
+	 * @param string  $name
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function get_proper_subsection($name, $require_construction_to_be_finalized = true)
+	{
+		$subsection = $this->get_subsection(
+			$name,
+			$require_construction_to_be_finalized
+		);
+		if (! $subsection instanceof EE_Form_Section_Proper) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Subsection '%'s is not an instanceof EE_Form_Section_Proper on form '%s'",
+						'event_espresso'
+					),
+					$name,
+					get_class($this)
+				)
+			);
+		}
+		return $subsection;
+	}
+
+
+	/**
+	 * Gets the value of the specified input. Should be called after receive_form_submission()
+	 * or populate_defaults() on the form, where the normalized value on the input is set.
+	 *
+	 * @param string $name
+	 * @return mixed depending on the input's type and its normalization strategy
+	 * @throws EE_Error
+	 */
+	public function get_input_value($name)
+	{
+		$input = $this->get_input($name);
+		return $input->normalized_value();
+	}
+
+
+	/**
+	 * Checks if this form section itself is valid, and then checks its subsections
+	 *
+	 * @throws EE_Error
+	 * @return boolean
+	 */
+	public function is_valid()
+	{
+		if($this->is_valid === null) {
+			if (! $this->has_received_submission()) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'You cannot check if a form is valid before receiving the form submission using receive_form_submission',
+							'event_espresso'
+						)
+					)
+				);
+			}
+			if (! parent::is_valid()) {
+				$this->is_valid = false;
+			} else {
+				// ok so no general errors to this entire form section.
+				// so let's check the subsections, but only set errors if that hasn't been done yet
+				$this->is_valid = true;
+				foreach ($this->get_validatable_subsections() as $subsection) {
+					if (! $subsection->is_valid()) {
+						$this->is_valid = false;
+					}
+				}
+			}
+		}
+		return $this->is_valid;
+	}
+
+
+	/**
+	 * gets the default name of this form section if none is specified
+	 *
+	 * @return void
+	 */
+	protected function _set_default_name_if_empty()
+	{
+		if (! $this->_name) {
+			$classname    = get_class($this);
+			$default_name = str_replace('EE_', '', $classname);
+			$this->_name  = $default_name;
+		}
+	}
+
+
+	/**
+	 * Returns the HTML for the form, except for the form opening and closing tags
+	 * (as the form section doesn't know where you necessarily want to send the information to),
+	 * and except for a submit button. Enqueues JS and CSS; if called early enough we will
+	 * try to enqueue them in the header, otherwise they'll be enqueued in the footer.
+	 * Not doing_it_wrong because theoretically this CAN be used properly,
+	 * provided its used during "wp_enqueue_scripts", or it doesn't need to enqueue
+	 * any CSS.
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_html_and_js()
+	{
+		$this->enqueue_js();
+		return $this->get_html();
+	}
+
+
+	/**
+	 * returns HTML for displaying this form section. recursively calls display_section() on all subsections
+	 *
+	 * @param bool $display_previously_submitted_data
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function get_html($display_previously_submitted_data = true)
+	{
+		$this->ensure_construct_finalized_called();
+		if ($display_previously_submitted_data) {
+			$this->populate_from_session();
+		}
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml($this->_layout_strategy->layout_form(), $this)
+			: $this->_layout_strategy->layout_form();
+	}
+
+
+	/**
+	 * enqueues JS and CSS for the form.
+	 * It is preferred to call this before wp_enqueue_scripts so the
+	 * scripts and styles can be put in the header, but if called later
+	 * they will be put in the footer (which is OK for JS, but in HTML4 CSS should
+	 * only be in the header; but in HTML5 its ok in the body.
+	 * See http://stackoverflow.com/questions/4957446/load-external-css-file-in-body-tag.
+	 * So if your form enqueues CSS, it's preferred to call this before wp_enqueue_scripts.)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function enqueue_js()
+	{
+		$this->_enqueue_and_localize_form_js();
+		foreach ($this->subsections() as $subsection) {
+			$subsection->enqueue_js();
+		}
+	}
+
+
+	/**
+	 * adds a filter so that jquery validate gets enqueued in EE_System::wp_enqueue_scripts().
+	 * This must be done BEFORE wp_enqueue_scripts() gets called, which is on
+	 * the wp_enqueue_scripts hook.
+	 * However, registering the form js and localizing it can happen when we
+	 * actually output the form (which is preferred, seeing how teh form's fields
+	 * could change until it's actually outputted)
+	 *
+	 * @param boolean $init_form_validation_automatically whether or not we want the form validation
+	 *                                                    to be triggered automatically or not
+	 * @return void
+	 */
+	public static function wp_enqueue_scripts($init_form_validation_automatically = true)
+	{
+		wp_register_script(
+			'ee_form_section_validation',
+			EE_GLOBAL_ASSETS_URL . 'scripts' . DS . 'form_section_validation.js',
+			array('jquery-validate', 'jquery-ui-datepicker', 'jquery-validate-extra-methods'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_validation_init',
+			array('init' => $init_form_validation_automatically ? '1' : '0')
+		);
+	}
+
+
+	/**
+	 * gets the variables used by form_section_validation.js.
+	 * This needs to be called AFTER we've called $this->_enqueue_jquery_validate_script,
+	 * but before the wordpress hook wp_loaded
+	 *
+	 * @throws EE_Error
+	 */
+	public function _enqueue_and_localize_form_js()
+	{
+		$this->ensure_construct_finalized_called();
+		//actually, we don't want to localize just yet. There may be other forms on the page.
+		//so we need to add our form section data to a static variable accessible by all form sections
+		//and localize it just before the footer
+		$this->localize_validation_rules();
+		add_action('wp_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'), 2);
+		add_action('admin_footer', array('EE_Form_Section_Proper', 'localize_script_for_all_forms'));
+	}
+
+
+	/**
+	 * add our form section data to a static variable accessible by all form sections
+	 *
+	 * @param bool $return_for_subsection
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function localize_validation_rules($return_for_subsection = false)
+	{
+		// we only want to localize vars ONCE for the entire form,
+		// so if the form section doesn't have a parent, then it must be the top dog
+		if ($return_for_subsection || ! $this->parent_section()) {
+			EE_Form_Section_Proper::$_js_localization['form_data'][ $this->html_id() ] = array(
+				'form_section_id'  => $this->html_id(true),
+				'validation_rules' => $this->get_jquery_validation_rules(),
+				'other_data'       => $this->get_other_js_data(),
+				'errors'           => $this->subsection_validation_errors_by_html_name(),
+			);
+			EE_Form_Section_Proper::$_scripts_localized                                = true;
+		}
+	}
+
+
+	/**
+	 * Gets an array of extra data that will be useful for client-side javascript.
+	 * This is primarily data added by inputs and forms in addition to any
+	 * scripts they might enqueue
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		foreach ($this->subsections() as $subsection) {
+			$form_other_js_data = $subsection->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+	/**
+	 * Gets a flat array of inputs for this form section and its subsections.
+	 * Keys are their form names, and values are the inputs themselves
+	 *
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	public function inputs_in_subsections()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection->html_name() ] = $subsection;
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs += $subsection->inputs_in_subsections();
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets a flat array of all the validation errors.
+	 * Keys are html names (because those should be unique)
+	 * and values are a string of all their validation errors
+	 *
+	 * @return string[]
+	 * @throws EE_Error
+	 */
+	public function subsection_validation_errors_by_html_name()
+	{
+		$inputs = $this->inputs();
+		$errors = array();
+		foreach ($inputs as $form_input) {
+			if ($form_input instanceof EE_Form_Input_Base && $form_input->get_validation_errors()) {
+				$errors[ $form_input->html_name() ] = $form_input->get_validation_error_string();
+			}
+		}
+		return $errors;
+	}
+
+
+	/**
+	 * passes all the form data required by the JS to the JS, and enqueues the few required JS files.
+	 * Should be setup by each form during the _enqueues_and_localize_form_js
+	 *
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function localize_script_for_all_forms()
+	{
+		//allow inputs and stuff to hook in their JS and stuff here
+		do_action('AHEE__EE_Form_Section_Proper__localize_script_for_all_forms__begin');
+		EE_Form_Section_Proper::$_js_localization['localized_error_messages'] = EE_Form_Section_Proper::_get_localized_error_messages();
+		$email_validation_level = isset(EE_Registry::instance()->CFG->registration->email_validation_level)
+			? EE_Registry::instance()->CFG->registration->email_validation_level
+			: 'wp_default';
+		EE_Form_Section_Proper::$_js_localization['email_validation_level']   = $email_validation_level;
+		wp_enqueue_script('ee_form_section_validation');
+		wp_localize_script(
+			'ee_form_section_validation',
+			'ee_form_section_vars',
+			EE_Form_Section_Proper::$_js_localization
+		);
+	}
+
+
+	/**
+	 * ensure_scripts_localized
+	 *
+	 * @throws EE_Error
+	 */
+	public function ensure_scripts_localized()
+	{
+		if (! EE_Form_Section_Proper::$_scripts_localized) {
+			$this->_enqueue_and_localize_form_js();
+		}
+	}
+
+
+	/**
+	 * Gets the hard-coded validation error messages to be used in the JS. The convention
+	 * is that the key here should be the same as the custom validation rule put in the JS file
+	 *
+	 * @return array keys are custom validation rules, and values are internationalized strings
+	 */
+	private static function _get_localized_error_messages()
+	{
+		return array(
+			'validUrl' => esc_html__('This is not a valid absolute URL. Eg, http://domain.com/monkey.jpg', 'event_espresso'),
+			'regex'    => esc_html__('Please check your input', 'event_espresso'),
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function js_localization()
+	{
+		return self::$_js_localization;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function reset_js_localization()
+	{
+		self::$_js_localization = array();
+	}
+
+
+	/**
+	 * Gets the JS to put inside the jquery validation rules for subsection of this form section.
+	 * See parent function for more...
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_jquery_validation_rules()
+	{
+		$jquery_validation_rules = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$jquery_validation_rules = array_merge(
+				$jquery_validation_rules,
+				$subsection->get_jquery_validation_rules()
+			);
+		}
+		return $jquery_validation_rules;
+	}
+
+
+	/**
+	 * Sanitizes all the data and sets the sanitized value of each field
+	 *
+	 * @param array $req_data like $_POST
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _normalize($req_data)
+	{
+		$this->_received_submission = true;
+		$this->_validation_errors   = array();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			try {
+				$subsection->_normalize($req_data);
+			} catch (EE_Validation_Error $e) {
+				$subsection->add_validation_error($e);
+			}
+		}
+	}
+
+
+	/**
+	 * Performs validation on this form section and its subsections.
+	 * For each subsection,
+	 * calls _validate_{subsection_name} on THIS form (if the function exists)
+	 * and passes it the subsection, then calls _validate on that subsection.
+	 * If you need to perform validation on the form as a whole (considering multiple)
+	 * you would be best to override this _validate method,
+	 * calling parent::_validate() first.
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _validate()
+	{
+		//reset the cache of whether this form is valid or not- we're re-validating it now
+		$this->is_valid = null;
+		foreach ($this->get_validatable_subsections() as $subsection_name => $subsection) {
+			if (method_exists($this, '_validate_' . $subsection_name)) {
+				call_user_func_array(array($this, '_validate_' . $subsection_name), array($subsection));
+			}
+			$subsection->_validate();
+		}
+	}
+
+
+	/**
+	 * Gets all the validated inputs for the form section
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function valid_data()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$inputs[ $subsection_name ] = $subsection->valid_data();
+			} elseif ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection_name ] = $subsection->normalized_value();
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets all the inputs on this form section
+	 *
+	 * @return EE_Form_Input_Base[]
+	 * @throws EE_Error
+	 */
+	public function inputs()
+	{
+		$inputs = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$inputs[ $subsection_name ] = $subsection;
+			}
+		}
+		return $inputs;
+	}
+
+
+	/**
+	 * Gets all the subsections which are a proper form
+	 *
+	 * @return EE_Form_Section_Proper[]
+	 * @throws EE_Error
+	 */
+	public function subforms()
+	{
+		$form_sections = array();
+		foreach ($this->subsections() as $name => $obj) {
+			if ($obj instanceof EE_Form_Section_Proper) {
+				$form_sections[ $name ] = $obj;
+			}
+		}
+		return $form_sections;
+	}
+
+
+	/**
+	 * Gets all the subsections (inputs, proper subsections, or html-only sections).
+	 * Consider using inputs() or subforms()
+	 * if you only want form inputs or proper form sections.
+	 *
+	 * @param boolean $require_construction_to_be_finalized most client code should
+	 *                                                      leave this as TRUE so that the inputs will be properly
+	 *                                                      configured. However, some client code may be ok with
+	 *                                                      construction finalize being called later
+	 *                                                      (realizing that the subsections' html names might not be
+	 *                                                      set yet, etc.)
+	 * @return EE_Form_Section_Proper[]
+	 * @throws EE_Error
+	 */
+	public function subsections($require_construction_to_be_finalized = true)
+	{
+		if ($require_construction_to_be_finalized) {
+			$this->ensure_construct_finalized_called();
+		}
+		return $this->_subsections;
+	}
+
+
+	/**
+	 * Returns whether this form has any subforms or inputs
+	 * @return bool
+	 */
+	public function hasSubsections()
+	{
+		return ! empty($this->_subsections);
+	}
+
+
+	/**
+	 * Returns a simple array where keys are input names, and values are their normalized
+	 * values. (Similar to calling get_input_value on inputs)
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function input_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(false, $include_subform_inputs, $flatten);
+	}
+
+
+	/**
+	 * Similar to EE_Form_Section_Proper::input_values(), except this returns the 'display_value'
+	 * of each input. On some inputs (especially radio boxes or checkboxes), the value stored
+	 * is not necessarily the value we want to display to users. This creates an array
+	 * where keys are the input names, and values are their display values
+	 *
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                        with array keys being input names
+	 *                                        (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function input_pretty_values($include_subform_inputs = false, $flatten = false)
+	{
+		return $this->_input_values(true, $include_subform_inputs, $flatten);
+	}
+
+
+	/**
+	 * Gets the input values from the form
+	 *
+	 * @param boolean $pretty                 Whether to retrieve the pretty value,
+	 *                                        or just the normalized value
+	 * @param boolean $include_subform_inputs Whether to include inputs from subforms,
+	 *                                        or just this forms' direct children inputs
+	 * @param boolean $flatten                Whether to force the results into 1-dimensional array,
+	 *                                        or allow multidimensional array
+	 * @return array if $flatten is TRUE it will always be a 1-dimensional array with array keys being
+	 *                                        input names (regardless of whether they are from a subsection or not),
+	 *                                        and if $flatten is FALSE it can be a multidimensional array
+	 *                                        where keys are always subsection names and values are either
+	 *                                        the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function _input_values($pretty = false, $include_subform_inputs = false, $flatten = false)
+	{
+		$input_values = array();
+		foreach ($this->subsections() as $subsection_name => $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				$input_values[ $subsection_name ] = $pretty
+					? $subsection->pretty_value()
+					: $subsection->normalized_value();
+			} elseif ($subsection instanceof EE_Form_Section_Proper && $include_subform_inputs) {
+				$subform_input_values = $subsection->_input_values(
+					$pretty,
+					$include_subform_inputs,
+					$flatten
+				);
+				if ($flatten) {
+					$input_values = array_merge($input_values, $subform_input_values);
+				} else {
+					$input_values[ $subsection_name ] = $subform_input_values;
+				}
+			}
+		}
+		return $input_values;
+	}
+
+
+	/**
+	 * Gets the originally submitted input values from the form
+	 *
+	 * @param boolean $include_subforms  Whether to include inputs from subforms,
+	 *                                   or just this forms' direct children inputs
+	 * @return array                     if $flatten is TRUE it will always be a 1-dimensional array
+	 *                                   with array keys being input names
+	 *                                   (regardless of whether they are from a subsection or not),
+	 *                                   and if $flatten is FALSE it can be a multidimensional array
+	 *                                   where keys are always subsection names and values are either
+	 *                                   the input's normalized value, or an array like the top-level array
+	 * @throws EE_Error
+	 */
+	public function submitted_values($include_subforms = false)
+	{
+		$submitted_values = array();
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				// is this input part of an array of inputs?
+				if (strpos($subsection->html_name(), '[') !== false) {
+					$full_input_name  = EEH_Array::convert_array_values_to_keys(
+						explode(
+							'[',
+							str_replace(']', '', $subsection->html_name())
+						),
+						$subsection->raw_value()
+					);
+					$submitted_values = array_replace_recursive($submitted_values, $full_input_name);
+				} else {
+					$submitted_values[ $subsection->html_name() ] = $subsection->raw_value();
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper && $include_subforms) {
+				$subform_input_values = $subsection->submitted_values($include_subforms);
+				$submitted_values     = array_replace_recursive($submitted_values, $subform_input_values);
+			}
+		}
+		return $submitted_values;
+	}
+
+
+	/**
+	 * Indicates whether or not this form has received a submission yet
+	 * (ie, had receive_form_submission called on it yet)
+	 *
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function has_received_submission()
+	{
+		$this->ensure_construct_finalized_called();
+		return $this->_received_submission;
+	}
+
+
+	/**
+	 * Equivalent to passing 'exclude' in the constructor's options array.
+	 * Removes the listed inputs from the form
+	 *
+	 * @param array $inputs_to_exclude values are the input names
+	 * @return void
+	 */
+	public function exclude(array $inputs_to_exclude = array())
+	{
+		foreach ($inputs_to_exclude as $input_to_exclude_name) {
+			unset($this->_subsections[ $input_to_exclude_name ]);
+		}
+	}
+
+
+	/**
+	 * Changes these inputs' display strategy to be EE_Hidden_Display_Strategy.
+	 * @param array $inputs_to_hide
+	 * @throws EE_Error
+	 */
+	public function hide(array $inputs_to_hide = array())
+	{
+		foreach ($inputs_to_hide as $input_to_hide) {
+			$input = $this->get_input($input_to_hide);
+			$input->set_display_strategy(new EE_Hidden_Display_Strategy());
+		}
+	}
+
+
+	/**
+	 * add_subsections
+	 * Adds the listed subsections to the form section.
+	 * If $subsection_name_to_target is provided,
+	 * then new subsections are added before or after that subsection,
+	 * otherwise to the start or end of the entire subsections array.
+	 *
+	 * @param EE_Form_Section_Base[] $new_subsections           array of new form subsections
+	 *                                                          where keys are their names
+	 * @param string                 $subsection_name_to_target an existing for section that $new_subsections
+	 *                                                          should be added before or after
+	 *                                                          IF $subsection_name_to_target is null,
+	 *                                                          then $new_subsections will be added to
+	 *                                                          the beginning or end of the entire subsections array
+	 * @param boolean                $add_before                whether to add $new_subsections, before or after
+	 *                                                          $subsection_name_to_target,
+	 *                                                          or if $subsection_name_to_target is null,
+	 *                                                          before or after entire subsections array
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function add_subsections($new_subsections, $subsection_name_to_target = null, $add_before = true)
+	{
+		foreach ($new_subsections as $subsection_name => $subsection) {
+			if (! $subsection instanceof EE_Form_Section_Base) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							"Trying to add a %s as a subsection (it was named '%s') to the form section '%s'. It was removed.",
+							'event_espresso'
+						),
+						get_class($subsection),
+						$subsection_name,
+						$this->name()
+					)
+				);
+				unset($new_subsections[ $subsection_name ]);
+			}
+		}
+		$this->_subsections = EEH_Array::insert_into_array(
+			$this->_subsections,
+			$new_subsections,
+			$subsection_name_to_target,
+			$add_before
+		);
+		if ($this->_construction_finalized) {
+			foreach ($this->_subsections as $name => $subsection) {
+				$subsection->_construct_finalize($this, $name);
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $subsection_name
+	 * @param bool   $recursive
+	 * @return bool
+	 */
+	public function has_subsection($subsection_name, $recursive = false)
+	{
+		foreach ($this->_subsections as $name => $subsection) {if(
+				$name === $subsection_name
+				|| (
+					$recursive
+					&& $subsection instanceof EE_Form_Section_Proper
+					&& $subsection->has_subsection($subsection_name, $recursive)
+				)
+			) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Just gets all validatable subsections to clean their sensitive data
+	 *
+	 * @throws EE_Error
+	 */
+	public function clean_sensitive_data()
+	{
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			$subsection->clean_sensitive_data();
+		}
+	}
+
+
+	/**
+	 * Sets the submission error message (aka validation error message for this form section and all sub-sections)
+	 * @param string                           $form_submission_error_message
+	 * @param EE_Form_Section_Validatable $form_section unused
+	 * @throws EE_Error
+	 */
+	public function set_submission_error_message(
+		$form_submission_error_message = ''
+	) {
+		$this->_form_submission_error_message = ! empty($form_submission_error_message)
+			? $form_submission_error_message
+			: $this->getAllValidationErrorsString();
+	}
+
+
+	/**
+	 * Returns the cached error message. A default value is set for this during _validate(),
+	 * (called during receive_form_submission) but it can be explicitly set using
+	 * set_submission_error_message
+	 *
+	 * @return string
+	 */
+	public function submission_error_message()
+	{
+		return $this->_form_submission_error_message;
+	}
+
+
+	/**
+	 * Sets a message to display if the data submitted to the form was valid.
+	 * @param string $form_submission_success_message
+	 */
+	public function set_submission_success_message($form_submission_success_message = '')
+	{
+		$this->_form_submission_success_message = ! empty($form_submission_success_message)
+			? $form_submission_success_message
+			: esc_html__('Form submitted successfully', 'event_espresso');
+	}
+
+
+	/**
+	 * Gets a message appropriate for display when the form is correctly submitted
+	 * @return string
+	 */
+	public function submission_success_message()
+	{
+		return $this->_form_submission_success_message;
+	}
+
+
+	/**
+	 * Returns the prefix that should be used on child of this form section for
+	 * their html names. If this form section itself has a parent, prepends ITS
+	 * prefix onto this form section's prefix. Used primarily by
+	 * EE_Form_Input_Base::_set_default_html_name_if_empty
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_name_prefix()
+	{
+		if ($this->parent_section() instanceof EE_Form_Section_Proper) {
+			return $this->parent_section()->html_name_prefix() . '[' . $this->name() . ']';
+		}
+		return $this->name();
+	}
+
+
+	/**
+	 * Gets the name, but first checks _construct_finalize has been called. If not,
+	 * calls it (assumes there is no parent and that we want the name to be whatever
+	 * was set, which is probably nothing, or the classname)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::name();
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	public function parent_section()
+	{
+		$this->ensure_construct_finalized_called();
+		return parent::parent_section();
+	}
+
+
+	/**
+	 * make sure construction finalized was called, otherwise children might not be ready
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function ensure_construct_finalized_called()
+	{
+		if (! $this->_construction_finalized) {
+			$this->_construct_finalize($this->_parent_section, $this->_name);
+		}
+	}
+
+
+	/**
+	 * Checks if any of this form section's inputs, or any of its children's inputs,
+	 * are in teh form data. If any are found, returns true. Else false
+	 *
+	 * @param array $req_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		$req_data = $this->getCachedRequest($req_data);
+		foreach ($this->subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Input_Base) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			} elseif ($subsection instanceof EE_Form_Section_Proper) {
+				if ($subsection->form_data_present_in($req_data)) {
+					return true;
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets validation errors for this form section and subsections
+	 * Similar to EE_Form_Section_Validatable::get_validation_errors() except this
+	 * gets the validation errors for ALL subsection
+	 *
+	 * @return EE_Validation_Error[]
+	 * @throws EE_Error
+	 */
+	public function get_validation_errors_accumulated()
+	{
+		$validation_errors = $this->get_validation_errors();
+		foreach ($this->get_validatable_subsections() as $subsection) {
+			if ($subsection instanceof EE_Form_Section_Proper) {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors_accumulated();
+			} else {
+				$validation_errors_on_this_subsection = $subsection->get_validation_errors();
+			}
+			if ($validation_errors_on_this_subsection) {
+				$validation_errors = array_merge($validation_errors, $validation_errors_on_this_subsection);
+			}
+		}
+		return $validation_errors;
+	}
+
+	/**
+	 * Fetch validation errors from children and grandchildren and puts them in a single string.
+	 * This traverses the form section tree to generate this, but you probably want to instead use
+	 * get_form_submission_error_message() which is usually this message cached (or a custom validation error message)
+	 *
+	 * @return string
+	 * @since 4.9.59.p
+	 */
+	protected function getAllValidationErrorsString()
+	{
+		$submission_error_messages = array();
+		// bad, bad, bad registrant
+		foreach ($this->get_validation_errors_accumulated() as $validation_error) {
+			if ($validation_error instanceof EE_Validation_Error) {
+				$form_section = $validation_error->get_form_section();
+				if ($form_section instanceof EE_Form_Input_Base) {
+				   $label = $validation_error->get_form_section()->html_label_text();
+				} elseif($form_section instanceof EE_Form_Section_Validatable) {
+					$label = $validation_error->get_form_section()->name();
+				} else {
+					$label = esc_html__('Unknown', 'event_espresso');
+				}
+				$submission_error_messages[] = sprintf(
+					__('%s : %s', 'event_espresso'),
+					$label,
+					$validation_error->getMessage()
+				);
+			}
+		}
+		return implode('<br', $submission_error_messages);
+	}
+
+
+	/**
+	 * This isn't just the name of an input, it's a path pointing to an input. The
+	 * path is similar to a folder path: slash (/) means to descend into a subsection,
+	 * dot-dot-slash (../) means to ascend into the parent section.
+	 * After a series of slashes and dot-dot-slashes, there should be the name of an input,
+	 * which will be returned.
+	 * Eg, if you want the related input to be conditional on a sibling input name 'foobar'
+	 * just use 'foobar'. If you want it to be conditional on an aunt/uncle input name
+	 * 'baz', use '../baz'. If you want it to be conditional on a cousin input,
+	 * the child of 'baz_section' named 'baz_child', use '../baz_section/baz_child'.
+	 * Etc
+	 *
+	 * @param string|false $form_section_path we accept false also because substr( '../', '../' ) = false
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 */
+	public function find_section_from_path($form_section_path)
+	{
+		//check if we can find the input from purely going straight up the tree
+		$input = parent::find_section_from_path($form_section_path);
+		if ($input instanceof EE_Form_Section_Base) {
+			return $input;
+		}
+		$next_slash_pos = strpos($form_section_path, '/');
+		if ($next_slash_pos !== false) {
+			$child_section_name = substr($form_section_path, 0, $next_slash_pos);
+			$subpath            = substr($form_section_path, $next_slash_pos + 1);
+		} else {
+			$child_section_name = $form_section_path;
+			$subpath            = '';
+		}
+		$child_section = $this->get_subsection($child_section_name);
+		if ($child_section instanceof EE_Form_Section_Base) {
+			return $child_section->find_section_from_path($subpath);
+		}
+		return null;
+	}
 }
 

core/services/request/Request.php

Indentation +584 added lines, -584 removed lines

@@ -20,590 +20,590 @@
 class Request implements InterminableInterface, RequestInterface
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array $get
-     */
-    private $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array $post
-     */
-    private $post;
-
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array $cookie
-     */
-    private $cookie;
-
-    /**
-     * $_SERVER parameters
-     *
-     * @var array $server
-     */
-    private $server;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array $request
-     */
-    private $request;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    private $request_type;
-
-    /**
-     * IP address for request
-     *
-     * @var string $ip_address
-     */
-    private $ip_address;
-
-    /**
-     * @var string $user_agent
-     */
-    private $user_agent;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool $is_bot
-     */
-    private $is_bot;
-
-
-
-    /**
-     * @param array                              $get
-     * @param array                              $post
-     * @param array                              $cookie
-     * @param array                              $server
-     */
-    public function __construct(array $get, array $post, array $cookie, array $server)
-    {
-        // grab request vars
-        $this->get        = $get;
-        $this->post       = $post;
-        $this->cookie     = $cookie;
-        $this->server     = $server;
-        $this->request    = array_merge($this->get, $this->post);
-        $this->ip_address = $this->visitorIp();
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookie;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server;
-    }
-
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if (
-            $key !== 'ee'
-            || ($key === 'ee' && empty($this->request['ee']))
-            || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
-        ) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param       $key
-     * @param null  $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null)
-    {
-        return $this->requestParameterDrillDown($key, $default, 'get');
-    }
-
-
-
-    /**
-     * check if param exists
-     *
-     * @param       $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->requestParameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param null|mixed $default
-     * @return false|int
-     */
-    public function getMatch($pattern, $default = null)
-    {
-        return $this->requestParameterDrillDown($pattern, $default, 'match');
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     */
-    public function matches($pattern)
-    {
-        return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are:
-     *                                      'bool' will return true or false if match is found or not
-     *                                      'key' will return the first key found that matches the supplied pattern
-     *                                      'value' will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
-    {
-        $return = in_array($return, array('bool', 'key', 'value'), true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            array("\*", "\?"),
-            array('.*', '.'),
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === 'value') {
-                    return $request_params[ $key ];
-                }
-                // or actual key or true just to indicate it was found
-                return $return === 'key' ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === 'value' ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param array  $request_params
-     * @return bool|mixed|null
-     */
-    private function requestParameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        array $request_params = array()
-    ) {
-        $callback       = in_array($callback, array('is_set', 'get', 'match'), true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key  = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key  = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, 'key');
-                $key      = $real_key ? $real_key : $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->requestParameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        unset($this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
-        }
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function visitorIp()
-    {
-        $visitor_ip  = '0.0.0.0';
-        $server_keys = array(
-            'HTTP_CLIENT_IP',
-            'HTTP_X_FORWARDED_FOR',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_FORWARDED',
-            'REMOTE_ADDR',
-        );
-        foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function requestUri()
-    {
-        $request_uri = filter_input(
-            INPUT_SERVER,
-            'REQUEST_URI',
-            FILTER_SANITIZE_URL,
-            FILTER_NULL_ON_FAILURE
-        );
-        if (empty($request_uri)) {
-            // fallback sanitization if the above fails
-            $request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
-        }
-        return $request_uri;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->user_agent;
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        if ($user_agent === '' || ! is_string($user_agent)) {
-            $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
-        }
-        $this->user_agent = $user_agent;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBot()
-    {
-        return $this->is_bot;
-    }
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->isAdmin();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->isAdminAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->request_type->isAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->request_type->isEeAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->isOtherAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->isApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->isCli();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->isCron();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->isFeed();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->isFrontend();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->isFrontAjax();
-    }
-
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array $get
+	 */
+	private $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array $post
+	 */
+	private $post;
+
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array $cookie
+	 */
+	private $cookie;
+
+	/**
+	 * $_SERVER parameters
+	 *
+	 * @var array $server
+	 */
+	private $server;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array $request
+	 */
+	private $request;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	private $request_type;
+
+	/**
+	 * IP address for request
+	 *
+	 * @var string $ip_address
+	 */
+	private $ip_address;
+
+	/**
+	 * @var string $user_agent
+	 */
+	private $user_agent;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool $is_bot
+	 */
+	private $is_bot;
+
+
+
+	/**
+	 * @param array                              $get
+	 * @param array                              $post
+	 * @param array                              $cookie
+	 * @param array                              $server
+	 */
+	public function __construct(array $get, array $post, array $cookie, array $server)
+	{
+		// grab request vars
+		$this->get        = $get;
+		$this->post       = $post;
+		$this->cookie     = $cookie;
+		$this->server     = $server;
+		$this->request    = array_merge($this->get, $this->post);
+		$this->ip_address = $this->visitorIp();
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookie;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server;
+	}
+
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if (
+			$key !== 'ee'
+			|| ($key === 'ee' && empty($this->request['ee']))
+			|| ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
+		) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param       $key
+	 * @param null  $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null)
+	{
+		return $this->requestParameterDrillDown($key, $default, 'get');
+	}
+
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param       $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->requestParameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param null|mixed $default
+	 * @return false|int
+	 */
+	public function getMatch($pattern, $default = null)
+	{
+		return $this->requestParameterDrillDown($pattern, $default, 'match');
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 */
+	public function matches($pattern)
+	{
+		return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are:
+	 *                                      'bool' will return true or false if match is found or not
+	 *                                      'key' will return the first key found that matches the supplied pattern
+	 *                                      'value' will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
+	{
+		$return = in_array($return, array('bool', 'key', 'value'), true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			array("\*", "\?"),
+			array('.*', '.'),
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === 'value') {
+					return $request_params[ $key ];
+				}
+				// or actual key or true just to indicate it was found
+				return $return === 'key' ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === 'value' ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param array  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function requestParameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		array $request_params = array()
+	) {
+		$callback       = in_array($callback, array('is_set', 'get', 'match'), true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key  = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key  = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, 'key');
+				$key      = $real_key ? $real_key : $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->requestParameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		unset($this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_REQUEST[ $key ]);
+		}
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function visitorIp()
+	{
+		$visitor_ip  = '0.0.0.0';
+		$server_keys = array(
+			'HTTP_CLIENT_IP',
+			'HTTP_X_FORWARDED_FOR',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_FORWARDED',
+			'REMOTE_ADDR',
+		);
+		foreach ($server_keys as $key) {
+			if (isset($this->server[ $key ])) {
+				foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function requestUri()
+	{
+		$request_uri = filter_input(
+			INPUT_SERVER,
+			'REQUEST_URI',
+			FILTER_SANITIZE_URL,
+			FILTER_NULL_ON_FAILURE
+		);
+		if (empty($request_uri)) {
+			// fallback sanitization if the above fails
+			$request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
+		}
+		return $request_uri;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->user_agent;
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		if ($user_agent === '' || ! is_string($user_agent)) {
+			$user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
+		}
+		$this->user_agent = $user_agent;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot()
+	{
+		return $this->is_bot;
+	}
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->isAdmin();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->isAdminAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->request_type->isAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->request_type->isEeAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->isOtherAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->isApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->isCli();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->isCron();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->isFeed();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->isFrontend();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->isFrontAjax();
+	}
+
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
 
 
 }

Spacing +14 added lines, -14 removed lines

@@ -174,7 +174,7 @@ 
             || ($key === 'ee' && empty($this->request['ee']))
             || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
         ) {
-            $this->request[ $key ] = $value;
+            $this->request[$key] = $value;
         }
     }
 
@@ -267,10 +267,10 @@ 
             preg_quote($pattern, '/')
         );
         foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
                 // return value for request param
                 if ($return === 'value') {
-                    return $request_params[ $key ];
+                    return $request_params[$key];
                 }
                 // or actual key or true just to indicate it was found
                 return $return === 'key' ? $key : true;
@@ -327,29 +327,29 @@ 
                 $key      = $real_key ? $real_key : $key;
             }
             // check if top level key exists
-            if (isset($request_params[ $key ])) {
+            if (isset($request_params[$key])) {
                 // build a new key to pass along like: 'second[third]'
                 // or just 'second' depending on depth of keys
                 $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
+                if ( ! empty($keys)) {
+                    $key_string .= '['.implode('][', $keys).']';
                 }
                 return $this->requestParameterDrillDown(
                     $key_string,
                     $default,
                     $callback,
-                    $request_params[ $key ]
+                    $request_params[$key]
                 );
             }
         }
         if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
+            return isset($request_params[$key]);
         }
         if ($callback === 'match') {
             return $this->match($key, $request_params, $default);
         }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
+        return isset($request_params[$key])
+            ? $request_params[$key]
             : $default;
     }
 
@@ -362,9 +362,9 @@ 
      */
     public function unSetRequestParam($key, $unset_from_global_too = false)
     {
-        unset($this->request[ $key ]);
+        unset($this->request[$key]);
         if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
+            unset($_REQUEST[$key]);
         }
     }
 
@@ -399,8 +399,8 @@ 
             'REMOTE_ADDR',
         );
         foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+            if (isset($this->server[$key])) {
+                foreach (array_map('trim', explode(',', $this->server[$key])) as $ip) {
                     if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
                         $visitor_ip = $ip;
                     }

Doc Comments +3 added lines, -3 removed lines

@@ -185,7 +185,7 @@ 
      *
      * @param       $key
      * @param null  $default
-     * @return mixed
+     * @return integer
      */
     public function getRequestParam($key, $default = null)
     {
@@ -231,7 +231,7 @@ 
      * returns true if a match is found or false if not
      *
      * @param string $pattern
-     * @return false|int
+     * @return boolean
      */
     public function matches($pattern)
     {
@@ -299,7 +299,7 @@ 
      * would return true if default parameters were set
      *
      * @param string $callback
-     * @param        $key
+     * @param        string $key
      * @param null   $default
      * @param array  $request_params
      * @return bool|mixed|null

core/services/request/RequestInterface.php

Indentation +118 added lines, -118 removed lines

@@ -20,139 +20,139 @@
 interface RequestInterface extends RequestTypeContextCheckerInterface
 {
 
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
-
-    /**
-     * @return array
-     */
-    public function getParams();
-
-
-    /**
-     * @return array
-     */
-    public function postParams();
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams();
-
-
-    /**
-     * @return array
-     */
-    public function serverParams();
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams();
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
+
+	/**
+	 * @return array
+	 */
+	public function getParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams();
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams();
 
 
-    /**
-     * @param string $key
-     * @param string $value
-     * @param bool   $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false);
+	/**
+	 * @param string $key
+	 * @param string $value
+	 * @param bool   $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false);
 
 
-    /**
-     * returns the value for a request param if the given key exists
-     *
-     * @param string $key
-     * @param null   $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null);
+	/**
+	 * returns the value for a request param if the given key exists
+	 *
+	 * @param string $key
+	 * @param null   $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null);
 
 
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key);
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key);
 
 
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param null|mixed $default
-     * @return false|int
-     */
-    public function getMatch($pattern, $default = null);
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param null|mixed $default
+	 * @return false|int
+	 */
+	public function getMatch($pattern, $default = null);
 
 
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     */
-    public function matches($pattern);
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 */
+	public function matches($pattern);
 
 
-    /**
-     * remove param
-     *
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false);
+	/**
+	 * remove param
+	 *
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false);
 
 
-    /**
-     * @return string
-     */
-    public function ipAddress();
+	/**
+	 * @return string
+	 */
+	public function ipAddress();
 
 
-    /**
-     * @return string
-     */
-    public function requestUri();
-
+	/**
+	 * @return string
+	 */
+	public function requestUri();
+
 
-    /**
-     * @return string
-     */
-    public function userAgent();
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '');
-
-
-    /**
-     * @return bool
-     */
-    public function isBot();
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot);
+	/**
+	 * @return string
+	 */
+	public function userAgent();
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '');
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot();
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot);
 }

core/libraries/messages/messenger/EE_Email_messenger.class.php

Indentation +645 added lines, -645 removed lines

@@ -8,649 +8,649 @@
 class EE_Email_messenger extends EE_messenger
 {
 
-    /**
-     * To field for email
-     * @var string
-     */
-    protected $_to = '';
-
-
-    /**
-     * CC field for email.
-     * @var string
-     */
-    protected $_cc = '';
-
-    /**
-     * From field for email
-     * @var string
-     */
-    protected $_from = '';
-
-
-    /**
-     * Subject field for email
-     * @var string
-     */
-    protected $_subject = '';
-
-
-    /**
-     * Content field for email
-     * @var string
-     */
-    protected $_content = '';
-
-
-    /**
-     * constructor
-     *
-     * @access public
-     */
-    public function __construct()
-    {
-        //set name and description properties
-        $this->name                = 'email';
-        $this->description         = sprintf(
-            esc_html__(
-                'This messenger delivers messages via email using the built-in %s function included with WordPress',
-                'event_espresso'
-            ),
-            '<code>wp_mail</code>'
-        );
-        $this->label               = array(
-            'singular' => esc_html__('email', 'event_espresso'),
-            'plural'   => esc_html__('emails', 'event_espresso'),
-        );
-        $this->activate_on_install = true;
-
-        //we're using defaults so let's call parent constructor that will take care of setting up all the other
-        // properties
-        parent::__construct();
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details.
-     */
-    protected function _set_admin_pages()
-    {
-        $this->admin_registered_pages = array(
-            'events_edit' => true,
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     */
-    protected function _set_valid_shortcodes()
-    {
-        //remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
-        // message type.
-        $this->_valid_shortcodes = array(
-            'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-            'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
-        );
-    }
-
-
-    /**
-     * see abstract declaration in parent class for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_validator_config()
-    {
-        $valid_shortcodes = $this->get_valid_shortcodes();
-
-        $this->_validator_config = array(
-            'to'            => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type'       => 'email',
-            ),
-            'cc' => array(
-                'shortcodes' => $valid_shortcodes['to'],
-                'type' => 'email',
-            ),
-            'from'          => array(
-                'shortcodes' => $valid_shortcodes['from'],
-                'type'       => 'email',
-            ),
-            'subject'       => array(
-                'shortcodes' => array(
-                    'organization',
-                    'primary_registration_details',
-                    'event_author',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-            ),
-            'content'       => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket_list',
-                    'organization',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                    'transaction',
-                    'messenger',
-                ),
-            ),
-            'attendee_list' => array(
-                'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
-                'required'   => array('[ATTENDEE_LIST]'),
-            ),
-            'event_list'    => array(
-                'shortcodes' => array(
-                    'event',
-                    'attendee_list',
-                    'ticket_list',
-                    'venue',
-                    'datetime_list',
-                    'attendee',
-                    'primary_registration_details',
-                    'primary_registration_list',
-                    'event_author',
-                    'recipient_details',
-                    'recipient_list',
-                ),
-                'required'   => array('[EVENT_LIST]'),
-            ),
-            'ticket_list'   => array(
-                'shortcodes' => array(
-                    'event_list',
-                    'attendee_list',
-                    'ticket',
-                    'datetime_list',
-                    'primary_registration_details',
-                    'recipient_details',
-                ),
-                'required'   => array('[TICKET_LIST]'),
-            ),
-            'datetime_list' => array(
-                'shortcodes' => array('datetime'),
-                'required'   => array('[DATETIME_LIST]'),
-            ),
-        );
-    }
-
-
-    /**
-     * @see   parent EE_messenger class for docs
-     * @since 4.5.0
-     */
-    public function do_secondary_messenger_hooks($sending_messenger_name)
-    {
-        if ($sending_messenger_name = 'html') {
-            add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        }
-    }
-
-
-    public function add_email_css(
-        $variation_path,
-        $messenger,
-        $message_type,
-        $type,
-        $variation,
-        $file_extension,
-        $url,
-        EE_Messages_Template_Pack $template_pack
-    ) {
-        //prevent recursion on this callback.
-        remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
-        $variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
-
-        add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
-        return $variation;
-    }
-
-
-    /**
-     * See parent for details
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_test_settings_fields()
-    {
-        $this->_test_settings_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html__('Send a test email to', 'event_espresso'),
-                'type'       => 'email',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-                'default'    => get_bloginfo('admin_email'),
-            ),
-            'subject' => array(
-                'input'      => 'hidden',
-                'label'      => '',
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => false,
-                'format'     => '%s',
-                'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
-                'default'    => '',
-                'css_class'  => '',
-            ),
-        );
-    }
-
-
-    /**
-     * _set_template_fields
-     * This sets up the fields that a messenger requires for the message to go out.
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _set_template_fields()
-    {
-        // any extra template fields that are NOT used by the messenger but will get used by a messenger field for
-        // shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
-        // they relate to.  This is important for the Messages_admin to know what fields to display to the user.
-        //  Also, notice that the "values" are equal to the field type that messages admin will use to know what
-        // kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
-        // indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
-        // displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
-        // will not be displayed/parsed.
-        $this->_template_fields = array(
-            'to'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'To',
-                    'Label for the "To" field for email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'cc'      => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'CC',
-                    'Label for the "Carbon Copy" field used for additional email addresses',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => false,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'from'    => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'From',
-                    'Label for the "From" field for email addresses.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'subject' => array(
-                'input'      => 'text',
-                'label'      => esc_html_x(
-                    'Subject',
-                    'Label for the "Subject" field (short description of contents) for emails.',
-                    'event_espresso'
-                ),
-                'type'       => 'string',
-                'required'   => true,
-                'validation' => true,
-                'css_class'  => 'large-text',
-                'format'     => '%s',
-            ),
-            'content' => '',
-            //left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
-            'extra'   => array(
-                'content' => array(
-                    'main'          => array(
-                        'input'      => 'wp_editor',
-                        'label'      => esc_html__('Main Content', 'event_espresso'),
-                        'type'       => 'string',
-                        'required'   => true,
-                        'validation' => true,
-                        'format'     => '%s',
-                        'rows'       => '15',
-                    ),
-                    'event_list'    => array(
-                        'input'               => 'wp_editor',
-                        'label'               => '[EVENT_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'rows'                => '15',
-                        'shortcodes_required' => array('[EVENT_LIST]'),
-                    ),
-                    'attendee_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[ATTENDEE_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '5',
-                        'shortcodes_required' => array('[ATTENDEE_LIST]'),
-                    ),
-                    'ticket_list'   => array(
-                        'input'               => 'textarea',
-                        'label'               => '[TICKET_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[TICKET_LIST]'),
-                    ),
-                    'datetime_list' => array(
-                        'input'               => 'textarea',
-                        'label'               => '[DATETIME_LIST]',
-                        'type'                => 'string',
-                        'required'            => true,
-                        'validation'          => true,
-                        'format'              => '%s',
-                        'css_class'           => 'large-text',
-                        'rows'                => '10',
-                        'shortcodes_required' => array('[DATETIME_LIST]'),
-                    ),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * See definition of this class in parent
-     */
-    protected function _set_default_message_types()
-    {
-        $this->_default_message_types = array(
-            'payment',
-            'payment_refund',
-            'registration',
-            'not_approved_registration',
-            'pending_approval',
-        );
-    }
-
-
-    /**
-     * @see   definition of this class in parent
-     * @since 4.5.0
-     */
-    protected function _set_valid_message_types()
-    {
-        $this->_valid_message_types = array(
-            'payment',
-            'registration',
-            'not_approved_registration',
-            'declined_registration',
-            'cancelled_registration',
-            'pending_approval',
-            'registration_summary',
-            'payment_reminder',
-            'payment_declined',
-            'payment_refund',
-        );
-    }
-
-
-    /**
-     * setting up admin_settings_fields for messenger.
-     */
-    protected function _set_admin_settings_fields()
-    {
-    }
-
-    /**
-     * We just deliver the messages don't kill us!!
-     *
-     * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
-     *              present.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _send_message()
-    {
-        $success = wp_mail(
-            $this->_to,
-            //some old values for subject may be expecting HTML entities to be decoded in the subject
-            //and subjects aren't interpreted as HTML, so there should be no HTML in them
-            wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
-            $this->_body(),
-            $this->_headers()
-        );
-        if (! $success) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
-                        'event_espresso'
-                    ),
-                    $this->_to,
-                    $this->_from,
-                    '<br />'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * see parent for definition
-     *
-     * @return string html body of the message content and the related css.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _preview()
-    {
-        return $this->_body(true);
-    }
-
-
-    /**
-     * Setup headers for email
-     *
-     * @access protected
-     * @return string formatted header for email
-     */
-    protected function _headers()
-    {
-        $this->_ensure_has_from_email_address();
-        $from    = $this->_from;
-        $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
-            'Content-Type:text/html; charset=utf-8',
-        );
-
-        /**
-         * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
-         * cover back compat where there may be users who have saved cc values in their db for the newsletter message
-         * type which they are no longer able to change.
-         */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
-        }
-
-        //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
-        // header.
-        add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
-        add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
-        return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
-    }
-
-
-    /**
-     * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
-     * address for the from address to avoid problems with sending emails.
-     */
-    protected function _ensure_has_from_email_address()
-    {
-        if (empty($this->_from)) {
-            $this->_from = get_bloginfo('admin_email');
-        }
-    }
-
-
-    /**
-     * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
-     * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
-     * be empty
-     *
-     * @since 4.3.1
-     * @return array
-     */
-    private function _parse_from()
-    {
-        if (strpos($this->_from, '<') !== false) {
-            $from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
-            $from_name = str_replace('"', '', $from_name);
-            $from_name = trim($from_name);
-
-            $from_email = substr($this->_from, strpos($this->_from, '<') + 1);
-            $from_email = str_replace('>', '', $from_email);
-            $from_email = trim($from_email);
-        } elseif (trim($this->_from) !== '') {
-            $from_name  = '';
-            $from_email = trim($this->_from);
-        } else {
-            $from_name = $from_email = '';
-        }
-        return array($from_name, $from_email);
-    }
-
-
-    /**
-     * Callback for the wp_mail_from filter.
-     *
-     * @since 4.3.1
-     * @param string $from_email What the original from_email is.
-     * @return string
-     */
-    public function set_from_address($from_email)
-    {
-        $parsed_from = $this->_parse_from();
-        //includes fallback if the parsing failed.
-        $from_email = is_array($parsed_from) && ! empty($parsed_from[1])
-            ? $parsed_from[1]
-            : get_bloginfo('admin_email');
-        return $from_email;
-    }
-
-
-    /**
-     * Callback fro the wp_mail_from_name filter.
-     *
-     * @since 4.3.1
-     * @param string $from_name The original from_name.
-     * @return string
-     */
-    public function set_from_name($from_name)
-    {
-        $parsed_from = $this->_parse_from();
-        if (is_array($parsed_from) && ! empty($parsed_from[0])) {
-            $from_name = $parsed_from[0];
-        }
-
-        //if from name is "WordPress" let's sub in the site name instead (more friendly!)
-        //but realize the default name is HTML entity-encoded
-        $from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
-
-        return $from_name;
-    }
-
-
-    /**
-     * setup body for email
-     *
-     * @param bool $preview will determine whether this is preview template or not.
-     * @return string formatted body for email.
-     * @throws EE_Error
-     * @throws \TijsVerkoyen\CssToInlineStyles\Exception
-     */
-    protected function _body($preview = false)
-    {
-        //setup template args!
-        $this->_template_args = array(
-            'subject'   => $this->_subject,
-            'from'      => $this->_from,
-            'main_body' => wpautop($this->_content),
-        );
-        $body                 = $this->_get_main_template($preview);
-
-        /**
-         * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
-         *
-         * @type    bool $preview Indicates whether a preview is being generated or not.
-         * @return  bool    true  indicates to use the inliner, false bypasses it.
-         */
-        if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
-            //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
-
-            //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
-                $style = file_get_contents(
-                    $this->get_variation(
-                        $this->_tmp_pack,
-                        $this->_incoming_message_type->name,
-                        false,
-                        'main',
-                        $this->_variation
-                    ),
-                    true
-                );
-                $CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
-                //for some reason the library has a bracket and new line at the beginning.  This takes care of that.
-                $body  = ltrim($CSS->convert(true), ">\n");
-                //see https://events.codebasehq.com/projects/event-espresso/tickets/8609
-                $body  = ltrim($body, "<?");
-            }
-
-        }
-        return $body;
-    }
-
-
-    /**
-     * This just returns any existing test settings that might be saved in the database
-     *
-     * @access public
-     * @return array
-     */
-    public function get_existing_test_settings()
-    {
-        $settings = parent::get_existing_test_settings();
-        //override subject if present because we always want it to be fresh.
-        if (is_array($settings) && ! empty($settings['subject'])) {
-            $settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
-        }
-        return $settings;
-    }
+	/**
+	 * To field for email
+	 * @var string
+	 */
+	protected $_to = '';
+
+
+	/**
+	 * CC field for email.
+	 * @var string
+	 */
+	protected $_cc = '';
+
+	/**
+	 * From field for email
+	 * @var string
+	 */
+	protected $_from = '';
+
+
+	/**
+	 * Subject field for email
+	 * @var string
+	 */
+	protected $_subject = '';
+
+
+	/**
+	 * Content field for email
+	 * @var string
+	 */
+	protected $_content = '';
+
+
+	/**
+	 * constructor
+	 *
+	 * @access public
+	 */
+	public function __construct()
+	{
+		//set name and description properties
+		$this->name                = 'email';
+		$this->description         = sprintf(
+			esc_html__(
+				'This messenger delivers messages via email using the built-in %s function included with WordPress',
+				'event_espresso'
+			),
+			'<code>wp_mail</code>'
+		);
+		$this->label               = array(
+			'singular' => esc_html__('email', 'event_espresso'),
+			'plural'   => esc_html__('emails', 'event_espresso'),
+		);
+		$this->activate_on_install = true;
+
+		//we're using defaults so let's call parent constructor that will take care of setting up all the other
+		// properties
+		parent::__construct();
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details.
+	 */
+	protected function _set_admin_pages()
+	{
+		$this->admin_registered_pages = array(
+			'events_edit' => true,
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		//remember by leaving the other fields not set, those fields will inherit the valid shortcodes from the
+		// message type.
+		$this->_valid_shortcodes = array(
+			'to'   => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'cc' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+			'from' => array('email', 'event_author', 'primary_registration_details', 'recipient_details'),
+		);
+	}
+
+
+	/**
+	 * see abstract declaration in parent class for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_validator_config()
+	{
+		$valid_shortcodes = $this->get_valid_shortcodes();
+
+		$this->_validator_config = array(
+			'to'            => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type'       => 'email',
+			),
+			'cc' => array(
+				'shortcodes' => $valid_shortcodes['to'],
+				'type' => 'email',
+			),
+			'from'          => array(
+				'shortcodes' => $valid_shortcodes['from'],
+				'type'       => 'email',
+			),
+			'subject'       => array(
+				'shortcodes' => array(
+					'organization',
+					'primary_registration_details',
+					'event_author',
+					'primary_registration_details',
+					'recipient_details',
+				),
+			),
+			'content'       => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket_list',
+					'organization',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+					'transaction',
+					'messenger',
+				),
+			),
+			'attendee_list' => array(
+				'shortcodes' => array('attendee', 'event_list', 'ticket_list'),
+				'required'   => array('[ATTENDEE_LIST]'),
+			),
+			'event_list'    => array(
+				'shortcodes' => array(
+					'event',
+					'attendee_list',
+					'ticket_list',
+					'venue',
+					'datetime_list',
+					'attendee',
+					'primary_registration_details',
+					'primary_registration_list',
+					'event_author',
+					'recipient_details',
+					'recipient_list',
+				),
+				'required'   => array('[EVENT_LIST]'),
+			),
+			'ticket_list'   => array(
+				'shortcodes' => array(
+					'event_list',
+					'attendee_list',
+					'ticket',
+					'datetime_list',
+					'primary_registration_details',
+					'recipient_details',
+				),
+				'required'   => array('[TICKET_LIST]'),
+			),
+			'datetime_list' => array(
+				'shortcodes' => array('datetime'),
+				'required'   => array('[DATETIME_LIST]'),
+			),
+		);
+	}
+
+
+	/**
+	 * @see   parent EE_messenger class for docs
+	 * @since 4.5.0
+	 */
+	public function do_secondary_messenger_hooks($sending_messenger_name)
+	{
+		if ($sending_messenger_name = 'html') {
+			add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		}
+	}
+
+
+	public function add_email_css(
+		$variation_path,
+		$messenger,
+		$message_type,
+		$type,
+		$variation,
+		$file_extension,
+		$url,
+		EE_Messages_Template_Pack $template_pack
+	) {
+		//prevent recursion on this callback.
+		remove_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10);
+		$variation = $this->get_variation($template_pack, $message_type, $url, 'main', $variation, false);
+
+		add_filter('FHEE__EE_Messages_Template_Pack__get_variation', array($this, 'add_email_css'), 10, 8);
+		return $variation;
+	}
+
+
+	/**
+	 * See parent for details
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_test_settings_fields()
+	{
+		$this->_test_settings_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html__('Send a test email to', 'event_espresso'),
+				'type'       => 'email',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+				'default'    => get_bloginfo('admin_email'),
+			),
+			'subject' => array(
+				'input'      => 'hidden',
+				'label'      => '',
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => false,
+				'format'     => '%s',
+				'value'      => sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name')),
+				'default'    => '',
+				'css_class'  => '',
+			),
+		);
+	}
+
+
+	/**
+	 * _set_template_fields
+	 * This sets up the fields that a messenger requires for the message to go out.
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _set_template_fields()
+	{
+		// any extra template fields that are NOT used by the messenger but will get used by a messenger field for
+		// shortcode replacement get added to the 'extra' key in an associated array indexed by the messenger field
+		// they relate to.  This is important for the Messages_admin to know what fields to display to the user.
+		//  Also, notice that the "values" are equal to the field type that messages admin will use to know what
+		// kind of field to display. The values ALSO have one index labeled "shortcode".  the values in that array
+		// indicate which ACTUAL SHORTCODE (i.e. [SHORTCODE]) is required in order for this extra field to be
+		// displayed.  If the required shortcode isn't part of the shortcodes array then the field is not needed and
+		// will not be displayed/parsed.
+		$this->_template_fields = array(
+			'to'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'To',
+					'Label for the "To" field for email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'cc'      => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'CC',
+					'Label for the "Carbon Copy" field used for additional email addresses',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => false,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'from'    => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'From',
+					'Label for the "From" field for email addresses.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'subject' => array(
+				'input'      => 'text',
+				'label'      => esc_html_x(
+					'Subject',
+					'Label for the "Subject" field (short description of contents) for emails.',
+					'event_espresso'
+				),
+				'type'       => 'string',
+				'required'   => true,
+				'validation' => true,
+				'css_class'  => 'large-text',
+				'format'     => '%s',
+			),
+			'content' => '',
+			//left empty b/c it is in the "extra array" but messenger still needs needs to know this is a field.
+			'extra'   => array(
+				'content' => array(
+					'main'          => array(
+						'input'      => 'wp_editor',
+						'label'      => esc_html__('Main Content', 'event_espresso'),
+						'type'       => 'string',
+						'required'   => true,
+						'validation' => true,
+						'format'     => '%s',
+						'rows'       => '15',
+					),
+					'event_list'    => array(
+						'input'               => 'wp_editor',
+						'label'               => '[EVENT_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'rows'                => '15',
+						'shortcodes_required' => array('[EVENT_LIST]'),
+					),
+					'attendee_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[ATTENDEE_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '5',
+						'shortcodes_required' => array('[ATTENDEE_LIST]'),
+					),
+					'ticket_list'   => array(
+						'input'               => 'textarea',
+						'label'               => '[TICKET_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[TICKET_LIST]'),
+					),
+					'datetime_list' => array(
+						'input'               => 'textarea',
+						'label'               => '[DATETIME_LIST]',
+						'type'                => 'string',
+						'required'            => true,
+						'validation'          => true,
+						'format'              => '%s',
+						'css_class'           => 'large-text',
+						'rows'                => '10',
+						'shortcodes_required' => array('[DATETIME_LIST]'),
+					),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * See definition of this class in parent
+	 */
+	protected function _set_default_message_types()
+	{
+		$this->_default_message_types = array(
+			'payment',
+			'payment_refund',
+			'registration',
+			'not_approved_registration',
+			'pending_approval',
+		);
+	}
+
+
+	/**
+	 * @see   definition of this class in parent
+	 * @since 4.5.0
+	 */
+	protected function _set_valid_message_types()
+	{
+		$this->_valid_message_types = array(
+			'payment',
+			'registration',
+			'not_approved_registration',
+			'declined_registration',
+			'cancelled_registration',
+			'pending_approval',
+			'registration_summary',
+			'payment_reminder',
+			'payment_declined',
+			'payment_refund',
+		);
+	}
+
+
+	/**
+	 * setting up admin_settings_fields for messenger.
+	 */
+	protected function _set_admin_settings_fields()
+	{
+	}
+
+	/**
+	 * We just deliver the messages don't kill us!!
+	 *
+	 * @return bool|WP_Error true if message delivered, false if it didn't deliver OR bubble up any error object if
+	 *              present.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _send_message()
+	{
+		$success = wp_mail(
+			$this->_to,
+			//some old values for subject may be expecting HTML entities to be decoded in the subject
+			//and subjects aren't interpreted as HTML, so there should be no HTML in them
+			wp_strip_all_tags(wp_specialchars_decode($this->_subject, ENT_QUOTES)),
+			$this->_body(),
+			$this->_headers()
+		);
+		if (! $success) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The email did not send successfully.%3$sThe WordPress wp_mail function is used for sending mails but does not give any useful information when an email fails to send.%3$sIt is possible the "to" address (%1$s) or "from" address (%2$s) is invalid.%3$s',
+						'event_espresso'
+					),
+					$this->_to,
+					$this->_from,
+					'<br />'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * see parent for definition
+	 *
+	 * @return string html body of the message content and the related css.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _preview()
+	{
+		return $this->_body(true);
+	}
+
+
+	/**
+	 * Setup headers for email
+	 *
+	 * @access protected
+	 * @return string formatted header for email
+	 */
+	protected function _headers()
+	{
+		$this->_ensure_has_from_email_address();
+		$from    = $this->_from;
+		$headers = array(
+			'From:' . $from,
+			'Reply-To:' . $from,
+			'Content-Type:text/html; charset=utf-8',
+		);
+
+		/**
+		 * Second condition added as a result of https://events.codebasehq.com/projects/event-espresso/tickets/11416 to
+		 * cover back compat where there may be users who have saved cc values in their db for the newsletter message
+		 * type which they are no longer able to change.
+		 */
+		if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+			$headers[] = 'cc: ' . $this->_cc;
+		}
+
+		//but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
+		// header.
+		add_filter('wp_mail_from', array($this, 'set_from_address'), 100);
+		add_filter('wp_mail_from_name', array($this, 'set_from_name'), 100);
+		return apply_filters('FHEE__EE_Email_messenger___headers', $headers, $this->_incoming_message_type, $this);
+	}
+
+
+	/**
+	 * This simply ensures that the from address is not empty.  If it is, then we use whatever is set as the site email
+	 * address for the from address to avoid problems with sending emails.
+	 */
+	protected function _ensure_has_from_email_address()
+	{
+		if (empty($this->_from)) {
+			$this->_from = get_bloginfo('admin_email');
+		}
+	}
+
+
+	/**
+	 * This simply parses whatever is set as the $_from address and determines if it is in the format {name} <{email}>
+	 * or just {email} and returns an array with the "from_name" and "from_email" as the values. Note from_name *MAY*
+	 * be empty
+	 *
+	 * @since 4.3.1
+	 * @return array
+	 */
+	private function _parse_from()
+	{
+		if (strpos($this->_from, '<') !== false) {
+			$from_name = substr($this->_from, 0, strpos($this->_from, '<') - 1);
+			$from_name = str_replace('"', '', $from_name);
+			$from_name = trim($from_name);
+
+			$from_email = substr($this->_from, strpos($this->_from, '<') + 1);
+			$from_email = str_replace('>', '', $from_email);
+			$from_email = trim($from_email);
+		} elseif (trim($this->_from) !== '') {
+			$from_name  = '';
+			$from_email = trim($this->_from);
+		} else {
+			$from_name = $from_email = '';
+		}
+		return array($from_name, $from_email);
+	}
+
+
+	/**
+	 * Callback for the wp_mail_from filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_email What the original from_email is.
+	 * @return string
+	 */
+	public function set_from_address($from_email)
+	{
+		$parsed_from = $this->_parse_from();
+		//includes fallback if the parsing failed.
+		$from_email = is_array($parsed_from) && ! empty($parsed_from[1])
+			? $parsed_from[1]
+			: get_bloginfo('admin_email');
+		return $from_email;
+	}
+
+
+	/**
+	 * Callback fro the wp_mail_from_name filter.
+	 *
+	 * @since 4.3.1
+	 * @param string $from_name The original from_name.
+	 * @return string
+	 */
+	public function set_from_name($from_name)
+	{
+		$parsed_from = $this->_parse_from();
+		if (is_array($parsed_from) && ! empty($parsed_from[0])) {
+			$from_name = $parsed_from[0];
+		}
+
+		//if from name is "WordPress" let's sub in the site name instead (more friendly!)
+		//but realize the default name is HTML entity-encoded
+		$from_name = $from_name == 'WordPress' ? wp_specialchars_decode(get_bloginfo(), ENT_QUOTES) : $from_name;
+
+		return $from_name;
+	}
+
+
+	/**
+	 * setup body for email
+	 *
+	 * @param bool $preview will determine whether this is preview template or not.
+	 * @return string formatted body for email.
+	 * @throws EE_Error
+	 * @throws \TijsVerkoyen\CssToInlineStyles\Exception
+	 */
+	protected function _body($preview = false)
+	{
+		//setup template args!
+		$this->_template_args = array(
+			'subject'   => $this->_subject,
+			'from'      => $this->_from,
+			'main_body' => wpautop($this->_content),
+		);
+		$body                 = $this->_get_main_template($preview);
+
+		/**
+		 * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
+		 *
+		 * @type    bool $preview Indicates whether a preview is being generated or not.
+		 * @return  bool    true  indicates to use the inliner, false bypasses it.
+		 */
+		if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
+			//require CssToInlineStyles library and its dependencies via composer autoloader
+			require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+
+			//now if this isn't a preview, let's setup the body so it has inline styles
+			if (! $preview || ($preview && defined('DOING_AJAX'))) {
+				$style = file_get_contents(
+					$this->get_variation(
+						$this->_tmp_pack,
+						$this->_incoming_message_type->name,
+						false,
+						'main',
+						$this->_variation
+					),
+					true
+				);
+				$CSS   = new TijsVerkoyen\CssToInlineStyles\CssToInlineStyles($body, $style);
+				//for some reason the library has a bracket and new line at the beginning.  This takes care of that.
+				$body  = ltrim($CSS->convert(true), ">\n");
+				//see https://events.codebasehq.com/projects/event-espresso/tickets/8609
+				$body  = ltrim($body, "<?");
+			}
+
+		}
+		return $body;
+	}
+
+
+	/**
+	 * This just returns any existing test settings that might be saved in the database
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_existing_test_settings()
+	{
+		$settings = parent::get_existing_test_settings();
+		//override subject if present because we always want it to be fresh.
+		if (is_array($settings) && ! empty($settings['subject'])) {
+			$settings['subject'] = sprintf(__('Test email sent from %s', 'event_espresso'), get_bloginfo('name'));
+		}
+		return $settings;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -58,7 +58,7 @@ 
             ),
             '<code>wp_mail</code>'
         );
-        $this->label               = array(
+        $this->label = array(
             'singular' => esc_html__('email', 'event_espresso'),
             'plural'   => esc_html__('emails', 'event_espresso'),
         );
@@ -440,7 +440,7 @@ 
             $this->_body(),
             $this->_headers()
         );
-        if (! $success) {
+        if ( ! $success) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -484,8 +484,8 @@ 
         $this->_ensure_has_from_email_address();
         $from    = $this->_from;
         $headers = array(
-            'From:' . $from,
-            'Reply-To:' . $from,
+            'From:'.$from,
+            'Reply-To:'.$from,
             'Content-Type:text/html; charset=utf-8',
         );
 
@@ -494,8 +494,8 @@ 
          * cover back compat where there may be users who have saved cc values in their db for the newsletter message
          * type which they are no longer able to change.
          */
-        if (! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
-            $headers[] = 'cc: ' . $this->_cc;
+        if ( ! empty($this->_cc) && ! $this->_incoming_message_type instanceof EE_Newsletter_message_type) {
+            $headers[] = 'cc: '.$this->_cc;
         }
 
         //but wait!  Header's for the from is NOT reliable because some plugins don't respect From: as set in the
@@ -602,7 +602,7 @@ 
             'from'      => $this->_from,
             'main_body' => wpautop($this->_content),
         );
-        $body                 = $this->_get_main_template($preview);
+        $body = $this->_get_main_template($preview);
 
         /**
          * This filter allows one to bypass the CSSToInlineStyles tool and leave the body untouched.
@@ -612,10 +612,10 @@ 
          */
         if (apply_filters('FHEE__EE_Email_messenger__apply_CSSInliner ', true, $preview)) {
             //require CssToInlineStyles library and its dependencies via composer autoloader
-            require_once EE_THIRD_PARTY . 'cssinliner/vendor/autoload.php';
+            require_once EE_THIRD_PARTY.'cssinliner/vendor/autoload.php';
 
             //now if this isn't a preview, let's setup the body so it has inline styles
-            if (! $preview || ($preview && defined('DOING_AJAX'))) {
+            if ( ! $preview || ($preview && defined('DOING_AJAX'))) {
                 $style = file_get_contents(
                     $this->get_variation(
                         $this->_tmp_pack,