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/services/Benchmark.php

Indentation +328 added lines, -328 removed lines

@@ -20,334 +20,334 @@
 class Benchmark
 {
 
-    /**
-     * @var string $output
-     */
-    private static $output;
-
-    /**
-     * @var array $start_times array containing the start time for the timers
-     */
-    private static $start_times;
-
-    /**
-     * @var array $times array containing all the timer'd times, which can be outputted via show_times()
-     */
-    private static $times = array();
-
-    /**
-     * @var array $memory_usage
-     */
-    protected static $memory_usage = array();
-
-
-    /**
-     * @param string $output
-     * @param bool   $formatted
-     */
-    public static function addOutput($output, $formatted = true)
-    {
-        Benchmark::$output .= $formatted
-            ? "<br />{$output}"
-            : "\n{$output}";
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function resetOutput()
-    {
-        Benchmark::$output = '';
-    }
-
-    /**
-     * whether to benchmark code or not
-     */
-    public static function doNotRun()
-    {
-        return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX);
-    }
-
-
-
-    /**
-     * resetTimes
-     */
-    public static function resetTimes()
-    {
-        Benchmark::$times = array();
-    }
-
-
-
-    /**
-     * Add Benchmark::startTimer() before a block of code you want to measure the performance of
-     *
-     * @param null $timer_name
-     */
-    public static function startTimer($timer_name = null)
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        Benchmark::$start_times[$timer_name] = microtime(true);
-    }
-
-
-
-    /**
-     * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
-     *
-     * @param string $timer_name
-     */
-    public static function stopTimer($timer_name = '')
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $timer_name = $timer_name !== '' ? $timer_name : get_called_class();
-        if (isset(Benchmark::$start_times[$timer_name])) {
-            $start_time = Benchmark::$start_times[$timer_name];
-            unset(Benchmark::$start_times[$timer_name]);
-        } else {
-            $start_time = array_pop(Benchmark::$start_times);
-        }
-        Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8);
-    }
-
-
-
-    /**
-     * Measure the memory usage by PHP so far.
-     *
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @param bool    $formatted
-     * @return void
-     */
-    public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true)
-    {
-        if (Benchmark::doNotRun()) {
-            return;
-        }
-        $memory_used = Benchmark::convert(memory_get_usage(true));
-        Benchmark::$memory_usage[$label] = $memory_used;
-        if ($output_now) {
-            echo $formatted
-                ? "<br>{$label} : {$memory_used}"
-                : "\n {$label} : {$memory_used}";
-        }
-    }
-
-
-
-    /**
-     * will display the benchmarking results at shutdown
-     *
-     * @param bool $formatted
-     * @return void
-     */
-    public static function displayResultsAtShutdown($formatted = true)
-    {
-        Benchmark::resetOutput();
-        add_action(
-            'shutdown',
-            function () use ($formatted) {
-                Benchmark::displayResults(true, $formatted);
-            }
-        );
-    }
-
-
-
-    /**
-     * will display the benchmarking results at shutdown
-     *
-     * @param string $filepath
-     * @param bool   $formatted
-     * @param bool   $append
-     * @return void
-     */
-    public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true)
-    {
-        Benchmark::resetOutput();
-        add_action(
-            'shutdown',
-            function () use ($filepath, $formatted, $append) {
-                Benchmark::writeResultsToFile($filepath, $formatted, $append);
-            }
-        );
-    }
-
-
-
-    /**
-     * @param bool $formatted
-     * @return string
-     */
-    private static function generateResults($formatted = true)
-    {
-        if (Benchmark::doNotRun()) {
-            return '';
-        }
-        if (! empty(Benchmark::$times)) {
-            $total = 0;
-            Benchmark::$output .= $formatted
-                ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
-                : '';
-            foreach (Benchmark::$times as $timer_name => $total_time) {
-                Benchmark::$output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
-                Benchmark::$output .= $formatted ? '<br />'  : "\n";
-                $total += $total_time;
-            }
-            if($formatted) {
-                Benchmark::$output .= '<br />';
-                Benchmark::$output .= '<h4>TOTAL TIME</h4>';
-                Benchmark::$output .= Benchmark::formatTime('', $total, $formatted);
-                Benchmark::$output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
-                Benchmark::$output .= '<br />';
-                Benchmark::$output .= '<h5>Performance scale (from best to worse)</h5>';
-                Benchmark::$output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
-                Benchmark::$output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
-                Benchmark::$output .= '<span style="color:limegreen">Like...groovy!</span><br />';
-                Benchmark::$output .= '<span style="color:gold">Ruh Oh</span><br />';
-                Benchmark::$output .= '<span style="color:darkorange">Zoinks!</span><br />';
-                Benchmark::$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
-            }
-        }
-        if (! empty(Benchmark::$memory_usage)) {
-            Benchmark::$output .= $formatted
-                ? '<h5>Memory</h5>'
-                : "\nMemory";
-            foreach (Benchmark::$memory_usage as $label => $memory_usage) {
-                Benchmark::$output .= $formatted
-                    ? "<br />{$memory_usage} : {$label}"
-                    : "\n{$memory_usage} : {$label}";
-            }
-        }
-        if (empty(Benchmark::$output)) {
-            return '';
-        }
-        Benchmark::$output = $formatted
-            ? '<div style="border:1px solid #dddddd; background-color:#ffffff;'
-              . (is_admin()
-                ? ' margin:2em 2em 2em 180px;'
-                : ' margin:2em;')
-              . ' padding:2em;">'
-              . '<h4>BENCHMARKING</h4>'
-              . Benchmark::$output
-              . '</div>'
-            : Benchmark::$output;
-        return Benchmark::$output;
-    }
-
-
-
-    /**
-     * @param bool $echo
-     * @param bool $formatted
-     * @return string
-     */
-    public static function displayResults($echo = true, $formatted = true)
-    {
-        $results = Benchmark::generateResults($formatted);
-        if ($echo) {
-            echo $results;
-            $results = '';
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param string $filepath
-     * @param bool   $formatted
-     * @param bool   $append
-     * @throws EE_Error
-     */
-    public static function writeResultsToFile($filepath = '', $formatted = true, $append = true)
-    {
-        $filepath = ! empty($filepath) && is_readable(dirname($filepath))
-            ? $filepath
-            : '';
-        if( empty($filepath)) {
-            $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
-        }
-        EEH_File::ensure_file_exists_and_is_writable($filepath);
-        file_put_contents(
-            $filepath,
-            "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
-            $append ? FILE_APPEND | LOCK_EX : LOCK_EX
-        );
-    }
-
-
-
-    /**
-     * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
-     *
-     * @param int $size
-     * @return string
-     */
-    public static function convert($size)
-    {
-        $unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
-        return round(
-            $size / pow(1024, $i = floor(log($size, 1024))),
-            2
-        ) . ' ' . $unit[absint($i)];
-    }
-
-
-
-    /**
-     * @param string $timer_name
-     * @param float  $total_time
-     * @param bool   $formatted
-     * @return string
-     */
-    public static function formatTime($timer_name, $total_time, $formatted = true)
-    {
-        $total_time *= 1000;
-        switch ($total_time) {
-            case $total_time > 12500 :
-                $color = 'red';
-                $bold = 'bold';
-                break;
-            case $total_time > 2500 :
-                $color = 'darkorange';
-                $bold = 'bold';
-                break;
-            case $total_time > 500 :
-                $color = 'gold';
-                $bold = 'bold';
-                break;
-            case $total_time > 100 :
-                $color = 'limegreen';
-                $bold = 'normal';
-                break;
-            case $total_time > 20 :
-                $color = 'deepskyblue';
-                $bold = 'normal';
-                break;
-            default :
-                $color = 'mediumpurple';
-                $bold = 'normal';
-                break;
-        }
-        return $formatted
-            ? '<span style="min-width: 10px; margin:0 1em; color:'
-               . $color
-               . '; font-weight:'
-               . $bold
-               . '; font-size:1.2em;">'
-               . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
-               . '</span> '
-               . $timer_name
-            :  str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT);
-    }
+	/**
+	 * @var string $output
+	 */
+	private static $output;
+
+	/**
+	 * @var array $start_times array containing the start time for the timers
+	 */
+	private static $start_times;
+
+	/**
+	 * @var array $times array containing all the timer'd times, which can be outputted via show_times()
+	 */
+	private static $times = array();
+
+	/**
+	 * @var array $memory_usage
+	 */
+	protected static $memory_usage = array();
+
+
+	/**
+	 * @param string $output
+	 * @param bool   $formatted
+	 */
+	public static function addOutput($output, $formatted = true)
+	{
+		Benchmark::$output .= $formatted
+			? "<br />{$output}"
+			: "\n{$output}";
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function resetOutput()
+	{
+		Benchmark::$output = '';
+	}
+
+	/**
+	 * whether to benchmark code or not
+	 */
+	public static function doNotRun()
+	{
+		return ! WP_DEBUG || (defined('DOING_AJAX') && DOING_AJAX);
+	}
+
+
+
+	/**
+	 * resetTimes
+	 */
+	public static function resetTimes()
+	{
+		Benchmark::$times = array();
+	}
+
+
+
+	/**
+	 * Add Benchmark::startTimer() before a block of code you want to measure the performance of
+	 *
+	 * @param null $timer_name
+	 */
+	public static function startTimer($timer_name = null)
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
+		Benchmark::$start_times[$timer_name] = microtime(true);
+	}
+
+
+
+	/**
+	 * Add Benchmark::stopTimer() after a block of code you want to measure the performance of
+	 *
+	 * @param string $timer_name
+	 */
+	public static function stopTimer($timer_name = '')
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$timer_name = $timer_name !== '' ? $timer_name : get_called_class();
+		if (isset(Benchmark::$start_times[$timer_name])) {
+			$start_time = Benchmark::$start_times[$timer_name];
+			unset(Benchmark::$start_times[$timer_name]);
+		} else {
+			$start_time = array_pop(Benchmark::$start_times);
+		}
+		Benchmark::$times[$timer_name] = number_format(microtime(true) - $start_time, 8);
+	}
+
+
+
+	/**
+	 * Measure the memory usage by PHP so far.
+	 *
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @param bool    $formatted
+	 * @return void
+	 */
+	public static function measureMemory($label = 'memory usage', $output_now = false, $formatted = true)
+	{
+		if (Benchmark::doNotRun()) {
+			return;
+		}
+		$memory_used = Benchmark::convert(memory_get_usage(true));
+		Benchmark::$memory_usage[$label] = $memory_used;
+		if ($output_now) {
+			echo $formatted
+				? "<br>{$label} : {$memory_used}"
+				: "\n {$label} : {$memory_used}";
+		}
+	}
+
+
+
+	/**
+	 * will display the benchmarking results at shutdown
+	 *
+	 * @param bool $formatted
+	 * @return void
+	 */
+	public static function displayResultsAtShutdown($formatted = true)
+	{
+		Benchmark::resetOutput();
+		add_action(
+			'shutdown',
+			function () use ($formatted) {
+				Benchmark::displayResults(true, $formatted);
+			}
+		);
+	}
+
+
+
+	/**
+	 * will display the benchmarking results at shutdown
+	 *
+	 * @param string $filepath
+	 * @param bool   $formatted
+	 * @param bool   $append
+	 * @return void
+	 */
+	public static function writeResultsAtShutdown($filepath = '', $formatted = true, $append = true)
+	{
+		Benchmark::resetOutput();
+		add_action(
+			'shutdown',
+			function () use ($filepath, $formatted, $append) {
+				Benchmark::writeResultsToFile($filepath, $formatted, $append);
+			}
+		);
+	}
+
+
+
+	/**
+	 * @param bool $formatted
+	 * @return string
+	 */
+	private static function generateResults($formatted = true)
+	{
+		if (Benchmark::doNotRun()) {
+			return '';
+		}
+		if (! empty(Benchmark::$times)) {
+			$total = 0;
+			Benchmark::$output .= $formatted
+				? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
+				: '';
+			foreach (Benchmark::$times as $timer_name => $total_time) {
+				Benchmark::$output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
+				Benchmark::$output .= $formatted ? '<br />'  : "\n";
+				$total += $total_time;
+			}
+			if($formatted) {
+				Benchmark::$output .= '<br />';
+				Benchmark::$output .= '<h4>TOTAL TIME</h4>';
+				Benchmark::$output .= Benchmark::formatTime('', $total, $formatted);
+				Benchmark::$output .= '<span style="color:#999999; font-size:.8em;"> milliseconds</span><br />';
+				Benchmark::$output .= '<br />';
+				Benchmark::$output .= '<h5>Performance scale (from best to worse)</h5>';
+				Benchmark::$output .= '<span style="color:mediumpurple">Like wow! How about a Scooby snack?</span><br />';
+				Benchmark::$output .= '<span style="color:deepskyblue">Like...no way man!</span><br />';
+				Benchmark::$output .= '<span style="color:limegreen">Like...groovy!</span><br />';
+				Benchmark::$output .= '<span style="color:gold">Ruh Oh</span><br />';
+				Benchmark::$output .= '<span style="color:darkorange">Zoinks!</span><br />';
+				Benchmark::$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
+			}
+		}
+		if (! empty(Benchmark::$memory_usage)) {
+			Benchmark::$output .= $formatted
+				? '<h5>Memory</h5>'
+				: "\nMemory";
+			foreach (Benchmark::$memory_usage as $label => $memory_usage) {
+				Benchmark::$output .= $formatted
+					? "<br />{$memory_usage} : {$label}"
+					: "\n{$memory_usage} : {$label}";
+			}
+		}
+		if (empty(Benchmark::$output)) {
+			return '';
+		}
+		Benchmark::$output = $formatted
+			? '<div style="border:1px solid #dddddd; background-color:#ffffff;'
+			  . (is_admin()
+				? ' margin:2em 2em 2em 180px;'
+				: ' margin:2em;')
+			  . ' padding:2em;">'
+			  . '<h4>BENCHMARKING</h4>'
+			  . Benchmark::$output
+			  . '</div>'
+			: Benchmark::$output;
+		return Benchmark::$output;
+	}
+
+
+
+	/**
+	 * @param bool $echo
+	 * @param bool $formatted
+	 * @return string
+	 */
+	public static function displayResults($echo = true, $formatted = true)
+	{
+		$results = Benchmark::generateResults($formatted);
+		if ($echo) {
+			echo $results;
+			$results = '';
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param string $filepath
+	 * @param bool   $formatted
+	 * @param bool   $append
+	 * @throws EE_Error
+	 */
+	public static function writeResultsToFile($filepath = '', $formatted = true, $append = true)
+	{
+		$filepath = ! empty($filepath) && is_readable(dirname($filepath))
+			? $filepath
+			: '';
+		if( empty($filepath)) {
+			$filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
+		}
+		EEH_File::ensure_file_exists_and_is_writable($filepath);
+		file_put_contents(
+			$filepath,
+			"\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
+			$append ? FILE_APPEND | LOCK_EX : LOCK_EX
+		);
+	}
+
+
+
+	/**
+	 * Converts a measure of memory bytes into the most logical units (eg kb, mb, etc)
+	 *
+	 * @param int $size
+	 * @return string
+	 */
+	public static function convert($size)
+	{
+		$unit = array('b', 'kb', 'mb', 'gb', 'tb', 'pb');
+		return round(
+			$size / pow(1024, $i = floor(log($size, 1024))),
+			2
+		) . ' ' . $unit[absint($i)];
+	}
+
+
+
+	/**
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @param bool   $formatted
+	 * @return string
+	 */
+	public static function formatTime($timer_name, $total_time, $formatted = true)
+	{
+		$total_time *= 1000;
+		switch ($total_time) {
+			case $total_time > 12500 :
+				$color = 'red';
+				$bold = 'bold';
+				break;
+			case $total_time > 2500 :
+				$color = 'darkorange';
+				$bold = 'bold';
+				break;
+			case $total_time > 500 :
+				$color = 'gold';
+				$bold = 'bold';
+				break;
+			case $total_time > 100 :
+				$color = 'limegreen';
+				$bold = 'normal';
+				break;
+			case $total_time > 20 :
+				$color = 'deepskyblue';
+				$bold = 'normal';
+				break;
+			default :
+				$color = 'mediumpurple';
+				$bold = 'normal';
+				break;
+		}
+		return $formatted
+			? '<span style="min-width: 10px; margin:0 1em; color:'
+			   . $color
+			   . '; font-weight:'
+			   . $bold
+			   . '; font-size:1.2em;">'
+			   . str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT)
+			   . '</span> '
+			   . $timer_name
+			:  str_pad(number_format($total_time, 3), 9, '0', STR_PAD_LEFT);
+	}
 
 
 

Spacing +10 added lines, -10 removed lines

@@ -154,7 +154,7 @@ 
         Benchmark::resetOutput();
         add_action(
             'shutdown',
-            function () use ($formatted) {
+            function() use ($formatted) {
                 Benchmark::displayResults(true, $formatted);
             }
         );
@@ -175,7 +175,7 @@ 
         Benchmark::resetOutput();
         add_action(
             'shutdown',
-            function () use ($filepath, $formatted, $append) {
+            function() use ($filepath, $formatted, $append) {
                 Benchmark::writeResultsToFile($filepath, $formatted, $append);
             }
         );
@@ -192,17 +192,17 @@ 
         if (Benchmark::doNotRun()) {
             return '';
         }
-        if (! empty(Benchmark::$times)) {
+        if ( ! empty(Benchmark::$times)) {
             $total = 0;
             Benchmark::$output .= $formatted
                 ? '<span style="color:#999999; font-size:.8em;">( time in milliseconds )</span><br />'
                 : '';
             foreach (Benchmark::$times as $timer_name => $total_time) {
                 Benchmark::$output .= Benchmark::formatTime($timer_name, $total_time, $formatted);
-                Benchmark::$output .= $formatted ? '<br />'  : "\n";
+                Benchmark::$output .= $formatted ? '<br />' : "\n";
                 $total += $total_time;
             }
-            if($formatted) {
+            if ($formatted) {
                 Benchmark::$output .= '<br />';
                 Benchmark::$output .= '<h4>TOTAL TIME</h4>';
                 Benchmark::$output .= Benchmark::formatTime('', $total, $formatted);
@@ -217,7 +217,7 @@ 
                 Benchmark::$output .= '<span style="color:red">Like...HEEELLLP</span><br />';
             }
         }
-        if (! empty(Benchmark::$memory_usage)) {
+        if ( ! empty(Benchmark::$memory_usage)) {
             Benchmark::$output .= $formatted
                 ? '<h5>Memory</h5>'
                 : "\nMemory";
@@ -272,13 +272,13 @@ 
         $filepath = ! empty($filepath) && is_readable(dirname($filepath))
             ? $filepath
             : '';
-        if( empty($filepath)) {
-            $filepath = EVENT_ESPRESSO_UPLOAD_DIR . 'logs/benchmarking-' . date('Y-m-d') . '.html';
+        if (empty($filepath)) {
+            $filepath = EVENT_ESPRESSO_UPLOAD_DIR.'logs/benchmarking-'.date('Y-m-d').'.html';
         }
         EEH_File::ensure_file_exists_and_is_writable($filepath);
         file_put_contents(
             $filepath,
-            "\n" . date('Y-m-d H:i:s') . Benchmark::generateResults($formatted),
+            "\n".date('Y-m-d H:i:s').Benchmark::generateResults($formatted),
             $append ? FILE_APPEND | LOCK_EX : LOCK_EX
         );
     }
@@ -297,7 +297,7 @@ 
         return round(
             $size / pow(1024, $i = floor(log($size, 1024))),
             2
-        ) . ' ' . $unit[absint($i)];
+        ).' '.$unit[absint($i)];
     }
 
 

core/EE_Encryption.core.php

Indentation +686 added lines, -686 removed lines

@@ -19,692 +19,692 @@
 class EE_Encryption implements InterminableInterface
 {
 
-    /**
-     * key used for saving the encryption key to the wp_options table
-     */
-    const ENCRYPTION_OPTION_KEY = 'ee_encryption_key';
-
-    /**
-     * the OPENSSL cipher method used
-     */
-    const OPENSSL_CIPHER_METHOD = 'AES-128-CBC';
-
-    /**
-     * WP "options_name" used to store a verified available cipher method
-     */
-    const OPENSSL_CIPHER_METHOD_OPTION_NAME = 'ee_openssl_cipher_method';
-
-    /**
-     * the OPENSSL digest method used
-     */
-    const OPENSSL_DIGEST_METHOD = 'sha512';
-
-    /**
-     * separates the encrypted text from the initialization vector
-     */
-    const OPENSSL_IV_DELIMITER = ':iv:';
-
-    /**
-     * appended to text encrypted using the acme encryption
-     */
-    const ACME_ENCRYPTION_FLAG = '::ae';
-
-
-
-    /**
-     * instance of the EE_Encryption object
-     */
-    protected static $_instance;
-
-    /**
-     * @var string $_encryption_key
-     */
-    protected $_encryption_key;
-
-    /**
-     * @var string $cipher_method
-     */
-    private $cipher_method = '';
-
-    /**
-     * @var array $cipher_methods
-     */
-    private $cipher_methods = array();
-
-    /**
-     * @var array $digest_methods
-     */
-    private $digest_methods = array();
-
-    /**
-     * @var boolean $_use_openssl_encrypt
-     */
-    protected $_use_openssl_encrypt = false;
-
-    /**
-     * @var boolean $_use_mcrypt
-     */
-    protected $_use_mcrypt = false;
-
-    /**
-     * @var boolean $_use_base64_encode
-     */
-    protected $_use_base64_encode = false;
-
-
-
-    /**
-     * protected constructor to prevent direct creation
-     */
-    protected function __construct()
-    {
-        if (! defined('ESPRESSO_ENCRYPT')) {
-            define('ESPRESSO_ENCRYPT', true);
-        }
-        if (extension_loaded('openssl')) {
-            $this->_use_openssl_encrypt = true;
-        } else if (extension_loaded('mcrypt')) {
-            $this->_use_mcrypt = true;
-        }
-        if (function_exists('base64_encode')) {
-            $this->_use_base64_encode = true;
-        }
-    }
-
-
-
-    /**
-     * singleton method used to instantiate class object
-     *
-     * @return EE_Encryption
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! EE_Encryption::$_instance instanceof EE_Encryption) {
-            EE_Encryption::$_instance = new self();
-        }
-        return EE_Encryption::$_instance;
-    }
-
-
-
-    /**
-     * get encryption key
-     *
-     * @return string
-     */
-    public function get_encryption_key()
-    {
-        // if encryption key has not been set
-        if (empty($this->_encryption_key)) {
-            // retrieve encryption_key from db
-            $this->_encryption_key = get_option(EE_Encryption::ENCRYPTION_OPTION_KEY, '');
-            // WHAT?? No encryption_key in the db ??
-            if ($this->_encryption_key === '') {
-                // let's make one. And md5 it to make it just the right size for a key
-                $new_key = md5($this->generate_random_string());
-                // now save it to the db for later
-                add_option(EE_Encryption::ENCRYPTION_OPTION_KEY, $new_key);
-                // here's the key - FINALLY !
-                $this->_encryption_key = $new_key;
-            }
-        }
-        return $this->_encryption_key;
-    }
-
-
-
-    /**
-     * encrypts data
-     *
-     * @param string $text_string - the text to be encrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    public function encrypt($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        if ($this->_use_openssl_encrypt) {
-            $encrypted_text = $this->openssl_encrypt($text_string);
-        } else {
-            $encrypted_text = $this->acme_encrypt($text_string);
-        }
-        return $encrypted_text;
-    }
-
-
-
-    /**
-     * decrypts data
-     *
-     * @param string $encrypted_text - the text to be decrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    public function decrypt($encrypted_text = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // if PHP's mcrypt functions are installed then we'll use them
-        if ($this->_use_openssl_encrypt) {
-            $decrypted_text = $this->openssl_decrypt($encrypted_text);
-        } else {
-            $decrypted_text = $this->acme_decrypt($encrypted_text);
-        }
-        return $decrypted_text;
-    }
-
-
-
-    /**
-     * encodes string with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $text_string the text to be encoded
-     * @return string
-     */
-    public function base64_string_encode($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string) || ! $this->_use_base64_encode) {
-            return $text_string;
-        }
-        // encode
-        return base64_encode($text_string);
-    }
-
-
-    /**
-     * decodes string that has been encoded with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $encoded_string the text to be decoded
-     * @return string
-     * @throws RuntimeException
-     */
-    public function base64_string_decode($encoded_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
-            return $encoded_string;
-        }
-        // decode
-        $decoded_string = base64_decode($encoded_string);
-        if ($decoded_string === false) {
-            throw new RuntimeException(
-                esc_html__('Base 64 decoding failed.', 'event_espresso')
-            );
-        }
-        return $decoded_string;
-    }
-
-
-
-    /**
-     * encodes  url string with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $text_string the text to be encoded
-     * @return string
-     */
-    public function base64_url_encode($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string) || ! $this->_use_base64_encode) {
-            return $text_string;
-        }
-        // encode
-        $encoded_string = base64_encode($text_string);
-        // remove chars to make encoding more URL friendly
-        return strtr($encoded_string, '+/=', '-_,');
-    }
-
-
-    /**
-     * decodes  url string that has been encoded with PHP's base64 encoding
-     *
-     * @see http://php.net/manual/en/function.base64-encode.php
-     * @param string $encoded_string the text to be decoded
-     * @return string
-     * @throws RuntimeException
-     */
-    public function base64_url_decode($encoded_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
-            return $encoded_string;
-        }
-        // replace previously removed characters
-        $encoded_string = strtr($encoded_string, '-_,', '+/=');
-        // decode
-        $decoded_string = base64_decode($encoded_string);
-        if ($decoded_string === false) {
-            throw new RuntimeException(
-                esc_html__('Base 64 decoding failed.', 'event_espresso')
-            );
-        }
-        return $decoded_string;
-    }
-
-
-    /**
-     * encrypts data using PHP's openssl functions
-     *
-     * @param string $text_string the text to be encrypted
-     * @param string $cipher_method
-     * @param string $encryption_key
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function openssl_encrypt(
-        $text_string = '',
-        $cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
-        $encryption_key = ''
-    ) {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        $this->cipher_method = $this->getCipherMethod($cipher_method);
-        // get initialization vector size
-        $iv_size = openssl_cipher_iv_length($this->cipher_method);
-        // generate initialization vector.
-        // The second parameter ("crypto_strong") is passed by reference,
-        // and is used to determines if the algorithm used was "cryptographically strong"
-        // openssl_random_pseudo_bytes() will toggle it to either true or false
-        $iv = openssl_random_pseudo_bytes($iv_size, $is_strong);
-        if ($iv === false || $is_strong === false) {
-            throw new RuntimeException(
-                esc_html__('Failed to generate OpenSSL initialization vector.', 'event_espresso')
-            );
-        }
-        // encrypt it
-        $encrypted_text = openssl_encrypt(
-            $text_string,
-            $this->cipher_method,
-            $this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
-            0,
-            $iv
-        );
-        // append the initialization vector
-        $encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER . $iv;
-        // trim and maybe encode
-        return $this->_use_base64_encode
-            ? trim(base64_encode($encrypted_text))
-            : trim($encrypted_text);
-    }
-
-
-
-    /**
-     * Returns a cipher method that has been verified to work.
-     * First checks if the cached cipher has been set already and if so, returns that.
-     * Then tests the incoming default and returns that if it's good.
-     * If not, then it retrieves the previously tested and saved cipher method.
-     * But if that doesn't exist, then calls getAvailableCipherMethod()
-     * to see what is available on the server, and returns the results.
-     *
-     * @param string $cipher_method
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function getCipherMethod($cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD)
-    {
-        if($this->cipher_method !== ''){
-            return $this->cipher_method;
-        }
-        // verify that the default cipher method can produce an initialization vector
-        if (openssl_cipher_iv_length($cipher_method) === false) {
-            // nope? okay let's get what we found in the past to work
-            $cipher_method = get_option(EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME, '');
-            // oops... haven't tested available cipher methods yet
-            if($cipher_method === '' || openssl_cipher_iv_length($cipher_method) === false) {
-                $cipher_method = $this->getAvailableCipherMethod($cipher_method);
-            }
-        }
-        return $cipher_method;
-    }
-
-
-
-    /**
-     * @param string $cipher_method
-     * @return string
-     * @throws \RuntimeException
-     */
-    protected function getAvailableCipherMethod($cipher_method)
-    {
-        // verify that the incoming cipher method can produce an initialization vector
-        if (openssl_cipher_iv_length($cipher_method) === false) {
-            // nope? then check the next cipher in the list of available cipher methods
-            $cipher_method = next($this->cipher_methods);
-            // what? there's no list? then generate that list and cache it,
-            if (empty($this->cipher_methods)) {
-                $this->cipher_methods = openssl_get_cipher_methods();
-                // then grab the first item from the list
-                $cipher_method = reset($this->cipher_methods);
-            }
-            if($cipher_method === false){
-                throw new RuntimeException(
-                    esc_html__(
-                        'OpenSSL support appears to be enabled on the server, but no cipher methods are available. Please contact the server administrator.',
-                        'event_espresso'
-                    )
-                );
-            }
-            // verify that the next cipher method works
-            return $this->getAvailableCipherMethod($cipher_method);
-        }
-        // if we've gotten this far, then we found an available cipher method that works
-        // so save that for next time
-        update_option(
-            EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME,
-            $cipher_method
-        );
-        return $cipher_method;
-    }
-
-
-    /**
-     * decrypts data that has been encrypted with PHP's openssl functions
-     *
-     * @param string $encrypted_text the text to be decrypted
-     * @param string $cipher_method
-     * @param string $encryption_key
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function openssl_decrypt(
-        $encrypted_text = '',
-        $cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
-        $encryption_key = ''
-    ) {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // decode
-        $encrypted_text = $this->valid_base_64($encrypted_text)
-            ? $this->base64_url_decode($encrypted_text)
-            : $encrypted_text;
-        $encrypted_components = explode(
-            EE_Encryption::OPENSSL_IV_DELIMITER,
-            $encrypted_text,
-            2
-        );
-        // check that iv exists, and if not, maybe text was encoded using mcrypt?
-        if ($this->_use_mcrypt && ! isset($encrypted_components[1])) {
-            return $this->m_decrypt($encrypted_text);
-        }
-        // decrypt it
-        $decrypted_text = openssl_decrypt(
-            $encrypted_components[0],
-            $this->getCipherMethod($cipher_method),
-            $this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD,$encryption_key),
-            0,
-            $encrypted_components[1]
-        );
-        $decrypted_text = trim($decrypted_text);
-        return $decrypted_text;
-    }
-
-
-    /**
-     * Computes the digest hash value using the specified digest method.
-     * If that digest method fails to produce a valid hash value,
-     * then we'll grab the next digest method and recursively try again until something works.
-     *
-     * @param string $digest_method
-     * @param string $encryption_key
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function getDigestHashValue($digest_method = EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key = ''){
-        $encryption_key = $encryption_key !== ''
-            ? $encryption_key
-            : $this->get_encryption_key();
-        $digest_hash_value = openssl_digest($encryption_key, $digest_method);
-        if ($digest_hash_value === false) {
-            return $this->getDigestHashValue($this->getDigestMethod());
-        }
-        return $digest_hash_value;
-    }
-
-
-
-    /**
-     * Returns the NEXT element in the $digest_methods array.
-     * If the $digest_methods array is empty, then we populate it
-     * with the available values returned from openssl_get_md_methods().
-     *
-     * @return string
-     * @throws \RuntimeException
-     */
-    protected function getDigestMethod(){
-        $digest_method = prev($this->digest_methods);
-        if (empty($this->digest_methods)) {
-            $this->digest_methods = openssl_get_md_methods();
-            $digest_method = end($this->digest_methods);
-        }
-        if ($digest_method === false) {
-            throw new RuntimeException(
-                esc_html__(
-                    'OpenSSL support appears to be enabled on the server, but no digest methods are available. Please contact the server administrator.',
-                    'event_espresso'
-                )
-            );
-        }
-        return $digest_method;
-    }
-
-
-    /**
-     * encrypts data for acme servers that didn't bother to install PHP mcrypt
-     *
-     * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
-     * @param string $text_string the text to be decrypted
-     * @return string
-     */
-    protected function acme_encrypt($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        $key_bits = str_split(
-            str_pad(
-                '',
-                strlen($text_string),
-                $this->get_encryption_key(),
-                STR_PAD_RIGHT
-            )
-        );
-        $string_bits = str_split($text_string);
-        foreach ($string_bits as $k => $v) {
-            $temp = ord($v) + ord($key_bits[$k]);
-            $string_bits[$k] = chr($temp > 255 ? ($temp - 256) : $temp);
-        }
-        $encrypted_text = implode('', $string_bits);
-        $encrypted_text .= EE_Encryption::ACME_ENCRYPTION_FLAG;
-        return $this->_use_base64_encode
-            ? base64_encode($encrypted_text)
-            : $encrypted_text;
-    }
-
-
-
-    /**
-     * decrypts data for acme servers that didn't bother to install PHP mcrypt
-     *
-     * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
-     * @param string $encrypted_text the text to be decrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function acme_decrypt($encrypted_text = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // decode the data ?
-        $encrypted_text = $this->valid_base_64($encrypted_text)
-            ? $this->base64_url_decode($encrypted_text)
-            : $encrypted_text;
-        if (
-            $this->_use_mcrypt
-            && strpos($encrypted_text, EE_Encryption::ACME_ENCRYPTION_FLAG) === false
-        ){
-            return $this->m_decrypt($encrypted_text);
-        }
-        $encrypted_text = substr($encrypted_text, 0, -4);
-        $key_bits = str_split(
-            str_pad(
-                '',
-                strlen($encrypted_text),
-                $this->get_encryption_key(),
-                STR_PAD_RIGHT
-            )
-        );
-        $string_bits = str_split($encrypted_text);
-        foreach ($string_bits as $k => $v) {
-            $temp = ord($v) - ord($key_bits[$k]);
-            $string_bits[$k] = chr($temp < 0 ? ($temp + 256) : $temp);
-        }
-        return implode('', $string_bits);
-    }
-
-
-
-    /**
-     * @see http://stackoverflow.com/questions/2556345/detect-base64-encoding-in-php#30231906
-     * @param $string
-     * @return bool
-     */
-    protected function valid_base_64($string)
-    {
-        // ensure data is a string
-        if (! is_string($string) || ! $this->_use_base64_encode) {
-            return false;
-        }
-        $decoded = base64_decode($string, true);
-        // Check if there is no invalid character in string
-        if (! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
-            return false;
-        }
-        // Decode the string in strict mode and send the response
-        if (! base64_decode($string, true)) {
-            return false;
-        }
-        // Encode and compare it to original one
-        return base64_encode($decoded) === $string;
-    }
-
-
-
-    /**
-     * generate random string
-     *
-     * @see http://stackoverflow.com/questions/637278/what-is-the-best-way-to-generate-a-random-key-within-php
-     * @param int $length number of characters for random string
-     * @return string
-     */
-    public function generate_random_string($length = 40)
-    {
-        $iterations = ceil($length / 40);
-        $random_string = '';
-        for ($i = 0; $i < $iterations; $i++) {
-            $random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
-        }
-        $random_string = substr($random_string, 0, $length);
-        return $random_string;
-    }
-
-
-
-    /**
-     * encrypts data using PHP's mcrypt functions
-     *
-     * @deprecated 4.9.39
-     * @param string $text_string
-     * @internal   param $string - the text to be encrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function m_encrypt($text_string = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($text_string)) {
-            return $text_string;
-        }
-        // get the initialization vector size
-        $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
-        // initialization vector
-        $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
-        if ($iv === false) {
-            throw new RuntimeException(
-                esc_html__('Failed to generate mcrypt initialization vector.', 'event_espresso')
-            );
-        }
-        // encrypt it
-        $encrypted_text = mcrypt_encrypt(
-            MCRYPT_RIJNDAEL_256,
-            $this->get_encryption_key(),
-            $text_string,
-            MCRYPT_MODE_ECB,
-            $iv
-        );
-        // trim and maybe encode
-        return $this->_use_base64_encode
-            ? trim(base64_encode($encrypted_text))
-            : trim($encrypted_text);
-    }
-
-
-
-    /**
-     * decrypts data that has been encrypted with PHP's mcrypt functions
-     *
-     * @deprecated 4.9.39
-     * @param string $encrypted_text the text to be decrypted
-     * @return string
-     * @throws RuntimeException
-     */
-    protected function m_decrypt($encrypted_text = '')
-    {
-        // you give me nothing??? GET OUT !
-        if (empty($encrypted_text)) {
-            return $encrypted_text;
-        }
-        // decode
-        $encrypted_text = $this->valid_base_64($encrypted_text)
-            ? $this->base64_url_decode($encrypted_text)
-            : $encrypted_text;
-        // get the initialization vector size
-        $iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
-        $iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
-        if ($iv === false) {
-            throw new RuntimeException(
-                esc_html__('Failed to generate mcrypt initialization vector.', 'event_espresso')
-            );
-        }
-        // decrypt it
-        $decrypted_text = mcrypt_decrypt(
-            MCRYPT_RIJNDAEL_256,
-            $this->get_encryption_key(),
-            $encrypted_text,
-            MCRYPT_MODE_ECB,
-            $iv
-        );
-        $decrypted_text = trim($decrypted_text);
-        return $decrypted_text;
-    }
+	/**
+	 * key used for saving the encryption key to the wp_options table
+	 */
+	const ENCRYPTION_OPTION_KEY = 'ee_encryption_key';
+
+	/**
+	 * the OPENSSL cipher method used
+	 */
+	const OPENSSL_CIPHER_METHOD = 'AES-128-CBC';
+
+	/**
+	 * WP "options_name" used to store a verified available cipher method
+	 */
+	const OPENSSL_CIPHER_METHOD_OPTION_NAME = 'ee_openssl_cipher_method';
+
+	/**
+	 * the OPENSSL digest method used
+	 */
+	const OPENSSL_DIGEST_METHOD = 'sha512';
+
+	/**
+	 * separates the encrypted text from the initialization vector
+	 */
+	const OPENSSL_IV_DELIMITER = ':iv:';
+
+	/**
+	 * appended to text encrypted using the acme encryption
+	 */
+	const ACME_ENCRYPTION_FLAG = '::ae';
+
+
+
+	/**
+	 * instance of the EE_Encryption object
+	 */
+	protected static $_instance;
+
+	/**
+	 * @var string $_encryption_key
+	 */
+	protected $_encryption_key;
+
+	/**
+	 * @var string $cipher_method
+	 */
+	private $cipher_method = '';
+
+	/**
+	 * @var array $cipher_methods
+	 */
+	private $cipher_methods = array();
+
+	/**
+	 * @var array $digest_methods
+	 */
+	private $digest_methods = array();
+
+	/**
+	 * @var boolean $_use_openssl_encrypt
+	 */
+	protected $_use_openssl_encrypt = false;
+
+	/**
+	 * @var boolean $_use_mcrypt
+	 */
+	protected $_use_mcrypt = false;
+
+	/**
+	 * @var boolean $_use_base64_encode
+	 */
+	protected $_use_base64_encode = false;
+
+
+
+	/**
+	 * protected constructor to prevent direct creation
+	 */
+	protected function __construct()
+	{
+		if (! defined('ESPRESSO_ENCRYPT')) {
+			define('ESPRESSO_ENCRYPT', true);
+		}
+		if (extension_loaded('openssl')) {
+			$this->_use_openssl_encrypt = true;
+		} else if (extension_loaded('mcrypt')) {
+			$this->_use_mcrypt = true;
+		}
+		if (function_exists('base64_encode')) {
+			$this->_use_base64_encode = true;
+		}
+	}
+
+
+
+	/**
+	 * singleton method used to instantiate class object
+	 *
+	 * @return EE_Encryption
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! EE_Encryption::$_instance instanceof EE_Encryption) {
+			EE_Encryption::$_instance = new self();
+		}
+		return EE_Encryption::$_instance;
+	}
+
+
+
+	/**
+	 * get encryption key
+	 *
+	 * @return string
+	 */
+	public function get_encryption_key()
+	{
+		// if encryption key has not been set
+		if (empty($this->_encryption_key)) {
+			// retrieve encryption_key from db
+			$this->_encryption_key = get_option(EE_Encryption::ENCRYPTION_OPTION_KEY, '');
+			// WHAT?? No encryption_key in the db ??
+			if ($this->_encryption_key === '') {
+				// let's make one. And md5 it to make it just the right size for a key
+				$new_key = md5($this->generate_random_string());
+				// now save it to the db for later
+				add_option(EE_Encryption::ENCRYPTION_OPTION_KEY, $new_key);
+				// here's the key - FINALLY !
+				$this->_encryption_key = $new_key;
+			}
+		}
+		return $this->_encryption_key;
+	}
+
+
+
+	/**
+	 * encrypts data
+	 *
+	 * @param string $text_string - the text to be encrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function encrypt($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		if ($this->_use_openssl_encrypt) {
+			$encrypted_text = $this->openssl_encrypt($text_string);
+		} else {
+			$encrypted_text = $this->acme_encrypt($text_string);
+		}
+		return $encrypted_text;
+	}
+
+
+
+	/**
+	 * decrypts data
+	 *
+	 * @param string $encrypted_text - the text to be decrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function decrypt($encrypted_text = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// if PHP's mcrypt functions are installed then we'll use them
+		if ($this->_use_openssl_encrypt) {
+			$decrypted_text = $this->openssl_decrypt($encrypted_text);
+		} else {
+			$decrypted_text = $this->acme_decrypt($encrypted_text);
+		}
+		return $decrypted_text;
+	}
+
+
+
+	/**
+	 * encodes string with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $text_string the text to be encoded
+	 * @return string
+	 */
+	public function base64_string_encode($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string) || ! $this->_use_base64_encode) {
+			return $text_string;
+		}
+		// encode
+		return base64_encode($text_string);
+	}
+
+
+	/**
+	 * decodes string that has been encoded with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $encoded_string the text to be decoded
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function base64_string_decode($encoded_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
+			return $encoded_string;
+		}
+		// decode
+		$decoded_string = base64_decode($encoded_string);
+		if ($decoded_string === false) {
+			throw new RuntimeException(
+				esc_html__('Base 64 decoding failed.', 'event_espresso')
+			);
+		}
+		return $decoded_string;
+	}
+
+
+
+	/**
+	 * encodes  url string with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $text_string the text to be encoded
+	 * @return string
+	 */
+	public function base64_url_encode($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string) || ! $this->_use_base64_encode) {
+			return $text_string;
+		}
+		// encode
+		$encoded_string = base64_encode($text_string);
+		// remove chars to make encoding more URL friendly
+		return strtr($encoded_string, '+/=', '-_,');
+	}
+
+
+	/**
+	 * decodes  url string that has been encoded with PHP's base64 encoding
+	 *
+	 * @see http://php.net/manual/en/function.base64-encode.php
+	 * @param string $encoded_string the text to be decoded
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	public function base64_url_decode($encoded_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encoded_string) || ! $this->valid_base_64($encoded_string)) {
+			return $encoded_string;
+		}
+		// replace previously removed characters
+		$encoded_string = strtr($encoded_string, '-_,', '+/=');
+		// decode
+		$decoded_string = base64_decode($encoded_string);
+		if ($decoded_string === false) {
+			throw new RuntimeException(
+				esc_html__('Base 64 decoding failed.', 'event_espresso')
+			);
+		}
+		return $decoded_string;
+	}
+
+
+	/**
+	 * encrypts data using PHP's openssl functions
+	 *
+	 * @param string $text_string the text to be encrypted
+	 * @param string $cipher_method
+	 * @param string $encryption_key
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function openssl_encrypt(
+		$text_string = '',
+		$cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
+		$encryption_key = ''
+	) {
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		$this->cipher_method = $this->getCipherMethod($cipher_method);
+		// get initialization vector size
+		$iv_size = openssl_cipher_iv_length($this->cipher_method);
+		// generate initialization vector.
+		// The second parameter ("crypto_strong") is passed by reference,
+		// and is used to determines if the algorithm used was "cryptographically strong"
+		// openssl_random_pseudo_bytes() will toggle it to either true or false
+		$iv = openssl_random_pseudo_bytes($iv_size, $is_strong);
+		if ($iv === false || $is_strong === false) {
+			throw new RuntimeException(
+				esc_html__('Failed to generate OpenSSL initialization vector.', 'event_espresso')
+			);
+		}
+		// encrypt it
+		$encrypted_text = openssl_encrypt(
+			$text_string,
+			$this->cipher_method,
+			$this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
+			0,
+			$iv
+		);
+		// append the initialization vector
+		$encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER . $iv;
+		// trim and maybe encode
+		return $this->_use_base64_encode
+			? trim(base64_encode($encrypted_text))
+			: trim($encrypted_text);
+	}
+
+
+
+	/**
+	 * Returns a cipher method that has been verified to work.
+	 * First checks if the cached cipher has been set already and if so, returns that.
+	 * Then tests the incoming default and returns that if it's good.
+	 * If not, then it retrieves the previously tested and saved cipher method.
+	 * But if that doesn't exist, then calls getAvailableCipherMethod()
+	 * to see what is available on the server, and returns the results.
+	 *
+	 * @param string $cipher_method
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function getCipherMethod($cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD)
+	{
+		if($this->cipher_method !== ''){
+			return $this->cipher_method;
+		}
+		// verify that the default cipher method can produce an initialization vector
+		if (openssl_cipher_iv_length($cipher_method) === false) {
+			// nope? okay let's get what we found in the past to work
+			$cipher_method = get_option(EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME, '');
+			// oops... haven't tested available cipher methods yet
+			if($cipher_method === '' || openssl_cipher_iv_length($cipher_method) === false) {
+				$cipher_method = $this->getAvailableCipherMethod($cipher_method);
+			}
+		}
+		return $cipher_method;
+	}
+
+
+
+	/**
+	 * @param string $cipher_method
+	 * @return string
+	 * @throws \RuntimeException
+	 */
+	protected function getAvailableCipherMethod($cipher_method)
+	{
+		// verify that the incoming cipher method can produce an initialization vector
+		if (openssl_cipher_iv_length($cipher_method) === false) {
+			// nope? then check the next cipher in the list of available cipher methods
+			$cipher_method = next($this->cipher_methods);
+			// what? there's no list? then generate that list and cache it,
+			if (empty($this->cipher_methods)) {
+				$this->cipher_methods = openssl_get_cipher_methods();
+				// then grab the first item from the list
+				$cipher_method = reset($this->cipher_methods);
+			}
+			if($cipher_method === false){
+				throw new RuntimeException(
+					esc_html__(
+						'OpenSSL support appears to be enabled on the server, but no cipher methods are available. Please contact the server administrator.',
+						'event_espresso'
+					)
+				);
+			}
+			// verify that the next cipher method works
+			return $this->getAvailableCipherMethod($cipher_method);
+		}
+		// if we've gotten this far, then we found an available cipher method that works
+		// so save that for next time
+		update_option(
+			EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME,
+			$cipher_method
+		);
+		return $cipher_method;
+	}
+
+
+	/**
+	 * decrypts data that has been encrypted with PHP's openssl functions
+	 *
+	 * @param string $encrypted_text the text to be decrypted
+	 * @param string $cipher_method
+	 * @param string $encryption_key
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function openssl_decrypt(
+		$encrypted_text = '',
+		$cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD,
+		$encryption_key = ''
+	) {
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// decode
+		$encrypted_text = $this->valid_base_64($encrypted_text)
+			? $this->base64_url_decode($encrypted_text)
+			: $encrypted_text;
+		$encrypted_components = explode(
+			EE_Encryption::OPENSSL_IV_DELIMITER,
+			$encrypted_text,
+			2
+		);
+		// check that iv exists, and if not, maybe text was encoded using mcrypt?
+		if ($this->_use_mcrypt && ! isset($encrypted_components[1])) {
+			return $this->m_decrypt($encrypted_text);
+		}
+		// decrypt it
+		$decrypted_text = openssl_decrypt(
+			$encrypted_components[0],
+			$this->getCipherMethod($cipher_method),
+			$this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD,$encryption_key),
+			0,
+			$encrypted_components[1]
+		);
+		$decrypted_text = trim($decrypted_text);
+		return $decrypted_text;
+	}
+
+
+	/**
+	 * Computes the digest hash value using the specified digest method.
+	 * If that digest method fails to produce a valid hash value,
+	 * then we'll grab the next digest method and recursively try again until something works.
+	 *
+	 * @param string $digest_method
+	 * @param string $encryption_key
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function getDigestHashValue($digest_method = EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key = ''){
+		$encryption_key = $encryption_key !== ''
+			? $encryption_key
+			: $this->get_encryption_key();
+		$digest_hash_value = openssl_digest($encryption_key, $digest_method);
+		if ($digest_hash_value === false) {
+			return $this->getDigestHashValue($this->getDigestMethod());
+		}
+		return $digest_hash_value;
+	}
+
+
+
+	/**
+	 * Returns the NEXT element in the $digest_methods array.
+	 * If the $digest_methods array is empty, then we populate it
+	 * with the available values returned from openssl_get_md_methods().
+	 *
+	 * @return string
+	 * @throws \RuntimeException
+	 */
+	protected function getDigestMethod(){
+		$digest_method = prev($this->digest_methods);
+		if (empty($this->digest_methods)) {
+			$this->digest_methods = openssl_get_md_methods();
+			$digest_method = end($this->digest_methods);
+		}
+		if ($digest_method === false) {
+			throw new RuntimeException(
+				esc_html__(
+					'OpenSSL support appears to be enabled on the server, but no digest methods are available. Please contact the server administrator.',
+					'event_espresso'
+				)
+			);
+		}
+		return $digest_method;
+	}
+
+
+	/**
+	 * encrypts data for acme servers that didn't bother to install PHP mcrypt
+	 *
+	 * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
+	 * @param string $text_string the text to be decrypted
+	 * @return string
+	 */
+	protected function acme_encrypt($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		$key_bits = str_split(
+			str_pad(
+				'',
+				strlen($text_string),
+				$this->get_encryption_key(),
+				STR_PAD_RIGHT
+			)
+		);
+		$string_bits = str_split($text_string);
+		foreach ($string_bits as $k => $v) {
+			$temp = ord($v) + ord($key_bits[$k]);
+			$string_bits[$k] = chr($temp > 255 ? ($temp - 256) : $temp);
+		}
+		$encrypted_text = implode('', $string_bits);
+		$encrypted_text .= EE_Encryption::ACME_ENCRYPTION_FLAG;
+		return $this->_use_base64_encode
+			? base64_encode($encrypted_text)
+			: $encrypted_text;
+	}
+
+
+
+	/**
+	 * decrypts data for acme servers that didn't bother to install PHP mcrypt
+	 *
+	 * @see http://stackoverflow.com/questions/800922/how-to-encrypt-string-without-mcrypt-library-in-php
+	 * @param string $encrypted_text the text to be decrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function acme_decrypt($encrypted_text = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// decode the data ?
+		$encrypted_text = $this->valid_base_64($encrypted_text)
+			? $this->base64_url_decode($encrypted_text)
+			: $encrypted_text;
+		if (
+			$this->_use_mcrypt
+			&& strpos($encrypted_text, EE_Encryption::ACME_ENCRYPTION_FLAG) === false
+		){
+			return $this->m_decrypt($encrypted_text);
+		}
+		$encrypted_text = substr($encrypted_text, 0, -4);
+		$key_bits = str_split(
+			str_pad(
+				'',
+				strlen($encrypted_text),
+				$this->get_encryption_key(),
+				STR_PAD_RIGHT
+			)
+		);
+		$string_bits = str_split($encrypted_text);
+		foreach ($string_bits as $k => $v) {
+			$temp = ord($v) - ord($key_bits[$k]);
+			$string_bits[$k] = chr($temp < 0 ? ($temp + 256) : $temp);
+		}
+		return implode('', $string_bits);
+	}
+
+
+
+	/**
+	 * @see http://stackoverflow.com/questions/2556345/detect-base64-encoding-in-php#30231906
+	 * @param $string
+	 * @return bool
+	 */
+	protected function valid_base_64($string)
+	{
+		// ensure data is a string
+		if (! is_string($string) || ! $this->_use_base64_encode) {
+			return false;
+		}
+		$decoded = base64_decode($string, true);
+		// Check if there is no invalid character in string
+		if (! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
+			return false;
+		}
+		// Decode the string in strict mode and send the response
+		if (! base64_decode($string, true)) {
+			return false;
+		}
+		// Encode and compare it to original one
+		return base64_encode($decoded) === $string;
+	}
+
+
+
+	/**
+	 * generate random string
+	 *
+	 * @see http://stackoverflow.com/questions/637278/what-is-the-best-way-to-generate-a-random-key-within-php
+	 * @param int $length number of characters for random string
+	 * @return string
+	 */
+	public function generate_random_string($length = 40)
+	{
+		$iterations = ceil($length / 40);
+		$random_string = '';
+		for ($i = 0; $i < $iterations; $i++) {
+			$random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
+		}
+		$random_string = substr($random_string, 0, $length);
+		return $random_string;
+	}
+
+
+
+	/**
+	 * encrypts data using PHP's mcrypt functions
+	 *
+	 * @deprecated 4.9.39
+	 * @param string $text_string
+	 * @internal   param $string - the text to be encrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function m_encrypt($text_string = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($text_string)) {
+			return $text_string;
+		}
+		// get the initialization vector size
+		$iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
+		// initialization vector
+		$iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
+		if ($iv === false) {
+			throw new RuntimeException(
+				esc_html__('Failed to generate mcrypt initialization vector.', 'event_espresso')
+			);
+		}
+		// encrypt it
+		$encrypted_text = mcrypt_encrypt(
+			MCRYPT_RIJNDAEL_256,
+			$this->get_encryption_key(),
+			$text_string,
+			MCRYPT_MODE_ECB,
+			$iv
+		);
+		// trim and maybe encode
+		return $this->_use_base64_encode
+			? trim(base64_encode($encrypted_text))
+			: trim($encrypted_text);
+	}
+
+
+
+	/**
+	 * decrypts data that has been encrypted with PHP's mcrypt functions
+	 *
+	 * @deprecated 4.9.39
+	 * @param string $encrypted_text the text to be decrypted
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	protected function m_decrypt($encrypted_text = '')
+	{
+		// you give me nothing??? GET OUT !
+		if (empty($encrypted_text)) {
+			return $encrypted_text;
+		}
+		// decode
+		$encrypted_text = $this->valid_base_64($encrypted_text)
+			? $this->base64_url_decode($encrypted_text)
+			: $encrypted_text;
+		// get the initialization vector size
+		$iv_size = mcrypt_get_iv_size(MCRYPT_RIJNDAEL_256, MCRYPT_MODE_ECB);
+		$iv = mcrypt_create_iv($iv_size, MCRYPT_RAND);
+		if ($iv === false) {
+			throw new RuntimeException(
+				esc_html__('Failed to generate mcrypt initialization vector.', 'event_espresso')
+			);
+		}
+		// decrypt it
+		$decrypted_text = mcrypt_decrypt(
+			MCRYPT_RIJNDAEL_256,
+			$this->get_encryption_key(),
+			$encrypted_text,
+			MCRYPT_MODE_ECB,
+			$iv
+		);
+		$decrypted_text = trim($decrypted_text);
+		return $decrypted_text;
+	}
 
 }
 /* End of file EE_Encryption.class.php */

Spacing +14 added lines, -14 removed lines

@@ -98,7 +98,7 @@ 
      */
     protected function __construct()
     {
-        if (! defined('ESPRESSO_ENCRYPT')) {
+        if ( ! defined('ESPRESSO_ENCRYPT')) {
             define('ESPRESSO_ENCRYPT', true);
         }
         if (extension_loaded('openssl')) {
@@ -121,7 +121,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! EE_Encryption::$_instance instanceof EE_Encryption) {
+        if ( ! EE_Encryption::$_instance instanceof EE_Encryption) {
             EE_Encryption::$_instance = new self();
         }
         return EE_Encryption::$_instance;
@@ -333,7 +333,7 @@ 
             $iv
         );
         // append the initialization vector
-        $encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER . $iv;
+        $encrypted_text .= EE_Encryption::OPENSSL_IV_DELIMITER.$iv;
         // trim and maybe encode
         return $this->_use_base64_encode
             ? trim(base64_encode($encrypted_text))
@@ -356,7 +356,7 @@ 
      */
     protected function getCipherMethod($cipher_method = EE_Encryption::OPENSSL_CIPHER_METHOD)
     {
-        if($this->cipher_method !== ''){
+        if ($this->cipher_method !== '') {
             return $this->cipher_method;
         }
         // verify that the default cipher method can produce an initialization vector
@@ -364,7 +364,7 @@ 
             // nope? okay let's get what we found in the past to work
             $cipher_method = get_option(EE_Encryption::OPENSSL_CIPHER_METHOD_OPTION_NAME, '');
             // oops... haven't tested available cipher methods yet
-            if($cipher_method === '' || openssl_cipher_iv_length($cipher_method) === false) {
+            if ($cipher_method === '' || openssl_cipher_iv_length($cipher_method) === false) {
                 $cipher_method = $this->getAvailableCipherMethod($cipher_method);
             }
         }
@@ -390,7 +390,7 @@ 
                 // then grab the first item from the list
                 $cipher_method = reset($this->cipher_methods);
             }
-            if($cipher_method === false){
+            if ($cipher_method === false) {
                 throw new RuntimeException(
                     esc_html__(
                         'OpenSSL support appears to be enabled on the server, but no cipher methods are available. Please contact the server administrator.',
@@ -446,7 +446,7 @@ 
         $decrypted_text = openssl_decrypt(
             $encrypted_components[0],
             $this->getCipherMethod($cipher_method),
-            $this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD,$encryption_key),
+            $this->getDigestHashValue(EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key),
             0,
             $encrypted_components[1]
         );
@@ -465,7 +465,7 @@ 
      * @return string
      * @throws RuntimeException
      */
-    protected function getDigestHashValue($digest_method = EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key = ''){
+    protected function getDigestHashValue($digest_method = EE_Encryption::OPENSSL_DIGEST_METHOD, $encryption_key = '') {
         $encryption_key = $encryption_key !== ''
             ? $encryption_key
             : $this->get_encryption_key();
@@ -486,7 +486,7 @@ 
      * @return string
      * @throws \RuntimeException
      */
-    protected function getDigestMethod(){
+    protected function getDigestMethod() {
         $digest_method = prev($this->digest_methods);
         if (empty($this->digest_methods)) {
             $this->digest_methods = openssl_get_md_methods();
@@ -560,7 +560,7 @@ 
         if (
             $this->_use_mcrypt
             && strpos($encrypted_text, EE_Encryption::ACME_ENCRYPTION_FLAG) === false
-        ){
+        ) {
             return $this->m_decrypt($encrypted_text);
         }
         $encrypted_text = substr($encrypted_text, 0, -4);
@@ -590,16 +590,16 @@ 
     protected function valid_base_64($string)
     {
         // ensure data is a string
-        if (! is_string($string) || ! $this->_use_base64_encode) {
+        if ( ! is_string($string) || ! $this->_use_base64_encode) {
             return false;
         }
         $decoded = base64_decode($string, true);
         // Check if there is no invalid character in string
-        if (! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
+        if ( ! preg_match('/^[a-zA-Z0-9\/\r\n+]*={0,2}$/', $string)) {
             return false;
         }
         // Decode the string in strict mode and send the response
-        if (! base64_decode($string, true)) {
+        if ( ! base64_decode($string, true)) {
             return false;
         }
         // Encode and compare it to original one
@@ -620,7 +620,7 @@ 
         $iterations = ceil($length / 40);
         $random_string = '';
         for ($i = 0; $i < $iterations; $i++) {
-            $random_string .= sha1(microtime(true) . mt_rand(10000, 90000));
+            $random_string .= sha1(microtime(true).mt_rand(10000, 90000));
         }
         $random_string = substr($random_string, 0, $length);
         return $random_string;

core/db_models/EEM_Line_Item.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -416,7 +416,7 @@
      * If $expired is set to true, then only line items for expired sessions will be returned.
      * If $expired is set to false, then only line items for active sessions will be returned.
      *
-     * @param null $expired
+     * @param boolean $expired
      * @return EE_Base_Class[]|EE_Line_Item[]
      * @throws EE_Error
      * @throws InvalidArgumentException

Spacing +5 added lines, -5 removed lines

@@ -4,7 +4,7 @@ 
 use EventEspresso\core\exceptions\InvalidInterfaceException;
 use EventEspresso\core\services\loaders\LoaderFactory;
 
-if (!defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
+if ( ! defined('EVENT_ESPRESSO_VERSION')) exit('No direct script access allowed');
 
 /**
  * Event Espresso
@@ -211,8 +211,8 @@ 
         );
         $query = $wpdb->prepare(
             'DELETE li
-				FROM ' . $this->table() . ' li
-				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
+				FROM ' . $this->table().' li
+				LEFT JOIN ' . EEM_Transaction::instance()->table().' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
             // use GMT time because that's what TXN_timestamps are in
             date('Y-m-d H:i:s', time() - $time_to_leave_alone)
@@ -253,7 +253,7 @@ 
         $query_params = array(
             'OBJ_type' => $OBJ_type,
             // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-            'OBJ_ID' => is_array($OBJ_IDs) && !isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
+            'OBJ_ID' => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
         );
         if ($TXN_ID) {
             $query_params['TXN_ID'] = $TXN_ID;
@@ -456,7 +456,7 @@ 
      */
     public function getTicketLineItemsForExpiredCarts($timestamp = 0)
     {
-        if(! absint($timestamp)) {
+        if ( ! absint($timestamp)) {
             /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
             $session_lifespan = LoaderFactory::getLoader()->getShared(
                 'EventEspresso\core\domain\values\session\SessionLifespan'

Indentation +436 added lines, -436 removed lines

@@ -47,444 +47,444 @@
 class EEM_Line_Item extends EEM_Base
 {
 
-    /**
-     * Tax sub-total is just the total of all the taxes, which should be children
-     * of this line item. There should only ever be one tax sub-total, and it should
-     * be a direct child of. Its quantity and LIN_unit_price = 1.
-     */
-    const type_tax_sub_total = 'tax-sub-total';
-
-    /**
-     * Tax line items indicate a tax applied to all the taxable line items.
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
-     */
-    const type_tax = 'tax';
-
-    /**
-     * Indicating individual items purchased, or discounts or surcharges.
-     * The sum of all the regular line items  plus the tax items should equal
-     * the grand total.
-     * Possible children are sub-line-items and cancellations.
-     * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
-     * LIN_totals. Its LIN_percent = 0.
-     * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
-     * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
-     */
-    const type_line_item = 'line-item';
-
-    /**
-     * Line item indicating all the factors that make a single line item.
-     * Sub-line items should have NO children line items.
-     * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
-     * contribution towards the price of ONE of their parent items, and its LIN_total should be
-     *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
-     * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
-     * = LIN_percent / 100 * sum of lower-priority sibling line items..
-     */
-    const type_sub_line_item = 'sub-item';
-
-    /**
-     * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
-     * Direct children should be event subtotals.
-     * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
-     *
-     */
-    const type_sub_total = 'sub-total';
-
-    /**
-     * Line item for the grand total of an order. Its direct children
-     * should be tax subtotals and (pre-tax) subtotals, and possibly a regular line item
-     * indicating a transaction-wide discount/surcharge. Should have a quantity of 1, a LIN_total and LIN_unit_price of
-     * the entire order's mount.
-     */
-    const type_total = 'total';
-
-    /**
-     * When a line item is cancelled, a sub-line-item of type 'cancellation'
-     * should be created, indicating the quantity that were cancelled
-     * (because a line item could have a quantity of 1, and its cancellation item
-     * could be for 3, indicating that originally 4 were purchased, but 3 have been
-     * cancelled, and only one remains).
-     * When items are refunded, a cancellation line item should be made, which points
-     * to teh payment model object which actually refunded the payment.
-     * Cancellations should NOT have any children line items; the should NOT affect
-     * any calculations, and are only meant as a record that cancellations have occurred.
-     * Their LIN_percent should be 0.
-     */
-    const type_cancellation = 'cancellation';
-
-    // private instance of the EEM_Line_Item object
-    protected static $_instance = NULL;
-
-
-    /**
-     *        private constructor to prevent direct creation
-     * @Constructor
-     * @access protected
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @return \EEM_Line_Item
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Line Item', 'event_espresso');
-        $this->plural_item = __('Line Items', 'event_espresso');
-
-        $this->_tables = array(
-            'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID')
-        );
-        $line_items_can_be_for = apply_filters('FHEE__EEM_Line_Item__line_items_can_be_for', array('Ticket', 'Price', 'Event'));
-        $this->_fields = array(
-            'Line_Item' => array(
-                'LIN_ID' => new EE_Primary_Key_Int_Field('LIN_ID', __("ID", "event_espresso")),
-                'LIN_code' => new EE_Slug_Field('LIN_code', __("Code for index into Cart", "event_espresso"), TRUE),
-                'TXN_ID' => new EE_Foreign_Key_Int_Field('TXN_ID', __("Transaction ID", "event_espresso"), TRUE, NULL, 'Transaction'),
-                'LIN_name' => new EE_Full_HTML_Field('LIN_name', __("Line Item Name", "event_espresso"), FALSE, ''),
-                'LIN_desc' => new EE_Full_HTML_Field('LIN_desc', __("Line Item Description", "event_espresso"), TRUE),
-                'LIN_unit_price' => new EE_Money_Field('LIN_unit_price', __("Unit Price", "event_espresso"), FALSE, 0),
-                'LIN_percent' => new EE_Float_Field('LIN_percent', __("Percent", "event_espresso"), FALSE, 0),
-                'LIN_is_taxable' => new EE_Boolean_Field('LIN_is_taxable', __("Taxable", "event_espresso"), FALSE, FALSE),
-                'LIN_order' => new EE_Integer_Field('LIN_order', __("Order of Application towards total of parent", "event_espresso"), FALSE, 1),
-                'LIN_total' => new EE_Money_Field('LIN_total', __("Total (unit price x quantity)", "event_espresso"), FALSE, 0),
-                'LIN_quantity' => new EE_Integer_Field('LIN_quantity', __("Quantity", "event_espresso"), TRUE, 1),
-                'LIN_parent' => new EE_Integer_Field('LIN_parent', __("Parent ID (this item goes towards that Line Item's total)", "event_espresso"), TRUE, NULL),
-                'LIN_type' => new EE_Enum_Text_Field('LIN_type', __("Type", "event_espresso"), FALSE, 'line-item', array(
-                        self::type_line_item => __("Line Item", "event_espresso"),
-                        self::type_sub_line_item => __("Sub-Item", "event_espresso"),
-                        self::type_sub_total => __("Subtotal", "event_espresso"),
-                        self::type_tax_sub_total => __("Tax Subtotal", "event_espresso"),
-                        self::type_tax => __("Tax", "event_espresso"),
-                        self::type_total => __("Total", "event_espresso"),
-                        self::type_cancellation => __('Cancellation', 'event_espresso')
-                    )
-                ),
-                'OBJ_ID' => new EE_Foreign_Key_Int_Field('OBJ_ID', __('ID of Item purchased.', 'event_espresso'), TRUE, NULL, $line_items_can_be_for),
-                'OBJ_type' => new EE_Any_Foreign_Model_Name_Field('OBJ_type', __("Model Name this Line Item is for", "event_espresso"), TRUE, NULL, $line_items_can_be_for),
-                'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('When the line item was created', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
-            )
-        );
-        $this->_model_relations = array(
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Ticket' => new EE_Belongs_To_Any_Relation(),
-            'Price' => new EE_Belongs_To_Any_Relation(),
-            'Event' => new EE_Belongs_To_Any_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
-        $this->_caps_slug = 'transactions';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets all the line items for this transaction of the given type
-     * @param string $line_item_type like one of EEM_Line_Item::type_*
-     * @param EE_Transaction|int $transaction
-     * @return EE_Line_Item[]
-     */
-    public function get_all_of_type_for_transaction($line_item_type, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(array(array(
-            'LIN_type' => $line_item_type,
-            'TXN_ID' => $transaction
-        )));
-    }
-
-
-    /**
-     * Gets all line items unrelated to tickets that are normal line items
-     * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
-     * @param EE_Transaction|int $transaction
-     * @return EE_Line_Item[]
-     */
-    public function get_all_non_ticket_line_items_for_transaction($transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(array(array(
-            'LIN_type' => self::type_line_item,
-            'TXN_ID' => $transaction,
-            'OR' => array(
-                'OBJ_type*notticket' => array('!=', 'Ticket'),
-                'OBJ_type*null' => array('IS_NULL'))
-        )));
-    }
-
-    /**
-     * Deletes line items with no transaction who have passed the transaction cutoff time.
-     * This needs to be very efficient
-     * because if there are spam bots afoot there will be LOTS of line items
-     * @return int count of how many deleted
-     */
-    public function delete_line_items_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone', WEEK_IN_SECONDS
-        );
-        $query = $wpdb->prepare(
-            'DELETE li
+	/**
+	 * Tax sub-total is just the total of all the taxes, which should be children
+	 * of this line item. There should only ever be one tax sub-total, and it should
+	 * be a direct child of. Its quantity and LIN_unit_price = 1.
+	 */
+	const type_tax_sub_total = 'tax-sub-total';
+
+	/**
+	 * Tax line items indicate a tax applied to all the taxable line items.
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
+	 */
+	const type_tax = 'tax';
+
+	/**
+	 * Indicating individual items purchased, or discounts or surcharges.
+	 * The sum of all the regular line items  plus the tax items should equal
+	 * the grand total.
+	 * Possible children are sub-line-items and cancellations.
+	 * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
+	 * LIN_totals. Its LIN_percent = 0.
+	 * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
+	 * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
+	 */
+	const type_line_item = 'line-item';
+
+	/**
+	 * Line item indicating all the factors that make a single line item.
+	 * Sub-line items should have NO children line items.
+	 * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
+	 * contribution towards the price of ONE of their parent items, and its LIN_total should be
+	 *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
+	 * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
+	 * = LIN_percent / 100 * sum of lower-priority sibling line items..
+	 */
+	const type_sub_line_item = 'sub-item';
+
+	/**
+	 * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
+	 * Direct children should be event subtotals.
+	 * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
+	 *
+	 */
+	const type_sub_total = 'sub-total';
+
+	/**
+	 * Line item for the grand total of an order. Its direct children
+	 * should be tax subtotals and (pre-tax) subtotals, and possibly a regular line item
+	 * indicating a transaction-wide discount/surcharge. Should have a quantity of 1, a LIN_total and LIN_unit_price of
+	 * the entire order's mount.
+	 */
+	const type_total = 'total';
+
+	/**
+	 * When a line item is cancelled, a sub-line-item of type 'cancellation'
+	 * should be created, indicating the quantity that were cancelled
+	 * (because a line item could have a quantity of 1, and its cancellation item
+	 * could be for 3, indicating that originally 4 were purchased, but 3 have been
+	 * cancelled, and only one remains).
+	 * When items are refunded, a cancellation line item should be made, which points
+	 * to teh payment model object which actually refunded the payment.
+	 * Cancellations should NOT have any children line items; the should NOT affect
+	 * any calculations, and are only meant as a record that cancellations have occurred.
+	 * Their LIN_percent should be 0.
+	 */
+	const type_cancellation = 'cancellation';
+
+	// private instance of the EEM_Line_Item object
+	protected static $_instance = NULL;
+
+
+	/**
+	 *        private constructor to prevent direct creation
+	 * @Constructor
+	 * @access protected
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any incoming timezone data that gets saved).  Note this just sends the timezone info to the date time model field objects.  Default is NULL (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @return \EEM_Line_Item
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Line Item', 'event_espresso');
+		$this->plural_item = __('Line Items', 'event_espresso');
+
+		$this->_tables = array(
+			'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID')
+		);
+		$line_items_can_be_for = apply_filters('FHEE__EEM_Line_Item__line_items_can_be_for', array('Ticket', 'Price', 'Event'));
+		$this->_fields = array(
+			'Line_Item' => array(
+				'LIN_ID' => new EE_Primary_Key_Int_Field('LIN_ID', __("ID", "event_espresso")),
+				'LIN_code' => new EE_Slug_Field('LIN_code', __("Code for index into Cart", "event_espresso"), TRUE),
+				'TXN_ID' => new EE_Foreign_Key_Int_Field('TXN_ID', __("Transaction ID", "event_espresso"), TRUE, NULL, 'Transaction'),
+				'LIN_name' => new EE_Full_HTML_Field('LIN_name', __("Line Item Name", "event_espresso"), FALSE, ''),
+				'LIN_desc' => new EE_Full_HTML_Field('LIN_desc', __("Line Item Description", "event_espresso"), TRUE),
+				'LIN_unit_price' => new EE_Money_Field('LIN_unit_price', __("Unit Price", "event_espresso"), FALSE, 0),
+				'LIN_percent' => new EE_Float_Field('LIN_percent', __("Percent", "event_espresso"), FALSE, 0),
+				'LIN_is_taxable' => new EE_Boolean_Field('LIN_is_taxable', __("Taxable", "event_espresso"), FALSE, FALSE),
+				'LIN_order' => new EE_Integer_Field('LIN_order', __("Order of Application towards total of parent", "event_espresso"), FALSE, 1),
+				'LIN_total' => new EE_Money_Field('LIN_total', __("Total (unit price x quantity)", "event_espresso"), FALSE, 0),
+				'LIN_quantity' => new EE_Integer_Field('LIN_quantity', __("Quantity", "event_espresso"), TRUE, 1),
+				'LIN_parent' => new EE_Integer_Field('LIN_parent', __("Parent ID (this item goes towards that Line Item's total)", "event_espresso"), TRUE, NULL),
+				'LIN_type' => new EE_Enum_Text_Field('LIN_type', __("Type", "event_espresso"), FALSE, 'line-item', array(
+						self::type_line_item => __("Line Item", "event_espresso"),
+						self::type_sub_line_item => __("Sub-Item", "event_espresso"),
+						self::type_sub_total => __("Subtotal", "event_espresso"),
+						self::type_tax_sub_total => __("Tax Subtotal", "event_espresso"),
+						self::type_tax => __("Tax", "event_espresso"),
+						self::type_total => __("Total", "event_espresso"),
+						self::type_cancellation => __('Cancellation', 'event_espresso')
+					)
+				),
+				'OBJ_ID' => new EE_Foreign_Key_Int_Field('OBJ_ID', __('ID of Item purchased.', 'event_espresso'), TRUE, NULL, $line_items_can_be_for),
+				'OBJ_type' => new EE_Any_Foreign_Model_Name_Field('OBJ_type', __("Model Name this Line Item is for", "event_espresso"), TRUE, NULL, $line_items_can_be_for),
+				'LIN_timestamp' => new EE_Datetime_Field('LIN_timestamp', __('When the line item was created', 'event_espresso'), false, EE_Datetime_Field::now, $timezone),
+			)
+		);
+		$this->_model_relations = array(
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Ticket' => new EE_Belongs_To_Any_Relation(),
+			'Price' => new EE_Belongs_To_Any_Relation(),
+			'Event' => new EE_Belongs_To_Any_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
+		$this->_caps_slug = 'transactions';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets all the line items for this transaction of the given type
+	 * @param string $line_item_type like one of EEM_Line_Item::type_*
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Line_Item[]
+	 */
+	public function get_all_of_type_for_transaction($line_item_type, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(array(
+			'LIN_type' => $line_item_type,
+			'TXN_ID' => $transaction
+		)));
+	}
+
+
+	/**
+	 * Gets all line items unrelated to tickets that are normal line items
+	 * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Line_Item[]
+	 */
+	public function get_all_non_ticket_line_items_for_transaction($transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(array(
+			'LIN_type' => self::type_line_item,
+			'TXN_ID' => $transaction,
+			'OR' => array(
+				'OBJ_type*notticket' => array('!=', 'Ticket'),
+				'OBJ_type*null' => array('IS_NULL'))
+		)));
+	}
+
+	/**
+	 * Deletes line items with no transaction who have passed the transaction cutoff time.
+	 * This needs to be very efficient
+	 * because if there are spam bots afoot there will be LOTS of line items
+	 * @return int count of how many deleted
+	 */
+	public function delete_line_items_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone', WEEK_IN_SECONDS
+		);
+		$query = $wpdb->prepare(
+			'DELETE li
 				FROM ' . $this->table() . ' li
 				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
-            // use GMT time because that's what TXN_timestamps are in
-            date('Y-m-d H:i:s', time() - $time_to_leave_alone)
-        );
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * get_line_item_for_transaction_object
-     * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
-     *
-     * @param int $TXN_ID
-     * @param \EE_Base_Class $object
-     * @return EE_Line_Item[]
-     */
-    public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
-    {
-        return $this->get_all(array(array(
-            'TXN_ID' => $TXN_ID,
-            'OBJ_type' => str_replace('EE_', '', get_class($object)),
-            'OBJ_ID' => $object->ID()
-        )));
-    }
-
-
-    /**
-     * get_object_line_items_for_transaction
-     * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
-     *
-     * @param int $TXN_ID
-     * @param string $OBJ_type
-     * @param array $OBJ_IDs
-     * @return EE_Line_Item[]
-     */
-    public function get_object_line_items_for_transaction($TXN_ID, $OBJ_type = 'Event', $OBJ_IDs = array())
-    {
-        $query_params = array(
-            'OBJ_type' => $OBJ_type,
-            // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-            'OBJ_ID' => is_array($OBJ_IDs) && !isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
-        );
-        if ($TXN_ID) {
-            $query_params['TXN_ID'] = $TXN_ID;
-        }
-        return $this->get_all(array($query_params));
-    }
-
-
-    /**
-     * get_all_ticket_line_items_for_transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item[]
-     */
-    public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->get_all(array(
-            array(
-                'TXN_ID' => $transaction->ID(),
-                'OBJ_type' => 'Ticket',
-            )
-        ));
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction
-     *
-     * @param int $TXN_ID
-     * @param int $TKT_ID
-     * @return \EE_Line_Item
-     */
-    public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
-    {
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
-                'OBJ_ID' => $TKT_ID,
-                'OBJ_type' => 'Ticket',
-            )
-        ));
-    }
-
-
-    /**
-     * get_existing_promotion_line_item
-     * searches the cart for existing line items for the specified promotion
-     *
-     * @since   1.0.0
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param EE_Promotion $promotion
-     * @return EE_Line_Item
-     */
-    public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
-    {
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => $parent_line_item->TXN_ID(),
-                'LIN_parent' => $parent_line_item->ID(),
-                'OBJ_type' => 'Promotion',
-                'OBJ_ID' => $promotion->ID()
-            )
-        ));
-    }
-
-
-    /**
-     * get_all_promotion_line_items
-     * searches the cart for any and all existing promotion line items
-     *
-     * @since   1.0.0
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @return EE_Line_Item[]
-     */
-    public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
-    {
-        return $this->get_all(array(
-            array(
-                'TXN_ID' => $parent_line_item->TXN_ID(),
-                'LIN_parent' => $parent_line_item->ID(),
-                'OBJ_type' => 'Promotion'
-            )
-        ));
-    }
-
-    /**
-     * Gets the registration's corresponding line item.
-     * Note: basically does NOT support having multiple line items for a single ticket,
-     * which would happen if some of the registrations had a price modifier while others didn't.
-     * In order to support that, we'd probably need a LIN_ID on registrations or something.
-     * @param EE_Registration $registration
-     * @return EE_Line_ITem
-     */
-    public function get_line_item_for_registration(EE_Registration $registration)
-    {
-        return $this->get_one($this->line_item_for_registration_query_params($registration));
-    }
-
-    /**
-     * Gets the query params used to retrieve a specific line item for the given registration
-     * @param EE_Registration $registration
-     * @param array $original_query_params any extra query params you'd like to be merged with
-     * @return array like EEM_Base::get_all()'s $query_params
-     */
-    public function line_item_for_registration_query_params(EE_Registration $registration, $original_query_params = array())
-    {
-        return array_replace_recursive($original_query_params, array(
-            array(
-                'OBJ_ID' => $registration->ticket_ID(),
-                'OBJ_type' => 'Ticket',
-                'TXN_ID' => $registration->transaction_ID()
-            )
-        ));
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_with_no_transaction()
-    {
-        return $this->get_total_line_items_for_carts();
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_active_carts()
-    {
-        return $this->get_total_line_items_for_carts(false);
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_expired_carts()
-    {
-        return $this->get_total_line_items_for_carts(true);
-    }
-
-
-    /**
-     * Returns an array of grand total line items where the TXN_ID is 0.
-     * If $expired is set to true, then only line items for expired sessions will be returned.
-     * If $expired is set to false, then only line items for active sessions will be returned.
-     *
-     * @param null $expired
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function get_total_line_items_for_carts($expired = null)
-    {
-        $where_params = array(
-            'TXN_ID' => 0,
-            'LIN_type' => 'total',
-        );
-        if ($expired !== null) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $where_params['LIN_timestamp'] = array(
-                $expired ? '<=' : '>',
-                $session_lifespan->expiration(),
-            );
-        }
-        return $this->get_all(array($where_params));
-    }
-
-
-    /**
-     * Returns an array of ticket total line items where the TXN_ID is 0
-     * AND the timestamp is older than the session lifespan.
-     *
-     * @param int $timestamp
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getTicketLineItemsForExpiredCarts($timestamp = 0)
-    {
-        if(! absint($timestamp)) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $timestamp = $session_lifespan->expiration();
-        }
-        return $this->get_all(
-            array(
-                array(
-                    'TXN_ID'        => 0,
-                    'OBJ_type'      => 'Ticket',
-                    'LIN_timestamp' => array('<=', $timestamp),
-                )
-            )
-        );
-    }
+			// use GMT time because that's what TXN_timestamps are in
+			date('Y-m-d H:i:s', time() - $time_to_leave_alone)
+		);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * get_line_item_for_transaction_object
+	 * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
+	 *
+	 * @param int $TXN_ID
+	 * @param \EE_Base_Class $object
+	 * @return EE_Line_Item[]
+	 */
+	public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
+	{
+		return $this->get_all(array(array(
+			'TXN_ID' => $TXN_ID,
+			'OBJ_type' => str_replace('EE_', '', get_class($object)),
+			'OBJ_ID' => $object->ID()
+		)));
+	}
+
+
+	/**
+	 * get_object_line_items_for_transaction
+	 * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
+	 *
+	 * @param int $TXN_ID
+	 * @param string $OBJ_type
+	 * @param array $OBJ_IDs
+	 * @return EE_Line_Item[]
+	 */
+	public function get_object_line_items_for_transaction($TXN_ID, $OBJ_type = 'Event', $OBJ_IDs = array())
+	{
+		$query_params = array(
+			'OBJ_type' => $OBJ_type,
+			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
+			'OBJ_ID' => is_array($OBJ_IDs) && !isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs
+		);
+		if ($TXN_ID) {
+			$query_params['TXN_ID'] = $TXN_ID;
+		}
+		return $this->get_all(array($query_params));
+	}
+
+
+	/**
+	 * get_all_ticket_line_items_for_transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item[]
+	 */
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->get_all(array(
+			array(
+				'TXN_ID' => $transaction->ID(),
+				'OBJ_type' => 'Ticket',
+			)
+		));
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction
+	 *
+	 * @param int $TXN_ID
+	 * @param int $TKT_ID
+	 * @return \EE_Line_Item
+	 */
+	public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
+	{
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
+				'OBJ_ID' => $TKT_ID,
+				'OBJ_type' => 'Ticket',
+			)
+		));
+	}
+
+
+	/**
+	 * get_existing_promotion_line_item
+	 * searches the cart for existing line items for the specified promotion
+	 *
+	 * @since   1.0.0
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param EE_Promotion $promotion
+	 * @return EE_Line_Item
+	 */
+	public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
+	{
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => $parent_line_item->TXN_ID(),
+				'LIN_parent' => $parent_line_item->ID(),
+				'OBJ_type' => 'Promotion',
+				'OBJ_ID' => $promotion->ID()
+			)
+		));
+	}
+
+
+	/**
+	 * get_all_promotion_line_items
+	 * searches the cart for any and all existing promotion line items
+	 *
+	 * @since   1.0.0
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @return EE_Line_Item[]
+	 */
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
+	{
+		return $this->get_all(array(
+			array(
+				'TXN_ID' => $parent_line_item->TXN_ID(),
+				'LIN_parent' => $parent_line_item->ID(),
+				'OBJ_type' => 'Promotion'
+			)
+		));
+	}
+
+	/**
+	 * Gets the registration's corresponding line item.
+	 * Note: basically does NOT support having multiple line items for a single ticket,
+	 * which would happen if some of the registrations had a price modifier while others didn't.
+	 * In order to support that, we'd probably need a LIN_ID on registrations or something.
+	 * @param EE_Registration $registration
+	 * @return EE_Line_ITem
+	 */
+	public function get_line_item_for_registration(EE_Registration $registration)
+	{
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
+	}
+
+	/**
+	 * Gets the query params used to retrieve a specific line item for the given registration
+	 * @param EE_Registration $registration
+	 * @param array $original_query_params any extra query params you'd like to be merged with
+	 * @return array like EEM_Base::get_all()'s $query_params
+	 */
+	public function line_item_for_registration_query_params(EE_Registration $registration, $original_query_params = array())
+	{
+		return array_replace_recursive($original_query_params, array(
+			array(
+				'OBJ_ID' => $registration->ticket_ID(),
+				'OBJ_type' => 'Ticket',
+				'TXN_ID' => $registration->transaction_ID()
+			)
+		));
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_with_no_transaction()
+	{
+		return $this->get_total_line_items_for_carts();
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_active_carts()
+	{
+		return $this->get_total_line_items_for_carts(false);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_expired_carts()
+	{
+		return $this->get_total_line_items_for_carts(true);
+	}
+
+
+	/**
+	 * Returns an array of grand total line items where the TXN_ID is 0.
+	 * If $expired is set to true, then only line items for expired sessions will be returned.
+	 * If $expired is set to false, then only line items for active sessions will be returned.
+	 *
+	 * @param null $expired
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function get_total_line_items_for_carts($expired = null)
+	{
+		$where_params = array(
+			'TXN_ID' => 0,
+			'LIN_type' => 'total',
+		);
+		if ($expired !== null) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$where_params['LIN_timestamp'] = array(
+				$expired ? '<=' : '>',
+				$session_lifespan->expiration(),
+			);
+		}
+		return $this->get_all(array($where_params));
+	}
+
+
+	/**
+	 * Returns an array of ticket total line items where the TXN_ID is 0
+	 * AND the timestamp is older than the session lifespan.
+	 *
+	 * @param int $timestamp
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getTicketLineItemsForExpiredCarts($timestamp = 0)
+	{
+		if(! absint($timestamp)) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$timestamp = $session_lifespan->expiration();
+		}
+		return $this->get_all(
+			array(
+				array(
+					'TXN_ID'        => 0,
+					'OBJ_type'      => 'Ticket',
+					'LIN_timestamp' => array('<=', $timestamp),
+				)
+			)
+		);
+	}
 
 }

modules/ticket_sales_monitor/EED_Ticket_Sales_Monitor.module.php

Indentation +1066 added lines, -1066 removed lines

@@ -24,1073 +24,1073 @@
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
 
-    const debug = false;    //	true false
-
-    private static $nl = '';
-
-    /**
-     * an array of raw ticket data from EED_Ticket_Selector
-     *
-     * @var array $ticket_selections
-     */
-    protected $ticket_selections = array();
-
-    /**
-     * the raw ticket data from EED_Ticket_Selector is organized in rows
-     * according to how they are displayed in the actual Ticket_Selector
-     * this tracks the current row being processed
-     *
-     * @var int $current_row
-     */
-    protected $current_row = 0;
-
-    /**
-     * an array for tracking names of tickets that have sold out
-     *
-     * @var array $sold_out_tickets
-     */
-    protected $sold_out_tickets = array();
-
-    /**
-     * an array for tracking names of tickets that have had their quantities reduced
-     *
-     * @var array $decremented_tickets
-     */
-    protected $decremented_tickets = array();
-
-
-
-    /**
-     * set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        self::$nl = defined('EE_TESTS_DIR')? "\n" : '<br />';
-        // release tickets for expired carts
-        add_action(
-            'EED_Ticket_Selector__process_ticket_selections__before',
-            array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
-            1
-        );
-        // check ticket reserves AFTER MER does it's check (hence priority 20)
-        add_filter(
-            'FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
-            array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
-            20,
-            3
-        );
-        // add notices for sold out tickets
-        add_action(
-            'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
-            array('EED_Ticket_Sales_Monitor', 'post_notices'),
-            10
-        );
-        // handle ticket quantities adjusted in cart
-        //add_action(
-        //	'FHEE__EED_Multi_Event_Registration__adjust_line_item_quantity__line_item_quantity_updated',
-        //	array( 'EED_Ticket_Sales_Monitor', 'ticket_quantity_updated' ),
-        //	10, 2
-        //);
-        // handle tickets deleted from cart
-        add_action(
-            'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
-            array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
-            10,
-            2
-        );
-        // handle emptied carts
-        add_action(
-            'AHEE__EE_Session__reset_cart__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
-            array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
-            10,
-            1
-        );
-        // handle cancelled registrations
-        add_action(
-            'AHEE__EE_Session__reset_checkout__before_reset',
-            array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
-            10,
-            1
-        );
-        // cron tasks
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
-            10,
-            1
-        );
-        add_action(
-            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-            array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
-            10,
-            1
-        );
-    }
-
-
-
-    /**
-     * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Ticket_Sales_Monitor::set_hooks();
-    }
-
-
-
-    /**
-     * @return EED_Ticket_Sales_Monitor|EED_Module
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     * @param WP_Query $WP_Query
-     * @return    void
-     */
-    public function run($WP_Query)
-    {
-    }
-
-
-
-    /********************************** PRE_TICKET_SALES  **********************************/
-
-
-
-    /**
-     * Retrieves grand totals from the line items that have no TXN ID
-     * and timestamps less than the current time minus the session lifespan.
-     * These are carts that have been abandoned before the "registrant" even attempted to checkout.
-     * We're going to release the tickets for these line items before attempting to add more to the cart.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     */
-    public static function release_tickets_for_expired_carts()
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-        }
-        do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
-        $expired_ticket_IDs = array();
-        /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-        $session_lifespan = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\values\session\SessionLifespan'
-        );
-        $timestamp = $session_lifespan->expiration();
-        $expired_ticket_line_items = EEM_Line_Item::instance()->getTicketLineItemsForExpiredCarts($timestamp);
-        if (self::debug) {
-            echo self::$nl . ' . time(): ' . time();
-            echo self::$nl . ' . time() as date: ' . date('Y-m-d H:i a');
-            echo self::$nl . ' . session expiration: ' . $session_lifespan->expiration();
-            echo self::$nl . ' . session expiration as date: ' . date('Y-m-d H:i a', $session_lifespan->expiration());
-            echo self::$nl . ' . timestamp: ' . $timestamp;
-            echo self::$nl . ' . $expired_ticket_line_items: ' . count($expired_ticket_line_items);
-        }
-        if (! empty($expired_ticket_line_items)) {
-            foreach ($expired_ticket_line_items as $expired_ticket_line_item) {
-                if (! $expired_ticket_line_item instanceof EE_Line_Item) {
-                    continue;
-                }
-                $expired_ticket_IDs[ $expired_ticket_line_item->OBJ_ID() ] = $expired_ticket_line_item->OBJ_ID();
-                if (self::debug) {
-                    echo self::$nl . ' . $expired_ticket_line_item->OBJ_ID(): ' . $expired_ticket_line_item->OBJ_ID();
-                    echo self::$nl . ' . $expired_ticket_line_item->timestamp(): ' . date('Y-m-d h:i a',
-                            $expired_ticket_line_item->timestamp(true));
-                }
-            }
-            if (! empty($expired_ticket_IDs)) {
-                EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-                    \EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
-                    array(),
-                    __FUNCTION__
-                );
-                // now  let's get rid of expired line items so that they can't interfere with tracking
-                EED_Ticket_Sales_Monitor::clear_expired_line_items_with_no_transaction($timestamp);
-            }
-        }
-        do_action(
-            'AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__end',
-            $expired_ticket_IDs,
-            $expired_ticket_line_items
-        );
-    }
-
-
-
-    /********************************** VALIDATE_TICKET_SALE  **********************************/
-
-
-
-    /**
-     * callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
-     *
-     * @param int       $qty
-     * @param EE_Ticket $ticket
-     * @return bool
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
-    {
-        $qty = absint($qty);
-        if ($qty > 0) {
-            $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
-        }
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-            echo self::$nl . self::$nl . '<b> RETURNED QTY: ' . $qty . '</b>';
-        }
-        return $qty;
-    }
-
-
-
-    /**
-     * checks whether an individual ticket is available for purchase based on datetime, and ticket details
-     *
-     * @param   EE_Ticket $ticket
-     * @param int         $qty
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        if (! $ticket instanceof EE_Ticket) {
-            return 0;
-        }
-        if (self::debug) {
-            echo self::$nl . '<b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo self::$nl . ' . original ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->refresh_from_db();
-        // first let's determine the ticket availability based on sales
-        $available = $ticket->qty('saleable');
-        if (self::debug) {
-            echo self::$nl . ' . . . ticket->qty: ' . $ticket->qty();
-            echo self::$nl . ' . . . ticket->sold: ' . $ticket->sold();
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
-            echo self::$nl . ' . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo self::$nl . ' . . . available: ' . $available;
-        }
-        if ($available < 1) {
-            $this->_ticket_sold_out($ticket);
-            return 0;
-        }
-        if (self::debug) {
-            echo self::$nl . ' . . . qty: ' . $qty;
-        }
-        if ($available < $qty) {
-            $qty = $available;
-            if (self::debug) {
-                echo self::$nl . ' . . . QTY ADJUSTED: ' . $qty;
-            }
-            $this->_ticket_quantity_decremented($ticket);
-        }
-        $this->_reserve_ticket($ticket, $qty);
-        return $qty;
-    }
-
-
-
-    /**
-     * increments ticket reserved based on quantity passed
-     *
-     * @param    EE_Ticket $ticket
-     * @param int          $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . ' . . . INCREASE RESERVED: ' . $quantity;
-        }
-        $ticket->increase_reserved($quantity, 'TicketSalesMonitor:'. __LINE__);
-        return $ticket->save();
-    }
-
-
-
-    /**
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
-    {
-        if (self::debug) {
-            echo self::$nl . ' . . . ticket->ID: ' . $ticket->ID();
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
-        }
-        $ticket->decrease_reserved($quantity, true, 'TicketSalesMonitor:'. __LINE__);
-        if (self::debug) {
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
-        }
-        return $ticket->save() ? 1 : 0;
-    }
-
-
-
-    /**
-     * removes quantities within the ticket selector based on zero ticket availability
-     *
-     * @param    EE_Ticket $ticket
-     * @return    void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_sold_out(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-
-    /**
-     * adjusts quantities within the ticket selector based on decreased ticket availability
-     *
-     * @param    EE_Ticket $ticket
-     * @return void
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _ticket_quantity_decremented(EE_Ticket $ticket)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
-        }
-        $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
-    }
-
-
-
-    /**
-     * builds string out of ticket and event name
-     *
-     * @param    EE_Ticket $ticket
-     * @return string
-     * @throws UnexpectedEntityException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_and_event_name(EE_Ticket $ticket)
-    {
-        $event = $ticket->get_related_event();
-        if ($event instanceof EE_Event) {
-            $ticket_name = sprintf(
-                _x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
-                $ticket->name(),
-                $event->name()
-            );
-        } else {
-            $ticket_name = $ticket->name();
-        }
-        return $ticket_name;
-    }
-
-
-
-    /********************************** EVENT CART  **********************************/
-
-
-
-    /**
-     * releases or reserves ticket(s) based on quantity passed
-     *
-     * @param  EE_Line_Item $line_item
-     * @param  int          $quantity
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
-    {
-        $ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
-        if ($ticket instanceof EE_Ticket) {
-            $ticket->add_extra_meta(
-                EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                __LINE__ . ') ' . __METHOD__ . '()'
-            );
-            if ($quantity > 0) {
-                EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
-            } else {
-                EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-            }
-        }
-    }
-
-
-
-    /**
-     * releases reserved ticket(s) based on quantity passed
-     *
-     * @param  EE_Ticket $ticket
-     * @param  int       $quantity
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
-    {
-        $ticket->add_extra_meta(
-            EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-            __LINE__ . ') ' . __METHOD__ . '()'
-        );
-        EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
-    }
-
-
-
-    /********************************** POST_NOTICES  **********************************/
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function post_notices()
-    {
-        EED_Ticket_Sales_Monitor::instance()->_post_notices();
-    }
-
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _post_notices()
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        $refresh_msg    = '';
-        $none_added_msg = '';
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $refresh_msg    = __(
-                'Please refresh the page to view updated ticket quantities.',
-                'event_espresso'
-            );
-            $none_added_msg = __('No tickets were added for the event.', 'event_espresso');
-        }
-        if (! empty($this->sold_out_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
-                        __(
-                            'We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso'
-                        )
-                    ),
-                    '<br />',
-                    implode('<br />', $this->sold_out_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            // alter code flow in the Ticket Selector for better UX
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
-            add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
-            $this->sold_out_tickets = array();
-            // and reset the cart
-            EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
-        }
-        if (! empty($this->decremented_tickets)) {
-            EE_Error::add_attention(
-                sprintf(
-                    apply_filters(
-                        'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
-                        __(
-                            'We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
-                            'event_espresso'
-                        )
-                    ),
-                    '<br />',
-                    implode('<br />', $this->decremented_tickets),
-                    $none_added_msg,
-                    $refresh_msg
-                )
-            );
-            $this->decremented_tickets = array();
-        }
-    }
-
-
-
-    /********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
-
-
-
-    /**
-     * releases reserved tickets for all registrations of an EE_Transaction
-     * by default, will NOT release tickets for finalized transactions
-     *
-     * @param    EE_Transaction $transaction
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . transaction->ID: ' . $transaction->ID();
-            echo self::$nl . ' . TXN status_ID: ' . $transaction->status_ID();
-        }
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        if (self::debug) {
-            // DEBUG LOG
-            EEH_Debug_Tools::log(
-                __CLASS__,
-                __FUNCTION__,
-                __LINE__,
-                array('finalized' => $finalized),
-                false,
-                'EE_Transaction: ' . $transaction->ID()
-            );
-        }
-        // how many tickets were released
-        $count = 0;
-        if (self::debug) {
-            echo self::$nl . ' . . . TXN finalized: ' . $finalized;
-        }
-        $release_tickets_with_TXN_status = array(
-            EEM_Transaction::failed_status_code,
-            EEM_Transaction::abandoned_status_code,
-            EEM_Transaction::incomplete_status_code,
-        );
-        $events = array();
-        // if the session is getting cleared BEFORE the TXN has been finalized or the transaction is not completed
-        if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
-            // cancel any reserved tickets for registrations that were not approved
-            $registrations = $transaction->registrations();
-            if (self::debug) {
-                echo self::$nl . ' . . . # registrations: ' . count($registrations);
-                $reg    = reset($registrations);
-                $ticket = $reg->ticket();
-                if ($ticket instanceof EE_Ticket) {
-                    $ticket->add_extra_meta(
-                        EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') Release All Tickets TXN:' . $transaction->ID()
-                    );
-                }
-            }
-            if (! empty($registrations)) {
-                foreach ($registrations as $registration) {
-                    if (
-                        $registration instanceof EE_Registration
-                        && $this->_release_reserved_ticket_for_registration($registration, $transaction)
-                    ) {
-                        $count++;
-                        $events[ $registration->event_ID() ] = $registration->event();
-                    }
-                }
-            }
-        }
-        if ($events !== array()) {
-            foreach ($events as $event) {
-                /** @var EE_Event $event */
-                $event->perform_sold_out_status_check();
-            }
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * releases reserved tickets for an EE_Registration
-     * by default, will NOT release tickets for APPROVED registrations
-     *
-     * @param EE_Registration $registration
-     * @param EE_Transaction  $transaction
-     * @return int
-     * @throws EE_Error
-     */
-    protected function _release_reserved_ticket_for_registration(
-        EE_Registration $registration,
-        EE_Transaction $transaction
-    ) {
-        $STS_ID = $transaction->status_ID();
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . registration->ID: ' . $registration->ID();
-            echo self::$nl . ' . . registration->status_ID: ' . $registration->status_ID();
-            echo self::$nl . ' . . transaction->status_ID(): ' . $STS_ID;
-        }
-        if (
-            // release Tickets for Failed Transactions and Abandoned Transactions
-            $STS_ID === EEM_Transaction::failed_status_code
-            || $STS_ID === EEM_Transaction::abandoned_status_code
-            || (
-                // also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
-                $STS_ID === EEM_Transaction::incomplete_status_code
-                && $registration->status_ID() !== EEM_Registration::status_id_approved
-            )
-        ) {
-            if (self::debug) {
-                echo self::$nl . self::$nl . ' . . RELEASE RESERVED TICKET';
-                $rsrvd = $registration->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
-                echo self::$nl . ' . . . registration HAS_RESERVED_TICKET_KEY: ';
-                var_dump($rsrvd);
-            }
-            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:'. __LINE__);
-            return 1;
-        }
-        return 0;
-    }
-
-
-
-    /********************************** SESSION_CART_RESET  **********************************/
-
-
-
-    /**
-     * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
-     *
-     * @param EE_Session $session
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function session_cart_reset(EE_Session $session)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        // first check of the session has a valid Checkout object
-        $checkout = $session->checkout();
-        if ($checkout instanceof EE_Checkout) {
-            // and use that to clear ticket reservations because it will update the associated registration meta data
-            EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
-            return;
-        }
-        $cart = $session->cart();
-        if ($cart instanceof EE_Cart) {
-            if (self::debug) {
-                echo self::$nl . self::$nl . ' cart instance of EE_Cart: ';
-            }
-            EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart, $session);
-        } else {
-            if (self::debug) {
-                echo self::$nl . self::$nl . ' invalid EE_Cart: ';
-                var_export($cart, true);
-            }
-        }
-    }
-
-
-
-    /**
-     * releases reserved tickets in the EE_Cart
-     *
-     * @param EE_Cart $cart
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _session_cart_reset(EE_Cart $cart, EE_Session $session)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        EE_Registry::instance()->load_helper('Line_Item');
-        $ticket_line_items = $cart->get_tickets();
-        if (empty($ticket_line_items)) {
-            return;
-        }
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (self::debug) {
-                echo self::$nl . ' . ticket_line_item->ID(): ' . $ticket_line_item->ID();
-            }
-            if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
-                if (self::debug) {
-                    echo self::$nl . ' . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
-                }
-                $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
-                if ($ticket instanceof EE_Ticket) {
-                    if (self::debug) {
-                        echo self::$nl . ' . . ticket->ID(): ' . $ticket->ID();
-                        echo self::$nl . ' . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
-                    }
-                    $ticket->add_extra_meta(
-                        EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') ' . __METHOD__ . '() SID = ' . $session->id()
-                    );
-                    $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
-                }
-            }
-        }
-        if (self::debug) {
-            echo self::$nl . self::$nl . ' RESET COMPLETED ';
-        }
-    }
-
-
-
-    /********************************** SESSION_CHECKOUT_RESET  **********************************/
-
-
-
-    /**
-     * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
-     *
-     * @param EE_Session $session
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    public static function session_checkout_reset(EE_Session $session)
-    {
-        $checkout = $session->checkout();
-        if ($checkout instanceof EE_Checkout) {
-            EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
-        }
-    }
-
-
-
-    /**
-     * releases reserved tickets for the EE_Checkout->transaction
-     *
-     * @param EE_Checkout $checkout
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    protected function _session_checkout_reset(EE_Checkout $checkout)
-    {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-        }
-        // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
-        if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
-            return;
-        }
-        $this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
-    }
-
-
-
-    /********************************** SESSION_EXPIRED_RESET  **********************************/
-
-
-
-    /**
-     * @param    EE_Session $session
-     * @return    void
-     */
-    public static function session_expired_reset(EE_Session $session)
-    {
-    }
-
-
-
-    /********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
-
-
-
-    /**
-     * releases reserved tickets for all registrations of an ABANDONED EE_Transaction
-     * by default, will NOT release tickets for free transactions, or any that have received a payment
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    public static function process_abandoned_transactions(EE_Transaction $transaction)
-    {
-        // is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
-        if ($transaction->is_free() || $transaction->paid() > 0) {
-            if (self::debug) {
-                // DEBUG LOG
-                EEH_Debug_Tools::log(
-                    __CLASS__,
-                    __FUNCTION__,
-                    __LINE__,
-                    array($transaction),
-                    false,
-                    'EE_Transaction: ' . $transaction->ID()
-                );
-            }
-            return;
-        }
-        // have their been any successful payments made ?
-        $payments = $transaction->payments();
-        foreach ($payments as $payment) {
-            if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
-                if (self::debug) {
-                    // DEBUG LOG
-                    EEH_Debug_Tools::log(
-                        __CLASS__,
-                        __FUNCTION__,
-                        __LINE__,
-                        array($payment),
-                        false,
-                        'EE_Transaction: ' . $transaction->ID()
-                    );
-                }
-                return;
-            }
-        }
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
-
-
-
-    /**
-     * releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidSessionDataException
-     */
-    public static function process_failed_transactions(EE_Transaction $transaction)
-    {
-        // since you haven't even attempted to pay for your ticket...
-        EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
-    }
-
-
-
-    /********************************** RESET RESERVATION COUNTS  *********************************/
-
-
-
-    /**
-     * Resets all ticket and datetime reserved counts to zero
-     * Tickets that are currently associated with a Transaction that is in progress
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws UnexpectedEntityException
-     */
-    public static function reset_reservation_counts()
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        /** @var EE_Transaction[] $transactions_not_in_progress */
-        $transactions_not_in_progress = EEM_Transaction::instance()->get_transactions_not_in_progress();
-        foreach ($transactions_not_in_progress as $transaction) {
-            // if this TXN has been fully completed, then skip it
-            if ($transaction->reg_step_completed('finalize_registration')) {
-                continue;
-            }
-            $total_line_item = $transaction->total_line_item();
-            // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
-                throw new DomainException(
-                    esc_html__(
-                        'Transaction does not have a valid Total Line Item associated with it.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        $total_line_items = EEM_Line_Item::instance()->get_total_line_items_for_active_carts();
-        foreach ($total_line_items as $total_line_item) {
-            $valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
-                $total_line_item
-            );
-        }
-        $tickets_with_reservations = EEM_Ticket::instance()->get_tickets_with_reservations();
-        return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
-            $tickets_with_reservations,
-            $valid_reserved_tickets,
-            __FUNCTION__
-        );
-    }
-
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @return EE_Line_Item[]
-     */
-    private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
-    {
-        /** @var EE_Line_Item[] $valid_reserved_tickets */
-        $valid_reserved_tickets = array();
-        $ticket_line_items      = EEH_Line_Item::get_ticket_line_items($total_line_item);
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if ($ticket_line_item instanceof EE_Line_Item) {
-                $valid_reserved_tickets[] = $ticket_line_item;
-            }
-        }
-        return $valid_reserved_tickets;
-    }
-
-
-
-    /**
-     * @param EE_Ticket[]    $tickets_with_reservations
-     * @param EE_Line_Item[] $valid_reserved_ticket_line_items
-     * @return int
-     * @throws UnexpectedEntityException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    private static function release_reservations_for_tickets(
-        array $tickets_with_reservations,
-        array $valid_reserved_ticket_line_items = array(),
-        $source
-    ) {
-        if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-        }
-        $total_tickets_released = 0;
-        $sold_out_events = array();
-        foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
-                continue;
-            }
-            $reserved_qty = $ticket_with_reservations->reserved();
-            if (self::debug) {
-                echo self::$nl . ' . $ticket_with_reservations->ID(): ' . $ticket_with_reservations->ID();
-                echo self::$nl . ' . $reserved_qty: ' . $reserved_qty;
-            }
-            foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
-                if (
-                    $valid_reserved_ticket_line_item instanceof EE_Line_Item
-                    && $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
-                ) {
-                    if (self::debug) {
-                        echo self::$nl . ' . $valid_reserved_ticket_line_item->quantity(): ' . $valid_reserved_ticket_line_item->quantity();
-                    }
-                    $reserved_qty -= $valid_reserved_ticket_line_item->quantity();
-                }
-            }
-            if ($reserved_qty > 0) {
-                $ticket_with_reservations->add_extra_meta(
-                    EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                    __LINE__ . ') ' . $source . '()'
-                );
-                $ticket_with_reservations->decrease_reserved($reserved_qty, true, 'TicketSalesMonitor:'. __LINE__);
-                $ticket_with_reservations->save();
-                $total_tickets_released += $reserved_qty;
-                $event = $ticket_with_reservations->get_related_event();
-                // track sold out events
-                if ($event instanceof EE_Event && $event->is_sold_out()) {
-                    $sold_out_events[] = $event;
-                }
-            }
-        }
-        if (self::debug) {
-            echo self::$nl . ' . $total_tickets_released: ' . $total_tickets_released;
-        }
-        // double check whether sold out events should remain sold out after releasing tickets
-        if($sold_out_events !== array()){
-            foreach ($sold_out_events as $sold_out_event) {
-                /** @var EE_Event $sold_out_event */
-                $sold_out_event->perform_sold_out_status_check();
-            }
-        }
-        return $total_tickets_released;
-    }
-
-
-
-    /********************************** SHUTDOWN  **********************************/
-
-
-
-    /**
-     * @param int $timestamp
-     * @return false|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function clear_expired_line_items_with_no_transaction($timestamp = 0)
-    {
-       /** @type WPDB $wpdb */
-        global $wpdb;
-        if (! absint($timestamp)) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $timestamp = $session_lifespan->expiration();
-        }
-         return $wpdb->query(
-            $wpdb->prepare(
-                'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
+	const debug = false;    //	true false
+
+	private static $nl = '';
+
+	/**
+	 * an array of raw ticket data from EED_Ticket_Selector
+	 *
+	 * @var array $ticket_selections
+	 */
+	protected $ticket_selections = array();
+
+	/**
+	 * the raw ticket data from EED_Ticket_Selector is organized in rows
+	 * according to how they are displayed in the actual Ticket_Selector
+	 * this tracks the current row being processed
+	 *
+	 * @var int $current_row
+	 */
+	protected $current_row = 0;
+
+	/**
+	 * an array for tracking names of tickets that have sold out
+	 *
+	 * @var array $sold_out_tickets
+	 */
+	protected $sold_out_tickets = array();
+
+	/**
+	 * an array for tracking names of tickets that have had their quantities reduced
+	 *
+	 * @var array $decremented_tickets
+	 */
+	protected $decremented_tickets = array();
+
+
+
+	/**
+	 * set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		self::$nl = defined('EE_TESTS_DIR')? "\n" : '<br />';
+		// release tickets for expired carts
+		add_action(
+			'EED_Ticket_Selector__process_ticket_selections__before',
+			array('EED_Ticket_Sales_Monitor', 'release_tickets_for_expired_carts'),
+			1
+		);
+		// check ticket reserves AFTER MER does it's check (hence priority 20)
+		add_filter(
+			'FHEE__EE_Ticket_Selector___add_ticket_to_cart__ticket_qty',
+			array('EED_Ticket_Sales_Monitor', 'validate_ticket_sale'),
+			20,
+			3
+		);
+		// add notices for sold out tickets
+		add_action(
+			'AHEE__EE_Ticket_Selector__process_ticket_selections__after_tickets_added_to_cart',
+			array('EED_Ticket_Sales_Monitor', 'post_notices'),
+			10
+		);
+		// handle ticket quantities adjusted in cart
+		//add_action(
+		//	'FHEE__EED_Multi_Event_Registration__adjust_line_item_quantity__line_item_quantity_updated',
+		//	array( 'EED_Ticket_Sales_Monitor', 'ticket_quantity_updated' ),
+		//	10, 2
+		//);
+		// handle tickets deleted from cart
+		add_action(
+			'FHEE__EED_Multi_Event_Registration__delete_ticket__ticket_removed_from_cart',
+			array('EED_Ticket_Sales_Monitor', 'ticket_removed_from_cart'),
+			10,
+			2
+		);
+		// handle emptied carts
+		add_action(
+			'AHEE__EE_Session__reset_cart__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EED_Multi_Event_Registration__empty_event_cart__before_delete_cart',
+			array('EED_Ticket_Sales_Monitor', 'session_cart_reset'),
+			10,
+			1
+		);
+		// handle cancelled registrations
+		add_action(
+			'AHEE__EE_Session__reset_checkout__before_reset',
+			array('EED_Ticket_Sales_Monitor', 'session_checkout_reset'),
+			10,
+			1
+		);
+		// cron tasks
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_abandoned_transactions'),
+			10,
+			1
+		);
+		add_action(
+			'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+			array('EED_Ticket_Sales_Monitor', 'process_failed_transactions'),
+			10,
+			1
+		);
+	}
+
+
+
+	/**
+	 * set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Ticket_Sales_Monitor::set_hooks();
+	}
+
+
+
+	/**
+	 * @return EED_Ticket_Sales_Monitor|EED_Module
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 * @param WP_Query $WP_Query
+	 * @return    void
+	 */
+	public function run($WP_Query)
+	{
+	}
+
+
+
+	/********************************** PRE_TICKET_SALES  **********************************/
+
+
+
+	/**
+	 * Retrieves grand totals from the line items that have no TXN ID
+	 * and timestamps less than the current time minus the session lifespan.
+	 * These are carts that have been abandoned before the "registrant" even attempted to checkout.
+	 * We're going to release the tickets for these line items before attempting to add more to the cart.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 */
+	public static function release_tickets_for_expired_carts()
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+		}
+		do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
+		$expired_ticket_IDs = array();
+		/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+		$session_lifespan = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\values\session\SessionLifespan'
+		);
+		$timestamp = $session_lifespan->expiration();
+		$expired_ticket_line_items = EEM_Line_Item::instance()->getTicketLineItemsForExpiredCarts($timestamp);
+		if (self::debug) {
+			echo self::$nl . ' . time(): ' . time();
+			echo self::$nl . ' . time() as date: ' . date('Y-m-d H:i a');
+			echo self::$nl . ' . session expiration: ' . $session_lifespan->expiration();
+			echo self::$nl . ' . session expiration as date: ' . date('Y-m-d H:i a', $session_lifespan->expiration());
+			echo self::$nl . ' . timestamp: ' . $timestamp;
+			echo self::$nl . ' . $expired_ticket_line_items: ' . count($expired_ticket_line_items);
+		}
+		if (! empty($expired_ticket_line_items)) {
+			foreach ($expired_ticket_line_items as $expired_ticket_line_item) {
+				if (! $expired_ticket_line_item instanceof EE_Line_Item) {
+					continue;
+				}
+				$expired_ticket_IDs[ $expired_ticket_line_item->OBJ_ID() ] = $expired_ticket_line_item->OBJ_ID();
+				if (self::debug) {
+					echo self::$nl . ' . $expired_ticket_line_item->OBJ_ID(): ' . $expired_ticket_line_item->OBJ_ID();
+					echo self::$nl . ' . $expired_ticket_line_item->timestamp(): ' . date('Y-m-d h:i a',
+							$expired_ticket_line_item->timestamp(true));
+				}
+			}
+			if (! empty($expired_ticket_IDs)) {
+				EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+					\EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
+					array(),
+					__FUNCTION__
+				);
+				// now  let's get rid of expired line items so that they can't interfere with tracking
+				EED_Ticket_Sales_Monitor::clear_expired_line_items_with_no_transaction($timestamp);
+			}
+		}
+		do_action(
+			'AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__end',
+			$expired_ticket_IDs,
+			$expired_ticket_line_items
+		);
+	}
+
+
+
+	/********************************** VALIDATE_TICKET_SALE  **********************************/
+
+
+
+	/**
+	 * callback for 'FHEE__EED_Ticket_Selector__process_ticket_selections__valid_post_data'
+	 *
+	 * @param int       $qty
+	 * @param EE_Ticket $ticket
+	 * @return bool
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	public static function validate_ticket_sale($qty = 1, EE_Ticket $ticket)
+	{
+		$qty = absint($qty);
+		if ($qty > 0) {
+			$qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
+		}
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+			echo self::$nl . self::$nl . '<b> RETURNED QTY: ' . $qty . '</b>';
+		}
+		return $qty;
+	}
+
+
+
+	/**
+	 * checks whether an individual ticket is available for purchase based on datetime, and ticket details
+	 *
+	 * @param   EE_Ticket $ticket
+	 * @param int         $qty
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		if (! $ticket instanceof EE_Ticket) {
+			return 0;
+		}
+		if (self::debug) {
+			echo self::$nl . '<b> . ticket->ID: ' . $ticket->ID() . '</b>';
+			echo self::$nl . ' . original ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->refresh_from_db();
+		// first let's determine the ticket availability based on sales
+		$available = $ticket->qty('saleable');
+		if (self::debug) {
+			echo self::$nl . ' . . . ticket->qty: ' . $ticket->qty();
+			echo self::$nl . ' . . . ticket->sold: ' . $ticket->sold();
+			echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
+			echo self::$nl . ' . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
+			echo self::$nl . ' . . . available: ' . $available;
+		}
+		if ($available < 1) {
+			$this->_ticket_sold_out($ticket);
+			return 0;
+		}
+		if (self::debug) {
+			echo self::$nl . ' . . . qty: ' . $qty;
+		}
+		if ($available < $qty) {
+			$qty = $available;
+			if (self::debug) {
+				echo self::$nl . ' . . . QTY ADJUSTED: ' . $qty;
+			}
+			$this->_ticket_quantity_decremented($ticket);
+		}
+		$this->_reserve_ticket($ticket, $qty);
+		return $qty;
+	}
+
+
+
+	/**
+	 * increments ticket reserved based on quantity passed
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @param int          $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . ' . . . INCREASE RESERVED: ' . $quantity;
+		}
+		$ticket->increase_reserved($quantity, 'TicketSalesMonitor:'. __LINE__);
+		return $ticket->save();
+	}
+
+
+
+	/**
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
+	{
+		if (self::debug) {
+			echo self::$nl . ' . . . ticket->ID: ' . $ticket->ID();
+			echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
+		}
+		$ticket->decrease_reserved($quantity, true, 'TicketSalesMonitor:'. __LINE__);
+		if (self::debug) {
+			echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
+		}
+		return $ticket->save() ? 1 : 0;
+	}
+
+
+
+	/**
+	 * removes quantities within the ticket selector based on zero ticket availability
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return    void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_sold_out(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+
+	/**
+	 * adjusts quantities within the ticket selector based on decreased ticket availability
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return void
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _ticket_quantity_decremented(EE_Ticket $ticket)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+		}
+		$this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
+	}
+
+
+
+	/**
+	 * builds string out of ticket and event name
+	 *
+	 * @param    EE_Ticket $ticket
+	 * @return string
+	 * @throws UnexpectedEntityException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_and_event_name(EE_Ticket $ticket)
+	{
+		$event = $ticket->get_related_event();
+		if ($event instanceof EE_Event) {
+			$ticket_name = sprintf(
+				_x('%1$s for %2$s', 'ticket name for event name', 'event_espresso'),
+				$ticket->name(),
+				$event->name()
+			);
+		} else {
+			$ticket_name = $ticket->name();
+		}
+		return $ticket_name;
+	}
+
+
+
+	/********************************** EVENT CART  **********************************/
+
+
+
+	/**
+	 * releases or reserves ticket(s) based on quantity passed
+	 *
+	 * @param  EE_Line_Item $line_item
+	 * @param  int          $quantity
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function ticket_quantity_updated(EE_Line_Item $line_item, $quantity = 1)
+	{
+		$ticket = EEM_Ticket::instance()->get_one_by_ID(absint($line_item->OBJ_ID()));
+		if ($ticket instanceof EE_Ticket) {
+			$ticket->add_extra_meta(
+				EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+				__LINE__ . ') ' . __METHOD__ . '()'
+			);
+			if ($quantity > 0) {
+				EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
+			} else {
+				EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+			}
+		}
+	}
+
+
+
+	/**
+	 * releases reserved ticket(s) based on quantity passed
+	 *
+	 * @param  EE_Ticket $ticket
+	 * @param  int       $quantity
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ticket_removed_from_cart(EE_Ticket $ticket, $quantity = 1)
+	{
+		$ticket->add_extra_meta(
+			EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+			__LINE__ . ') ' . __METHOD__ . '()'
+		);
+		EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
+	}
+
+
+
+	/********************************** POST_NOTICES  **********************************/
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function post_notices()
+	{
+		EED_Ticket_Sales_Monitor::instance()->_post_notices();
+	}
+
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _post_notices()
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		$refresh_msg    = '';
+		$none_added_msg = '';
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$refresh_msg    = __(
+				'Please refresh the page to view updated ticket quantities.',
+				'event_espresso'
+			);
+			$none_added_msg = __('No tickets were added for the event.', 'event_espresso');
+		}
+		if (! empty($this->sold_out_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___post_notices__sold_out_tickets_notice',
+						__(
+							'We\'re sorry...%1$sThe following items have sold out since you first viewed this page, and can no longer be registered for:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso'
+						)
+					),
+					'<br />',
+					implode('<br />', $this->sold_out_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			// alter code flow in the Ticket Selector for better UX
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__tckts_slctd', '__return_true');
+			add_filter('FHEE__EED_Ticket_Selector__process_ticket_selections__success', '__return_false');
+			$this->sold_out_tickets = array();
+			// and reset the cart
+			EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
+		}
+		if (! empty($this->decremented_tickets)) {
+			EE_Error::add_attention(
+				sprintf(
+					apply_filters(
+						'FHEE__EED_Ticket_Sales_Monitor___ticket_quantity_decremented__notice',
+						__(
+							'We\'re sorry...%1$sDue to sales that have occurred since you first viewed the last page, the following items have had their quantities adjusted to match the current available amount:%1$s%1$s%2$s%1$s%1$sPlease note that availability can change at any time due to cancellations, so please check back again later if registration for this event(s) is important to you.%1$s%1$s%3$s%1$s%4$s%1$s',
+							'event_espresso'
+						)
+					),
+					'<br />',
+					implode('<br />', $this->decremented_tickets),
+					$none_added_msg,
+					$refresh_msg
+				)
+			);
+			$this->decremented_tickets = array();
+		}
+	}
+
+
+
+	/********************************** RELEASE_ALL_RESERVED_TICKETS_FOR_TRANSACTION  **********************************/
+
+
+
+	/**
+	 * releases reserved tickets for all registrations of an EE_Transaction
+	 * by default, will NOT release tickets for finalized transactions
+	 *
+	 * @param    EE_Transaction $transaction
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . transaction->ID: ' . $transaction->ID();
+			echo self::$nl . ' . TXN status_ID: ' . $transaction->status_ID();
+		}
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		if (self::debug) {
+			// DEBUG LOG
+			EEH_Debug_Tools::log(
+				__CLASS__,
+				__FUNCTION__,
+				__LINE__,
+				array('finalized' => $finalized),
+				false,
+				'EE_Transaction: ' . $transaction->ID()
+			);
+		}
+		// how many tickets were released
+		$count = 0;
+		if (self::debug) {
+			echo self::$nl . ' . . . TXN finalized: ' . $finalized;
+		}
+		$release_tickets_with_TXN_status = array(
+			EEM_Transaction::failed_status_code,
+			EEM_Transaction::abandoned_status_code,
+			EEM_Transaction::incomplete_status_code,
+		);
+		$events = array();
+		// if the session is getting cleared BEFORE the TXN has been finalized or the transaction is not completed
+		if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+			// cancel any reserved tickets for registrations that were not approved
+			$registrations = $transaction->registrations();
+			if (self::debug) {
+				echo self::$nl . ' . . . # registrations: ' . count($registrations);
+				$reg    = reset($registrations);
+				$ticket = $reg->ticket();
+				if ($ticket instanceof EE_Ticket) {
+					$ticket->add_extra_meta(
+						EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+						__LINE__ . ') Release All Tickets TXN:' . $transaction->ID()
+					);
+				}
+			}
+			if (! empty($registrations)) {
+				foreach ($registrations as $registration) {
+					if (
+						$registration instanceof EE_Registration
+						&& $this->_release_reserved_ticket_for_registration($registration, $transaction)
+					) {
+						$count++;
+						$events[ $registration->event_ID() ] = $registration->event();
+					}
+				}
+			}
+		}
+		if ($events !== array()) {
+			foreach ($events as $event) {
+				/** @var EE_Event $event */
+				$event->perform_sold_out_status_check();
+			}
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * releases reserved tickets for an EE_Registration
+	 * by default, will NOT release tickets for APPROVED registrations
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Transaction  $transaction
+	 * @return int
+	 * @throws EE_Error
+	 */
+	protected function _release_reserved_ticket_for_registration(
+		EE_Registration $registration,
+		EE_Transaction $transaction
+	) {
+		$STS_ID = $transaction->status_ID();
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+			echo self::$nl . ' . . registration->ID: ' . $registration->ID();
+			echo self::$nl . ' . . registration->status_ID: ' . $registration->status_ID();
+			echo self::$nl . ' . . transaction->status_ID(): ' . $STS_ID;
+		}
+		if (
+			// release Tickets for Failed Transactions and Abandoned Transactions
+			$STS_ID === EEM_Transaction::failed_status_code
+			|| $STS_ID === EEM_Transaction::abandoned_status_code
+			|| (
+				// also release Tickets for Incomplete Transactions, but ONLY if the Registrations are NOT Approved
+				$STS_ID === EEM_Transaction::incomplete_status_code
+				&& $registration->status_ID() !== EEM_Registration::status_id_approved
+			)
+		) {
+			if (self::debug) {
+				echo self::$nl . self::$nl . ' . . RELEASE RESERVED TICKET';
+				$rsrvd = $registration->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
+				echo self::$nl . ' . . . registration HAS_RESERVED_TICKET_KEY: ';
+				var_dump($rsrvd);
+			}
+			$registration->release_reserved_ticket(true, 'TicketSalesMonitor:'. __LINE__);
+			return 1;
+		}
+		return 0;
+	}
+
+
+
+	/********************************** SESSION_CART_RESET  **********************************/
+
+
+
+	/**
+	 * callback hooked into 'AHEE__EE_Session__reset_cart__before_reset'
+	 *
+	 * @param EE_Session $session
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function session_cart_reset(EE_Session $session)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		// first check of the session has a valid Checkout object
+		$checkout = $session->checkout();
+		if ($checkout instanceof EE_Checkout) {
+			// and use that to clear ticket reservations because it will update the associated registration meta data
+			EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
+			return;
+		}
+		$cart = $session->cart();
+		if ($cart instanceof EE_Cart) {
+			if (self::debug) {
+				echo self::$nl . self::$nl . ' cart instance of EE_Cart: ';
+			}
+			EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart, $session);
+		} else {
+			if (self::debug) {
+				echo self::$nl . self::$nl . ' invalid EE_Cart: ';
+				var_export($cart, true);
+			}
+		}
+	}
+
+
+
+	/**
+	 * releases reserved tickets in the EE_Cart
+	 *
+	 * @param EE_Cart $cart
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _session_cart_reset(EE_Cart $cart, EE_Session $session)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		EE_Registry::instance()->load_helper('Line_Item');
+		$ticket_line_items = $cart->get_tickets();
+		if (empty($ticket_line_items)) {
+			return;
+		}
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (self::debug) {
+				echo self::$nl . ' . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+			}
+			if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
+				if (self::debug) {
+					echo self::$nl . ' . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+				}
+				$ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
+				if ($ticket instanceof EE_Ticket) {
+					if (self::debug) {
+						echo self::$nl . ' . . ticket->ID(): ' . $ticket->ID();
+						echo self::$nl . ' . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+					}
+					$ticket->add_extra_meta(
+						EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+						__LINE__ . ') ' . __METHOD__ . '() SID = ' . $session->id()
+					);
+					$this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
+				}
+			}
+		}
+		if (self::debug) {
+			echo self::$nl . self::$nl . ' RESET COMPLETED ';
+		}
+	}
+
+
+
+	/********************************** SESSION_CHECKOUT_RESET  **********************************/
+
+
+
+	/**
+	 * callback hooked into 'AHEE__EE_Session__reset_checkout__before_reset'
+	 *
+	 * @param EE_Session $session
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	public static function session_checkout_reset(EE_Session $session)
+	{
+		$checkout = $session->checkout();
+		if ($checkout instanceof EE_Checkout) {
+			EED_Ticket_Sales_Monitor::instance()->_session_checkout_reset($checkout);
+		}
+	}
+
+
+
+	/**
+	 * releases reserved tickets for the EE_Checkout->transaction
+	 *
+	 * @param EE_Checkout $checkout
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	protected function _session_checkout_reset(EE_Checkout $checkout)
+	{
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+		}
+		// we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
+		if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
+			return;
+		}
+		$this->_release_all_reserved_tickets_for_transaction($checkout->transaction);
+	}
+
+
+
+	/********************************** SESSION_EXPIRED_RESET  **********************************/
+
+
+
+	/**
+	 * @param    EE_Session $session
+	 * @return    void
+	 */
+	public static function session_expired_reset(EE_Session $session)
+	{
+	}
+
+
+
+	/********************************** PROCESS_ABANDONED_TRANSACTIONS  **********************************/
+
+
+
+	/**
+	 * releases reserved tickets for all registrations of an ABANDONED EE_Transaction
+	 * by default, will NOT release tickets for free transactions, or any that have received a payment
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	public static function process_abandoned_transactions(EE_Transaction $transaction)
+	{
+		// is this TXN free or has any money been paid towards this TXN? If so, then leave it alone
+		if ($transaction->is_free() || $transaction->paid() > 0) {
+			if (self::debug) {
+				// DEBUG LOG
+				EEH_Debug_Tools::log(
+					__CLASS__,
+					__FUNCTION__,
+					__LINE__,
+					array($transaction),
+					false,
+					'EE_Transaction: ' . $transaction->ID()
+				);
+			}
+			return;
+		}
+		// have their been any successful payments made ?
+		$payments = $transaction->payments();
+		foreach ($payments as $payment) {
+			if ($payment instanceof EE_Payment && $payment->status() === EEM_Payment::status_id_approved) {
+				if (self::debug) {
+					// DEBUG LOG
+					EEH_Debug_Tools::log(
+						__CLASS__,
+						__FUNCTION__,
+						__LINE__,
+						array($payment),
+						false,
+						'EE_Transaction: ' . $transaction->ID()
+					);
+				}
+				return;
+			}
+		}
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** PROCESS_FAILED_TRANSACTIONS  **********************************/
+
+
+
+	/**
+	 * releases reserved tickets for absolutely ALL registrations of a FAILED EE_Transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidSessionDataException
+	 */
+	public static function process_failed_transactions(EE_Transaction $transaction)
+	{
+		// since you haven't even attempted to pay for your ticket...
+		EED_Ticket_Sales_Monitor::instance()->_release_all_reserved_tickets_for_transaction($transaction);
+	}
+
+
+
+	/********************************** RESET RESERVATION COUNTS  *********************************/
+
+
+
+	/**
+	 * Resets all ticket and datetime reserved counts to zero
+	 * Tickets that are currently associated with a Transaction that is in progress
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws UnexpectedEntityException
+	 */
+	public static function reset_reservation_counts()
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		/** @var EE_Transaction[] $transactions_not_in_progress */
+		$transactions_not_in_progress = EEM_Transaction::instance()->get_transactions_not_in_progress();
+		foreach ($transactions_not_in_progress as $transaction) {
+			// if this TXN has been fully completed, then skip it
+			if ($transaction->reg_step_completed('finalize_registration')) {
+				continue;
+			}
+			$total_line_item = $transaction->total_line_item();
+			// $transaction_in_progress->line
+			if (! $total_line_item instanceof EE_Line_Item) {
+				throw new DomainException(
+					esc_html__(
+						'Transaction does not have a valid Total Line Item associated with it.',
+						'event_espresso'
+					)
+				);
+			}
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		$total_line_items = EEM_Line_Item::instance()->get_total_line_items_for_active_carts();
+		foreach ($total_line_items as $total_line_item) {
+			$valid_reserved_tickets += EED_Ticket_Sales_Monitor::get_ticket_line_items_for_grand_total(
+				$total_line_item
+			);
+		}
+		$tickets_with_reservations = EEM_Ticket::instance()->get_tickets_with_reservations();
+		return EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
+			$tickets_with_reservations,
+			$valid_reserved_tickets,
+			__FUNCTION__
+		);
+	}
+
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @return EE_Line_Item[]
+	 */
+	private static function get_ticket_line_items_for_grand_total(EE_Line_Item $total_line_item)
+	{
+		/** @var EE_Line_Item[] $valid_reserved_tickets */
+		$valid_reserved_tickets = array();
+		$ticket_line_items      = EEH_Line_Item::get_ticket_line_items($total_line_item);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if ($ticket_line_item instanceof EE_Line_Item) {
+				$valid_reserved_tickets[] = $ticket_line_item;
+			}
+		}
+		return $valid_reserved_tickets;
+	}
+
+
+
+	/**
+	 * @param EE_Ticket[]    $tickets_with_reservations
+	 * @param EE_Line_Item[] $valid_reserved_ticket_line_items
+	 * @return int
+	 * @throws UnexpectedEntityException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	private static function release_reservations_for_tickets(
+		array $tickets_with_reservations,
+		array $valid_reserved_ticket_line_items = array(),
+		$source
+	) {
+		if (self::debug) {
+			echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+		}
+		$total_tickets_released = 0;
+		$sold_out_events = array();
+		foreach ($tickets_with_reservations as $ticket_with_reservations) {
+			if (! $ticket_with_reservations instanceof EE_Ticket) {
+				continue;
+			}
+			$reserved_qty = $ticket_with_reservations->reserved();
+			if (self::debug) {
+				echo self::$nl . ' . $ticket_with_reservations->ID(): ' . $ticket_with_reservations->ID();
+				echo self::$nl . ' . $reserved_qty: ' . $reserved_qty;
+			}
+			foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
+				if (
+					$valid_reserved_ticket_line_item instanceof EE_Line_Item
+					&& $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
+				) {
+					if (self::debug) {
+						echo self::$nl . ' . $valid_reserved_ticket_line_item->quantity(): ' . $valid_reserved_ticket_line_item->quantity();
+					}
+					$reserved_qty -= $valid_reserved_ticket_line_item->quantity();
+				}
+			}
+			if ($reserved_qty > 0) {
+				$ticket_with_reservations->add_extra_meta(
+					EE_Ticket::META_KEY_TICKET_RESERVATIONS,
+					__LINE__ . ') ' . $source . '()'
+				);
+				$ticket_with_reservations->decrease_reserved($reserved_qty, true, 'TicketSalesMonitor:'. __LINE__);
+				$ticket_with_reservations->save();
+				$total_tickets_released += $reserved_qty;
+				$event = $ticket_with_reservations->get_related_event();
+				// track sold out events
+				if ($event instanceof EE_Event && $event->is_sold_out()) {
+					$sold_out_events[] = $event;
+				}
+			}
+		}
+		if (self::debug) {
+			echo self::$nl . ' . $total_tickets_released: ' . $total_tickets_released;
+		}
+		// double check whether sold out events should remain sold out after releasing tickets
+		if($sold_out_events !== array()){
+			foreach ($sold_out_events as $sold_out_event) {
+				/** @var EE_Event $sold_out_event */
+				$sold_out_event->perform_sold_out_status_check();
+			}
+		}
+		return $total_tickets_released;
+	}
+
+
+
+	/********************************** SHUTDOWN  **********************************/
+
+
+
+	/**
+	 * @param int $timestamp
+	 * @return false|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function clear_expired_line_items_with_no_transaction($timestamp = 0)
+	{
+	   /** @type WPDB $wpdb */
+		global $wpdb;
+		if (! absint($timestamp)) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$timestamp = $session_lifespan->expiration();
+		}
+		 return $wpdb->query(
+			$wpdb->prepare(
+				'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
                 WHERE TXN_ID = 0 AND LIN_timestamp <= %s',
-                // use GMT time because that's what LIN_timestamps are in
-                date('Y-m-d H:i:s', $timestamp)
-            )
-        );
-    }
+				// use GMT time because that's what LIN_timestamps are in
+				date('Y-m-d H:i:s', $timestamp)
+			)
+		);
+	}
 
 }
 // End of file EED_Ticket_Sales_Monitor.module.php

Spacing +86 added lines, -86 removed lines

@@ -24,7 +24,7 @@ 
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
 
-    const debug = false;    //	true false
+    const debug = false; //	true false
 
     private static $nl = '';
 
@@ -67,7 +67,7 @@ 
      */
     public static function set_hooks()
     {
-        self::$nl = defined('EE_TESTS_DIR')? "\n" : '<br />';
+        self::$nl = defined('EE_TESTS_DIR') ? "\n" : '<br />';
         // release tickets for expired carts
         add_action(
             'EED_Ticket_Selector__process_ticket_selections__before',
@@ -196,7 +196,7 @@ 
     public static function release_tickets_for_expired_carts()
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'()';
         }
         do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
         $expired_ticket_IDs = array();
@@ -207,26 +207,26 @@ 
         $timestamp = $session_lifespan->expiration();
         $expired_ticket_line_items = EEM_Line_Item::instance()->getTicketLineItemsForExpiredCarts($timestamp);
         if (self::debug) {
-            echo self::$nl . ' . time(): ' . time();
-            echo self::$nl . ' . time() as date: ' . date('Y-m-d H:i a');
-            echo self::$nl . ' . session expiration: ' . $session_lifespan->expiration();
-            echo self::$nl . ' . session expiration as date: ' . date('Y-m-d H:i a', $session_lifespan->expiration());
-            echo self::$nl . ' . timestamp: ' . $timestamp;
-            echo self::$nl . ' . $expired_ticket_line_items: ' . count($expired_ticket_line_items);
+            echo self::$nl.' . time(): '.time();
+            echo self::$nl.' . time() as date: '.date('Y-m-d H:i a');
+            echo self::$nl.' . session expiration: '.$session_lifespan->expiration();
+            echo self::$nl.' . session expiration as date: '.date('Y-m-d H:i a', $session_lifespan->expiration());
+            echo self::$nl.' . timestamp: '.$timestamp;
+            echo self::$nl.' . $expired_ticket_line_items: '.count($expired_ticket_line_items);
         }
-        if (! empty($expired_ticket_line_items)) {
+        if ( ! empty($expired_ticket_line_items)) {
             foreach ($expired_ticket_line_items as $expired_ticket_line_item) {
-                if (! $expired_ticket_line_item instanceof EE_Line_Item) {
+                if ( ! $expired_ticket_line_item instanceof EE_Line_Item) {
                     continue;
                 }
-                $expired_ticket_IDs[ $expired_ticket_line_item->OBJ_ID() ] = $expired_ticket_line_item->OBJ_ID();
+                $expired_ticket_IDs[$expired_ticket_line_item->OBJ_ID()] = $expired_ticket_line_item->OBJ_ID();
                 if (self::debug) {
-                    echo self::$nl . ' . $expired_ticket_line_item->OBJ_ID(): ' . $expired_ticket_line_item->OBJ_ID();
-                    echo self::$nl . ' . $expired_ticket_line_item->timestamp(): ' . date('Y-m-d h:i a',
+                    echo self::$nl.' . $expired_ticket_line_item->OBJ_ID(): '.$expired_ticket_line_item->OBJ_ID();
+                    echo self::$nl.' . $expired_ticket_line_item->timestamp(): '.date('Y-m-d h:i a',
                             $expired_ticket_line_item->timestamp(true));
                 }
             }
-            if (! empty($expired_ticket_IDs)) {
+            if ( ! empty($expired_ticket_IDs)) {
                 EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
                     \EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
                     array(),
@@ -265,8 +265,8 @@ 
             $qty = EED_Ticket_Sales_Monitor::instance()->_validate_ticket_sale($ticket, $qty);
         }
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-            echo self::$nl . self::$nl . '<b> RETURNED QTY: ' . $qty . '</b>';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'()';
+            echo self::$nl.self::$nl.'<b> RETURNED QTY: '.$qty.'</b>';
         }
         return $qty;
     }
@@ -285,36 +285,36 @@ 
     protected function _validate_ticket_sale(EE_Ticket $ticket, $qty = 1)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             return 0;
         }
         if (self::debug) {
-            echo self::$nl . '<b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo self::$nl . ' . original ticket->reserved: ' . $ticket->reserved();
+            echo self::$nl.'<b> . ticket->ID: '.$ticket->ID().'</b>';
+            echo self::$nl.' . original ticket->reserved: '.$ticket->reserved();
         }
         $ticket->refresh_from_db();
         // first let's determine the ticket availability based on sales
         $available = $ticket->qty('saleable');
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->qty: ' . $ticket->qty();
-            echo self::$nl . ' . . . ticket->sold: ' . $ticket->sold();
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
-            echo self::$nl . ' . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo self::$nl . ' . . . available: ' . $available;
+            echo self::$nl.' . . . ticket->qty: '.$ticket->qty();
+            echo self::$nl.' . . . ticket->sold: '.$ticket->sold();
+            echo self::$nl.' . . . ticket->reserved: '.$ticket->reserved();
+            echo self::$nl.' . . . ticket->qty(saleable): '.$ticket->qty('saleable');
+            echo self::$nl.' . . . available: '.$available;
         }
         if ($available < 1) {
             $this->_ticket_sold_out($ticket);
             return 0;
         }
         if (self::debug) {
-            echo self::$nl . ' . . . qty: ' . $qty;
+            echo self::$nl.' . . . qty: '.$qty;
         }
         if ($available < $qty) {
             $qty = $available;
             if (self::debug) {
-                echo self::$nl . ' . . . QTY ADJUSTED: ' . $qty;
+                echo self::$nl.' . . . QTY ADJUSTED: '.$qty;
             }
             $this->_ticket_quantity_decremented($ticket);
         }
@@ -335,9 +335,9 @@ 
     protected function _reserve_ticket(EE_Ticket $ticket, $quantity = 1)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . ' . . . INCREASE RESERVED: ' . $quantity;
+            echo self::$nl.self::$nl.' . . . INCREASE RESERVED: '.$quantity;
         }
-        $ticket->increase_reserved($quantity, 'TicketSalesMonitor:'. __LINE__);
+        $ticket->increase_reserved($quantity, 'TicketSalesMonitor:'.__LINE__);
         return $ticket->save();
     }
 
@@ -352,12 +352,12 @@ 
     protected function _release_reserved_ticket(EE_Ticket $ticket, $quantity = 1)
     {
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->ID: ' . $ticket->ID();
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
+            echo self::$nl.' . . . ticket->ID: '.$ticket->ID();
+            echo self::$nl.' . . . ticket->reserved: '.$ticket->reserved();
         }
-        $ticket->decrease_reserved($quantity, true, 'TicketSalesMonitor:'. __LINE__);
+        $ticket->decrease_reserved($quantity, true, 'TicketSalesMonitor:'.__LINE__);
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
+            echo self::$nl.' . . . ticket->reserved: '.$ticket->reserved();
         }
         return $ticket->save() ? 1 : 0;
     }
@@ -375,8 +375,8 @@ 
     protected function _ticket_sold_out(EE_Ticket $ticket)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -394,8 +394,8 @@ 
     protected function _ticket_quantity_decremented(EE_Ticket $ticket)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -448,7 +448,7 @@ 
         if ($ticket instanceof EE_Ticket) {
             $ticket->add_extra_meta(
                 EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                __LINE__ . ') ' . __METHOD__ . '()'
+                __LINE__.') '.__METHOD__.'()'
             );
             if ($quantity > 0) {
                 EED_Ticket_Sales_Monitor::instance()->_reserve_ticket($ticket, $quantity);
@@ -472,7 +472,7 @@ 
     {
         $ticket->add_extra_meta(
             EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-            __LINE__ . ') ' . __METHOD__ . '()'
+            __LINE__.') '.__METHOD__.'()'
         );
         EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
     }
@@ -509,18 +509,18 @@ 
     protected function _post_notices()
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         $refresh_msg    = '';
         $none_added_msg = '';
         if (defined('DOING_AJAX') && DOING_AJAX) {
-            $refresh_msg    = __(
+            $refresh_msg = __(
                 'Please refresh the page to view updated ticket quantities.',
                 'event_espresso'
             );
             $none_added_msg = __('No tickets were added for the event.', 'event_espresso');
         }
-        if (! empty($this->sold_out_tickets)) {
+        if ( ! empty($this->sold_out_tickets)) {
             EE_Error::add_attention(
                 sprintf(
                     apply_filters(
@@ -543,7 +543,7 @@ 
             // and reset the cart
             EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
         }
-        if (! empty($this->decremented_tickets)) {
+        if ( ! empty($this->decremented_tickets)) {
             EE_Error::add_attention(
                 sprintf(
                     apply_filters(
@@ -581,9 +581,9 @@ 
     protected function _release_all_reserved_tickets_for_transaction(EE_Transaction $transaction)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . transaction->ID: ' . $transaction->ID();
-            echo self::$nl . ' . TXN status_ID: ' . $transaction->status_ID();
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . transaction->ID: '.$transaction->ID();
+            echo self::$nl.' . TXN status_ID: '.$transaction->status_ID();
         }
         // check if 'finalize_registration' step has been completed...
         $finalized = $transaction->reg_step_completed('finalize_registration');
@@ -595,13 +595,13 @@ 
                 __LINE__,
                 array('finalized' => $finalized),
                 false,
-                'EE_Transaction: ' . $transaction->ID()
+                'EE_Transaction: '.$transaction->ID()
             );
         }
         // how many tickets were released
         $count = 0;
         if (self::debug) {
-            echo self::$nl . ' . . . TXN finalized: ' . $finalized;
+            echo self::$nl.' . . . TXN finalized: '.$finalized;
         }
         $release_tickets_with_TXN_status = array(
             EEM_Transaction::failed_status_code,
@@ -610,28 +610,28 @@ 
         );
         $events = array();
         // if the session is getting cleared BEFORE the TXN has been finalized or the transaction is not completed
-        if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+        if ( ! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
             // cancel any reserved tickets for registrations that were not approved
             $registrations = $transaction->registrations();
             if (self::debug) {
-                echo self::$nl . ' . . . # registrations: ' . count($registrations);
+                echo self::$nl.' . . . # registrations: '.count($registrations);
                 $reg    = reset($registrations);
                 $ticket = $reg->ticket();
                 if ($ticket instanceof EE_Ticket) {
                     $ticket->add_extra_meta(
                         EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') Release All Tickets TXN:' . $transaction->ID()
+                        __LINE__.') Release All Tickets TXN:'.$transaction->ID()
                     );
                 }
             }
-            if (! empty($registrations)) {
+            if ( ! empty($registrations)) {
                 foreach ($registrations as $registration) {
                     if (
                         $registration instanceof EE_Registration
                         && $this->_release_reserved_ticket_for_registration($registration, $transaction)
                     ) {
                         $count++;
-                        $events[ $registration->event_ID() ] = $registration->event();
+                        $events[$registration->event_ID()] = $registration->event();
                     }
                 }
             }
@@ -662,10 +662,10 @@ 
     ) {
         $STS_ID = $transaction->status_ID();
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . registration->ID: ' . $registration->ID();
-            echo self::$nl . ' . . registration->status_ID: ' . $registration->status_ID();
-            echo self::$nl . ' . . transaction->status_ID(): ' . $STS_ID;
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . registration->ID: '.$registration->ID();
+            echo self::$nl.' . . registration->status_ID: '.$registration->status_ID();
+            echo self::$nl.' . . transaction->status_ID(): '.$STS_ID;
         }
         if (
             // release Tickets for Failed Transactions and Abandoned Transactions
@@ -678,12 +678,12 @@ 
             )
         ) {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' . . RELEASE RESERVED TICKET';
+                echo self::$nl.self::$nl.' . . RELEASE RESERVED TICKET';
                 $rsrvd = $registration->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
-                echo self::$nl . ' . . . registration HAS_RESERVED_TICKET_KEY: ';
+                echo self::$nl.' . . . registration HAS_RESERVED_TICKET_KEY: ';
                 var_dump($rsrvd);
             }
-            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:'. __LINE__);
+            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:'.__LINE__);
             return 1;
         }
         return 0;
@@ -709,7 +709,7 @@ 
     public static function session_cart_reset(EE_Session $session)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         // first check of the session has a valid Checkout object
         $checkout = $session->checkout();
@@ -721,12 +721,12 @@ 
         $cart = $session->cart();
         if ($cart instanceof EE_Cart) {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' cart instance of EE_Cart: ';
+                echo self::$nl.self::$nl.' cart instance of EE_Cart: ';
             }
             EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart, $session);
         } else {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' invalid EE_Cart: ';
+                echo self::$nl.self::$nl.' invalid EE_Cart: ';
                 var_export($cart, true);
             }
         }
@@ -748,7 +748,7 @@ 
     protected function _session_cart_reset(EE_Cart $cart, EE_Session $session)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         EE_Registry::instance()->load_helper('Line_Item');
         $ticket_line_items = $cart->get_tickets();
@@ -757,28 +757,28 @@ 
         }
         foreach ($ticket_line_items as $ticket_line_item) {
             if (self::debug) {
-                echo self::$nl . ' . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+                echo self::$nl.' . ticket_line_item->ID(): '.$ticket_line_item->ID();
             }
             if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
                 if (self::debug) {
-                    echo self::$nl . ' . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+                    echo self::$nl.' . . ticket_line_item->OBJ_ID(): '.$ticket_line_item->OBJ_ID();
                 }
                 $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
                 if ($ticket instanceof EE_Ticket) {
                     if (self::debug) {
-                        echo self::$nl . ' . . ticket->ID(): ' . $ticket->ID();
-                        echo self::$nl . ' . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+                        echo self::$nl.' . . ticket->ID(): '.$ticket->ID();
+                        echo self::$nl.' . . ticket_line_item->quantity(): '.$ticket_line_item->quantity();
                     }
                     $ticket->add_extra_meta(
                         EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') ' . __METHOD__ . '() SID = ' . $session->id()
+                        __LINE__.') '.__METHOD__.'() SID = '.$session->id()
                     );
                     $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
                 }
             }
         }
         if (self::debug) {
-            echo self::$nl . self::$nl . ' RESET COMPLETED ';
+            echo self::$nl.self::$nl.' RESET COMPLETED ';
         }
     }
 
@@ -817,7 +817,7 @@ 
     protected function _session_checkout_reset(EE_Checkout $checkout)
     {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
         if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
@@ -867,7 +867,7 @@ 
                     __LINE__,
                     array($transaction),
                     false,
-                    'EE_Transaction: ' . $transaction->ID()
+                    'EE_Transaction: '.$transaction->ID()
                 );
             }
             return;
@@ -884,7 +884,7 @@ 
                         __LINE__,
                         array($payment),
                         false,
-                        'EE_Transaction: ' . $transaction->ID()
+                        'EE_Transaction: '.$transaction->ID()
                     );
                 }
                 return;
@@ -944,7 +944,7 @@ 
             }
             $total_line_item = $transaction->total_line_item();
             // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
+            if ( ! $total_line_item instanceof EE_Line_Item) {
                 throw new DomainException(
                     esc_html__(
                         'Transaction does not have a valid Total Line Item associated with it.',
@@ -1005,18 +1005,18 @@ 
         $source
     ) {
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'()';
         }
         $total_tickets_released = 0;
         $sold_out_events = array();
         foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
+            if ( ! $ticket_with_reservations instanceof EE_Ticket) {
                 continue;
             }
             $reserved_qty = $ticket_with_reservations->reserved();
             if (self::debug) {
-                echo self::$nl . ' . $ticket_with_reservations->ID(): ' . $ticket_with_reservations->ID();
-                echo self::$nl . ' . $reserved_qty: ' . $reserved_qty;
+                echo self::$nl.' . $ticket_with_reservations->ID(): '.$ticket_with_reservations->ID();
+                echo self::$nl.' . $reserved_qty: '.$reserved_qty;
             }
             foreach ($valid_reserved_ticket_line_items as $valid_reserved_ticket_line_item) {
                 if (
@@ -1024,7 +1024,7 @@ 
                     && $valid_reserved_ticket_line_item->OBJ_ID() === $ticket_with_reservations->ID()
                 ) {
                     if (self::debug) {
-                        echo self::$nl . ' . $valid_reserved_ticket_line_item->quantity(): ' . $valid_reserved_ticket_line_item->quantity();
+                        echo self::$nl.' . $valid_reserved_ticket_line_item->quantity(): '.$valid_reserved_ticket_line_item->quantity();
                     }
                     $reserved_qty -= $valid_reserved_ticket_line_item->quantity();
                 }
@@ -1032,9 +1032,9 @@ 
             if ($reserved_qty > 0) {
                 $ticket_with_reservations->add_extra_meta(
                     EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                    __LINE__ . ') ' . $source . '()'
+                    __LINE__.') '.$source.'()'
                 );
-                $ticket_with_reservations->decrease_reserved($reserved_qty, true, 'TicketSalesMonitor:'. __LINE__);
+                $ticket_with_reservations->decrease_reserved($reserved_qty, true, 'TicketSalesMonitor:'.__LINE__);
                 $ticket_with_reservations->save();
                 $total_tickets_released += $reserved_qty;
                 $event = $ticket_with_reservations->get_related_event();
@@ -1045,10 +1045,10 @@ 
             }
         }
         if (self::debug) {
-            echo self::$nl . ' . $total_tickets_released: ' . $total_tickets_released;
+            echo self::$nl.' . $total_tickets_released: '.$total_tickets_released;
         }
         // double check whether sold out events should remain sold out after releasing tickets
-        if($sold_out_events !== array()){
+        if ($sold_out_events !== array()) {
             foreach ($sold_out_events as $sold_out_event) {
                 /** @var EE_Event $sold_out_event */
                 $sold_out_event->perform_sold_out_status_check();
@@ -1075,7 +1075,7 @@ 
     {
        /** @type WPDB $wpdb */
         global $wpdb;
-        if (! absint($timestamp)) {
+        if ( ! absint($timestamp)) {
             /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
             $session_lifespan = LoaderFactory::getLoader()->getShared(
                 'EventEspresso\core\domain\values\session\SessionLifespan'
@@ -1084,7 +1084,7 @@ 
         }
          return $wpdb->query(
             $wpdb->prepare(
-                'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
+                'DELETE FROM '.EEM_Line_Item::instance()->table().'
                 WHERE TXN_ID = 0 AND LIN_timestamp <= %s',
                 // use GMT time because that's what LIN_timestamps are in
                 date('Y-m-d H:i:s', $timestamp)

core/domain/values/session/SessionLifespan.php

Indentation +95 added lines, -95 removed lines

@@ -24,99 +24,99 @@
 class SessionLifespan
 {
 
-    /**
-     * how long an EE session lasts in seconds
-     * default session lifespan of 1 hour (for not so instant IPNs)
-     *
-     * @var int $lifespan
-     */
-    private $lifespan;
-
-
-    /**
-     * SessionLifespan constructor.
-     *
-     * @param int $lifespan
-     * @throws DomainException
-     */
-    public function __construct($lifespan = 0)
-    {
-        $lifespan = absint($lifespan);
-        $lifespan = $lifespan > 0 ? $lifespan : (int) HOUR_IN_SECONDS;
-        $this->setLifespan($lifespan);
-    }
-
-
-    /**
-     * @param int $lifespan
-     * @throws DomainException
-     */
-    protected function setLifespan($lifespan)
-    {
-        if($lifespan < 60) {
-            throw new DomainException(
-                esc_html__(
-                    'The session lifespan needs to be at least 60 seconds, and even that is extremely short',
-                    'event_espresso'
-                )
-            );
-
-        }
-        $this->lifespan = apply_filters(
-            'FHEE__EventEspresso_core_domain_values_session_SessionLifespan__setLifespan___lifespan',
-            // apply legacy filter for now but add doing it wrong notice in future
-            apply_filters(
-                'FHEE__EE_Session__construct___lifespan',
-                $lifespan
-            )
-        ) + 1;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function inSeconds()
-    {
-        return $this->lifespan;
-    }
-
-
-    /**
-     * @param string $separator
-     * @return string
-     */
-    public function inHoursMinutesSeconds($separator = ':')
-    {
-        return sprintf(
-            '%02d%s%02d%s%02d',
-            floor($this->lifespan / 3600),
-            $separator,
-            ($this->lifespan / 60) % 60,
-            $separator,
-            $this->lifespan % 60
-        );
-    }
-
-
-    /**
-     * Returns a timestamp for when the session would expire based on this lifespan
-     *
-     * @param bool $utc If true, displays expiration in UTC
-     *                  If false, displays expiration in local time
-     * @return int
-     */
-    public function expiration($utc = true)
-    {
-        return (int) current_time('timestamp', $utc) - $this->lifespan;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return (string) $this->inSeconds();
-    }
+	/**
+	 * how long an EE session lasts in seconds
+	 * default session lifespan of 1 hour (for not so instant IPNs)
+	 *
+	 * @var int $lifespan
+	 */
+	private $lifespan;
+
+
+	/**
+	 * SessionLifespan constructor.
+	 *
+	 * @param int $lifespan
+	 * @throws DomainException
+	 */
+	public function __construct($lifespan = 0)
+	{
+		$lifespan = absint($lifespan);
+		$lifespan = $lifespan > 0 ? $lifespan : (int) HOUR_IN_SECONDS;
+		$this->setLifespan($lifespan);
+	}
+
+
+	/**
+	 * @param int $lifespan
+	 * @throws DomainException
+	 */
+	protected function setLifespan($lifespan)
+	{
+		if($lifespan < 60) {
+			throw new DomainException(
+				esc_html__(
+					'The session lifespan needs to be at least 60 seconds, and even that is extremely short',
+					'event_espresso'
+				)
+			);
+
+		}
+		$this->lifespan = apply_filters(
+			'FHEE__EventEspresso_core_domain_values_session_SessionLifespan__setLifespan___lifespan',
+			// apply legacy filter for now but add doing it wrong notice in future
+			apply_filters(
+				'FHEE__EE_Session__construct___lifespan',
+				$lifespan
+			)
+		) + 1;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function inSeconds()
+	{
+		return $this->lifespan;
+	}
+
+
+	/**
+	 * @param string $separator
+	 * @return string
+	 */
+	public function inHoursMinutesSeconds($separator = ':')
+	{
+		return sprintf(
+			'%02d%s%02d%s%02d',
+			floor($this->lifespan / 3600),
+			$separator,
+			($this->lifespan / 60) % 60,
+			$separator,
+			$this->lifespan % 60
+		);
+	}
+
+
+	/**
+	 * Returns a timestamp for when the session would expire based on this lifespan
+	 *
+	 * @param bool $utc If true, displays expiration in UTC
+	 *                  If false, displays expiration in local time
+	 * @return int
+	 */
+	public function expiration($utc = true)
+	{
+		return (int) current_time('timestamp', $utc) - $this->lifespan;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return (string) $this->inSeconds();
+	}
 }

core/services/payment_methods/gateways/GatewayDataFormatter.php

Indentation +116 added lines, -116 removed lines

@@ -17,122 +17,122 @@
 class GatewayDataFormatter implements GatewayDataFormatterInterface
 {
 
-    /**
-     * Gets the text to use for a gateway's line item name when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemName(\EEI_Payment $payment)
-    {
-        return apply_filters(
-            'EEG_Paypal_Pro__do_direct_payment__partial_amount_line_item_name',
-            $payment->get_first_event_name(),
-            $this,
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Gets the text to use for a gateway's line item description when this is a partial payment
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___partial_payment_desc',
-            sprintf(
-                __("Payment of %s for %s", "event_espresso"),
-                $payment->get_pretty('PAY_amount', 'no_currency_code'),
-                $payment->get_first_event_name()
-            ),
-            $this,
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Gets the name to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_gateway___line_item_name',
-            sprintf(
-                _x('%1$s for %2$s', 'Ticket for Event', 'event_espresso'),
-                $line_item->name(),
-                $line_item->ticket_event_name()
-            ),
-            $this,
-            $line_item,
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Gets the description to use for a line item when sending line items to the gateway
-     *
-     * @param \EEI_Line_Item $line_item
-     * @param \EEI_Payment   $payment
-     * @return string
-     */
-    public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___line_item_desc',
-            $line_item->desc(),
-            $this,
-            $line_item,
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Gets the order description that should generally be sent to gateways
-     *
-     * @param \EEI_Payment $payment
-     * @return string
-     */
-    public function formatOrderDescription(\EEI_Payment $payment)
-    {
-        return apply_filters(
-            'FHEE__EE_Gateway___order_description',
-            sprintf(
-                __('Event Registrations from %1$s for %2$s', "event_espresso"),
-                wp_specialchars_decode(get_bloginfo(), ENT_QUOTES),
-                $payment->get_first_event_name()
-            ),
-            $this,
-            $payment
-        );
-    }
-
-
-
-    /**
-     * Formats the amount so it can generally be sent to gateways
-     *
-     * @param float $amount
-     * @return string
-     */
-    public function formatCurrency($amount)
-    {
-        return number_format($amount, 2, '.', '');
-    }
+	/**
+	 * Gets the text to use for a gateway's line item name when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemName(\EEI_Payment $payment)
+	{
+		return apply_filters(
+			'EEG_Paypal_Pro__do_direct_payment__partial_amount_line_item_name',
+			$payment->get_first_event_name(),
+			$this,
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Gets the text to use for a gateway's line item description when this is a partial payment
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatPartialPaymentLineItemDesc(\EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___partial_payment_desc',
+			sprintf(
+				__("Payment of %s for %s", "event_espresso"),
+				$payment->get_pretty('PAY_amount', 'no_currency_code'),
+				$payment->get_first_event_name()
+			),
+			$this,
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Gets the name to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemName(\EEI_Line_Item $line_item, \EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_gateway___line_item_name',
+			sprintf(
+				_x('%1$s for %2$s', 'Ticket for Event', 'event_espresso'),
+				$line_item->name(),
+				$line_item->ticket_event_name()
+			),
+			$this,
+			$line_item,
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Gets the description to use for a line item when sending line items to the gateway
+	 *
+	 * @param \EEI_Line_Item $line_item
+	 * @param \EEI_Payment   $payment
+	 * @return string
+	 */
+	public function formatLineItemDesc(\EEI_Line_Item $line_item, \EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___line_item_desc',
+			$line_item->desc(),
+			$this,
+			$line_item,
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Gets the order description that should generally be sent to gateways
+	 *
+	 * @param \EEI_Payment $payment
+	 * @return string
+	 */
+	public function formatOrderDescription(\EEI_Payment $payment)
+	{
+		return apply_filters(
+			'FHEE__EE_Gateway___order_description',
+			sprintf(
+				__('Event Registrations from %1$s for %2$s', "event_espresso"),
+				wp_specialchars_decode(get_bloginfo(), ENT_QUOTES),
+				$payment->get_first_event_name()
+			),
+			$this,
+			$payment
+		);
+	}
+
+
+
+	/**
+	 * Formats the amount so it can generally be sent to gateways
+	 *
+	 * @param float $amount
+	 * @return string
+	 */
+	public function formatCurrency($amount)
+	{
+		return number_format($amount, 2, '.', '');
+	}
 }
 // End of file GatewayDataFormatter.php
 // Location: core\services\gateways/GatewayDataFormatter.php
\ No newline at end of file