eventespresso / event-espresso-core

modules/single_page_checkout/reg_steps/payment_options/EE_SPCO_Reg_Step_Payment_Options.class.php

Indentation +84 added lines, -84 removed lines

@@ -286,41 +286,41 @@ 
 			$this->checkout->revisit
 		);
 		foreach ( $registrations as $REG_ID => $registration ) {
-            /** @var $registration EE_Registration */
-            // has this registration lost it's space ?
+			/** @var $registration EE_Registration */
+			// has this registration lost it's space ?
 			if ( isset( $ejected_registrations[ $REG_ID ] ) ) {
 				$insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
 				continue;
 			}
-            // event requires admin approval
-            if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
-                // add event to list of events with pre-approval reg status
-                $registrations_requiring_pre_approval[$REG_ID] = $registration;
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
-                    $registration->event(),
-                    $this
-                );
-                continue;
-            }
-            if (
+			// event requires admin approval
+			if ($registration->status_ID() === EEM_Registration::status_id_not_approved) {
+				// add event to list of events with pre-approval reg status
+				$registrations_requiring_pre_approval[$REG_ID] = $registration;
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_pre_approval',
+					$registration->event(),
+					$this
+				);
+				continue;
+			}
+			if (
 				// returning registrant
 				$this->checkout->revisit
 				// anything other than Approved
 				&& $registration->status_ID() !== EEM_Registration::status_id_approved
-                && (
-                    $registration->event()->is_sold_out()
-                    || $registration->event()->is_sold_out( true )
-                )
-            ) {
-                // add event to list of events that are sold out
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
-                do_action(
-                    'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
-                    $registration->event(),
-                    $this
-                );
-                continue;
+				&& (
+					$registration->event()->is_sold_out()
+					|| $registration->event()->is_sold_out( true )
+				)
+			) {
+				// add event to list of events that are sold out
+				$sold_out_events[ $registration->event()->ID() ] = $registration->event();
+				do_action(
+					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
+					$registration->event(),
+					$this
+				);
+				continue;
 			}
 			// are they allowed to pay now and is there monies owing?
 			if ( $registration->owes_monies_and_can_pay() ) {
@@ -428,11 +428,11 @@ 
 			new EE_Billable_Line_Item_Filter(
 				EE_SPCO_Reg_Step_Payment_Options::remove_ejected_registrations(
 					EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                        EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                    )
+						EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+					)
 				)
 			)
-        );
+		);
 		$line_item_filter_collection->add( new EE_Non_Zero_Line_Item_Filter() );
 		return $line_item_filter_collection;
 	}
@@ -481,38 +481,38 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function find_registrations_that_lost_their_space( array $registrations, $revisit = false ) {
-        // registrations per event
+		// registrations per event
 		$event_reg_count = array();
 		// spaces left per event
 		$event_spaces_remaining = array();
-        // tickets left sorted by ID
-        $tickets_remaining = array();
-        // registrations that have lost their space
+		// tickets left sorted by ID
+		$tickets_remaining = array();
+		// registrations that have lost their space
 		$ejected_registrations = array();
 		foreach ( $registrations as $REG_ID => $registration ) {
 			if ( $registration->status_ID() === EEM_Registration::status_id_approved ) {
 				continue;
 			}
 			$EVT_ID = $registration->event_ID();
-            $ticket = $registration->ticket();
-            if ( ! isset($tickets_remaining[$ticket->ID()])) {
-                $tickets_remaining[$ticket->ID()] = $ticket->remaining();
-            }
-            if ($tickets_remaining[$ticket->ID()] > 0) {
-                if ( ! isset($event_reg_count[$EVT_ID])) {
-                    $event_reg_count[$EVT_ID] = 0;
-                }
-                $event_reg_count[$EVT_ID]++;
-                if ( ! isset($event_spaces_remaining[$EVT_ID])) {
-                    $event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
-                }
-            }
+			$ticket = $registration->ticket();
+			if ( ! isset($tickets_remaining[$ticket->ID()])) {
+				$tickets_remaining[$ticket->ID()] = $ticket->remaining();
+			}
+			if ($tickets_remaining[$ticket->ID()] > 0) {
+				if ( ! isset($event_reg_count[$EVT_ID])) {
+					$event_reg_count[$EVT_ID] = 0;
+				}
+				$event_reg_count[$EVT_ID]++;
+				if ( ! isset($event_spaces_remaining[$EVT_ID])) {
+					$event_spaces_remaining[$EVT_ID] = $registration->event()->spaces_remaining_for_sale();
+				}
+			}
 			if (
 				$revisit
 				&& (
-                    $tickets_remaining[$ticket->ID()] === 0
-				    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
-                )
+					$tickets_remaining[$ticket->ID()] === 0
+					|| $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
+				)
 			) {
 				$ejected_registrations[ $REG_ID ] = $registration->event();
 				if ( $registration->status_ID() !== EEM_Registration::status_id_wait_list ) {
@@ -581,9 +581,9 @@ 
 				'layout_strategy'		=> new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'sold_out_events.template.php',
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
 						'template_args'        => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
 							array(
@@ -636,9 +636,9 @@ 
 				'layout_strategy' => new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'sold_out_events.template.php',
+												  . $this->_slug
+												  . DS
+												  . 'sold_out_events.template.php',
 						'template_args'        => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
 							array(
@@ -686,9 +686,9 @@ 
 				'layout_strategy'		=> new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'events_requiring_pre_approval.template.php', // layout_template
+												  . $this->_slug
+												  . DS
+												  . 'events_requiring_pre_approval.template.php', // layout_template
 						'template_args'        => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
 							array(
@@ -726,9 +726,9 @@ 
 				'layout_strategy' 	=> new EE_Template_Layout(
 					array(
 						'layout_template_file' => SPCO_REG_STEPS_PATH
-						                          . $this->_slug
-						                          . DS
-						                          . 'no_payment_required.template.php', // layout_template
+												  . $this->_slug
+												  . DS
+												  . 'no_payment_required.template.php', // layout_template
 						'template_args'        => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
 							array(
@@ -956,7 +956,7 @@ 
 					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
 				}
 				$payment_methods_billing_info[ $payment_method->slug()
-				                               . '-info' ] = $this->_payment_method_billing_info(
+											   . '-info' ] = $this->_payment_method_billing_info(
 					$payment_method
 				);
 			}
@@ -1144,7 +1144,7 @@ 
 		// fill form with attendee info if applicable
 		if (
 			$payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
-		    && $this->checkout->transaction_has_primary_registrant()
+			&& $this->checkout->transaction_has_primary_registrant()
 		) {
 			$payment_method_billing_form->populate_from_attendee(
 				$this->checkout->transaction->primary_registration()->attendee()
@@ -1153,7 +1153,7 @@ 
 		// and debug content
 		if (
 			$payment_method_billing_form instanceof EE_Billing_Info_Form
-		    && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+			&& $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
 		) {
 			$payment_method_billing_form = $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
 				$payment_method_billing_form
@@ -1328,7 +1328,7 @@ 
 		}
 		// and debug content
 		if ( $this->checkout->billing_form instanceof EE_Billing_Info_Form
-		     && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
+			 && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
 		) {
 			$this->checkout->billing_form = $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
 				$this->checkout->billing_form
@@ -1498,8 +1498,8 @@ 
 		}
 		// does this attendee already exist in the db ? we're searching using a combination of first name, last name, AND email address
 		if ( ! empty( $attendee_data['ATT_fname'] )
-		     && ! empty( $attendee_data['ATT_lname'] )
-		     && ! empty( $attendee_data['ATT_email'] )
+			 && ! empty( $attendee_data['ATT_lname'] )
+			 && ! empty( $attendee_data['ATT_email'] )
 		) {
 			$existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
 				array(
@@ -1746,7 +1746,7 @@ 
 			$payment_status = $payment->status();
 			if (
 				$payment_status === EEM_Payment::status_id_approved
-			    || $payment_status === EEM_Payment::status_id_pending
+				|| $payment_status === EEM_Payment::status_id_pending
 			) {
 				return true;
 			} else {
@@ -1972,8 +1972,8 @@ 
 			return false;
 		}
 		if ( ! $primary_registration->_add_relation_to( $this->checkout->primary_attendee_obj, 'Attendee' )
-		       instanceof
-		       EE_Attendee
+			   instanceof
+			   EE_Attendee
 		) {
 			EE_Error::add_error(
 				sprintf(
@@ -2691,19 +2691,19 @@ 
 
 
 
-    /**
-     *    __sleep
-     * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon serialization
-     * EE_Checkout will handle the reimplementation of itself upon waking,
-     * but we won't bother with the reg form, because if needed, it will be regenerated anyways
-     *
-     * @return array
-     */
-    public function __sleep()
-    {
-        // remove the reg form and the checkout
-        return array_diff( array_keys( get_object_vars( $this ) ), array( 'reg_form', 'checkout', 'line_item_display' ) );
-    }
+	/**
+	 *    __sleep
+	 * to conserve db space, let's remove the reg_form and the EE_Checkout object from EE_SPCO_Reg_Step objects upon serialization
+	 * EE_Checkout will handle the reimplementation of itself upon waking,
+	 * but we won't bother with the reg form, because if needed, it will be regenerated anyways
+	 *
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		// remove the reg form and the checkout
+		return array_diff( array_keys( get_object_vars( $this ) ), array( 'reg_form', 'checkout', 'line_item_display' ) );
+	}
 
 
 

Spacing +363 added lines, -363 removed lines

@@ -1,5 +1,5 @@ 
-<?php if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -38,32 +38,32 @@ 
 	public static function set_hooks() {
 		add_filter(
 			'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters')
 		);
 		add_action(
 			'wp_ajax_switch_spco_billing_form',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
 		);
 		add_action(
 			'wp_ajax_nopriv_switch_spco_billing_form',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form')
 		);
-		add_action( 'wp_ajax_save_payer_details', array( 'EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details' ) );
+		add_action('wp_ajax_save_payer_details', array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details'));
 		add_action(
 			'wp_ajax_nopriv_save_payer_details',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details')
 		);
 		add_action(
 			'wp_ajax_get_transaction_details_for_gateways',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
 		);
 		add_action(
 			'wp_ajax_nopriv_get_transaction_details_for_gateways',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details' )
+			array('EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details')
 		);
 		add_filter(
 			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-			array( 'EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method' ),
+			array('EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'),
 			10,
 			1
 		);
@@ -77,7 +77,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function switch_spco_billing_form() {
-		EED_Single_Page_Checkout::process_ajax_request( 'switch_payment_method' );
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
 	}
 
 
@@ -88,7 +88,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function save_payer_details() {
-		EED_Single_Page_Checkout::process_ajax_request( 'save_payer_details_via_ajax' );
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
 	}
 
 
@@ -99,7 +99,7 @@ 
 	 * @throws \EE_Error
 	 */
 	public static function get_transaction_details() {
-		EED_Single_Page_Checkout::process_ajax_request( 'get_transaction_details_for_gateways' );
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
 	}
 
 
@@ -126,10 +126,10 @@ 
 	 * @access    public
 	 * @param    EE_Checkout $checkout
 	 */
-	public function __construct( EE_Checkout $checkout ) {
+	public function __construct(EE_Checkout $checkout) {
 		$this->_slug = 'payment_options';
-		$this->_name = __( 'Payment Options', 'event_espresso' );
-		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'payment_options_main.template.php';
+		$this->_name = __('Payment Options', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'payment_options_main.template.php';
 		$this->checkout = $checkout;
 		$this->_reset_success_message();
 		$this->set_instructions(
@@ -154,7 +154,7 @@ 
 	/**
 	 * @param null $line_item_display
 	 */
-	public function set_line_item_display( $line_item_display ) {
+	public function set_line_item_display($line_item_display) {
 		$this->line_item_display = $line_item_display;
 	}
 
@@ -172,8 +172,8 @@ 
 	/**
 	 * @param boolean $handle_IPN_in_this_request
 	 */
-	public function set_handle_IPN_in_this_request( $handle_IPN_in_this_request ) {
-		$this->handle_IPN_in_this_request = filter_var( $handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN );
+	public function set_handle_IPN_in_this_request($handle_IPN_in_this_request) {
+		$this->handle_IPN_in_this_request = filter_var($handle_IPN_in_this_request, FILTER_VALIDATE_BOOLEAN);
 	}
 
 
@@ -208,14 +208,14 @@ 
 	public function enqueue_styles_and_scripts() {
 		$transaction = $this->checkout->transaction;
 		//if the transaction isn't set or nothing is owed on it, don't enqueue any JS
-		if( ! $transaction instanceof EE_Transaction || EEH_Money::compare_floats( $transaction->remaining(), 0 ) ) {
+		if ( ! $transaction instanceof EE_Transaction || EEH_Money::compare_floats($transaction->remaining(), 0)) {
 			return;
 		}
-		foreach( EEM_Payment_Method::instance()->get_all_for_transaction( $transaction, EEM_Payment_Method::scope_cart ) as $payment_method ) {
+		foreach (EEM_Payment_Method::instance()->get_all_for_transaction($transaction, EEM_Payment_Method::scope_cart) as $payment_method) {
 			$type_obj = $payment_method->type_obj();
-			if( $type_obj instanceof EE_PMT_Base ) {
-				$billing_form = $type_obj->generate_new_billing_form( $transaction );
-				if( $billing_form instanceof EE_Form_Section_Proper ) {
+			if ($type_obj instanceof EE_PMT_Base) {
+				$billing_form = $type_obj->generate_new_billing_form($transaction);
+				if ($billing_form instanceof EE_Form_Section_Proper) {
 					$billing_form->enqueue_js();
 				}
 			}
@@ -240,20 +240,20 @@ 
 			// 	$ 0.00 transactions (no payment required)
 			! $this->checkout->payment_required()
 			// but do NOT remove if current action being called belongs to this reg step
-			&& ! is_callable( array( $this, $this->checkout->action ) )
+			&& ! is_callable(array($this, $this->checkout->action))
 			&& ! $this->completed()
 		) {
 			// and if so, then we no longer need the Payment Options step
-			if ( $this->is_current_step() ) {
+			if ($this->is_current_step()) {
 				$this->checkout->generate_reg_form = false;
 			}
-			$this->checkout->remove_reg_step( $this->_slug );
+			$this->checkout->remove_reg_step($this->_slug);
 			// DEBUG LOG
 			//$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
 			return false;
 		}
 		// load EEM_Payment_Method
-		EE_Registry::instance()->load_model( 'Payment_Method' );
+		EE_Registry::instance()->load_model('Payment_Method');
 		// get all active payment methods
 		$this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
 			$this->checkout->transaction,
@@ -280,16 +280,16 @@ 
 		$insufficient_spaces_available = array();
 		$no_payment_required = true;
 		// loop thru registrations to gather info
-		$registrations = $this->checkout->transaction->registrations( $this->checkout->reg_cache_where_params );
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
 		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
 			$registrations,
 			$this->checkout->revisit
 		);
-		foreach ( $registrations as $REG_ID => $registration ) {
+		foreach ($registrations as $REG_ID => $registration) {
             /** @var $registration EE_Registration */
             // has this registration lost it's space ?
-			if ( isset( $ejected_registrations[ $REG_ID ] ) ) {
-				$insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
+			if (isset($ejected_registrations[$REG_ID])) {
+				$insufficient_spaces_available[$registration->event()->ID()] = $registration->event();
 				continue;
 			}
             // event requires admin approval
@@ -310,11 +310,11 @@ 
 				&& $registration->status_ID() !== EEM_Registration::status_id_approved
                 && (
                     $registration->event()->is_sold_out()
-                    || $registration->event()->is_sold_out( true )
+                    || $registration->event()->is_sold_out(true)
                 )
             ) {
                 // add event to list of events that are sold out
-                $sold_out_events[ $registration->event()->ID() ] = $registration->event();
+                $sold_out_events[$registration->event()->ID()] = $registration->event();
                 do_action(
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__sold_out_event',
                     $registration->event(),
@@ -323,8 +323,8 @@ 
                 continue;
 			}
 			// are they allowed to pay now and is there monies owing?
-			if ( $registration->owes_monies_and_can_pay() ) {
-				$registrations_requiring_payment[ $REG_ID ] = $registration;
+			if ($registration->owes_monies_and_can_pay()) {
+				$registrations_requiring_payment[$REG_ID] = $registration;
 				do_action(
 					'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
 					$registration->event(),
@@ -335,29 +335,29 @@ 
 				&& $registration->status_ID() !== EEM_Registration::status_id_not_approved
 				&& $registration->ticket()->is_free()
 			) {
-				$registrations_for_free_events[ $registration->event()->ID() ] = $registration;
+				$registrations_for_free_events[$registration->event()->ID()] = $registration;
 			}
 		}
 		$subsections = array();
 		// now decide which template to load
-		if ( ! empty( $sold_out_events ) ) {
-			$subsections['sold_out_events'] = $this->_sold_out_events( $sold_out_events );
+		if ( ! empty($sold_out_events)) {
+			$subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
 		}
-		if ( ! empty( $insufficient_spaces_available ) ) {
+		if ( ! empty($insufficient_spaces_available)) {
 			$subsections['insufficient_space'] = $this->_insufficient_spaces_available(
 				$insufficient_spaces_available
 			);
 		}
-		if ( ! empty( $registrations_requiring_pre_approval ) ) {
+		if ( ! empty($registrations_requiring_pre_approval)) {
 			$subsections['registrations_requiring_pre_approval'] = $this->_registrations_requiring_pre_approval(
 				$registrations_requiring_pre_approval
 			);
 		}
-		if ( ! empty( $registrations_for_free_events ) ) {
-			$subsections['no_payment_required'] = $this->_no_payment_required( $registrations_for_free_events );
+		if ( ! empty($registrations_for_free_events)) {
+			$subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
 		}
-		if ( ! empty( $registrations_requiring_payment ) ) {
-			if ( $this->checkout->amount_owing > 0 ) {
+		if ( ! empty($registrations_requiring_payment)) {
+			if ($this->checkout->amount_owing > 0) {
 				// autoload Line_Item_Display classes
 				EEH_Autoloader::register_line_item_filter_autoloaders();
 				$line_item_filter_processor = new EE_Line_Item_Filter_Processor(
@@ -370,15 +370,15 @@ 
 				/** @var EE_Line_Item $filtered_line_item_tree */
 				$filtered_line_item_tree = $line_item_filter_processor->process();
 				EEH_Autoloader::register_line_item_display_autoloaders();
-				$this->set_line_item_display( new EE_Line_Item_Display( 'spco' ) );
+				$this->set_line_item_display(new EE_Line_Item_Display('spco'));
 				$subsections['payment_options'] = $this->_display_payment_options(
 					$this->line_item_display->display_line_item(
 						$filtered_line_item_tree,
-						array( 'registrations' => $registrations )
+						array('registrations' => $registrations)
 					)
 				);
 				$this->checkout->amount_owing = $filtered_line_item_tree->total();
-				$this->_apply_registration_payments_to_amount_owing( $registrations );
+				$this->_apply_registration_payments_to_amount_owing($registrations);
 			}
 			$no_payment_required = false;
 		} else {
@@ -387,7 +387,7 @@ 
 		$this->_save_selected_method_of_payment();
 
 		$subsections['default_hidden_inputs'] = $this->reg_step_hidden_inputs();
-		$subsections['extra_hidden_inputs' ] = $this->_extra_hidden_inputs( $no_payment_required );
+		$subsections['extra_hidden_inputs'] = $this->_extra_hidden_inputs($no_payment_required);
 
 		return new EE_Form_Section_Proper(
 			array(
@@ -414,14 +414,14 @@ 
 	 * @return \EE_Line_Item_Filter_Collection
 	 * @throws \EE_Error
 	 */
-	public static function add_spco_line_item_filters( EE_Line_Item_Filter_Collection $line_item_filter_collection ) {
-		if ( ! EE_Registry::instance()->SSN instanceof EE_Session ) {
+	public static function add_spco_line_item_filters(EE_Line_Item_Filter_Collection $line_item_filter_collection) {
+		if ( ! EE_Registry::instance()->SSN instanceof EE_Session) {
 			return $line_item_filter_collection;
 		}
-		if ( ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout ) {
+		if ( ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout) {
 			return $line_item_filter_collection;
 		}
-		if ( ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction ) {
+		if ( ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction) {
 			return $line_item_filter_collection;
 		}
 		$line_item_filter_collection->add(
@@ -433,7 +433,7 @@ 
 				)
 			)
         );
-		$line_item_filter_collection->add( new EE_Non_Zero_Line_Item_Filter() );
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
 		return $line_item_filter_collection;
 	}
 
@@ -449,15 +449,15 @@ 
 	 * @return \EE_Registration[]
 	 * @throws \EE_Error
 	 */
-	public static function remove_ejected_registrations( array $registrations ) {
+	public static function remove_ejected_registrations(array $registrations) {
 		$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
 			$registrations,
 			EE_Registry::instance()->SSN->checkout()->revisit
 		);
-		foreach ( $registrations as $REG_ID => $registration ) {
+		foreach ($registrations as $REG_ID => $registration) {
 			// has this registration lost it's space ?
-			if ( isset( $ejected_registrations[ $REG_ID ] ) ) {
-				unset( $registrations[ $REG_ID ] );
+			if (isset($ejected_registrations[$REG_ID])) {
+				unset($registrations[$REG_ID]);
 				continue;
 			}
 		}
@@ -480,7 +480,7 @@ 
 	 * @return array
 	 * @throws \EE_Error
 	 */
-	public static function find_registrations_that_lost_their_space( array $registrations, $revisit = false ) {
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false) {
         // registrations per event
 		$event_reg_count = array();
 		// spaces left per event
@@ -489,8 +489,8 @@ 
         $tickets_remaining = array();
         // registrations that have lost their space
 		$ejected_registrations = array();
-		foreach ( $registrations as $REG_ID => $registration ) {
-			if ( $registration->status_ID() === EEM_Registration::status_id_approved ) {
+		foreach ($registrations as $REG_ID => $registration) {
+			if ($registration->status_ID() === EEM_Registration::status_id_approved) {
 				continue;
 			}
 			$EVT_ID = $registration->event_ID();
@@ -511,13 +511,13 @@ 
 				$revisit
 				&& (
                     $tickets_remaining[$ticket->ID()] === 0
-				    || $event_reg_count[ $EVT_ID ] > $event_spaces_remaining[ $EVT_ID ]
+				    || $event_reg_count[$EVT_ID] > $event_spaces_remaining[$EVT_ID]
                 )
 			) {
-				$ejected_registrations[ $REG_ID ] = $registration->event();
-				if ( $registration->status_ID() !== EEM_Registration::status_id_wait_list ) {
+				$ejected_registrations[$REG_ID] = $registration->event();
+				if ($registration->status_ID() !== EEM_Registration::status_id_wait_list) {
 					/** @type EE_Registration_Processor $registration_processor */
-					$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 					// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
 					$registration_processor->manually_update_registration_status(
 						$registration,
@@ -552,8 +552,8 @@ 
 	 * @return void
 	 */
 	protected function _hide_reg_step_submit_button_if_revisit() {
-		if ( $this->checkout->revisit ) {
-			add_filter( 'FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string' );
+		if ($this->checkout->revisit) {
+			add_filter('FHEE__EE_SPCO_Reg_Step__reg_step_submit_button__sbmt_btn_html', '__return_empty_string');
 		}
 	}
 
@@ -567,13 +567,13 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _sold_out_events( $sold_out_events_array = array() ) {
+	private function _sold_out_events($sold_out_events_array = array()) {
 		// set some defaults
 		$this->checkout->selected_method_of_payment = 'events_sold_out';
 		$sold_out_events = '';
-		foreach ( $sold_out_events_array as $sold_out_event ) {
+		foreach ($sold_out_events_array as $sold_out_event) {
 			$sold_out_events .= EEH_HTML::li(
-				EEH_HTML::span( '  ' .$sold_out_event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text' )
+				EEH_HTML::span('  '.$sold_out_event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
 			);
 		}
 		return new EE_Form_Section_Proper(
@@ -591,7 +591,7 @@ 
 								'sold_out_events_msg' => apply_filters(
 									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
 									sprintf(
-										__( 'It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$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.%2$s', 'event_espresso' ),
+										__('It appears that the event you were about to make a payment for has sold out since you first registered. If you have already made a partial payment towards this event, please contact the event administrator for a refund.%3$s%3$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.%2$s', 'event_espresso'),
 										'<strong>',
 										'</strong>',
 										'<br />'
@@ -616,14 +616,14 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _insufficient_spaces_available( $insufficient_spaces_events_array = array() ) {
+	private function _insufficient_spaces_available($insufficient_spaces_events_array = array()) {
 		// set some defaults
 		$this->checkout->selected_method_of_payment = 'invoice';
 		$insufficient_space_events = '';
-		foreach ( $insufficient_spaces_events_array as $event ) {
-			if ( $event instanceof EE_Event ) {
+		foreach ($insufficient_spaces_events_array as $event) {
+			if ($event instanceof EE_Event) {
 				$insufficient_space_events .= EEH_HTML::li(
-					EEH_HTML::span( ' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text' )
+					EEH_HTML::span(' '.$event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
 				);
 			}
 		}
@@ -667,17 +667,17 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _registrations_requiring_pre_approval( $registrations_requiring_pre_approval = array() ) {
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = array()) {
 		$events_requiring_pre_approval = '';
-		foreach ( $registrations_requiring_pre_approval as $registration ) {
-			if ( $registration instanceof EE_Registration && $registration->event() instanceof EE_Event ) {
-				$events_requiring_pre_approval[ $registration->event()->ID() ] = EEH_HTML::li(
+		foreach ($registrations_requiring_pre_approval as $registration) {
+			if ($registration instanceof EE_Registration && $registration->event() instanceof EE_Event) {
+				$events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
 					EEH_HTML::span(
 						'',
 						'',
 						'dashicons dashicons-marker ee-icon-size-16 orange-text'
 					)
-					. EEH_HTML::span( $registration->event()->name(), '', 'orange-text' )
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
 				);
 			}
 		}
@@ -692,7 +692,7 @@ 
 						'template_args'        => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
 							array(
-								'events_requiring_pre_approval'     => implode( '', $events_requiring_pre_approval ),
+								'events_requiring_pre_approval'     => implode('', $events_requiring_pre_approval),
 								'events_requiring_pre_approval_msg' => apply_filters(
 									'FHEE__EE_SPCO_Reg_Step_Payment_Options___events_requiring_pre_approval__events_requiring_pre_approval_msg',
 									__(
@@ -717,7 +717,7 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _no_payment_required( $registrations_for_free_events = array() ) {
+	private function _no_payment_required($registrations_for_free_events = array()) {
 		// set some defaults
 		$this->checkout->selected_method_of_payment = 'no_payment_required';
 		// generate no_payment_required form
@@ -737,7 +737,7 @@ 
 								'ticket_count'                  => array(),
 								'registrations_for_free_events' => $registrations_for_free_events,
 								'no_payment_required_msg'       => EEH_HTML::p(
-									__( 'This is a free event, so no billing will occur.', 'event_espresso' )
+									__('This is a free event, so no billing will occur.', 'event_espresso')
 								)
 							)
 						),
@@ -756,7 +756,7 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _display_payment_options( $transaction_details = '' ) {
+	private function _display_payment_options($transaction_details = '') {
 		// has method_of_payment been set by no-js user?
 		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment();
 		// build payment options form
@@ -768,14 +768,14 @@ 
 						'before_payment_options' => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
 							new EE_Form_Section_Proper(
-								array( 'layout_strategy' => new EE_Div_Per_Section_Layout() )
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
 							)
 						),
 						'payment_options'        => $this->_setup_payment_options(),
 						'after_payment_options'  => apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__after_payment_options',
 							new EE_Form_Section_Proper(
-								array( 'layout_strategy' => new EE_Div_Per_Section_Layout() )
+								array('layout_strategy' => new EE_Div_Per_Section_Layout())
 							)
 						),
 					),
@@ -806,10 +806,10 @@ 
 	 * @return \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _extra_hidden_inputs( $no_payment_required = true ) {
+	private function _extra_hidden_inputs($no_payment_required = true) {
 		return new EE_Form_Section_Proper(
 			array(
-				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+				'html_id'         => 'ee-'.$this->slug().'-extra-hidden-inputs',
 				'layout_strategy' => new EE_Div_Per_Section_Layout(),
 				'subsections'     => array(
 					'spco_no_payment_required' => new EE_Hidden_Input(
@@ -841,16 +841,16 @@ 
 	 * @access protected
 	 * @param array $registrations
 	 */
-	protected function _apply_registration_payments_to_amount_owing( array $registrations ) {
+	protected function _apply_registration_payments_to_amount_owing(array $registrations) {
 		$payments = array();
-		foreach ( $registrations as $registration ) {
-			if ( $registration instanceof EE_Registration && $registration->owes_monies_and_can_pay() ) {
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration && $registration->owes_monies_and_can_pay()) {
 				$payments += $registration->registration_payments();
 			}
 		}
-		if ( ! empty( $payments ) ) {
-			foreach ( $payments as $payment ) {
-				if ( $payment instanceof EE_Registration_Payment ) {
+		if ( ! empty($payments)) {
+			foreach ($payments as $payment) {
+				if ($payment instanceof EE_Registration_Payment) {
 					$this->checkout->amount_owing -= $payment->amount();
 				}
 			}
@@ -866,11 +866,11 @@ 
 	 * @param    bool $force_reset
 	 * @return    void
 	 */
-	private function _reset_selected_method_of_payment( $force_reset = false ) {
+	private function _reset_selected_method_of_payment($force_reset = false) {
 		$reset_payment_method = $force_reset
 			? true
-			: sanitize_text_field( EE_Registry::instance()->REQ->get( 'reset_payment_method', false ) );
-		if ( $reset_payment_method ) {
+			: sanitize_text_field(EE_Registry::instance()->REQ->get('reset_payment_method', false));
+		if ($reset_payment_method) {
 			$this->checkout->selected_method_of_payment = null;
 			$this->checkout->payment_method = null;
 			$this->checkout->billing_form = null;
@@ -889,12 +889,12 @@ 
 	 * @param string $selected_method_of_payment
 	 * @return  void
 	 */
-	private function _save_selected_method_of_payment( $selected_method_of_payment = '' ) {
-		$selected_method_of_payment = ! empty( $selected_method_of_payment )
+	private function _save_selected_method_of_payment($selected_method_of_payment = '') {
+		$selected_method_of_payment = ! empty($selected_method_of_payment)
 			? $selected_method_of_payment
 			: $this->checkout->selected_method_of_payment;
 		EE_Registry::instance()->SSN->set_session_data(
-			array( 'selected_method_of_payment' => $selected_method_of_payment )
+			array('selected_method_of_payment' => $selected_method_of_payment)
 		);
 	}
 
@@ -910,19 +910,19 @@ 
 		// load payment method classes
 		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
 		// switch up header depending on number of available payment methods
-		$payment_method_header = count( $this->checkout->available_payment_methods ) > 1
+		$payment_method_header = count($this->checkout->available_payment_methods) > 1
 			? apply_filters(
 				'FHEE__registration_page_payment_options__method_of_payment_hdr',
-				__( 'Please Select Your Method of Payment', 'event_espresso' )
+				__('Please Select Your Method of Payment', 'event_espresso')
 			)
 			: apply_filters(
 				'FHEE__registration_page_payment_options__method_of_payment_hdr',
-				__( 'Method of Payment', 'event_espresso' )
+				__('Method of Payment', 'event_espresso')
 			);
 		$available_payment_methods = array(
 			// display the "Payment Method" header
 			'payment_method_header' => new EE_Form_Section_HTML(
-				EEH_HTML::h4( $payment_method_header, 'method-of-payment-hdr' )
+				EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr')
 			)
 		);
 		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
@@ -931,32 +931,32 @@ 
 		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
 		$payment_methods_billing_info = array(
 			new EE_Form_Section_HTML(
-				EEH_HTML::div( '<br />', '', '', 'clear:both;' )
+				EEH_HTML::div('<br />', '', '', 'clear:both;')
 			)
 		);
 		// loop through payment methods
-		foreach ( $this->checkout->available_payment_methods as $payment_method ) {
-			if ( $payment_method instanceof EE_Payment_Method ) {
+		foreach ($this->checkout->available_payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
 				$payment_method_button = EEH_HTML::img(
 					$payment_method->button_url(),
 					$payment_method->name(),
-					'spco-payment-method-' . $payment_method->slug() . '-btn-img',
+					'spco-payment-method-'.$payment_method->slug().'-btn-img',
 					'spco-payment-method-btn-img'
 				);
 				// check if any payment methods are set as default
 				// if payment method is already selected OR nothing is selected and this payment method should be open_by_default
 				if (
-					( $this->checkout->selected_method_of_payment === $payment_method->slug() )
-					|| ( ! $this->checkout->selected_method_of_payment && $payment_method->open_by_default() )
+					($this->checkout->selected_method_of_payment === $payment_method->slug())
+					|| ( ! $this->checkout->selected_method_of_payment && $payment_method->open_by_default())
 				) {
 					$this->checkout->selected_method_of_payment = $payment_method->slug();
 					$this->_save_selected_method_of_payment();
-					$default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
+					$default_payment_method_option[$payment_method->slug()] = $payment_method_button;
 				} else {
-					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
+					$available_payment_method_options[$payment_method->slug()] = $payment_method_button;
 				}
-				$payment_methods_billing_info[ $payment_method->slug()
-				                               . '-info' ] = $this->_payment_method_billing_info(
+				$payment_methods_billing_info[$payment_method->slug()
+				                               . '-info'] = $this->_payment_method_billing_info(
 					$payment_method
 				);
 			}
@@ -986,12 +986,12 @@ 
 	 * @return EE_Payment_Method[]
 	 */
 	protected function _get_available_payment_methods() {
-		if ( ! empty( $this->checkout->available_payment_methods ) ) {
+		if ( ! empty($this->checkout->available_payment_methods)) {
 			return $this->checkout->available_payment_methods;
 		}
 		$available_payment_methods = array();
 		// load EEM_Payment_Method
-		EE_Registry::instance()->load_model( 'Payment_Method' );
+		EE_Registry::instance()->load_model('Payment_Method');
 		/** @type EEM_Payment_Method $EEM_Payment_Method */
 		$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
 		// get all active payment methods
@@ -999,9 +999,9 @@ 
 			$this->checkout->transaction,
 			EEM_Payment_Method::scope_cart
 		);
-		foreach ( $payment_methods as $payment_method ) {
-			if ( $payment_method instanceof EE_Payment_Method ) {
-				$available_payment_methods[ $payment_method->slug() ] = $payment_method;
+		foreach ($payment_methods as $payment_method) {
+			if ($payment_method instanceof EE_Payment_Method) {
+				$available_payment_methods[$payment_method->slug()] = $payment_method;
 			}
 		}
 		return $available_payment_methods;
@@ -1016,14 +1016,14 @@ 
 	 * @param    array $available_payment_method_options
 	 * @return    \EE_Form_Section_Proper
 	 */
-	private function _available_payment_method_inputs( $available_payment_method_options = array() ) {
+	private function _available_payment_method_inputs($available_payment_method_options = array()) {
 		// generate inputs
 		return new EE_Form_Section_Proper(
 			array(
 				'html_id'         => 'ee-available-payment-method-inputs',
 				'layout_strategy' => new EE_Div_Per_Section_Layout(),
 				'subsections'     => array(
-					'' => new EE_Radio_Button_Input (
+					'' => new EE_Radio_Button_Input(
 						$available_payment_method_options,
 						array(
 							'html_name'          => 'selected_method_of_payment',
@@ -1048,28 +1048,28 @@ 
 	 * @return    \EE_Form_Section_Proper
 	 * @throws \EE_Error
 	 */
-	private function _payment_method_billing_info( EE_Payment_Method $payment_method ) {
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method) {
 		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug()
 			? true
 			: false;
 		// generate the billing form for payment method
 		$billing_form = $currently_selected
-			? $this->_get_billing_form_for_payment_method( $payment_method )
+			? $this->_get_billing_form_for_payment_method($payment_method)
 			: new EE_Form_Section_HTML();
 		$this->checkout->billing_form = $currently_selected
 			? $billing_form
 			: $this->checkout->billing_form;
 		// it's all in the details
 		$info_html = EEH_HTML::h3(
-			__( 'Important information regarding your payment', 'event_espresso' ),
+			__('Important information regarding your payment', 'event_espresso'),
 			'',
 			'spco-payment-method-hdr'
 		);
 		// add some info regarding the step, either from what's saved in the admin,
 		// or a default string depending on whether the PM has a billing form or not
-		if ( $payment_method->description() ) {
+		if ($payment_method->description()) {
 			$payment_method_info = $payment_method->description();
-		} elseif ( $billing_form instanceof EE_Billing_Info_Form ) {
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
 			$payment_method_info = sprintf(
 				__(
 					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
@@ -1079,7 +1079,7 @@ 
 			);
 		} else {
 			$payment_method_info = sprintf(
-				__( 'Please click the "%1$s" button below in order to proceed.', 'event_espresso' ),
+				__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
 				$this->submit_button_text()
 			);
 		}
@@ -1093,13 +1093,13 @@ 
 		);
 		return new EE_Form_Section_Proper(
 			array(
-				'html_id'         => 'spco-payment-method-info-' . $payment_method->slug(),
+				'html_id'         => 'spco-payment-method-info-'.$payment_method->slug(),
 				'html_class'      => 'spco-payment-method-info-dv',
 				// only display the selected or default PM
 				'html_style'      => $currently_selected ? '' : 'display:none;',
 				'layout_strategy' => new EE_Div_Per_Section_Layout(),
 				'subsections'     => array(
-					'info'         => new EE_Form_Section_HTML( $info_html ),
+					'info'         => new EE_Form_Section_HTML($info_html),
 					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML()
 				)
 			)
@@ -1117,15 +1117,15 @@ 
 	 */
 	public function get_billing_form_html_for_payment_method() {
 		// how have they chosen to pay?
-		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment( true );
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
 		$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
-		if ( ! $this->checkout->payment_method instanceof EE_Payment_Method ) {
+		if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
 			return false;
 		}
-		if ( apply_filters(
+		if (apply_filters(
 			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
 			false
-		) ) {
+		)) {
 			EE_Error::add_success(
 				apply_filters(
 					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
@@ -1140,7 +1140,7 @@ 
 			);
 		}
 		// now generate billing form for selected method of payment
-		$payment_method_billing_form = $this->_get_billing_form_for_payment_method( $this->checkout->payment_method );
+		$payment_method_billing_form = $this->_get_billing_form_for_payment_method($this->checkout->payment_method);
 		// fill form with attendee info if applicable
 		if (
 			$payment_method_billing_form instanceof EE_Billing_Attendee_Info_Form
@@ -1162,10 +1162,10 @@ 
 		$billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
 			? $payment_method_billing_form->get_html()
 			: '';
-		$this->checkout->json_response->set_return_data( array( 'payment_method_info' => $billing_info ) );
+		$this->checkout->json_response->set_return_data(array('payment_method_info' => $billing_info));
 		// localize validation rules for main form
 		$this->checkout->current_step->reg_form->localize_validation_rules();
-		$this->checkout->json_response->add_validation_rules( EE_Form_Section_Proper::js_localization() );
+		$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
 		return true;
 	}
 
@@ -1179,18 +1179,18 @@ 
 	 * @return \EE_Billing_Info_Form|\EE_Form_Section_HTML
 	 * @throws \EE_Error
 	 */
-	private function _get_billing_form_for_payment_method( EE_Payment_Method $payment_method ) {
+	private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method) {
 		$billing_form = $payment_method->type_obj()->billing_form(
 			$this->checkout->transaction,
-			array( 'amount_owing' => $this->checkout->amount_owing )
+			array('amount_owing' => $this->checkout->amount_owing)
 		);
-		if ( $billing_form instanceof EE_Billing_Info_Form ) {
+		if ($billing_form instanceof EE_Billing_Info_Form) {
 			if (
 				apply_filters(
 					'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
 					false
 				)
-				&& EE_Registry::instance()->REQ->is_set( 'payment_method' )
+				&& EE_Registry::instance()->REQ->is_set('payment_method')
 			) {
 				EE_Error::add_success(
 					apply_filters(
@@ -1232,15 +1232,15 @@ 
 		$request_param = 'selected_method_of_payment'
 	) {
 		// is selected_method_of_payment set in the request ?
-		$selected_method_of_payment = EE_Registry::instance()->REQ->get( $request_param, false );
-		if ( $selected_method_of_payment ) {
+		$selected_method_of_payment = EE_Registry::instance()->REQ->get($request_param, false);
+		if ($selected_method_of_payment) {
 			// sanitize it
-			$selected_method_of_payment = is_array( $selected_method_of_payment )
-				? array_shift( $selected_method_of_payment )
+			$selected_method_of_payment = is_array($selected_method_of_payment)
+				? array_shift($selected_method_of_payment)
 				: $selected_method_of_payment;
-			$selected_method_of_payment = sanitize_text_field( $selected_method_of_payment );
+			$selected_method_of_payment = sanitize_text_field($selected_method_of_payment);
 			// store it in the session so that it's available for all subsequent requests including AJAX
-			$this->_save_selected_method_of_payment( $selected_method_of_payment );
+			$this->_save_selected_method_of_payment($selected_method_of_payment);
 		} else {
 			// or is is set in the session ?
 			$selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
@@ -1248,7 +1248,7 @@ 
 			);
 		}
 		// do ya really really gotta have it?
-		if ( empty( $selected_method_of_payment ) && $required ) {
+		if (empty($selected_method_of_payment) && $required) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -1257,7 +1257,7 @@ 
 					),
 					'<br/>',
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1284,13 +1284,13 @@ 
 	 * @throws \EE_Error
 	 */
 	public function switch_payment_method() {
-		if ( ! $this->_verify_payment_method_is_set() ) {
+		if ( ! $this->_verify_payment_method_is_set()) {
 			return false;
 		}
-		if ( apply_filters(
+		if (apply_filters(
 			'FHEE__EE_SPCO_Reg_Step_Payment_Options__registration_checkout__selected_payment_method__display_success',
 			false
-		) ) {
+		)) {
 			EE_Error::add_success(
 				apply_filters(
 					'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
@@ -1305,7 +1305,7 @@ 
 			);
 		}
 		// generate billing form for selected method of payment if it hasn't been done already
-		if ( $this->checkout->payment_method->type_obj()->has_billing_form() ) {
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
 			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
 				$this->checkout->payment_method
 			);
@@ -1327,7 +1327,7 @@ 
 			);
 		}
 		// and debug content
-		if ( $this->checkout->billing_form instanceof EE_Billing_Info_Form
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form
 		     && $this->checkout->payment_method->type_obj() instanceof EE_PMT_Base
 		) {
 			$this->checkout->billing_form = $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
@@ -1335,15 +1335,15 @@ 
 			);
 		}
 		// get html and validation rules for form
-		if ( $this->checkout->billing_form instanceof EE_Form_Section_Proper ) {
+		if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
 			$this->checkout->json_response->set_return_data(
-				array( 'payment_method_info' => $this->checkout->billing_form->get_html() )
+				array('payment_method_info' => $this->checkout->billing_form->get_html())
 			);
 			// localize validation rules for main form
-			$this->checkout->billing_form->localize_validation_rules( true );
-			$this->checkout->json_response->add_validation_rules( EE_Form_Section_Proper::js_localization() );
+			$this->checkout->billing_form->localize_validation_rules(true);
+			$this->checkout->json_response->add_validation_rules(EE_Form_Section_Proper::js_localization());
 		} else {
-			$this->checkout->json_response->set_return_data( array( 'payment_method_info' => '' ) );
+			$this->checkout->json_response->set_return_data(array('payment_method_info' => ''));
 		}
 		//prevents advancement to next step
 		$this->checkout->continue_reg = false;
@@ -1360,18 +1360,18 @@ 
 	 */
 	protected function _verify_payment_method_is_set() {
 		// generate billing form for selected method of payment if it hasn't been done already
-		if ( empty( $this->checkout->selected_method_of_payment ) ) {
+		if (empty($this->checkout->selected_method_of_payment)) {
 			// how have they chosen to pay?
-			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment( true );
+			$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
 		} else {
 			// choose your own adventure based on method_of_payment
-			switch ( $this->checkout->selected_method_of_payment ) {
+			switch ($this->checkout->selected_method_of_payment) {
 				case 'events_sold_out' :
 					EE_Error::add_attention(
 						apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__sold_out_events_msg',
-							__( 'It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
-								'event_espresso' )
+							__('It appears that the event you were about to make a payment for has sold out since this form first loaded. Please contact the event administrator if you believe this is an error.',
+								'event_espresso')
 						),
 						__FILE__, __FUNCTION__, __LINE__
 					);
@@ -1381,7 +1381,7 @@ 
 					EE_Error::add_attention(
 						apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
-							__( 'It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.', 'event_espresso' )
+							__('It appears that the event you were about to make a payment for is not accepting payments at this time. Please contact the event administrator if you believe this is an error.', 'event_espresso')
 						),
 						__FILE__, __FUNCTION__, __LINE__
 					);
@@ -1391,7 +1391,7 @@ 
 					EE_Error::add_attention(
 						apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
-							__( 'It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.', 'event_espresso' )
+							__('It appears that the event you were about to make a payment for does not require payment. Please contact the event administrator if you believe this is an error.', 'event_espresso')
 						),
 						__FILE__, __FUNCTION__, __LINE__
 					);
@@ -1401,7 +1401,7 @@ 
 			}
 		}
 		// verify payment method
-		if ( ! $this->checkout->payment_method instanceof EE_Payment_Method ) {
+		if ( ! $this->checkout->payment_method instanceof EE_Payment_Method) {
 			// get payment method for selected method of payment
 			$this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment();
 		}
@@ -1420,25 +1420,25 @@ 
 	 * @throws \EE_Error
 	 */
 	public function save_payer_details_via_ajax() {
-		if ( ! $this->_verify_payment_method_is_set() ) {
+		if ( ! $this->_verify_payment_method_is_set()) {
 			return;
 		}
 		// generate billing form for selected method of payment if it hasn't been done already
-		if ( $this->checkout->payment_method->type_obj()->has_billing_form() ) {
+		if ($this->checkout->payment_method->type_obj()->has_billing_form()) {
 			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
 				$this->checkout->payment_method
 			);
 		}
 		// generate primary attendee from payer info if applicable
-		if ( ! $this->checkout->transaction_has_primary_registrant() ) {
+		if ( ! $this->checkout->transaction_has_primary_registrant()) {
 			$attendee = $this->_create_attendee_from_request_data();
-			if ( $attendee instanceof EE_Attendee ) {
-				foreach ( $this->checkout->transaction->registrations() as $registration ) {
-					if ( $registration->is_primary_registrant() ) {
+			if ($attendee instanceof EE_Attendee) {
+				foreach ($this->checkout->transaction->registrations() as $registration) {
+					if ($registration->is_primary_registrant()) {
 						$this->checkout->primary_attendee_obj = $attendee;
-						$registration->_add_relation_to( $attendee, 'Attendee' );
-						$registration->set_attendee_id( $attendee->ID() );
-						$registration->update_cache_after_object_save( 'Attendee', $attendee );
+						$registration->_add_relation_to($attendee, 'Attendee');
+						$registration->set_attendee_id($attendee->ID());
+						$registration->update_cache_after_object_save('Attendee', $attendee);
 					}
 				}
 			}
@@ -1456,50 +1456,50 @@ 
 	 */
 	protected function _create_attendee_from_request_data() {
 		// get State ID
-		$STA_ID = ! empty( $_REQUEST['state'] ) ? sanitize_text_field( $_REQUEST['state'] ) : '';
-		if ( ! empty( $STA_ID ) ) {
+		$STA_ID = ! empty($_REQUEST['state']) ? sanitize_text_field($_REQUEST['state']) : '';
+		if ( ! empty($STA_ID)) {
 			// can we get state object from name ?
-			EE_Registry::instance()->load_model( 'State' );
-			$state = EEM_State::instance()->get_col( array( array( 'STA_name' => $STA_ID ), 'limit' => 1 ), 'STA_ID' );
-			$STA_ID = is_array( $state ) && ! empty( $state ) ? reset( $state ) : $STA_ID;
+			EE_Registry::instance()->load_model('State');
+			$state = EEM_State::instance()->get_col(array(array('STA_name' => $STA_ID), 'limit' => 1), 'STA_ID');
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
 		}
 		// get Country ISO
-		$CNT_ISO = ! empty( $_REQUEST['country'] ) ? sanitize_text_field( $_REQUEST['country'] ) : '';
-		if ( ! empty( $CNT_ISO ) ) {
+		$CNT_ISO = ! empty($_REQUEST['country']) ? sanitize_text_field($_REQUEST['country']) : '';
+		if ( ! empty($CNT_ISO)) {
 			// can we get country object from name ?
-			EE_Registry::instance()->load_model( 'Country' );
+			EE_Registry::instance()->load_model('Country');
 			$country = EEM_Country::instance()->get_col(
-				array( array( 'CNT_name' => $CNT_ISO ), 'limit' => 1 ),
+				array(array('CNT_name' => $CNT_ISO), 'limit' => 1),
 				'CNT_ISO'
 			);
-			$CNT_ISO = is_array( $country ) && ! empty( $country ) ? reset( $country ) : $CNT_ISO;
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
 		}
 		// grab attendee data
 		$attendee_data = array(
-			'ATT_fname'    => ! empty( $_REQUEST['first_name'] ) ? sanitize_text_field( $_REQUEST['first_name'] ) : '',
-			'ATT_lname'    => ! empty( $_REQUEST['last_name'] ) ? sanitize_text_field( $_REQUEST['last_name'] ) : '',
-			'ATT_email'    => ! empty( $_REQUEST['email'] ) ? sanitize_email( $_REQUEST['email'] ) : '',
-			'ATT_address'  => ! empty( $_REQUEST['address'] ) ? sanitize_text_field( $_REQUEST['address'] ) : '',
-			'ATT_address2' => ! empty( $_REQUEST['address2'] ) ? sanitize_text_field( $_REQUEST['address2'] ) : '',
-			'ATT_city'     => ! empty( $_REQUEST['city'] ) ? sanitize_text_field( $_REQUEST['city'] ) : '',
+			'ATT_fname'    => ! empty($_REQUEST['first_name']) ? sanitize_text_field($_REQUEST['first_name']) : '',
+			'ATT_lname'    => ! empty($_REQUEST['last_name']) ? sanitize_text_field($_REQUEST['last_name']) : '',
+			'ATT_email'    => ! empty($_REQUEST['email']) ? sanitize_email($_REQUEST['email']) : '',
+			'ATT_address'  => ! empty($_REQUEST['address']) ? sanitize_text_field($_REQUEST['address']) : '',
+			'ATT_address2' => ! empty($_REQUEST['address2']) ? sanitize_text_field($_REQUEST['address2']) : '',
+			'ATT_city'     => ! empty($_REQUEST['city']) ? sanitize_text_field($_REQUEST['city']) : '',
 			'STA_ID'       => $STA_ID,
 			'CNT_ISO'      => $CNT_ISO,
-			'ATT_zip'      => ! empty( $_REQUEST['zip'] ) ? sanitize_text_field( $_REQUEST['zip'] ) : '',
-			'ATT_phone'    => ! empty( $_REQUEST['phone'] ) ? sanitize_text_field( $_REQUEST['phone'] ) : '',
+			'ATT_zip'      => ! empty($_REQUEST['zip']) ? sanitize_text_field($_REQUEST['zip']) : '',
+			'ATT_phone'    => ! empty($_REQUEST['phone']) ? sanitize_text_field($_REQUEST['phone']) : '',
 		);
 		// validate the email address since it is the most important piece of info
-		if ( empty( $attendee_data['ATT_email'] ) || $attendee_data['ATT_email'] !== $_REQUEST['email'] ) {
+		if (empty($attendee_data['ATT_email']) || $attendee_data['ATT_email'] !== $_REQUEST['email']) {
 			EE_Error::add_error(
-				__( 'An invalid email address was submitted.', 'event_espresso' ),
+				__('An invalid email address was submitted.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
 			);
 		}
 		// does this attendee already exist in the db ? we're searching using a combination of first name, last name, AND email address
-		if ( ! empty( $attendee_data['ATT_fname'] )
-		     && ! empty( $attendee_data['ATT_lname'] )
-		     && ! empty( $attendee_data['ATT_email'] )
+		if ( ! empty($attendee_data['ATT_fname'])
+		     && ! empty($attendee_data['ATT_lname'])
+		     && ! empty($attendee_data['ATT_email'])
 		) {
 			$existing_attendee = EE_Registry::instance()->LIB->EEM_Attendee->find_existing_attendee(
 				array(
@@ -1508,19 +1508,19 @@ 
 					'ATT_email' => $attendee_data['ATT_email']
 				)
 			);
-			if ( $existing_attendee instanceof EE_Attendee ) {
+			if ($existing_attendee instanceof EE_Attendee) {
 				return $existing_attendee;
 			}
 		}
 		// no existing attendee? kk let's create a new one
 		// kinda lame, but we need a first and last name to create an attendee, so use the email address if those don't exist
-		$attendee_data['ATT_fname'] = ! empty( $attendee_data['ATT_fname'] )
+		$attendee_data['ATT_fname'] = ! empty($attendee_data['ATT_fname'])
 			? $attendee_data['ATT_fname']
 			: $attendee_data['ATT_email'];
-		$attendee_data['ATT_lname'] = ! empty( $attendee_data['ATT_lname'] )
+		$attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
 			? $attendee_data['ATT_lname']
 			: $attendee_data['ATT_email'];
-		return EE_Attendee::new_instance( $attendee_data );
+		return EE_Attendee::new_instance($attendee_data);
 	}
 
 
@@ -1538,26 +1538,26 @@ 
 		// how have they chosen to pay?
 		$this->checkout->selected_method_of_payment = $this->checkout->transaction->is_free()
 			? 'no_payment_required'
-			: $this->_get_selected_method_of_payment( true );
+			: $this->_get_selected_method_of_payment(true);
 		// choose your own adventure based on method_of_payment
-		switch ( $this->checkout->selected_method_of_payment ) {
+		switch ($this->checkout->selected_method_of_payment) {
 
 			case 'events_sold_out' :
 				$this->checkout->redirect = true;
 				$this->checkout->redirect_url = $this->checkout->cancel_page_url;
-				$this->checkout->json_response->set_redirect_url( $this->checkout->redirect_url );
+				$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
 				// mark this reg step as completed
 				$this->set_completed();
 				return false;
 				break;
 
 			case 'payments_closed' :
-				if ( apply_filters(
+				if (apply_filters(
 					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
 					false
-				) ) {
+				)) {
 					EE_Error::add_success(
-						__( 'no payment required at this time.', 'event_espresso' ),
+						__('no payment required at this time.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1569,12 +1569,12 @@ 
 				break;
 
 			case 'no_payment_required' :
-				if ( apply_filters(
+				if (apply_filters(
 					'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
 					false
-				) ) {
+				)) {
 					EE_Error::add_success(
-						__( 'no payment required.', 'event_espresso' ),
+						__('no payment required.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -1594,15 +1594,15 @@ 
 					EE_Registry::instance()->SSN->checkout()->revisit
 				);
 				// calculate difference between the two arrays
-				$registrations = array_diff( $registrations, $ejected_registrations );
-				if ( empty( $registrations ) ) {
+				$registrations = array_diff($registrations, $ejected_registrations);
+				if (empty($registrations)) {
 					$this->_redirect_because_event_sold_out();
 					return false;
 				}
 				$payment_successful = $this->_process_payment();
-				if ( $payment_successful ) {
+				if ($payment_successful) {
 					$this->checkout->continue_reg = true;
-					$this->_maybe_set_completed( $this->checkout->payment_method );
+					$this->_maybe_set_completed($this->checkout->payment_method);
 				} else {
 					$this->checkout->continue_reg = false;
 				}
@@ -1623,10 +1623,10 @@ 
 		$this->checkout->continue_reg = false;
 		// set redirect URL
 		$this->checkout->redirect_url = add_query_arg(
-			array( 'e_reg_url_link' => $this->checkout->reg_url_link ),
+			array('e_reg_url_link' => $this->checkout->reg_url_link),
 			$this->checkout->current_step->reg_step_url()
 		);
-		$this->checkout->json_response->set_redirect_url( $this->checkout->redirect_url );
+		$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
 	}
 
 
@@ -1639,8 +1639,8 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _maybe_set_completed( EE_Payment_Method $payment_method ) {
-		switch ( $payment_method->type_obj()->payment_occurs() ) {
+	protected function _maybe_set_completed(EE_Payment_Method $payment_method) {
+		switch ($payment_method->type_obj()->payment_occurs()) {
 			case EE_PMT_Base::offsite :
 				break;
 			case EE_PMT_Base::onsite :
@@ -1663,7 +1663,7 @@ 
 	public function update_reg_step() {
 		$success = true;
 		// if payment required
-		if ( $this->checkout->transaction->total() > 0 ) {
+		if ($this->checkout->transaction->total() > 0) {
 			do_action(
 				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
 				$this->checkout->transaction
@@ -1671,13 +1671,13 @@ 
 			// attempt payment via payment method
 			$success = $this->process_reg_step();
 		}
-		if ( $success && ! $this->checkout->redirect ) {
+		if ($success && ! $this->checkout->redirect) {
 			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn(
 				$this->checkout->transaction->ID()
 			);
 			// set return URL
 			$this->checkout->redirect_url = add_query_arg(
-				array( 'e_reg_url_link' => $this->checkout->reg_url_link ),
+				array('e_reg_url_link' => $this->checkout->reg_url_link),
 				$this->checkout->thank_you_page_url
 			);
 		}
@@ -1695,36 +1695,36 @@ 
 	 */
 	private function _process_payment() {
 		// basically confirm that the event hasn't sold out since they hit the page
-		if ( ! $this->_last_second_ticket_verifications() ) {
+		if ( ! $this->_last_second_ticket_verifications()) {
 			return false;
 		}
 		// ya gotta make a choice man
-		if ( empty( $this->checkout->selected_method_of_payment ) ) {
+		if (empty($this->checkout->selected_method_of_payment)) {
 			$this->checkout->json_response->set_plz_select_method_of_payment(
-				__( 'Please select a method of payment before proceeding.', 'event_espresso' )
+				__('Please select a method of payment before proceeding.', 'event_espresso')
 			);
 			return false;
 		}
 		// get EE_Payment_Method object
-		if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment() ) {
+		if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
 			return false;
 		}
 		// setup billing form
-		if ( $this->checkout->payment_method->is_on_site() ) {
+		if ($this->checkout->payment_method->is_on_site()) {
 			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
 				$this->checkout->payment_method
 			);
 			// bad billing form ?
-			if ( ! $this->_billing_form_is_valid() ) {
+			if ( ! $this->_billing_form_is_valid()) {
 				return false;
 			}
 		}
 		// ensure primary registrant has been fully processed
-		if ( ! $this->_setup_primary_registrant_prior_to_payment() ) {
+		if ( ! $this->_setup_primary_registrant_prior_to_payment()) {
 			return false;
 		}
 		// if session is close to expiring (under 10 minutes by default)
-		if ( ( time() - EE_Registry::instance()->SSN->expiration() ) < EE_Registry::instance()->SSN->extension() ) {
+		if ((time() - EE_Registry::instance()->SSN->expiration()) < EE_Registry::instance()->SSN->extension()) {
 			// add some time to session expiration so that payment can be completed
 			EE_Registry::instance()->SSN->extend_expiration();
 		}
@@ -1733,12 +1733,12 @@ 
 		// in case a registrant leaves to an Off-Site Gateway and never returns, we want to approve any registrations for events with a default reg status of Approved
 		//$transaction_processor->toggle_registration_statuses_for_default_approved_events( $this->checkout->transaction, $this->checkout->reg_cache_where_params );
 		// attempt payment
-		$payment = $this->_attempt_payment( $this->checkout->payment_method );
+		$payment = $this->_attempt_payment($this->checkout->payment_method);
 		// process results
-		$payment = $this->_validate_payment( $payment );
-		$payment = $this->_post_payment_processing( $payment );
+		$payment = $this->_validate_payment($payment);
+		$payment = $this->_post_payment_processing($payment);
 		// verify payment
-		if ( $payment instanceof EE_Payment ) {
+		if ($payment instanceof EE_Payment) {
 			// store that for later
 			$this->checkout->payment = $payment;
 			// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to abandoned
@@ -1752,7 +1752,7 @@ 
 			} else {
 				return false;
 			}
-		} else if ( $payment === true ) {
+		} else if ($payment === true) {
 			// please note that offline payment methods will NOT make a payment,
 			// but instead just mark themselves as the PMD_ID on the transaction, and return true
 			$this->checkout->payment = $payment;
@@ -1772,22 +1772,22 @@ 
 	 */
 	protected function _last_second_ticket_verifications() {
 		// don't bother re-validating if not a return visit
-		if ( ! $this->checkout->revisit ) {
+		if ( ! $this->checkout->revisit) {
 			return true;
 		}
 		$registrations = $this->checkout->transaction->registrations();
-		if ( empty( $registrations ) ) {
+		if (empty($registrations)) {
 			return false;
 		}
-		foreach ( $registrations as $registration ) {
-			if ( $registration instanceof EE_Registration ) {
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
 				$event = $registration->event_obj();
-				if ( $event instanceof EE_Event && $event->is_sold_out( true ) ) {
+				if ($event instanceof EE_Event && $event->is_sold_out(true)) {
 					EE_Error::add_error(
 						apply_filters(
 							'FHEE__EE_SPCO_Reg_Step_Payment_Options___last_second_ticket_verifications__sold_out_events_msg',
 							sprintf(
-								__( 'It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.', 'event_espresso' ),
+								__('It appears that the %1$s event that you were about to make a payment for has sold out since you first registered and/or arrived at this page. Please refresh the page and try again. If you have already made a partial payment towards this event, please contact the event administrator for a refund.', 'event_espresso'),
 								$event->name()
 							)
 						),
@@ -1817,7 +1817,7 @@ 
 		);
 		$html = $payment_method_billing_info->get_html();
 		$html .= $this->checkout->redirect_form;
-		EE_Registry::instance()->REQ->add_output( $html );
+		EE_Registry::instance()->REQ->add_output($html);
 		return true;
 	}
 
@@ -1831,28 +1831,28 @@ 
 	 * @throws \EE_Error
 	 */
 	private function _billing_form_is_valid() {
-		if ( ! $this->checkout->payment_method->type_obj()->has_billing_form() ) {
+		if ( ! $this->checkout->payment_method->type_obj()->has_billing_form()) {
 			return true;
 		}
-		if ( $this->checkout->billing_form instanceof EE_Billing_Info_Form ) {
-			if ( $this->checkout->billing_form->was_submitted() ) {
+		if ($this->checkout->billing_form instanceof EE_Billing_Info_Form) {
+			if ($this->checkout->billing_form->was_submitted()) {
 				$this->checkout->billing_form->receive_form_submission();
-				if ( $this->checkout->billing_form->is_valid() ) {
+				if ($this->checkout->billing_form->is_valid()) {
 					return true;
 				}
 				$validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
 				$error_strings = array();
-				foreach ( $validation_errors as $validation_error ) {
-					if ( $validation_error instanceof EE_Validation_Error ) {
+				foreach ($validation_errors as $validation_error) {
+					if ($validation_error instanceof EE_Validation_Error) {
 						$form_section = $validation_error->get_form_section();
-						if ( $form_section instanceof EE_Form_Input_Base ) {
+						if ($form_section instanceof EE_Form_Input_Base) {
 							$label = $form_section->html_label_text();
-						} elseif ( $form_section instanceof EE_Form_Section_Base ) {
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
 							$label = $form_section->name();
 						} else {
-							$label = __( 'Validation Error', 'event_espresso' );
+							$label = __('Validation Error', 'event_espresso');
 						}
-						$error_strings[] = sprintf( '%1$s: %2$s', $label, $validation_error->getMessage() );
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
 					}
 				}
 				EE_Error::add_error(
@@ -1862,7 +1862,7 @@ 
 							'event_espresso'
 						),
 						'<br/>',
-						implode( '<br/>', $error_strings )
+						implode('<br/>', $error_strings)
 					),
 					__FILE__,
 					__FUNCTION__,
@@ -1881,7 +1881,7 @@ 
 			}
 		} else {
 			EE_Error::add_error(
-				__( 'The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso' ),
+				__('The submitted billing form is invalid possibly due to a technical reason.', 'event_espresso'),
 				__FILE__,
 				__FUNCTION__,
 				__LINE__
@@ -1920,7 +1920,7 @@ 
 		// save the TXN ( which clears cached copy of primary_registration)
 		$this->checkout->transaction->save();
 		// grab TXN ID and save it to the primary_registration
-		$primary_registration->set_transaction_id( $this->checkout->transaction->ID() );
+		$primary_registration->set_transaction_id($this->checkout->transaction->ID());
 		// save what we have so far
 		$primary_registration->save();
 		return true;
@@ -1938,7 +1938,7 @@ 
 	private function _capture_primary_registration_data_from_billing_form() {
 		// convert billing form data into an attendee
 		$this->checkout->primary_attendee_obj = $this->checkout->billing_form->create_attendee_from_billing_form_data();
-		if ( ! $this->checkout->primary_attendee_obj instanceof EE_Attendee ) {
+		if ( ! $this->checkout->primary_attendee_obj instanceof EE_Attendee) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -1946,7 +1946,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1955,7 +1955,7 @@ 
 			return false;
 		}
 		$primary_registration = $this->checkout->transaction->primary_registration();
-		if ( ! $primary_registration instanceof EE_Registration ) {
+		if ( ! $primary_registration instanceof EE_Registration) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -1963,7 +1963,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1971,7 +1971,7 @@ 
 			);
 			return false;
 		}
-		if ( ! $primary_registration->_add_relation_to( $this->checkout->primary_attendee_obj, 'Attendee' )
+		if ( ! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
 		       instanceof
 		       EE_Attendee
 		) {
@@ -1982,7 +1982,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -1991,9 +1991,9 @@ 
 			return false;
 		}
 		/** @type EE_Registration_Processor $registration_processor */
-		$registration_processor = EE_Registry::instance()->load_class( 'Registration_Processor' );
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
 		// at this point, we should have enough details about the registrant to consider the registration NOT incomplete
-		$registration_processor->toggle_incomplete_registration_status_to_default( $primary_registration );
+		$registration_processor->toggle_incomplete_registration_status_to_default($primary_registration);
 		return true;
 	}
 
@@ -2008,22 +2008,22 @@ 
 	 * @throws \EE_Error
 	 */
 	private function _get_payment_method_for_selected_method_of_payment() {
-		if ( $this->checkout->selected_method_of_payment === 'events_sold_out' ) {
+		if ($this->checkout->selected_method_of_payment === 'events_sold_out') {
 			$this->_redirect_because_event_sold_out();
 			return null;
 		}
 		// get EE_Payment_Method object
-		if ( isset( $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ] ) ) {
-			$payment_method = $this->checkout->available_payment_methods[ $this->checkout->selected_method_of_payment ];
+		if (isset($this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment])) {
+			$payment_method = $this->checkout->available_payment_methods[$this->checkout->selected_method_of_payment];
 		} else {
 			// load EEM_Payment_Method
-			EE_Registry::instance()->load_model( 'Payment_Method' );
+			EE_Registry::instance()->load_model('Payment_Method');
 			/** @type EEM_Payment_Method $EEM_Payment_Method */
 			$EEM_Payment_Method = EE_Registry::instance()->LIB->EEM_Payment_Method;
-			$payment_method = $EEM_Payment_Method->get_one_by_slug( $this->checkout->selected_method_of_payment );
+			$payment_method = $EEM_Payment_Method->get_one_by_slug($this->checkout->selected_method_of_payment);
 		}
 		// verify $payment_method
-		if ( ! $payment_method instanceof EE_Payment_Method ) {
+		if ( ! $payment_method instanceof EE_Payment_Method) {
 			// not a payment
 			EE_Error::add_error(
 				sprintf(
@@ -2032,7 +2032,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2041,7 +2041,7 @@ 
 			return null;
 		}
 		// and verify it has a valid Payment_Method Type object
-		if ( ! $payment_method->type_obj() instanceof EE_PMT_Base ) {
+		if ( ! $payment_method->type_obj() instanceof EE_PMT_Base) {
 			// not a payment
 			EE_Error::add_error(
 				sprintf(
@@ -2050,7 +2050,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2071,29 +2071,29 @@ 
 	 * @return    mixed    EE_Payment | boolean
 	 * @throws \EE_Error
 	 */
-	private function _attempt_payment( EE_Payment_Method $payment_method ) {
+	private function _attempt_payment(EE_Payment_Method $payment_method) {
 		$payment = null;
 		$this->checkout->transaction->save();
-		$payment_processor = EE_Registry::instance()->load_core( 'Payment_Processor' );
-		if ( ! $payment_processor instanceof EE_Payment_Processor ) {
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		if ( ! $payment_processor instanceof EE_Payment_Processor) {
 			return false;
 		}
 		try {
-			$payment_processor->set_revisit( $this->checkout->revisit );
+			$payment_processor->set_revisit($this->checkout->revisit);
 			// generate payment object
 			$payment = $payment_processor->process_payment(
 				$payment_method,
 				$this->checkout->transaction,
 				$this->checkout->amount_owing,
 				$this->checkout->billing_form,
-				$this->_get_return_url( $payment_method ),
+				$this->_get_return_url($payment_method),
 				'CART',
 				$this->checkout->admin_request,
 				true,
 				$this->reg_step_url()
 			);
-		} catch ( Exception $e ) {
-			$this->_handle_payment_processor_exception( $e );
+		} catch (Exception $e) {
+			$this->_handle_payment_processor_exception($e);
 		}
 		return $payment;
 	}
@@ -2108,7 +2108,7 @@ 
 	 * @return void
 	 * @throws \EE_Error
 	 */
-	protected function _handle_payment_processor_exception( Exception $e ) {
+	protected function _handle_payment_processor_exception(Exception $e) {
 		EE_Error::add_error(
 			sprintf(
 				__(
@@ -2116,7 +2116,7 @@ 
 					'event_espresso'
 				),
 				'<br/>',
-				EE_Registry::instance()->CFG->organization->get_pretty( 'email' ),
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
 				$e->getMessage(),
 				$e->getFile(),
 				$e->getLine()
@@ -2137,9 +2137,9 @@ 
 	 * @return string
 	 * @throws \EE_Error
 	 */
-	protected function _get_return_url( EE_Payment_Method $payment_method ) {
+	protected function _get_return_url(EE_Payment_Method $payment_method) {
 		$return_url = '';
-		switch ( $payment_method->type_obj()->payment_occurs() ) {
+		switch ($payment_method->type_obj()->payment_occurs()) {
 			case EE_PMT_Base::offsite :
 				$return_url = add_query_arg(
 					array(
@@ -2168,12 +2168,12 @@ 
 	 * @return EE_Payment | FALSE
 	 * @throws \EE_Error
 	 */
-	private function _validate_payment( $payment = null ) {
-		if ( $this->checkout->payment_method->is_off_line() ) {
+	private function _validate_payment($payment = null) {
+		if ($this->checkout->payment_method->is_off_line()) {
 			return true;
 		}
 		// verify payment object
-		if ( ! $payment instanceof EE_Payment ) {
+		if ( ! $payment instanceof EE_Payment) {
 			// not a payment
 			EE_Error::add_error(
 				sprintf(
@@ -2182,7 +2182,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2203,27 +2203,27 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	private function _post_payment_processing( $payment = null ) {
+	private function _post_payment_processing($payment = null) {
 		// Off-Line payment?
-		if ( $payment === true ) {
+		if ($payment === true) {
 			//$this->_setup_redirect_for_next_step();
 			return true;
 		// On-Site payment?
-		} else if ( $this->checkout->payment_method->is_on_site() ) {
-			if ( ! $this->_process_payment_status( $payment, EE_PMT_Base::onsite ) ) {
+		} else if ($this->checkout->payment_method->is_on_site()) {
+			if ( ! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
 				//$this->_setup_redirect_for_next_step();
 				$this->checkout->continue_reg = false;
 			}
 		// Off-Site payment?
-		} else if ( $this->checkout->payment_method->is_off_site() ) {
+		} else if ($this->checkout->payment_method->is_off_site()) {
 			// if a payment object was made and it specifies a redirect url, then we'll setup that redirect info
-			if ( $payment instanceof EE_Payment && $payment->redirect_url() ) {
-				do_action( 'AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()' );
+			if ($payment instanceof EE_Payment && $payment->redirect_url()) {
+				do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->redirect_url(), '$payment->redirect_url()');
 				$this->checkout->redirect = true;
 				$this->checkout->redirect_form = $payment->redirect_form();
-				$this->checkout->redirect_url = $this->reg_step_url( 'redirect_form' );
+				$this->checkout->redirect_url = $this->reg_step_url('redirect_form');
 				// set JSON response
-				$this->checkout->json_response->set_redirect_form( $this->checkout->redirect_form );
+				$this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
 				// set cron job for finalizing the TXN
 				// in case the user does not return from the off-site gateway
 				EE_Cron_Tasks::schedule_finalize_abandoned_transactions_check(
@@ -2231,7 +2231,7 @@ 
 					$this->checkout->transaction->ID()
 				);
 				// and lastly, let's bump the payment status to pending
-				$payment->set_status( EEM_Payment::status_id_pending );
+				$payment->set_status(EEM_Payment::status_id_pending);
 				$payment->save();
 			} else {
 				// not a payment
@@ -2243,7 +2243,7 @@ 
 							'event_espresso'
 						),
 						'<br/>',
-						EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
 					),
 					__FILE__,
 					__FUNCTION__,
@@ -2281,21 +2281,21 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	private function _process_payment_status( $payment, $payment_occurs = EE_PMT_Base::offline ) {
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline) {
 		// off-line payment? carry on
-		if ( $payment_occurs === EE_PMT_Base::offline ) {
+		if ($payment_occurs === EE_PMT_Base::offline) {
 			return true;
 		}
 		// verify payment validity
-		if ( $payment instanceof EE_Payment ) {
-			do_action( 'AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()' );
+		if ($payment instanceof EE_Payment) {
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $payment->status(), '$payment->status()');
 			$msg = $payment->gateway_response();
 			// check results
-			switch ( $payment->status() ) {
+			switch ($payment->status()) {
 				// good payment
 				case EEM_Payment::status_id_approved :
 					EE_Error::add_success(
-						__( 'Your payment was processed successfully.', 'event_espresso' ),
+						__('Your payment was processed successfully.', 'event_espresso'),
 						__FILE__,
 						__FUNCTION__,
 						__LINE__
@@ -2304,45 +2304,45 @@ 
 					break;
 				// slow payment
 				case EEM_Payment::status_id_pending :
-					if ( empty( $msg ) ) {
+					if (empty($msg)) {
 						$msg = __(
 							'Your payment appears to have been processed successfully, but the Instant Payment Notification has not yet been received. It should arrive shortly.',
 							'event_espresso'
 						);
 					}
-					EE_Error::add_success( $msg, __FILE__, __FUNCTION__, __LINE__ );
+					EE_Error::add_success($msg, __FILE__, __FUNCTION__, __LINE__);
 					return true;
 					break;
 				// don't wanna payment
 				case EEM_Payment::status_id_cancelled :
-					if ( empty( $msg ) ) {
+					if (empty($msg)) {
 						$msg = _n(
 							'Payment cancelled. Please try again.',
 							'Payment cancelled. Please try again or select another method of payment.',
-							count( $this->checkout->available_payment_methods ),
+							count($this->checkout->available_payment_methods),
 							'event_espresso'
 						);
 					}
-					EE_Error::add_attention( $msg, __FILE__, __FUNCTION__, __LINE__ );
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
 					return false;
 					break;
 				// not enough payment
 				case EEM_Payment::status_id_declined :
-					if ( empty( $msg ) ) {
+					if (empty($msg)) {
 						$msg = _n(
 							'We\'re sorry but your payment was declined. Please try again.',
 							'We\'re sorry but your payment was declined. Please try again or select another method of payment.',
-							count( $this->checkout->available_payment_methods ),
+							count($this->checkout->available_payment_methods),
 							'event_espresso'
 						);
 					}
-					EE_Error::add_attention( $msg, __FILE__, __FUNCTION__, __LINE__ );
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
 					return false;
 					break;
 				// bad payment
 				case EEM_Payment::status_id_failed :
-					if ( ! empty( $msg ) ) {
-						EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ );
+					if ( ! empty($msg)) {
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
 						return false;
 					}
 					// default to error below
@@ -2351,7 +2351,7 @@ 
 		}
 		// off-site payment gateway responses are too unreliable, so let's just assume that
 		// the payment processing is just running slower than the registrant's request
-		if ( $payment_occurs === EE_PMT_Base::offsite ) {
+		if ($payment_occurs === EE_PMT_Base::offsite) {
 			return true;
 		}
 		EE_Error::add_error(
@@ -2361,7 +2361,7 @@ 
 					'event_espresso'
 				),
 				'<br/>',
-				EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
 			),
 			__FILE__,
 			__FUNCTION__,
@@ -2394,13 +2394,13 @@ 
 	public function process_gateway_response() {
 		$payment = null;
 		// how have they chosen to pay?
-		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment( true );
+		$this->checkout->selected_method_of_payment = $this->_get_selected_method_of_payment(true);
 		// get EE_Payment_Method object
-		if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment() ) {
+		if ( ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
 			$this->checkout->continue_reg = false;
 			return false;
 		}
-		if ( ! $this->checkout->payment_method->is_off_site() ) {
+		if ( ! $this->checkout->payment_method->is_off_site()) {
 			return false;
 		}
 		$this->_validate_offsite_return();
@@ -2414,23 +2414,23 @@ 
 		//	true
 		//);
 		// verify TXN
-		if ( $this->checkout->transaction instanceof EE_Transaction ) {
+		if ($this->checkout->transaction instanceof EE_Transaction) {
 			$gateway = $this->checkout->payment_method->type_obj()->get_gateway();
-			if ( ! $gateway instanceof EE_Offsite_Gateway ) {
+			if ( ! $gateway instanceof EE_Offsite_Gateway) {
 				$this->checkout->continue_reg = false;
 				return false;
 			}
-			$payment = $this->_process_off_site_payment( $gateway );
-			$payment = $this->_process_cancelled_payments( $payment );
-			$payment = $this->_validate_payment( $payment );
+			$payment = $this->_process_off_site_payment($gateway);
+			$payment = $this->_process_cancelled_payments($payment);
+			$payment = $this->_validate_payment($payment);
 			// if payment was not declined by the payment gateway or cancelled by the registrant
-			if ( $this->_process_payment_status( $payment, EE_PMT_Base::offsite ) ) {
+			if ($this->_process_payment_status($payment, EE_PMT_Base::offsite)) {
 				//$this->_setup_redirect_for_next_step();
 				// store that for later
 				$this->checkout->payment = $payment;
 				// mark this reg step as completed, as long as gateway doesn't use a separate IPN request,
 				// because we will complete this step during the IPN processing then
-				if ( $gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request() ) {
+				if ($gateway instanceof EE_Offsite_Gateway && ! $this->handle_IPN_in_this_request()) {
 					$this->set_completed();
 				}
 				return true;
@@ -2454,21 +2454,21 @@ 
 	 * @throws \EE_Error
 	 */
 	private function _validate_offsite_return() {
-		$TXN_ID = (int)EE_Registry::instance()->REQ->get( 'spco_txn', 0 );
-		if ( $TXN_ID !== $this->checkout->transaction->ID() ) {
+		$TXN_ID = (int) EE_Registry::instance()->REQ->get('spco_txn', 0);
+		if ($TXN_ID !== $this->checkout->transaction->ID()) {
 			// Houston... we might have a problem
 			$invalid_TXN = false;
 			// first gather some info
-			$valid_TXN = EEM_Transaction::instance()->get_one_by_ID( $TXN_ID );
+			$valid_TXN = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
 			$primary_registrant = $valid_TXN instanceof EE_Transaction
 				? $valid_TXN->primary_registration()
 				: null;
 			// let's start by retrieving the cart for this TXN
-			$cart = $this->checkout->get_cart_for_transaction( $this->checkout->transaction );
-			if ( $cart instanceof EE_Cart ) {
+			$cart = $this->checkout->get_cart_for_transaction($this->checkout->transaction);
+			if ($cart instanceof EE_Cart) {
 				// verify that the current cart has tickets
 				$tickets = $cart->get_tickets();
-				if ( empty( $tickets ) ) {
+				if (empty($tickets)) {
 					$invalid_TXN = true;
 				}
 			} else {
@@ -2478,35 +2478,35 @@ 
 				? $primary_registrant->session_ID()
 				: null;
 			// validate current Session ID and compare against valid TXN session ID
-			if ( EE_Session::instance()->id() === null ) {
+			if (EE_Session::instance()->id() === null) {
 				$invalid_TXN = true;
-			} else if ( EE_Session::instance()->id() === $valid_TXN_SID ) {
+			} else if (EE_Session::instance()->id() === $valid_TXN_SID) {
 				// WARNING !!!
 				// this could be PayPal sending back duplicate requests (ya they do that)
 				// or it **could** mean someone is simply registering AGAIN after having just done so
 				// so now we need to determine if this current TXN looks valid or not
 				// has this step even been started ?
-				if ( $this->checkout->transaction->reg_step_completed( $this->slug() === false )
+				if ($this->checkout->transaction->reg_step_completed($this->slug() === false)
 				) {
 					// really? you're half way through this reg step, but you never started it ?
 					$invalid_TXN = true;
 				}
 			}
-			if ( $invalid_TXN ) {
+			if ($invalid_TXN) {
 				// is the valid TXN completed ?
-				if ( $valid_TXN instanceof EE_Transaction ) {
+				if ($valid_TXN instanceof EE_Transaction) {
 					// has this step even been started ?
-					$reg_step_completed = $valid_TXN->reg_step_completed( $this->slug() );
-					if ( $reg_step_completed !== false && $reg_step_completed !== true ) {
+					$reg_step_completed = $valid_TXN->reg_step_completed($this->slug());
+					if ($reg_step_completed !== false && $reg_step_completed !== true) {
 						// so it **looks** like this is a double request from PayPal
 						// so let's try to pick up where we left off
 						$this->checkout->transaction = $valid_TXN;
-						$this->checkout->refresh_all_entities( true );
+						$this->checkout->refresh_all_entities(true);
 						return;
 					}
 				}
 				// you appear to be lost?
-				$this->_redirect_wayward_request( $primary_registrant );
+				$this->_redirect_wayward_request($primary_registrant);
 			}
 		}
 	}
@@ -2521,14 +2521,14 @@ 
 	 * @return bool
 	 * @throws \EE_Error
 	 */
-	private function _redirect_wayward_request( EE_Registration $primary_registrant ) {
-		if ( ! $primary_registrant instanceof EE_Registration ) {
+	private function _redirect_wayward_request(EE_Registration $primary_registrant) {
+		if ( ! $primary_registrant instanceof EE_Registration) {
 			// try redirecting based on the current TXN
 			$primary_registrant = $this->checkout->transaction instanceof EE_Transaction
 				? $this->checkout->transaction->primary_registration()
 				: null;
 		}
-		if ( ! $primary_registrant instanceof EE_Registration ) {
+		if ( ! $primary_registrant instanceof EE_Registration) {
 			EE_Error::add_error(
 				sprintf(
 					__(
@@ -2536,7 +2536,7 @@ 
 						'event_espresso'
 					),
 					'<br/>',
-					EE_Registry::instance()->CFG->organization->get_pretty( 'email' )
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
 				),
 				__FILE__,
 				__FUNCTION__,
@@ -2567,17 +2567,17 @@ 
 	 * @return \EE_Payment
 	 * @throws \EE_Error
 	 */
-	private function _process_off_site_payment( EE_Offsite_Gateway $gateway ) {
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway) {
 		try {
 			$request_data = \EE_Registry::instance()->REQ->params();
 			// if gateway uses_separate_IPN_request, then we don't have to process the IPN manually
 			$this->set_handle_IPN_in_this_request(
-				$gateway->handle_IPN_in_this_request( $request_data, false )
+				$gateway->handle_IPN_in_this_request($request_data, false)
 			);
-			if ( $this->handle_IPN_in_this_request() ) {
+			if ($this->handle_IPN_in_this_request()) {
 				// get payment details and process results
 				/** @type EE_Payment_Processor $payment_processor */
-				$payment_processor = EE_Registry::instance()->load_core( 'Payment_Processor' );
+				$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
 				$payment = $payment_processor->process_ipn(
 					$request_data,
 					$this->checkout->transaction,
@@ -2590,14 +2590,14 @@ 
 				$payment = $this->checkout->transaction->last_payment();
 				//$payment_source = 'last_payment';
 			}
-		} catch ( Exception $e ) {
+		} catch (Exception $e) {
 			// let's just eat the exception and try to move on using any previously set payment info
 			$payment = $this->checkout->transaction->last_payment();
 			//$payment_source = 'last_payment after Exception';
 			// but if we STILL don't have a payment object
-			if ( ! $payment instanceof EE_Payment ) {
+			if ( ! $payment instanceof EE_Payment) {
 				// then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
-				$this->_handle_payment_processor_exception( $e );
+				$this->_handle_payment_processor_exception($e);
 			}
 		}
 		// DEBUG LOG
@@ -2622,13 +2622,13 @@ 
 	 * @return EE_Payment | FALSE
 	 * @throws \EE_Error
 	 */
-	private function _process_cancelled_payments( $payment = null ) {
+	private function _process_cancelled_payments($payment = null) {
 		if (
 			$payment instanceof EE_Payment
-			&& isset( $_REQUEST['ee_cancel_payment'] )
+			&& isset($_REQUEST['ee_cancel_payment'])
 			&& $payment->status() === EEM_Payment::status_id_failed
 		) {
-			$payment->set_status( EEM_Payment::status_id_cancelled );
+			$payment->set_status(EEM_Payment::status_id_cancelled);
 		}
 		return $payment;
 	}
@@ -2645,14 +2645,14 @@ 
 	public function get_transaction_details_for_gateways() {
 		$txn_details = array();
 		// ya gotta make a choice man
-		if ( empty( $this->checkout->selected_method_of_payment ) ) {
+		if (empty($this->checkout->selected_method_of_payment)) {
 			$txn_details = array(
-				'error' => __( 'Please select a method of payment before proceeding.', 'event_espresso' )
+				'error' => __('Please select a method of payment before proceeding.', 'event_espresso')
 			);
 		}
 		// get EE_Payment_Method object
 		if (
-			empty( $txn_details )
+			empty($txn_details)
 			&&
 			! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
 		) {
@@ -2664,8 +2664,8 @@ 
 				)
 			);
 		}
-		if ( empty( $txn_details ) && $this->checkout->transaction instanceof EE_Transaction ) {
-			$return_url = $this->_get_return_url( $this->checkout->payment_method );
+		if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
+			$return_url = $this->_get_return_url($this->checkout->payment_method);
 			$txn_details = array(
 				'TXN_ID'         => $this->checkout->transaction->ID(),
 				'TXN_timestamp'  => $this->checkout->transaction->datetime(),
@@ -2676,7 +2676,7 @@ 
 				'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
 				'payment_amount' => $this->checkout->amount_owing,
 				'return_url'     => $return_url,
-				'cancel_url'     => add_query_arg( array( 'ee_cancel_payment' => true ), $return_url ),
+				'cancel_url'     => add_query_arg(array('ee_cancel_payment' => true), $return_url),
 				'notify_url'     => EE_Config::instance()->core->txn_page_url(
 					array(
 						'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
@@ -2685,7 +2685,7 @@ 
 				)
 			);
 		}
-		echo wp_json_encode( $txn_details );
+		echo wp_json_encode($txn_details);
 		exit();
 	}
 
@@ -2702,7 +2702,7 @@ 
     public function __sleep()
     {
         // remove the reg form and the checkout
-        return array_diff( array_keys( get_object_vars( $this ) ), array( 'reg_form', 'checkout', 'line_item_display' ) );
+        return array_diff(array_keys(get_object_vars($this)), array('reg_form', 'checkout', 'line_item_display'));
     }
 
 

core/EE_Cart.core.php

Indentation +413 added lines, -413 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 
@@ -20,418 +20,418 @@ 
 class EE_Cart
 {
 
-    /**
-     * instance of the EE_Cart object
-     *
-     * @access    private
-     * @var EE_Cart $_instance
-     */
-    private static $_instance;
-
-    /**
-     * instance of the EE_Session object
-     *
-     * @access    protected
-     * @var EE_Session $_session
-     */
-    protected $_session;
-
-    /**
-     * The total Line item which comprises all the children line-item subtotals,
-     * which in turn each have their line items.
-     * Typically, the line item structure will look like:
-     * grand total
-     * -tickets-sub-total
-     * --ticket1
-     * --ticket2
-     * --...
-     * -taxes-sub-total
-     * --tax1
-     * --tax2
-     *
-     * @var EE_Line_Item
-     */
-    private $_grand_total;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @return \EE_Cart
-     * @throws \EE_Error
-     */
-    public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        if ( ! empty($grand_total)) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        // or maybe retrieve an existing one ?
-        if ( ! self::$_instance instanceof EE_Cart) {
-            // try getting the cart out of the session
-            $saved_cart = $session instanceof EE_Session ? $session->cart() : null;
-            self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
-            unset($saved_cart);
-        }
-        // verify that cart is ok and grand total line item exists
-        if ( ! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
-            self::$_instance = new self($grand_total, $session);
-        }
-        self::$_instance->get_grand_total();
-        // once everything is all said and done, save the cart to the EE_Session
-        add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     */
-    private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->set_session($session);
-        if ($grand_total instanceof EE_Line_Item) {
-            $this->set_grand_total_line_item($grand_total);
-        }
-    }
-
-
-
-    /**
-     * Resets the cart completely (whereas empty_cart
-     *
-     * @param EE_Line_Item $grand_total
-     * @param EE_Session   $session
-     * @return EE_Cart
-     * @throws \EE_Error
-     */
-    public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null)
-    {
-        remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
-        if ($session instanceof EE_Session) {
-            $session->reset_cart();
-        }
-        self::$_instance = null;
-        return self::instance($grand_total, $session);
-    }
-
-
-
-    /**
-     * @return \EE_Session
-     */
-    public function session()
-    {
-        if ( ! $this->_session instanceof EE_Session) {
-            $this->set_session();
-        }
-        return $this->_session;
-    }
-
-
-
-    /**
-     * @param EE_Session $session
-     */
-    public function set_session(EE_Session $session = null)
-    {
-        $this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
-    }
-
-
-
-    /**
-     * Sets the cart to match the line item. Especially handy for loading an old cart where you
-     *  know the grand total line item on it
-     *
-     * @param EE_Line_Item $line_item
-     */
-    public function set_grand_total_line_item(EE_Line_Item $line_item)
-    {
-        $this->_grand_total = $line_item;
-    }
-
-
-
-    /**
-     * get_cart_from_reg_url_link
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param EE_Session     $session
-     * @return \EE_Cart
-     * @throws \EE_Error
-     */
-    public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null)
-    {
-        $grand_total = $transaction->total_line_item();
-        $grand_total->get_items();
-        $grand_total->tax_descendants();
-        return EE_Cart::instance($grand_total, $session);
-    }
-
-
-
-    /**
-     * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
-     *
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    private function _create_grand_total()
-    {
-        $this->_grand_total = EEH_Line_Item::create_total_line_item();
-        return $this->_grand_total;
-    }
-
-
-
-    /**
-     * Gets all the line items of object type Ticket
-     *
-     * @access public
-     * @return \EE_Line_Item[]
-     */
-    public function get_tickets()
-    {
-        if ($this->_grand_total === null ) {
-            return array();
-        }
-        return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
-    }
-
-
-
-    /**
-     * returns the total quantity of tickets in the cart
-     *
-     * @access public
-     * @return int
-     * @throws \EE_Error
-     */
-    public function all_ticket_quantity_count()
-    {
-        $tickets = $this->get_tickets();
-        if (empty($tickets)) {
-            return 0;
-        }
-        $count = 0;
-        foreach ($tickets as $ticket) {
-            $count += $ticket->get('LIN_quantity');
-        }
-        return $count;
-    }
-
-
-
-    /**
-     * Gets all the tax line items
-     *
-     * @return \EE_Line_Item[]
-     * @throws \EE_Error
-     */
-    public function get_taxes()
-    {
-        return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
-    }
-
-
-
-    /**
-     * Gets the total line item (which is a parent of all other line items) on this cart
-     *
-     * @return EE_Line_Item
-     * @throws \EE_Error
-     */
-    public function get_grand_total()
-    {
-        return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
-    }
-
-
-
-    /**
-     * @process items for adding to cart
-     * @access  public
-     * @param EE_Ticket $ticket
-     * @param int       $qty
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
-    {
-        EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty);
-        return $this->save_cart() ? true : false;
-    }
-
-
-
-    /**
-     * get_cart_total_before_tax
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_cart_total_before_tax()
-    {
-        return $this->get_grand_total()->recalculate_pre_tax_total();
-    }
-
-
-
-    /**
-     * gets the total amount of tax paid for items in this cart
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_applied_taxes()
-    {
-        return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-    }
-
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function get_cart_grand_total()
-    {
-        EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-        return $this->get_grand_total()->total();
-    }
-
-
-
-    /**
-     * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
-     *
-     * @access public
-     * @return float
-     * @throws \EE_Error
-     */
-    public function recalculate_all_cart_totals()
-    {
-        $pre_tax_total = $this->get_cart_total_before_tax();
-        $taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-        $this->_grand_total->set_total($pre_tax_total + $taxes_total);
-        $this->_grand_total->save_this_and_descendants_to_txn();
-        return $this->get_grand_total()->total();
-    }
-
-
-
-    /**
-     * deletes an item from the cart
-     *
-     * @access public
-     * @param array|bool|string $line_item_codes
-     * @return int on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function delete_items($line_item_codes = false)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
-    }
-
-
-
-    /**
-     * @remove ALL items from cart and zero ALL totals
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function empty_cart()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_grand_total = $this->_create_grand_total();
-        return $this->save_cart(true);
-    }
-
-
-
-    /**
-     * @remove ALL items from cart and delete total as well
-     * @access public
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function delete_cart()
-    {
-        $deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
-        if ($deleted) {
-            $deleted += $this->_grand_total->delete();
-            $this->_grand_total = null;
-        }
-        return $deleted;
-    }
-
-
-
-    /**
-     * @save   cart to session
-     * @access public
-     * @param bool $apply_taxes
-     * @return TRUE on success, FALSE on fail
-     * @throws \EE_Error
-     */
-    public function save_cart($apply_taxes = true)
-    {
-        if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
-            EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
-            //make sure we don't cache the transaction because it can get stale
-            if ($this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
-                && $this->_grand_total->get_one_from_cache('Transaction')->ID()
-            ) {
-                $this->_grand_total->clear_cache('Transaction', null, true);
-            }
-        }
-        if ($this->session() instanceof EE_Session) {
-            return $this->session()->set_cart($this);
-        } else {
-            return false;
-        }
-    }
-
-
-
-    public function __wakeup()
-    {
-        if ( ! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
-            // $this->_grand_total is actually just an ID, so use it to get the object from the db
-            $this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
-        }
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function __sleep()
-    {
-        if ($this->_grand_total instanceof EE_Line_Item && $this->_grand_total->ID()) {
-            $this->_grand_total = $this->_grand_total->ID();
-        }
-        return array('_grand_total');
-    }
+	/**
+	 * instance of the EE_Cart object
+	 *
+	 * @access    private
+	 * @var EE_Cart $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * instance of the EE_Session object
+	 *
+	 * @access    protected
+	 * @var EE_Session $_session
+	 */
+	protected $_session;
+
+	/**
+	 * The total Line item which comprises all the children line-item subtotals,
+	 * which in turn each have their line items.
+	 * Typically, the line item structure will look like:
+	 * grand total
+	 * -tickets-sub-total
+	 * --ticket1
+	 * --ticket2
+	 * --...
+	 * -taxes-sub-total
+	 * --tax1
+	 * --tax2
+	 *
+	 * @var EE_Line_Item
+	 */
+	private $_grand_total;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @return \EE_Cart
+	 * @throws \EE_Error
+	 */
+	public static function instance(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		if ( ! empty($grand_total)) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		// or maybe retrieve an existing one ?
+		if ( ! self::$_instance instanceof EE_Cart) {
+			// try getting the cart out of the session
+			$saved_cart = $session instanceof EE_Session ? $session->cart() : null;
+			self::$_instance = $saved_cart instanceof EE_Cart ? $saved_cart : new self($grand_total, $session);
+			unset($saved_cart);
+		}
+		// verify that cart is ok and grand total line item exists
+		if ( ! self::$_instance instanceof EE_Cart || ! self::$_instance->_grand_total instanceof EE_Line_Item) {
+			self::$_instance = new self($grand_total, $session);
+		}
+		self::$_instance->get_grand_total();
+		// once everything is all said and done, save the cart to the EE_Session
+		add_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 */
+	private function __construct(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->set_session($session);
+		if ($grand_total instanceof EE_Line_Item) {
+			$this->set_grand_total_line_item($grand_total);
+		}
+	}
+
+
+
+	/**
+	 * Resets the cart completely (whereas empty_cart
+	 *
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Session   $session
+	 * @return EE_Cart
+	 * @throws \EE_Error
+	 */
+	public static function reset(EE_Line_Item $grand_total = null, EE_Session $session = null)
+	{
+		remove_action('shutdown', array(self::$_instance, 'save_cart'), 90);
+		if ($session instanceof EE_Session) {
+			$session->reset_cart();
+		}
+		self::$_instance = null;
+		return self::instance($grand_total, $session);
+	}
+
+
+
+	/**
+	 * @return \EE_Session
+	 */
+	public function session()
+	{
+		if ( ! $this->_session instanceof EE_Session) {
+			$this->set_session();
+		}
+		return $this->_session;
+	}
+
+
+
+	/**
+	 * @param EE_Session $session
+	 */
+	public function set_session(EE_Session $session = null)
+	{
+		$this->_session = $session instanceof EE_Session ? $session : EE_Registry::instance()->load_core('Session');
+	}
+
+
+
+	/**
+	 * Sets the cart to match the line item. Especially handy for loading an old cart where you
+	 *  know the grand total line item on it
+	 *
+	 * @param EE_Line_Item $line_item
+	 */
+	public function set_grand_total_line_item(EE_Line_Item $line_item)
+	{
+		$this->_grand_total = $line_item;
+	}
+
+
+
+	/**
+	 * get_cart_from_reg_url_link
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param EE_Session     $session
+	 * @return \EE_Cart
+	 * @throws \EE_Error
+	 */
+	public static function get_cart_from_txn(EE_Transaction $transaction, EE_Session $session = null)
+	{
+		$grand_total = $transaction->total_line_item();
+		$grand_total->get_items();
+		$grand_total->tax_descendants();
+		return EE_Cart::instance($grand_total, $session);
+	}
+
+
+
+	/**
+	 * Creates the total line item, and ensures it has its 'tickets' and 'taxes' sub-items
+	 *
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	private function _create_grand_total()
+	{
+		$this->_grand_total = EEH_Line_Item::create_total_line_item();
+		return $this->_grand_total;
+	}
+
+
+
+	/**
+	 * Gets all the line items of object type Ticket
+	 *
+	 * @access public
+	 * @return \EE_Line_Item[]
+	 */
+	public function get_tickets()
+	{
+		if ($this->_grand_total === null ) {
+			return array();
+		}
+		return EEH_Line_Item::get_ticket_line_items($this->_grand_total);
+	}
+
+
+
+	/**
+	 * returns the total quantity of tickets in the cart
+	 *
+	 * @access public
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public function all_ticket_quantity_count()
+	{
+		$tickets = $this->get_tickets();
+		if (empty($tickets)) {
+			return 0;
+		}
+		$count = 0;
+		foreach ($tickets as $ticket) {
+			$count += $ticket->get('LIN_quantity');
+		}
+		return $count;
+	}
+
+
+
+	/**
+	 * Gets all the tax line items
+	 *
+	 * @return \EE_Line_Item[]
+	 * @throws \EE_Error
+	 */
+	public function get_taxes()
+	{
+		return EEH_Line_Item::get_taxes_subtotal($this->_grand_total)->children();
+	}
+
+
+
+	/**
+	 * Gets the total line item (which is a parent of all other line items) on this cart
+	 *
+	 * @return EE_Line_Item
+	 * @throws \EE_Error
+	 */
+	public function get_grand_total()
+	{
+		return $this->_grand_total instanceof EE_Line_Item ? $this->_grand_total : $this->_create_grand_total();
+	}
+
+
+
+	/**
+	 * @process items for adding to cart
+	 * @access  public
+	 * @param EE_Ticket $ticket
+	 * @param int       $qty
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function add_ticket_to_cart(EE_Ticket $ticket, $qty = 1)
+	{
+		EEH_Line_Item::add_ticket_purchase($this->get_grand_total(), $ticket, $qty);
+		return $this->save_cart() ? true : false;
+	}
+
+
+
+	/**
+	 * get_cart_total_before_tax
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_cart_total_before_tax()
+	{
+		return $this->get_grand_total()->recalculate_pre_tax_total();
+	}
+
+
+
+	/**
+	 * gets the total amount of tax paid for items in this cart
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_applied_taxes()
+	{
+		return EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+	}
+
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function get_cart_grand_total()
+	{
+		EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		return $this->get_grand_total()->total();
+	}
+
+
+
+	/**
+	 * Gets the total amount to be paid for the items in the cart, including taxes and other modifiers
+	 *
+	 * @access public
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function recalculate_all_cart_totals()
+	{
+		$pre_tax_total = $this->get_cart_total_before_tax();
+		$taxes_total = EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+		$this->_grand_total->set_total($pre_tax_total + $taxes_total);
+		$this->_grand_total->save_this_and_descendants_to_txn();
+		return $this->get_grand_total()->total();
+	}
+
+
+
+	/**
+	 * deletes an item from the cart
+	 *
+	 * @access public
+	 * @param array|bool|string $line_item_codes
+	 * @return int on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function delete_items($line_item_codes = false)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		return EEH_Line_Item::delete_items($this->get_grand_total(), $line_item_codes);
+	}
+
+
+
+	/**
+	 * @remove ALL items from cart and zero ALL totals
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function empty_cart()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_grand_total = $this->_create_grand_total();
+		return $this->save_cart(true);
+	}
+
+
+
+	/**
+	 * @remove ALL items from cart and delete total as well
+	 * @access public
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function delete_cart()
+	{
+		$deleted = EEH_Line_Item::delete_all_child_items($this->_grand_total);
+		if ($deleted) {
+			$deleted += $this->_grand_total->delete();
+			$this->_grand_total = null;
+		}
+		return $deleted;
+	}
+
+
+
+	/**
+	 * @save   cart to session
+	 * @access public
+	 * @param bool $apply_taxes
+	 * @return TRUE on success, FALSE on fail
+	 * @throws \EE_Error
+	 */
+	public function save_cart($apply_taxes = true)
+	{
+		if ($apply_taxes && $this->_grand_total instanceof EE_Line_Item) {
+			EEH_Line_Item::ensure_taxes_applied($this->_grand_total);
+			//make sure we don't cache the transaction because it can get stale
+			if ($this->_grand_total->get_one_from_cache('Transaction') instanceof EE_Transaction
+				&& $this->_grand_total->get_one_from_cache('Transaction')->ID()
+			) {
+				$this->_grand_total->clear_cache('Transaction', null, true);
+			}
+		}
+		if ($this->session() instanceof EE_Session) {
+			return $this->session()->set_cart($this);
+		} else {
+			return false;
+		}
+	}
+
+
+
+	public function __wakeup()
+	{
+		if ( ! $this->_grand_total instanceof EE_Line_Item && absint($this->_grand_total) !== 0) {
+			// $this->_grand_total is actually just an ID, so use it to get the object from the db
+			$this->_grand_total = EEM_Line_Item::instance()->get_one_by_ID($this->_grand_total);
+		}
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function __sleep()
+	{
+		if ($this->_grand_total instanceof EE_Line_Item && $this->_grand_total->ID()) {
+			$this->_grand_total = $this->_grand_total->ID();
+		}
+		return array('_grand_total');
+	}
 
 
 }

Spacing +1 added lines, -1 removed lines

@@ -203,7 +203,7 @@
      */
     public function get_tickets()
     {
-        if ($this->_grand_total === null ) {
+        if ($this->_grand_total === null) {
             return array();
         }
         return EEH_Line_Item::get_ticket_line_items($this->_grand_total);

core/EE_Session.core.php

Indentation +190 added lines, -190 removed lines

@@ -52,12 +52,12 @@ 
 	  */
 	 private $_expiration;
 
-    /**
-     * whether or not session has expired at some point
-     *
-     * @var boolean
-     */
-    private $_expired = false;
+	/**
+	 * whether or not session has expired at some point
+	 *
+	 * @var boolean
+	 */
+	private $_expired = false;
 
 	 /**
 	  * current time as Unix timestamp in GMT
@@ -100,14 +100,14 @@ 
 	  * @var array
 	  */
 	 private $_default_session_vars = array (
-        'id'            => null,
-        'user_id'       => null,
-        'ip_address'    => null,
-        'user_agent'    => null,
-        'init_access'   => null,
-        'last_access'   => null,
-        'expiration'    => null,
-        'pages_visited' => array(),
+		'id'            => null,
+		'user_id'       => null,
+		'ip_address'    => null,
+		'user_agent'    => null,
+		'init_access'   => null,
+		'last_access'   => null,
+		'expiration'    => null,
+		'pages_visited' => array(),
 	);
 
 
@@ -171,18 +171,18 @@ 
 				$this->{$var_name} = $session_setting;
 			}
 		}
-         // are we using encryption?
-         $this->_use_encryption = $encryption instanceof EE_Encryption && EE_Registry::instance()->CFG->admin->encode_session_data();
-         // \EEH_Debug_Tools::printr($this->_use_encryption, '$this->_use_encryption', __FILE__, __LINE__);
-        // encrypt data via: $this->encryption->encrypt();
-        $this->encryption = $encryption;
+		 // are we using encryption?
+		 $this->_use_encryption = $encryption instanceof EE_Encryption && EE_Registry::instance()->CFG->admin->encode_session_data();
+		 // \EEH_Debug_Tools::printr($this->_use_encryption, '$this->_use_encryption', __FILE__, __LINE__);
+		// encrypt data via: $this->encryption->encrypt();
+		$this->encryption = $encryption;
 		// filter hook allows outside functions/classes/plugins to change default empty cart
 		$extra_default_session_vars = apply_filters( 'FHEE__EE_Session__construct__extra_default_session_vars', array() );
 		array_merge( $this->_default_session_vars, $extra_default_session_vars );
 		// apply default session vars
 		$this->_set_defaults();
-         add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
-         // check request for 'clear_session' param
+		 add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
+		 // check request for 'clear_session' param
 		add_action( 'AHEE__EE_Request_Handler__construct__complete', array( $this, 'wp_loaded' ));
 		// once everything is all said and done,
 		add_action( 'shutdown', array( $this, 'update' ), 100 );
@@ -191,38 +191,38 @@ 
 
 
 
-     /**
-      * @return void
-      * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-      * @throws \EE_Error
-      */
+	 /**
+	  * @return void
+	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	  * @throws \EE_Error
+	  */
 	 public function open_session() {
-         // check for existing session and retrieve it from db
-         if ( ! $this->_espresso_session()) {
-             // or just start a new one
-             $this->_create_espresso_session();
-         }
-     }
+		 // check for existing session and retrieve it from db
+		 if ( ! $this->_espresso_session()) {
+			 // or just start a new one
+			 $this->_create_espresso_session();
+		 }
+	 }
 
 
 
-    /**
-     * @return bool
-     */
-    public function expired()
-    {
-        return $this->_expired;
-    }
+	/**
+	 * @return bool
+	 */
+	public function expired()
+	{
+		return $this->_expired;
+	}
 
 
 
-    /**
-     * @return void
-     */
-    public function reset_expired()
-    {
-        $this->_expired = false;
-    }
+	/**
+	 * @return void
+	 */
+	public function reset_expired()
+	{
+		$this->_expired = false;
+	}
 
 
 	 /**
@@ -234,25 +234,25 @@ 
 
 
 
-    /**
-     * @return int
-     */
-    public function extension()
-    {
-        return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', (10 * MINUTE_IN_SECONDS));
-    }
+	/**
+	 * @return int
+	 */
+	public function extension()
+	{
+		return apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', (10 * MINUTE_IN_SECONDS));
+	}
 
 
 
-    /**
-     * @param int $time number of seconds to add to session expiration
-     * @return int
-     */
-    public function extend_expiration($time = 0)
-    {
-        $time = $time ? $time : $this->extension();
-        $this->_expiration += absint($time);
-    }
+	/**
+	 * @param int $time number of seconds to add to session expiration
+	 * @return int
+	 */
+	public function extend_expiration($time = 0)
+	{
+		$time = $time ? $time : $this->extension();
+		$this->_expiration += absint($time);
+	}
 
 
 
@@ -296,15 +296,15 @@ 
 
 
 
-    /**
-     * @param \EE_Cart $cart
-     * @return bool
-     */
-    public function set_cart(EE_Cart $cart)
-    {
-        $this->_session_data['cart'] = $cart;
-        return true;
-    }
+	/**
+	 * @param \EE_Cart $cart
+	 * @return bool
+	 */
+	public function set_cart(EE_Cart $cart)
+	{
+		$this->_session_data['cart'] = $cart;
+		return true;
+	}
 
 
 
@@ -312,7 +312,7 @@ 
 	  * reset_cart
 	  */
 	 public function reset_cart() {
-        do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
+		do_action('AHEE__EE_Session__reset_cart__before_reset', $this);
 		 $this->_session_data['cart'] = NULL;
 	 }
 
@@ -322,9 +322,9 @@ 
 	  * @return \EE_Cart
 	  */
 	 public function cart() {
-        return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
-            ? $this->_session_data['cart']
-            : null;
+		return isset($this->_session_data['cart']) && $this->_session_data['cart'] instanceof EE_Cart
+			? $this->_session_data['cart']
+			: null;
 	 }
 
 
@@ -344,7 +344,7 @@ 
 	  * reset_checkout
 	  */
 	 public function reset_checkout() {
-        do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
+		do_action('AHEE__EE_Session__reset_checkout__before_reset', $this);
 		 $this->_session_data['checkout'] = NULL;
 	 }
 
@@ -354,9 +354,9 @@ 
 	  * @return \EE_Checkout
 	  */
 	 public function checkout() {
-        return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
-            ? $this->_session_data['checkout']
-            : null;
+		return isset($this->_session_data['checkout']) && $this->_session_data['checkout'] instanceof EE_Checkout
+			? $this->_session_data['checkout']
+			: null;
 	 }
 
 
@@ -379,7 +379,7 @@ 
 	  * reset_transaction
 	  */
 	 public function reset_transaction() {
-        do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
+		do_action('AHEE__EE_Session__reset_transaction__before_reset', $this);
 		 $this->_session_data['transaction'] = NULL;
 	 }
 
@@ -389,10 +389,10 @@ 
 	  * @return \EE_Transaction
 	  */
 	 public function transaction() {
-        return isset($this->_session_data['transaction'])
-               && $this->_session_data['transaction'] instanceof EE_Transaction
-           ? $this->_session_data['transaction']
-           : null;
+		return isset($this->_session_data['transaction'])
+			   && $this->_session_data['transaction'] instanceof EE_Transaction
+		   ? $this->_session_data['transaction']
+		   : null;
 	 }
 
 
@@ -469,16 +469,16 @@ 
 		// set the "user agent"
 		$this->_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? esc_attr( $_SERVER['HTTP_USER_AGENT'] ) : FALSE;
 		// now let's retrieve what's in the db
-        $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
-            // get the current time in UTC
+		$session_data = $this->_retrieve_session_data();
+		if (! empty($session_data)) {
+			// get the current time in UTC
 			$this->_time = isset( $this->_time ) ? $this->_time : time();
 			// and reset the session expiration
 			$this->_expiration = isset( $session_data['expiration'] )
 				? $session_data['expiration']
 				: $this->_time + $this->_lifespan;
 		} else {
-            // set initial site access time and the session expiration
+			// set initial site access time and the session expiration
 			$this->_set_init_access_and_expiration();
 			// set referer
 			$this->_session_data[ 'pages_visited' ][ $this->_session_data['init_access'] ] = isset( $_SERVER['HTTP_REFERER'] )
@@ -487,14 +487,14 @@ 
 			// no previous session = go back and create one (on top of the data above)
 			return FALSE;
 		}
-        // now the user agent
+		// now the user agent
 		if ( $session_data['user_agent'] !== $this->_user_agent ) {
 			return FALSE;
 		}
 		// wait a minute... how old are you?
 		if ( $this->_time > $this->_expiration ) {
 			// yer too old fer me!
-            $this->_expired = true;
+			$this->_expired = true;
 			// wipe out everything that isn't a default session datum
 			$this->clear_session( __CLASS__, __FUNCTION__ );
 		}
@@ -506,95 +506,95 @@ 
 
 
 
-     /**
-      * _get_session_data
-      * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup databases
-      *
-      * @return array
-      * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
-      */
-     protected function _retrieve_session_data()
-     {
-         $ssn_key = EE_Session::session_id_prefix . $this->_sid;
-         try {
-             // we're using WP's Transient API to store session data using the PHP session ID as the option name
-             $session_data = get_transient($ssn_key);
-	         if ($session_data === false) {
-		         return array();
-             }
-             if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-                 $hash_check = get_transient(EE_Session::hash_check_prefix . $this->_sid);
-                 if ($hash_check && $hash_check !== md5($session_data)) {
-	                 EE_Error::add_error(
-                         sprintf(
-                             __('The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.', 'event_espresso'),
-                             EE_Session::session_id_prefix . $this->_sid
-                         ),
-                         __FILE__, __FUNCTION__, __LINE__
-                     );
-                 }
-             }
-         } catch (Exception $e) {
-             // let's just eat that error for now and attempt to correct any corrupted data
-             global $wpdb;
-             $row = $wpdb->get_row(
-                 $wpdb->prepare(
-                     "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                     '_transient_' . $ssn_key
-                 )
-             );
-             $session_data = is_object($row) ? $row->option_value : null;
-             if ($session_data) {
-                 $session_data = preg_replace_callback(
-                     '!s:(d+):"(.*?)";!',
-                     function ($match) {
-                         return $match[1] === strlen($match[2])
-                             ? $match[0]
-                             : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
-                     },
-                     $session_data
-                 );
-             }
-	         $session_data = maybe_unserialize($session_data);
-         }
-	     // in case the data is encoded... try to decode it
-         $session_data = $this->encryption instanceof EE_Encryption
-             ? $this->encryption->base64_string_decode($session_data)
-             : $session_data;
-
-         if ( ! is_array($session_data)) {
-             try {
-	             $session_data = maybe_unserialize($session_data);
-             } catch (Exception $e) {
-                 $msg = esc_html__(
-                     'An error occurred while attempting to unserialize the session data.',
-                     'event_espresso'
-                 );
-                 $msg .= WP_DEBUG
-                     ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
-                     : '';
-                 throw new InvalidSessionDataException($msg, 0, $e);
-             }
-         }
-         // just a check to make sure the session array is indeed an array
-         if ( ! is_array($session_data)) {
-             // no?!?! then something is wrong
-             $msg = esc_html__(
-                 'The session data is missing, invalid, or corrupted.',
-                 'event_espresso'
-             );
-             $msg .= WP_DEBUG
-                 ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
-                 : '';
-	         throw new InvalidSessionDataException($msg);
-         }
-	     if ( isset( $this->_session_data['transaction'] ) && absint( $this->_session_data['transaction'] ) !== 0 ) {
-		     $this->_session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
-			     $this->_session_data['transaction']
-	         );
-	     }
-	     return $session_data;
-     }
+	 /**
+	  * _get_session_data
+	  * Retrieves the session data, and attempts to correct any encoding issues that can occur due to improperly setup databases
+	  *
+	  * @return array
+	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
+	  */
+	 protected function _retrieve_session_data()
+	 {
+		 $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+		 try {
+			 // we're using WP's Transient API to store session data using the PHP session ID as the option name
+			 $session_data = get_transient($ssn_key);
+			 if ($session_data === false) {
+				 return array();
+			 }
+			 if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+				 $hash_check = get_transient(EE_Session::hash_check_prefix . $this->_sid);
+				 if ($hash_check && $hash_check !== md5($session_data)) {
+					 EE_Error::add_error(
+						 sprintf(
+							 __('The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.', 'event_espresso'),
+							 EE_Session::session_id_prefix . $this->_sid
+						 ),
+						 __FILE__, __FUNCTION__, __LINE__
+					 );
+				 }
+			 }
+		 } catch (Exception $e) {
+			 // let's just eat that error for now and attempt to correct any corrupted data
+			 global $wpdb;
+			 $row = $wpdb->get_row(
+				 $wpdb->prepare(
+					 "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
+					 '_transient_' . $ssn_key
+				 )
+			 );
+			 $session_data = is_object($row) ? $row->option_value : null;
+			 if ($session_data) {
+				 $session_data = preg_replace_callback(
+					 '!s:(d+):"(.*?)";!',
+					 function ($match) {
+						 return $match[1] === strlen($match[2])
+							 ? $match[0]
+							 : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+					 },
+					 $session_data
+				 );
+			 }
+			 $session_data = maybe_unserialize($session_data);
+		 }
+		 // in case the data is encoded... try to decode it
+		 $session_data = $this->encryption instanceof EE_Encryption
+			 ? $this->encryption->base64_string_decode($session_data)
+			 : $session_data;
+
+		 if ( ! is_array($session_data)) {
+			 try {
+				 $session_data = maybe_unserialize($session_data);
+			 } catch (Exception $e) {
+				 $msg = esc_html__(
+					 'An error occurred while attempting to unserialize the session data.',
+					 'event_espresso'
+				 );
+				 $msg .= WP_DEBUG
+					 ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+					 : '';
+				 throw new InvalidSessionDataException($msg, 0, $e);
+			 }
+		 }
+		 // just a check to make sure the session array is indeed an array
+		 if ( ! is_array($session_data)) {
+			 // no?!?! then something is wrong
+			 $msg = esc_html__(
+				 'The session data is missing, invalid, or corrupted.',
+				 'event_espresso'
+			 );
+			 $msg .= WP_DEBUG
+				 ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+				 : '';
+			 throw new InvalidSessionDataException($msg);
+		 }
+		 if ( isset( $this->_session_data['transaction'] ) && absint( $this->_session_data['transaction'] ) !== 0 ) {
+			 $this->_session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
+				 $this->_session_data['transaction']
+			 );
+		 }
+		 return $session_data;
+	 }
 
 
 
@@ -1040,17 +1040,17 @@ 
 					OR option_value > {$too_far_in_the_the_future} )
 					LIMIT {$expired_session_transient_delete_query_limit}
 				";
-                    $expired_sessions = $wpdb->get_col($SQL);
-                    // valid results?
-                    if ( ! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
-                        // format array of results into something usable within the actual DELETE query's IN clause
-                        $expired = array();
-                        foreach ($expired_sessions as $expired_session) {
-                            $expired[] = "'" . $expired_session . "'";
-                            $expired[] = "'" . str_replace('timeout_', '', $expired_session) . "'";
-                        }
-                        $expired = implode(', ', $expired);
-                        $SQL = "
+					$expired_sessions = $wpdb->get_col($SQL);
+					// valid results?
+					if ( ! $expired_sessions instanceof WP_Error && ! empty($expired_sessions)) {
+						// format array of results into something usable within the actual DELETE query's IN clause
+						$expired = array();
+						foreach ($expired_sessions as $expired_session) {
+							$expired[] = "'" . $expired_session . "'";
+							$expired[] = "'" . str_replace('timeout_', '', $expired_session) . "'";
+						}
+						$expired = implode(', ', $expired);
+						$SQL = "
 						DELETE FROM {$wpdb->options}
 						WHERE option_name
 						IN ( $expired );

Spacing +161 added lines, -161 removed lines

@@ -1,6 +1,6 @@ 
 <?php use EventEspresso\core\exceptions\InvalidSessionDataException;
 
-if (!defined( 'EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed');}
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {exit('No direct script access allowed'); }
 /**
  *
  * EE_Session class
@@ -99,7 +99,7 @@ 
 	  * array for defining default session vars
 	  * @var array
 	  */
-	 private $_default_session_vars = array (
+	 private $_default_session_vars = array(
         'id'            => null,
         'user_id'       => null,
         'ip_address'    => null,
@@ -119,12 +119,12 @@ 
 	  * @throws InvalidSessionDataException
 	  * @throws \EE_Error
 	  */
-	public static function instance( EE_Encryption $encryption = null ) {
+	public static function instance(EE_Encryption $encryption = null) {
 		// check if class object is instantiated
 		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via:
 		// add_filter( 'FHEE_load_EE_Session', '__return_false' );
-		if ( ! self::$_instance instanceof EE_Session && apply_filters( 'FHEE_load_EE_Session', true ) ) {
-			self::$_instance = new self( $encryption );
+		if ( ! self::$_instance instanceof EE_Session && apply_filters('FHEE_load_EE_Session', true)) {
+			self::$_instance = new self($encryption);
 		}
 		return self::$_instance;
 	}
@@ -140,15 +140,15 @@ 
 	  * @throws \EE_Error
 	  * @throws \EventEspresso\core\exceptions\InvalidSessionDataException
 	  */
-	 protected function __construct( EE_Encryption $encryption = null ) {
+	 protected function __construct(EE_Encryption $encryption = null) {
 
 		// session loading is turned ON by default, but prior to the init hook, can be turned back OFF via: add_filter( 'FHEE_load_EE_Session', '__return_false' );
-		if ( ! apply_filters( 'FHEE_load_EE_Session', true ) ) {
+		if ( ! apply_filters('FHEE_load_EE_Session', true)) {
 			return;
 		}
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
-		if ( ! defined( 'ESPRESSO_SESSION' ) ) {
-			define( 'ESPRESSO_SESSION', true );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! defined('ESPRESSO_SESSION')) {
+			define('ESPRESSO_SESSION', true);
 		}
 		// default session lifespan in seconds
 		$this->_lifespan = apply_filters(
@@ -162,12 +162,12 @@ 
 		 * 		}
 		 */
 		// retrieve session options from db
-		$session_settings = (array) get_option( 'ee_session_settings', array() );
-		if ( ! empty( $session_settings )) {
+		$session_settings = (array) get_option('ee_session_settings', array());
+		if ( ! empty($session_settings)) {
 			// cycle though existing session options
-			foreach ( $session_settings as $var_name => $session_setting ) {
+			foreach ($session_settings as $var_name => $session_setting) {
 				// set values for class properties
-				$var_name = '_' . $var_name;
+				$var_name = '_'.$var_name;
 				$this->{$var_name} = $session_setting;
 			}
 		}
@@ -177,16 +177,16 @@ 
         // encrypt data via: $this->encryption->encrypt();
         $this->encryption = $encryption;
 		// filter hook allows outside functions/classes/plugins to change default empty cart
-		$extra_default_session_vars = apply_filters( 'FHEE__EE_Session__construct__extra_default_session_vars', array() );
-		array_merge( $this->_default_session_vars, $extra_default_session_vars );
+		$extra_default_session_vars = apply_filters('FHEE__EE_Session__construct__extra_default_session_vars', array());
+		array_merge($this->_default_session_vars, $extra_default_session_vars);
 		// apply default session vars
 		$this->_set_defaults();
          add_action('AHEE__EE_System__initialize', array($this, 'open_session'));
          // check request for 'clear_session' param
-		add_action( 'AHEE__EE_Request_Handler__construct__complete', array( $this, 'wp_loaded' ));
+		add_action('AHEE__EE_Request_Handler__construct__complete', array($this, 'wp_loaded'));
 		// once everything is all said and done,
-		add_action( 'shutdown', array( $this, 'update' ), 100 );
-		add_action( 'shutdown', array( $this, 'garbage_collection' ), 999 );
+		add_action('shutdown', array($this, 'update'), 100);
+		add_action('shutdown', array($this, 'garbage_collection'), 999);
 	}
 
 
@@ -274,11 +274,11 @@ 
 	 */
 	private function _set_defaults() {
 		// set some defaults
-		foreach ( $this->_default_session_vars as $key => $default_var ) {
-			if ( is_array( $default_var )) {
-				$this->_session_data[ $key ] = array();
+		foreach ($this->_default_session_vars as $key => $default_var) {
+			if (is_array($default_var)) {
+				$this->_session_data[$key] = array();
 			} else {
-				$this->_session_data[ $key ] = '';
+				$this->_session_data[$key] = '';
 			}
 		}
 	}
@@ -333,7 +333,7 @@ 
 	  * @param \EE_Checkout $checkout
 	  * @return bool
 	  */
-	 public function set_checkout( EE_Checkout $checkout ) {
+	 public function set_checkout(EE_Checkout $checkout) {
 		 $this->_session_data['checkout'] = $checkout;
 		 return TRUE;
 	 }
@@ -366,9 +366,9 @@ 
 	  * @return bool
 	  * @throws \EE_Error
 	  */
-	 public function set_transaction( EE_Transaction $transaction ) {
+	 public function set_transaction(EE_Transaction $transaction) {
 		 // first remove the session from the transaction before we save the transaction in the session
-		 $transaction->set_txn_session_data( NULL );
+		 $transaction->set_txn_session_data(NULL);
 		 $this->_session_data['transaction'] = $transaction;
 		 return TRUE;
 	 }
@@ -404,15 +404,15 @@ 
 	  * @param bool $reset_cache
 	  * @return    array
 	  */
-	public function get_session_data( $key = NULL, $reset_cache = FALSE ) {
-		if ( $reset_cache ) {
+	public function get_session_data($key = NULL, $reset_cache = FALSE) {
+		if ($reset_cache) {
 			$this->reset_cart();
 			$this->reset_checkout();
 			$this->reset_transaction();
 		}
-		 if ( ! empty( $key ))  {
-			return  isset( $this->_session_data[ $key ] ) ? $this->_session_data[ $key ] : NULL;
-		}  else  {
+		 if ( ! empty($key)) {
+			return  isset($this->_session_data[$key]) ? $this->_session_data[$key] : NULL;
+		} else {
 			return $this->_session_data;
 		}
 	}
@@ -425,20 +425,20 @@ 
 	  * @param 	array $data
 	  * @return 	TRUE on success, FALSE on fail
 	  */
-	public function set_session_data( $data ) {
+	public function set_session_data($data) {
 
 		// nothing ??? bad data ??? go home!
-		if ( empty( $data ) || ! is_array( $data )) {
-			EE_Error::add_error( __( 'No session data or invalid session data was provided.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($data) || ! is_array($data)) {
+			EE_Error::add_error(__('No session data or invalid session data was provided.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 
-		foreach ( $data as $key =>$value ) {
-			if ( isset( $this->_default_session_vars[ $key ] )) {
-				EE_Error::add_error( sprintf( __( 'Sorry! %s is a default session datum and can not be reset.', 'event_espresso' ), $key ), __FILE__, __FUNCTION__, __LINE__ );
+		foreach ($data as $key =>$value) {
+			if (isset($this->_default_session_vars[$key])) {
+				EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.', 'event_espresso'), $key), __FILE__, __FUNCTION__, __LINE__);
 				return FALSE;
 			} else {
-				$this->_session_data[ $key ] = $value;
+				$this->_session_data[$key] = $value;
 			}
 		}
 
@@ -456,9 +456,9 @@ 
 	  * @throws \EE_Error
 	  */
 	private function _espresso_session() {
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, '' );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 		// check that session has started
-		if ( session_id() === '' ) {
+		if (session_id() === '') {
 			//starts a new session if one doesn't already exist, or re-initiates an existing one
 			session_start();
 		}
@@ -467,39 +467,39 @@ 
 		// and the visitors IP
 		$this->_ip_address = $this->_visitor_ip();
 		// set the "user agent"
-		$this->_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? esc_attr( $_SERVER['HTTP_USER_AGENT'] ) : FALSE;
+		$this->_user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? esc_attr($_SERVER['HTTP_USER_AGENT']) : FALSE;
 		// now let's retrieve what's in the db
         $session_data = $this->_retrieve_session_data();
-        if (! empty($session_data)) {
+        if ( ! empty($session_data)) {
             // get the current time in UTC
-			$this->_time = isset( $this->_time ) ? $this->_time : time();
+			$this->_time = isset($this->_time) ? $this->_time : time();
 			// and reset the session expiration
-			$this->_expiration = isset( $session_data['expiration'] )
+			$this->_expiration = isset($session_data['expiration'])
 				? $session_data['expiration']
 				: $this->_time + $this->_lifespan;
 		} else {
             // set initial site access time and the session expiration
 			$this->_set_init_access_and_expiration();
 			// set referer
-			$this->_session_data[ 'pages_visited' ][ $this->_session_data['init_access'] ] = isset( $_SERVER['HTTP_REFERER'] )
-				? esc_attr( $_SERVER['HTTP_REFERER'] )
+			$this->_session_data['pages_visited'][$this->_session_data['init_access']] = isset($_SERVER['HTTP_REFERER'])
+				? esc_attr($_SERVER['HTTP_REFERER'])
 				: '';
 			// no previous session = go back and create one (on top of the data above)
 			return FALSE;
 		}
         // now the user agent
-		if ( $session_data['user_agent'] !== $this->_user_agent ) {
+		if ($session_data['user_agent'] !== $this->_user_agent) {
 			return FALSE;
 		}
 		// wait a minute... how old are you?
-		if ( $this->_time > $this->_expiration ) {
+		if ($this->_time > $this->_expiration) {
 			// yer too old fer me!
             $this->_expired = true;
 			// wipe out everything that isn't a default session datum
-			$this->clear_session( __CLASS__, __FUNCTION__ );
+			$this->clear_session(__CLASS__, __FUNCTION__);
 		}
 		// make event espresso session data available to plugin
-		$this->_session_data = array_merge( $this->_session_data, $session_data );
+		$this->_session_data = array_merge($this->_session_data, $session_data);
 		return TRUE;
 
 	}
@@ -515,7 +515,7 @@ 
       */
      protected function _retrieve_session_data()
      {
-         $ssn_key = EE_Session::session_id_prefix . $this->_sid;
+         $ssn_key = EE_Session::session_id_prefix.$this->_sid;
          try {
              // we're using WP's Transient API to store session data using the PHP session ID as the option name
              $session_data = get_transient($ssn_key);
@@ -523,12 +523,12 @@ 
 		         return array();
              }
              if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
-                 $hash_check = get_transient(EE_Session::hash_check_prefix . $this->_sid);
+                 $hash_check = get_transient(EE_Session::hash_check_prefix.$this->_sid);
                  if ($hash_check && $hash_check !== md5($session_data)) {
 	                 EE_Error::add_error(
                          sprintf(
                              __('The stored data for session %1$s failed to pass a hash check and therefore appears to be invalid.', 'event_espresso'),
-                             EE_Session::session_id_prefix . $this->_sid
+                             EE_Session::session_id_prefix.$this->_sid
                          ),
                          __FILE__, __FUNCTION__, __LINE__
                      );
@@ -540,17 +540,17 @@ 
              $row = $wpdb->get_row(
                  $wpdb->prepare(
                      "SELECT option_value FROM {$wpdb->options} WHERE option_name = %s LIMIT 1",
-                     '_transient_' . $ssn_key
+                     '_transient_'.$ssn_key
                  )
              );
              $session_data = is_object($row) ? $row->option_value : null;
              if ($session_data) {
                  $session_data = preg_replace_callback(
                      '!s:(d+):"(.*?)";!',
-                     function ($match) {
+                     function($match) {
                          return $match[1] === strlen($match[2])
                              ? $match[0]
-                             : 's:' . strlen($match[2]) . ':"' . $match[2] . '";';
+                             : 's:'.strlen($match[2]).':"'.$match[2].'";';
                      },
                      $session_data
                  );
@@ -571,7 +571,7 @@ 
                      'event_espresso'
                  );
                  $msg .= WP_DEBUG
-                     ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                     ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                      : '';
                  throw new InvalidSessionDataException($msg, 0, $e);
              }
@@ -584,11 +584,11 @@ 
                  'event_espresso'
              );
              $msg .= WP_DEBUG
-                 ? '<br><pre>' . print_r($session_data, true) . '</pre><br>' . $this->find_serialize_error($session_data)
+                 ? '<br><pre>'.print_r($session_data, true).'</pre><br>'.$this->find_serialize_error($session_data)
                  : '';
 	         throw new InvalidSessionDataException($msg);
          }
-	     if ( isset( $this->_session_data['transaction'] ) && absint( $this->_session_data['transaction'] ) !== 0 ) {
+	     if (isset($this->_session_data['transaction']) && absint($this->_session_data['transaction']) !== 0) {
 		     $this->_session_data['transaction'] = EEM_Transaction::instance()->get_one_by_ID(
 			     $this->_session_data['transaction']
 	         );
@@ -609,12 +609,12 @@ 
 	  */
 	protected function _generate_session_id() {
 		// check if the SID was passed explicitly, otherwise get from session, then add salt and hash it to reduce length
-		if ( isset( $_REQUEST[ 'EESID' ] ) ) {
-			$session_id = sanitize_text_field( $_REQUEST[ 'EESID' ] );
+		if (isset($_REQUEST['EESID'])) {
+			$session_id = sanitize_text_field($_REQUEST['EESID']);
 		} else {
-			$session_id = md5( session_id() . get_current_blog_id() . $this->_get_sid_salt() );
+			$session_id = md5(session_id().get_current_blog_id().$this->_get_sid_salt());
 		}
-		return apply_filters( 'FHEE__EE_Session___generate_session_id__session_id', $session_id );
+		return apply_filters('FHEE__EE_Session___generate_session_id__session_id', $session_id);
 	}
 
 
@@ -626,20 +626,20 @@ 
 	  */
 	protected function _get_sid_salt() {
 		// was session id salt already saved to db ?
-		if ( empty( $this->_sid_salt ) ) {
+		if (empty($this->_sid_salt)) {
 			// no?  then maybe use WP defined constant
-			if ( defined( 'AUTH_SALT' ) ) {
+			if (defined('AUTH_SALT')) {
 				$this->_sid_salt = AUTH_SALT;
 			}
 			// if salt doesn't exist or is too short
-			if ( empty( $this->_sid_salt ) || strlen( $this->_sid_salt ) < 32 ) {
+			if (empty($this->_sid_salt) || strlen($this->_sid_salt) < 32) {
 				// create a new one
-				$this->_sid_salt = wp_generate_password( 64 );
+				$this->_sid_salt = wp_generate_password(64);
 			}
 			// and save it as a permanent session setting
-			$session_settings = get_option( 'ee_session_settings' );
-			$session_settings[ 'sid_salt' ] = $this->_sid_salt;
-			update_option( 'ee_session_settings', $session_settings );
+			$session_settings = get_option('ee_session_settings');
+			$session_settings['sid_salt'] = $this->_sid_salt;
+			update_option('ee_session_settings', $session_settings);
 		}
 		return $this->_sid_salt;
 	}
@@ -667,19 +667,19 @@ 
 	  * @param bool $new_session
 	  * @return TRUE on success, FALSE on fail
 	  */
-	public function update( $new_session = FALSE ) {
-		$this->_session_data = isset( $this->_session_data )
-			&& is_array( $this->_session_data )
-			&& isset( $this->_session_data['id'])
+	public function update($new_session = FALSE) {
+		$this->_session_data = isset($this->_session_data)
+			&& is_array($this->_session_data)
+			&& isset($this->_session_data['id'])
 			? $this->_session_data
 			: array();
-		if ( empty( $this->_session_data )) {
+		if (empty($this->_session_data)) {
 			$this->_set_defaults();
 		}
 		$session_data = array();
-		foreach ( $this->_session_data as $key => $value ) {
+		foreach ($this->_session_data as $key => $value) {
 
-			switch( $key ) {
+			switch ($key) {
 
 				case 'id' :
 					// session ID
@@ -697,7 +697,7 @@ 
 				break;
 
 				case 'init_access' :
-					$session_data['init_access'] = absint( $value );
+					$session_data['init_access'] = absint($value);
 				break;
 
 				case 'last_access' :
@@ -707,7 +707,7 @@ 
 
 				case 'expiration' :
 					// when the session expires
-					$session_data['expiration'] = ! empty( $this->_expiration )
+					$session_data['expiration'] = ! empty($this->_expiration)
 						? $this->_expiration
 						: $session_data['init_access'] + $this->_lifespan;
 				break;
@@ -719,11 +719,11 @@ 
 
 				case 'pages_visited' :
 					$page_visit = $this->_get_page_visit();
-					if ( $page_visit ) {
+					if ($page_visit) {
 						// set pages visited where the first will be the http referrer
-						$this->_session_data[ 'pages_visited' ][ $this->_time ] = $page_visit;
+						$this->_session_data['pages_visited'][$this->_time] = $page_visit;
 						// we'll only save the last 10 page visits.
-						$session_data[ 'pages_visited' ] = array_slice( $this->_session_data['pages_visited'], -10 );
+						$session_data['pages_visited'] = array_slice($this->_session_data['pages_visited'], -10);
 					}
 				break;
 
@@ -737,9 +737,9 @@ 
 
 		$this->_session_data = $session_data;
 		// creating a new session does not require saving to the db just yet
-		if ( ! $new_session ) {
+		if ( ! $new_session) {
 			// ready? let's save
-			if ( $this->_save_session_to_db() ) {
+			if ($this->_save_session_to_db()) {
 				return TRUE;
 			} else {
 				return FALSE;
@@ -758,9 +758,9 @@ 
 	 * 	@return bool
 	 */
 	private function _create_espresso_session( ) {
-		do_action( 'AHEE_log', __CLASS__, __FUNCTION__, '' );
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, '');
 		// use the update function for now with $new_session arg set to TRUE
-		return  $this->update( TRUE ) ? TRUE : FALSE;
+		return  $this->update(TRUE) ? TRUE : FALSE;
 	}
 
 
@@ -786,15 +786,15 @@ 
 				// OR an admin request that is NOT AJAX
 				|| (
 					is_admin()
-					&& ! ( defined( 'DOING_AJAX' ) && DOING_AJAX )
+					&& ! (defined('DOING_AJAX') && DOING_AJAX)
 				)
 			)
 		) {
 			return false;
 		}
 		$transaction = $this->transaction();
-		if ( $transaction instanceof EE_Transaction ) {
-			if ( ! $transaction->ID() ) {
+		if ($transaction instanceof EE_Transaction) {
+			if ( ! $transaction->ID()) {
 				$transaction->save();
 			}
 			$this->_session_data['transaction'] = $transaction->ID();
@@ -802,13 +802,13 @@ 
 		// then serialize all of our session data
 		$session_data = serialize($this->_session_data);
 		// do we need to also encode it to avoid corrupted data when saved to the db?
-		$session_data = $this->_use_encryption ? $this->encryption->base64_string_encode( $session_data ) : $session_data;
+		$session_data = $this->_use_encryption ? $this->encryption->base64_string_encode($session_data) : $session_data;
 		// maybe save hash check
-		if ( apply_filters( 'FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG ) ) {
-			set_transient( EE_Session::hash_check_prefix . $this->_sid, md5( $session_data ), $this->_lifespan );
+		if (apply_filters('FHEE__EE_Session___perform_session_id_hash_check', WP_DEBUG)) {
+			set_transient(EE_Session::hash_check_prefix.$this->_sid, md5($session_data), $this->_lifespan);
 		}
 		// we're using the Transient API for storing session data, cuz it's so damn simple -> set_transient(  transient ID, data, expiry )
-		return set_transient( EE_Session::session_id_prefix . $this->_sid, $session_data, $this->_lifespan );
+		return set_transient(EE_Session::session_id_prefix.$this->_sid, $session_data, $this->_lifespan);
 	}
 
 
@@ -834,10 +834,10 @@ 
 			'HTTP_FORWARDED',
 			'REMOTE_ADDR'
 		);
-		foreach ( $server_keys as $key ){
-			if ( isset( $_SERVER[ $key ] )) {
-				foreach ( array_map( 'trim', explode( ',', $_SERVER[ $key ] )) as $ip ) {
-					if ( $ip === '127.0.0.1' || filter_var( $ip, FILTER_VALIDATE_IP ) !== FALSE ) {
+		foreach ($server_keys as $key) {
+			if (isset($_SERVER[$key])) {
+				foreach (array_map('trim', explode(',', $_SERVER[$key])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== FALSE) {
 						$visitor_ip = $ip;
 					}
 				}
@@ -856,32 +856,32 @@ 
 	 *			@return string
 	 */
 	public function _get_page_visit() {
-		$page_visit = home_url('/') . 'wp-admin/admin-ajax.php';
+		$page_visit = home_url('/').'wp-admin/admin-ajax.php';
 		// check for request url
-		if ( isset( $_SERVER['REQUEST_URI'] )) {
+		if (isset($_SERVER['REQUEST_URI'])) {
 			$http_host = '';
 			$page_id = '?';
 			$e_reg = '';
-			$request_uri = esc_url( $_SERVER['REQUEST_URI'] );
-			$ru_bits = explode( '?', $request_uri );
+			$request_uri = esc_url($_SERVER['REQUEST_URI']);
+			$ru_bits = explode('?', $request_uri);
 			$request_uri = $ru_bits[0];
 			// check for and grab host as well
-			if ( isset( $_SERVER['HTTP_HOST'] )) {
-				$http_host = esc_url( $_SERVER['HTTP_HOST'] );
+			if (isset($_SERVER['HTTP_HOST'])) {
+				$http_host = esc_url($_SERVER['HTTP_HOST']);
 			}
 			// check for page_id in SERVER REQUEST
-			if ( isset( $_REQUEST['page_id'] )) {
+			if (isset($_REQUEST['page_id'])) {
 				// rebuild $e_reg without any of the extra parameters
-				$page_id = '?page_id=' . esc_attr( $_REQUEST['page_id'] ) . '&amp;';
+				$page_id = '?page_id='.esc_attr($_REQUEST['page_id']).'&amp;';
 			}
 			// check for $e_reg in SERVER REQUEST
-			if ( isset( $_REQUEST['ee'] )) {
+			if (isset($_REQUEST['ee'])) {
 				// rebuild $e_reg without any of the extra parameters
-				$e_reg = 'ee=' . esc_attr( $_REQUEST['ee'] );
+				$e_reg = 'ee='.esc_attr($_REQUEST['ee']);
 			}
-			$page_visit = rtrim( $http_host . $request_uri . $page_id . $e_reg, '?' );
+			$page_visit = rtrim($http_host.$request_uri.$page_id.$e_reg, '?');
 		}
-		return $page_visit !== home_url( '/wp-admin/admin-ajax.php' ) ? $page_visit : '';
+		return $page_visit !== home_url('/wp-admin/admin-ajax.php') ? $page_visit : '';
 
 	}
 
@@ -910,14 +910,14 @@ 
 	  * @param string $function
 	  * @return void
 	  */
-	public function clear_session( $class = '', $function = '' ) {
+	public function clear_session($class = '', $function = '') {
 		//echo '<h3 style="color:#999;line-height:.9em;"><span style="color:#2EA2CC">' . __CLASS__ . '</span>::<span style="color:#E76700">' . __FUNCTION__ . '( ' . $class . '::' . $function . '() )</span><br/><span style="font-size:9px;font-weight:normal;">' . __FILE__ . '</span>    <b style="font-size:10px;">  ' . __LINE__ . ' </b></h3>';
-		do_action( 'AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : ' . $class . '::' .  $function . '()' );
+		do_action('AHEE_log', __FILE__, __FUNCTION__, 'session cleared by : '.$class.'::'.$function.'()');
 		$this->reset_cart();
 		$this->reset_checkout();
 		$this->reset_transaction();
 		// wipe out everything that isn't a default session datum
-		$this->reset_data( array_keys( $this->_session_data ));
+		$this->reset_data(array_keys($this->_session_data));
 		// reset initial site access time and the session expiration
 		$this->_set_init_access_and_expiration();
 		$this->_save_session_to_db();
@@ -932,42 +932,42 @@ 
 	  * @param bool  $show_all_notices
 	  * @return TRUE on success, FALSE on fail
 	  */
-	public function reset_data( $data_to_reset = array(), $show_all_notices = FALSE ) {
+	public function reset_data($data_to_reset = array(), $show_all_notices = FALSE) {
 		// if $data_to_reset is not in an array, then put it in one
-		if ( ! is_array( $data_to_reset ) ) {
-			$data_to_reset = array ( $data_to_reset );
+		if ( ! is_array($data_to_reset)) {
+			$data_to_reset = array($data_to_reset);
 		}
 		// nothing ??? go home!
-		if ( empty( $data_to_reset )) {
-			EE_Error::add_error( __( 'No session data could be reset, because no session var name was provided.', 'event_espresso' ), __FILE__, __FUNCTION__, __LINE__ );
+		if (empty($data_to_reset)) {
+			EE_Error::add_error(__('No session data could be reset, because no session var name was provided.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
 			return FALSE;
 		}
 		$return_value = TRUE;
 		// since $data_to_reset is an array, cycle through the values
-		foreach ( $data_to_reset as $reset ) {
+		foreach ($data_to_reset as $reset) {
 
 			// first check to make sure it is a valid session var
-			if ( isset( $this->_session_data[ $reset ] )) {
+			if (isset($this->_session_data[$reset])) {
 				// then check to make sure it is not a default var
-				if ( ! array_key_exists( $reset, $this->_default_session_vars )) {
+				if ( ! array_key_exists($reset, $this->_default_session_vars)) {
 					// remove session var
-					unset( $this->_session_data[ $reset ] );
-					if ( $show_all_notices ) {
-						EE_Error::add_success( sprintf( __( 'The session variable %s was removed.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+					unset($this->_session_data[$reset]);
+					if ($show_all_notices) {
+						EE_Error::add_success(sprintf(__('The session variable %s was removed.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 					}
-					$return_value = !isset($return_value) ? TRUE : $return_value;
+					$return_value = ! isset($return_value) ? TRUE : $return_value;
 
 				} else {
 					// yeeeeeeeeerrrrrrrrrrr OUT !!!!
-					if ( $show_all_notices ) {
-						EE_Error::add_error( sprintf( __( 'Sorry! %s is a default session datum and can not be reset.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+					if ($show_all_notices) {
+						EE_Error::add_error(sprintf(__('Sorry! %s is a default session datum and can not be reset.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 					}
 					$return_value = FALSE;
 				}
 
-			} else if ( $show_all_notices ) {
+			} else if ($show_all_notices) {
 				// oops! that session var does not exist!
-				EE_Error::add_error( sprintf( __( 'The session item provided, %s, is invalid or does not exist.', 'event_espresso' ), $reset ), __FILE__, __FUNCTION__, __LINE__ );
+				EE_Error::add_error(sprintf(__('The session item provided, %s, is invalid or does not exist.', 'event_espresso'), $reset), __FILE__, __FUNCTION__, __LINE__);
 				$return_value = FALSE;
 			}
 
@@ -987,8 +987,8 @@ 
 	 *   @access public
 	 */
 	public function wp_loaded() {
-		if ( isset(  EE_Registry::instance()->REQ ) && EE_Registry::instance()->REQ->is_set( 'clear_session' )) {
-			$this->clear_session( __CLASS__, __FUNCTION__ );
+		if (isset(EE_Registry::instance()->REQ) && EE_Registry::instance()->REQ->is_set('clear_session')) {
+			$this->clear_session(__CLASS__, __FUNCTION__);
 		}
 	}
 
@@ -1013,24 +1013,24 @@ 
 	  */
 	 public function garbage_collection() {
 		 // only perform during regular requests
-		 if ( ! defined( 'DOING_AJAX') || ! DOING_AJAX ) {
+		 if ( ! defined('DOING_AJAX') || ! DOING_AJAX) {
 			 /** @type WPDB $wpdb */
 			 global $wpdb;
 			 // since transient expiration timestamps are set in the future, we can compare against NOW
 			 $expiration = time();
-			 $too_far_in_the_the_future = $expiration + ( $this->_lifespan * 2 );
+			 $too_far_in_the_the_future = $expiration + ($this->_lifespan * 2);
 			 // filter the query limit. Set to 0 to turn off garbage collection
-			 $expired_session_transient_delete_query_limit = absint( apply_filters( 'FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit', 50 ));
+			 $expired_session_transient_delete_query_limit = absint(apply_filters('FHEE__EE_Session__garbage_collection___expired_session_transient_delete_query_limit', 50));
 			 // non-zero LIMIT means take out the trash
-			 if ( $expired_session_transient_delete_query_limit ) {
+			 if ($expired_session_transient_delete_query_limit) {
 				 //array of transient keys that require garbage collection
 				 $session_keys = array(
 					 EE_Session::session_id_prefix,
 					 EE_Session::hash_check_prefix,
 				 );
-				 foreach ( $session_keys as $session_key ) {
-					 $session_key = str_replace( '_', '\_', $session_key );
-					 $session_key = '\_transient\_timeout\_' . $session_key . '%';
+				 foreach ($session_keys as $session_key) {
+					 $session_key = str_replace('_', '\_', $session_key);
+					 $session_key = '\_transient\_timeout\_'.$session_key.'%';
 					 $SQL = "
 					SELECT option_name
 					FROM {$wpdb->options}
@@ -1046,8 +1046,8 @@ 
                         // format array of results into something usable within the actual DELETE query's IN clause
                         $expired = array();
                         foreach ($expired_sessions as $expired_session) {
-                            $expired[] = "'" . $expired_session . "'";
-                            $expired[] = "'" . str_replace('timeout_', '', $expired_session) . "'";
+                            $expired[] = "'".$expired_session."'";
+                            $expired[] = "'".str_replace('timeout_', '', $expired_session)."'";
                         }
                         $expired = implode(', ', $expired);
                         $SQL = "
@@ -1055,10 +1055,10 @@ 
 						WHERE option_name
 						IN ( $expired );
 					 ";
-						 $results = $wpdb->query( $SQL );
+						 $results = $wpdb->query($SQL);
 						 // if something went wrong, then notify the admin
-						 if ( $results instanceof WP_Error && is_admin() ) {
-							 EE_Error::add_error( $results->get_error_message(), __FILE__, __FUNCTION__, __LINE__ );
+						 if ($results instanceof WP_Error && is_admin()) {
+							 EE_Error::add_error($results->get_error_message(), __FILE__, __FUNCTION__, __LINE__);
 						 }
 					 }
 				 }
@@ -1079,34 +1079,34 @@ 
 	  * @param $data1
 	  * @return string
 	  */
-	 private function find_serialize_error( $data1 ) {
+	 private function find_serialize_error($data1) {
 		$error = "<pre>";
 		 $data2 = preg_replace_callback(
 			 '!s:(\d+):"(.*?)";!',
-			 function ( $match ) {
-				 return ( $match[1] === strlen( $match[2] ) )
+			 function($match) {
+				 return ($match[1] === strlen($match[2]))
 					 ? $match[0]
 					 : 's:'
-					   . strlen( $match[2] )
+					   . strlen($match[2])
 					   . ':"'
 					   . $match[2]
 					   . '";';
 			 },
 			 $data1
 		 );
-		$max = ( strlen( $data1 ) > strlen( $data2 ) ) ? strlen( $data1 ) : strlen( $data2 );
-		$error .= $data1 . PHP_EOL;
-		$error .= $data2 . PHP_EOL;
-		for ( $i = 0; $i < $max; $i++ ) {
-			if ( @$data1[ $i ] !== @$data2[ $i ] ) {
-				$error .= "Difference " . @$data1[ $i ] . " != " . @$data2[ $i ] . PHP_EOL;
-				$error .= "\t-> ORD number " . ord( @$data1[ $i ] ) . " != " . ord( @$data2[ $i ] ) . PHP_EOL;
-				$error .= "\t-> Line Number = $i" . PHP_EOL;
-				$start = ( $i - 20 );
-				$start = ( $start < 0 ) ? 0 : $start;
+		$max = (strlen($data1) > strlen($data2)) ? strlen($data1) : strlen($data2);
+		$error .= $data1.PHP_EOL;
+		$error .= $data2.PHP_EOL;
+		for ($i = 0; $i < $max; $i++) {
+			if (@$data1[$i] !== @$data2[$i]) {
+				$error .= "Difference ".@$data1[$i]." != ".@$data2[$i].PHP_EOL;
+				$error .= "\t-> ORD number ".ord(@$data1[$i])." != ".ord(@$data2[$i]).PHP_EOL;
+				$error .= "\t-> Line Number = $i".PHP_EOL;
+				$start = ($i - 20);
+				$start = ($start < 0) ? 0 : $start;
 				$length = 40;
 				$point = $max - $i;
-				if ( $point < 20 ) {
+				if ($point < 20) {
 					$rlength = 1;
 					$rpoint = -$point;
 				} else {
@@ -1115,16 +1115,16 @@ 
 				}
 				$error .= "\t-> Section Data1  = ";
 				$error .= substr_replace(
-					substr( $data1, $start, $length ),
-					"<b style=\"color:green\">{$data1[ $i ]}</b>",
+					substr($data1, $start, $length),
+					"<b style=\"color:green\">{$data1[$i]}</b>",
 					$rpoint,
 					$rlength
 				);
 				$error .= PHP_EOL;
 				$error .= "\t-> Section Data2  = ";
 				$error .= substr_replace(
-					substr( $data2, $start, $length ),
-					"<b style=\"color:red\">{$data2[ $i ]}</b>",
+					substr($data2, $start, $length),
+					"<b style=\"color:red\">{$data2[$i]}</b>",
 					$rpoint,
 					$rlength
 				);

core/EE_Payment_Processor.core.php

Indentation +734 added lines, -734 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 EE_Registry::instance()->load_class('Processor_Base');
 
@@ -16,737 +16,737 @@ 
 class EE_Payment_Processor extends EE_Processor_Base
 {
 
-    /**
-     * @var EE_Payment_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Payment_Processor instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if ( ! self::$_instance instanceof EE_Payment_Processor) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     *private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Payment_Processor__construct');
-        add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
-    }
-
-
-
-    /**
-     * Using the selected gateway, processes the payment for that transaction, and updates the transaction
-     * appropriately. Saves the payment that is generated
-     *
-     * @param EE_Payment_Method    $payment_method
-     * @param EE_Transaction       $transaction
-     * @param float                $amount       if only part of the transaction is to be paid for, how much.
-     *                                           Leave null if payment is for the full amount owing
-     * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
-     *                                           Receive_form_submission() should have
-     *                                           already been called on the billing form
-     *                                           (ie, its inputs should have their normalized values set).
-     * @param string               $return_url   string used mostly by offsite gateways to specify
-     *                                           where to go AFTER the offsite gateway
-     * @param string               $method       like 'CART', indicates who the client who called this was
-     * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
-     * @param boolean              $update_txn   whether or not to call
-     *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param string               $cancel_url   URL to return to if off-site payments are cancelled
-     * @return \EE_Payment
-     * @throws \EE_Error
-     */
-    public function process_payment(
-        EE_Payment_Method $payment_method,
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_form = null,
-        $return_url = null,
-        $method = 'CART',
-        $by_admin = false,
-        $update_txn = true,
-        $cancel_url = ''
-    ) {
-        if ((float)$amount < 0) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
-                        'event_espresso'
-                    ),
-                    $amount,
-                    $transaction->ID()
-                )
-            );
-        }
-        // verify payment method
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
-        // verify transaction
-        EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $transaction->set_payment_method_ID($payment_method->ID());
-        // verify payment method type
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            $payment = $payment_method->type_obj()->process_payment(
-                $transaction,
-                min($amount, $transaction->remaining()),//make sure we don't overcharge
-                $billing_form,
-                $return_url,
-                add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
-                $method,
-                $by_admin
-            );
-            // check if payment method uses an off-site gateway
-            if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
-                // don't process payments for off-site gateways yet because no payment has occurred yet
-                $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            }
-            return $payment;
-        } else {
-            EE_Error::add_error(
-                sprintf(
-                    __('A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.', 'event_espresso'),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ), __FILE__, __FUNCTION__, __LINE__
-            );
-            return null;
-        }
-    }
-
-
-
-    /**
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment_Method  $payment_method
-     * @throws EE_Error
-     * @return string
-     */
-    public function get_ipn_url_for_payment_method($transaction, $payment_method)
-    {
-        /** @type \EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $primary_reg = $transaction->primary_registration();
-        if ( ! $primary_reg instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        "Cannot get IPN URL for transaction with ID %d because it has no primary registration",
-                        "event_espresso"
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
-        $url = add_query_arg(
-            array(
-                'e_reg_url_link'    => $primary_reg->reg_url_link(),
-                'ee_payment_method' => $payment_method->slug(),
-            ),
-            EE_Registry::instance()->CFG->core->txn_page_url()
-        );
-        return $url;
-    }
-
-
-
-    /**
-     * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
-     * we can easily find what registration the IPN is for and what payment method.
-     * However, if not, we'll give all payment methods a chance to claim it and process it.
-     * If a payment is found for the IPN info, it is saved.
-     *
-     * @param array              $_req_data            eg $_REQUEST
-     * @param EE_Transaction|int $transaction          optional (or a transactions id)
-     * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
-     * @param boolean            $update_txn           whether or not to call
-     *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param bool               $separate_IPN_request whether the IPN uses a separate request ( true like PayPal )
-     *                                                 or is processed manually ( false like Mijireh )
-     * @throws EE_Error
-     * @throws Exception
-     * @return EE_Payment
-     */
-    public function process_ipn(
-        $_req_data,
-        $transaction = null,
-        $payment_method = null,
-        $update_txn = true,
-        $separate_IPN_request = true
-    ) {
-        EE_Registry::instance()->load_model('Change_Log');
-        $_req_data = $this->_remove_unusable_characters_from_array((array)$_req_data);
-        EE_Processor_Base::set_IPN($separate_IPN_request);
-        $obj_for_log = null;
-        if ($transaction instanceof EE_Transaction) {
-            $obj_for_log = $transaction;
-            if ($payment_method instanceof EE_Payment_Method) {
-                $obj_for_log = EEM_Payment::instance()->get_one(
-                    array(
-                        array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
-                        'order_by' => array('PAY_timestamp' => 'desc'),
-                    )
-                );
-            }
-        } else if ($payment_method instanceof EE_Payment) {
-            $obj_for_log = $payment_method;
-        }
-        $log = EEM_Change_Log::instance()->log(
-            EEM_Change_Log::type_gateway,
-            array('IPN data received' => $_req_data),
-            $obj_for_log
-        );
-        try {
-            /**
-             * @var EE_Payment $payment
-             */
-            $payment = null;
-            if ($transaction && $payment_method) {
-                /** @type EE_Transaction $transaction */
-                $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-                /** @type EE_Payment_Method $payment_method */
-                $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
-                if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-                    try {
-                        $payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
-                        $log->set_object($payment);
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    }
-                } else {
-                    // not a payment
-                    EE_Error::add_error(
-                        sprintf(
-                            __('A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.', 'event_espresso'),
-                            '<br/>',
-                            EE_Registry::instance()->CFG->organization->get_pretty('email')
-                        ),
-                        __FILE__, __FUNCTION__, __LINE__
-                    );
-                }
-            } else {
-                //that's actually pretty ok. The IPN just wasn't able
-                //to identify which transaction or payment method this was for
-                // give all active payment methods a chance to claim it
-                $active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
-                foreach ($active_payment_methods as $active_payment_method) {
-                    try {
-                        $payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
-                        $payment_method = $active_payment_method;
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment
-                        );
-                        break;
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    } catch (EE_Error $e) {
-                        //that's fine- it apparently couldn't handle the IPN
-                    }
-                }
-            }
-            // 			EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
-            if ($payment instanceof EE_Payment) {
-                $payment->save();
-                //  update the TXN
-                $this->update_txn_based_on_payment($transaction, $payment, $update_txn, $separate_IPN_request);
-            } else {
-                //we couldn't find the payment for this IPN... let's try and log at least SOMETHING
-                if ($payment_method) {
-                    EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment_method);
-                } elseif ($transaction) {
-                    EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $transaction);
-                }
-            }
-            return $payment;
-        } catch (EE_Error $e) {
-            do_action(
-                'AHEE__log', __FILE__, __FUNCTION__, sprintf(
-                    __('Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"', 'event_espresso'),
-                    print_r($transaction, true),
-                    print_r($_req_data, true),
-                    $e->getMessage()
-                )
-            );
-            throw $e;
-        }
-    }
-
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param  array $request_data
-     * @return array
-     */
-    protected function _remove_unusable_characters_from_array(array $request_data)
-    {
-        $return_data = array();
-        foreach ($request_data as $key => $value) {
-            $return_data[$this->_remove_unusable_characters($key)] = $this->_remove_unusable_characters($value);
-        }
-        return $return_data;
-    }
-
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param string $request_data
-     * @return string
-     */
-    protected function _remove_unusable_characters($request_data)
-    {
-        return preg_replace('/[^[:print:]]/', '', $request_data);
-    }
-
-
-
-    /**
-     * Should be called just before displaying the payment attempt results to the user,
-     * when the payment attempt has finished. Some payment methods may have special
-     * logic to perform here. For example, if process_payment() happens on a special request
-     * and then the user is redirected to a page that displays the payment's status, this
-     * should be called while loading the page that displays the payment's status. If the user is
-     * sent to an offsite payment provider, this should be called upon returning from that offsite payment
-     * provider.
-     *
-     * @param EE_Transaction|int $transaction
-     * @param bool               $update_txn whether or not to call
-     *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @throws \EE_Error
-     * @return EE_Payment
-     * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
-     *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
-     */
-    public function finalize_payment_for($transaction, $update_txn = true)
-    {
-        /** @var $transaction EE_Transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $last_payment_method = $transaction->payment_method();
-        if ($last_payment_method instanceof EE_Payment_Method) {
-            $payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
-            $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            return $payment;
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param EE_Payment        $payment_to_refund
-     * @param array             $refund_info
-     * @return EE_Payment
-     * @throws \EE_Error
-     */
-    public function process_refund(
-        EE_Payment_Method $payment_method,
-        EE_Payment $payment_to_refund,
-        $refund_info = array()
-    ) {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
-            $payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
-            $this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
-        }
-        return $payment_to_refund;
-    }
-
-
-
-    /**
-     * This should be called each time there may have been an update to a
-     * payment on a transaction (ie, we asked for a payment to process a
-     * payment for a transaction, or we told a payment method about an IPN, or
-     * we told a payment method to
-     * "finalize_payment_for" (a transaction), or we told a payment method to
-     * process a refund. This should handle firing the correct hooks to
-     * indicate
-     * what exactly happened and updating the transaction appropriately). This
-     * could be integrated directly into EE_Transaction upon save, but we want
-     * this logic to be separate from 'normal' plain-jane saving and updating
-     * of transactions and payments, and to be tied to payment processing.
-     * Note: this method DOES NOT save the payment passed into it. It is the responsibility
-     * of previous code to decide whether or not to save (because the payment passed into
-     * this method might be a temporary, never-to-be-saved payment from an offline gateway,
-     * in which case we only want that payment object for some temporary usage during this request,
-     * but we don't want it to be saved).
-     *
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment         $payment
-     * @param boolean            $update_txn
-     *                        whether or not to call
-     *                        EE_Transaction_Processor::
-     *                        update_transaction_and_registrations_after_checkout_or_payment()
-     *                        (you can save 1 DB query if you know you're going
-     *                        to save it later instead)
-     * @param bool               $IPN
-     *                        if processing IPNs or other similar payment
-     *                        related activities that occur in alternate
-     *                        requests than the main one that is processing the
-     *                        TXN, then set this to true to check whether the
-     *                        TXN is locked before updating
-     * @throws \EE_Error
-     */
-    public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
-    {
-        $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
-        /** @type EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        // can we freely update the TXN at this moment?
-        if ($IPN && $transaction->is_locked()) {
-            // don't update the transaction at this exact moment
-            // because the TXN is active in another request
-            EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                time(),
-                $transaction->ID(),
-                $payment->ID()
-            );
-        } else {
-            // verify payment and that it has been saved
-            if ($payment instanceof EE_Payment && $payment->ID()) {
-                if (
-                    $payment->payment_method() instanceof EE_Payment_Method
-                    && $payment->payment_method()->type_obj() instanceof EE_PMT_Base
-                ) {
-                    $payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
-                    // update TXN registrations with payment info
-                    $this->process_registration_payments($transaction, $payment);
-                }
-                $do_action = $payment->just_approved()
-                    ? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
-                    : $do_action;
-            } else {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
-            }
-            if ($payment->status() !== EEM_Payment::status_id_failed) {
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                // set new value for total paid
-                $transaction_payments->calculate_total_payments_and_update_status($transaction);
-                // call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
-                if ($update_txn) {
-                    $this->_post_payment_processing($transaction, $payment, $IPN);
-                }
-            }
-            // granular hook for others to use.
-            do_action($do_action, $transaction, $payment);
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
-            //global hook for others to use.
-            do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
-        }
-    }
-
-
-
-    /**
-     * update registrations REG_paid field after successful payment and link registrations with payment
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment        $payment
-     * @param EE_Registration[] $registrations
-     * @throws \EE_Error
-     */
-    public function process_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        $registrations = array()
-    ) {
-        // only process if payment was successful
-        if ($payment->status() !== EEM_Payment::status_id_approved) {
-            return;
-        }
-        //EEM_Registration::instance()->show_next_x_db_queries();
-        if (empty($registrations)) {
-            // find registrations with monies owing that can receive a payment
-            $registrations = $transaction->registrations(
-                array(
-                    array(
-                        // only these reg statuses can receive payments
-                        'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
-                        'REG_final_price'  => array('!=', 0),
-                        'REG_final_price*' => array('!=', 'REG_paid', true),
-                    ),
-                )
-            );
-        }
-        // still nothing ??!??
-        if (empty($registrations)) {
-            return;
-        }
-        // todo: break out the following logic into a separate strategy class
-        // todo: named something like "Sequential_Reg_Payment_Strategy"
-        // todo: which would apply payments using the capitalist "first come first paid" approach
-        // todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
-        // todo: which would be the socialist "everybody gets a piece of pie" approach,
-        // todo: which would be better for deposits, where you want a bit of the payment applied to each registration
-        $refund = $payment->is_a_refund();
-        // how much is available to apply to registrations?
-        $available_payment_amount = abs($payment->amount());
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                // nothing left?
-                if ($available_payment_amount <= 0) {
-                    break;
-                }
-                if ($refund) {
-                    $available_payment_amount = $this->process_registration_refund($registration, $payment, $available_payment_amount);
-                } else {
-                    $available_payment_amount = $this->process_registration_payment($registration, $payment, $available_payment_amount);
-                }
-            }
-        }
-        if ($available_payment_amount > 0 && apply_filters('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', false)) {
-            EE_Error::add_attention(
-                sprintf(
-                    __('A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
-                        'event_espresso'),
-                    EEH_Template::format_currency($available_payment_amount),
-                    implode(', ', array_keys($registrations)),
-                    '<br/>',
-                    EEH_Template::format_currency($payment->amount())
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-    }
-
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_payment_amount
-     * @return float
-     * @throws \EE_Error
-     */
-    public function process_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_payment_amount = 0.00
-    ) {
-        $owing = $registration->final_price() - $registration->paid();
-        if ($owing > 0) {
-            // don't allow payment amount to exceed the available payment amount, OR the amount owing
-            $payment_amount = min($available_payment_amount, $owing);
-            // update $available_payment_amount
-            $available_payment_amount -= $payment_amount;
-            //calculate and set new REG_paid
-            $registration->set_paid($registration->paid() + $payment_amount);
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $payment_amount);
-        }
-        return $available_payment_amount;
-    }
-
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $payment_amount
-     * @return void
-     * @throws \EE_Error
-     */
-    protected function _apply_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $payment_amount = 0.00
-    ) {
-        // find any existing reg payment records for this registration and payment
-        $existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
-            array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
-        );
-        // if existing registration payment exists
-        if ($existing_reg_payment instanceof EE_Registration_Payment) {
-            // then update that record
-            $existing_reg_payment->set_amount($payment_amount);
-            $existing_reg_payment->save();
-        } else {
-            // or add new relation between registration and payment and set amount
-            $registration->_add_relation_to($payment, 'Payment', array('RPY_amount' => $payment_amount));
-            // make it stick
-            $registration->save();
-        }
-    }
-
-
-
-    /**
-     * update registration REG_paid field after refund and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
-     * @return float
-     * @throws \EE_Error
-     */
-    public function process_registration_refund(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_refund_amount = 0.00
-    ) {
-        //EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
-        if ($registration->paid() > 0) {
-            // ensure $available_refund_amount is NOT negative
-            $available_refund_amount = (float)abs($available_refund_amount);
-            // don't allow refund amount to exceed the available payment amount, OR the amount paid
-            $refund_amount = min($available_refund_amount, (float)$registration->paid());
-            // update $available_payment_amount
-            $available_refund_amount -= $refund_amount;
-            //calculate and set new REG_paid
-            $registration->set_paid($registration->paid() - $refund_amount);
-            // convert payment amount back to a negative value for storage in the db
-            $refund_amount = (float)abs($refund_amount) * -1;
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $refund_amount);
-        }
-        return $available_refund_amount;
-    }
-
-
-
-    /**
-     * Process payments and transaction after payment process completed.
-     * ultimately this will send the TXN and payment details off so that notifications can be sent out.
-     * if this request happens to be processing an IPN,
-     * then we will also set the Payment Options Reg Step to completed,
-     * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $IPN
-     * @throws \EE_Error
-     */
-    protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
-    {
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // is the Payment Options Reg Step completed ?
-        $payment_options_step_completed = $transaction->reg_step_completed('payment_options');
-        // if the Payment Options Reg Step is completed...
-        $revisit = $payment_options_step_completed === true ? true : false;
-        // then this is kinda sorta a revisit with regards to payments at least
-        $transaction_processor->set_revisit($revisit);
-        // if this is an IPN, let's consider the Payment Options Reg Step completed if not already
-        if (
-            $IPN
-            && $payment_options_step_completed !== true
-            && ($payment->is_approved() || $payment->is_pending())
-        ) {
-            $payment_options_step_completed = $transaction->set_reg_step_completed(
-                'payment_options'
-            );
-        }
-        // maybe update status, but don't save transaction just yet
-        $transaction->update_status_based_on_total_paid(false);
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        //  if this is an IPN and the final step has not been initiated
-        if ($IPN && $payment_options_step_completed && $finalized === false) {
-            // and if it hasn't already been set as being started...
-            $finalized = $transaction->set_reg_step_initiated('finalize_registration');
-        }
-        $transaction->save();
-        // because the above will return false if the final step was not fully completed, we need to check again...
-        if ($IPN && $finalized !== false) {
-            // and if we are all good to go, then send out notifications
-            add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            //ok, now process the transaction according to the payment
-            $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($transaction, $payment);
-        }
-        // DEBUG LOG
-        $payment_method = $payment->payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $payment_method_type_obj = $payment_method->type_obj();
-            if ($payment_method_type_obj instanceof EE_PMT_Base) {
-                $gateway = $payment_method_type_obj->get_gateway();
-                if ($gateway instanceof EE_Gateway) {
-                    $gateway->log(
-                        array(
-                            'message'               => __('Post Payment Transaction Details', 'event_espresso'),
-                            'transaction'           => $transaction->model_field_array(),
-                            'finalized'             => $finalized,
-                            'IPN'                   => $IPN,
-                            'deliver_notifications' => has_filter(
-                                'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-                            ),
-                        ),
-                        $payment
-                    );
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Force posts to PayPal to use TLS v1.2. See:
-     * https://core.trac.wordpress.org/ticket/36320
-     * https://core.trac.wordpress.org/ticket/34924#comment:15
-     * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
-     * This will affect paypal standard, pro, express, and payflow.
-     */
-    public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
-    {
-        if (strstr($url, 'https://') && strstr($url, '.paypal.com')) {
-            //Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
-            //instead of the constant because it might not be defined
-            curl_setopt($handle, CURLOPT_SSLVERSION, 1);
-        }
-    }
+	/**
+	 * @var EE_Payment_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Payment_Processor instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if ( ! self::$_instance instanceof EE_Payment_Processor) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Payment_Processor__construct');
+		add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
+	}
+
+
+
+	/**
+	 * Using the selected gateway, processes the payment for that transaction, and updates the transaction
+	 * appropriately. Saves the payment that is generated
+	 *
+	 * @param EE_Payment_Method    $payment_method
+	 * @param EE_Transaction       $transaction
+	 * @param float                $amount       if only part of the transaction is to be paid for, how much.
+	 *                                           Leave null if payment is for the full amount owing
+	 * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
+	 *                                           Receive_form_submission() should have
+	 *                                           already been called on the billing form
+	 *                                           (ie, its inputs should have their normalized values set).
+	 * @param string               $return_url   string used mostly by offsite gateways to specify
+	 *                                           where to go AFTER the offsite gateway
+	 * @param string               $method       like 'CART', indicates who the client who called this was
+	 * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
+	 * @param boolean              $update_txn   whether or not to call
+	 *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param string               $cancel_url   URL to return to if off-site payments are cancelled
+	 * @return \EE_Payment
+	 * @throws \EE_Error
+	 */
+	public function process_payment(
+		EE_Payment_Method $payment_method,
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_form = null,
+		$return_url = null,
+		$method = 'CART',
+		$by_admin = false,
+		$update_txn = true,
+		$cancel_url = ''
+	) {
+		if ((float)$amount < 0) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
+						'event_espresso'
+					),
+					$amount,
+					$transaction->ID()
+				)
+			);
+		}
+		// verify payment method
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
+		// verify transaction
+		EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$transaction->set_payment_method_ID($payment_method->ID());
+		// verify payment method type
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			$payment = $payment_method->type_obj()->process_payment(
+				$transaction,
+				min($amount, $transaction->remaining()),//make sure we don't overcharge
+				$billing_form,
+				$return_url,
+				add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
+				$method,
+				$by_admin
+			);
+			// check if payment method uses an off-site gateway
+			if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
+				// don't process payments for off-site gateways yet because no payment has occurred yet
+				$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			}
+			return $payment;
+		} else {
+			EE_Error::add_error(
+				sprintf(
+					__('A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.', 'event_espresso'),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				), __FILE__, __FUNCTION__, __LINE__
+			);
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment_Method  $payment_method
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function get_ipn_url_for_payment_method($transaction, $payment_method)
+	{
+		/** @type \EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$primary_reg = $transaction->primary_registration();
+		if ( ! $primary_reg instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						"Cannot get IPN URL for transaction with ID %d because it has no primary registration",
+						"event_espresso"
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method, true);
+		$url = add_query_arg(
+			array(
+				'e_reg_url_link'    => $primary_reg->reg_url_link(),
+				'ee_payment_method' => $payment_method->slug(),
+			),
+			EE_Registry::instance()->CFG->core->txn_page_url()
+		);
+		return $url;
+	}
+
+
+
+	/**
+	 * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
+	 * we can easily find what registration the IPN is for and what payment method.
+	 * However, if not, we'll give all payment methods a chance to claim it and process it.
+	 * If a payment is found for the IPN info, it is saved.
+	 *
+	 * @param array              $_req_data            eg $_REQUEST
+	 * @param EE_Transaction|int $transaction          optional (or a transactions id)
+	 * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
+	 * @param boolean            $update_txn           whether or not to call
+	 *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param bool               $separate_IPN_request whether the IPN uses a separate request ( true like PayPal )
+	 *                                                 or is processed manually ( false like Mijireh )
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @return EE_Payment
+	 */
+	public function process_ipn(
+		$_req_data,
+		$transaction = null,
+		$payment_method = null,
+		$update_txn = true,
+		$separate_IPN_request = true
+	) {
+		EE_Registry::instance()->load_model('Change_Log');
+		$_req_data = $this->_remove_unusable_characters_from_array((array)$_req_data);
+		EE_Processor_Base::set_IPN($separate_IPN_request);
+		$obj_for_log = null;
+		if ($transaction instanceof EE_Transaction) {
+			$obj_for_log = $transaction;
+			if ($payment_method instanceof EE_Payment_Method) {
+				$obj_for_log = EEM_Payment::instance()->get_one(
+					array(
+						array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
+						'order_by' => array('PAY_timestamp' => 'desc'),
+					)
+				);
+			}
+		} else if ($payment_method instanceof EE_Payment) {
+			$obj_for_log = $payment_method;
+		}
+		$log = EEM_Change_Log::instance()->log(
+			EEM_Change_Log::type_gateway,
+			array('IPN data received' => $_req_data),
+			$obj_for_log
+		);
+		try {
+			/**
+			 * @var EE_Payment $payment
+			 */
+			$payment = null;
+			if ($transaction && $payment_method) {
+				/** @type EE_Transaction $transaction */
+				$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+				/** @type EE_Payment_Method $payment_method */
+				$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
+				if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+					try {
+						$payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
+						$log->set_object($payment);
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					}
+				} else {
+					// not a payment
+					EE_Error::add_error(
+						sprintf(
+							__('A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.', 'event_espresso'),
+							'<br/>',
+							EE_Registry::instance()->CFG->organization->get_pretty('email')
+						),
+						__FILE__, __FUNCTION__, __LINE__
+					);
+				}
+			} else {
+				//that's actually pretty ok. The IPN just wasn't able
+				//to identify which transaction or payment method this was for
+				// give all active payment methods a chance to claim it
+				$active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
+				foreach ($active_payment_methods as $active_payment_method) {
+					try {
+						$payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
+						$payment_method = $active_payment_method;
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment
+						);
+						break;
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					} catch (EE_Error $e) {
+						//that's fine- it apparently couldn't handle the IPN
+					}
+				}
+			}
+			// 			EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
+			if ($payment instanceof EE_Payment) {
+				$payment->save();
+				//  update the TXN
+				$this->update_txn_based_on_payment($transaction, $payment, $update_txn, $separate_IPN_request);
+			} else {
+				//we couldn't find the payment for this IPN... let's try and log at least SOMETHING
+				if ($payment_method) {
+					EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $payment_method);
+				} elseif ($transaction) {
+					EEM_Change_Log::instance()->log(EEM_Change_Log::type_gateway, array('IPN data' => $_req_data), $transaction);
+				}
+			}
+			return $payment;
+		} catch (EE_Error $e) {
+			do_action(
+				'AHEE__log', __FILE__, __FUNCTION__, sprintf(
+					__('Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"', 'event_espresso'),
+					print_r($transaction, true),
+					print_r($_req_data, true),
+					$e->getMessage()
+				)
+			);
+			throw $e;
+		}
+	}
+
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param  array $request_data
+	 * @return array
+	 */
+	protected function _remove_unusable_characters_from_array(array $request_data)
+	{
+		$return_data = array();
+		foreach ($request_data as $key => $value) {
+			$return_data[$this->_remove_unusable_characters($key)] = $this->_remove_unusable_characters($value);
+		}
+		return $return_data;
+	}
+
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param string $request_data
+	 * @return string
+	 */
+	protected function _remove_unusable_characters($request_data)
+	{
+		return preg_replace('/[^[:print:]]/', '', $request_data);
+	}
+
+
+
+	/**
+	 * Should be called just before displaying the payment attempt results to the user,
+	 * when the payment attempt has finished. Some payment methods may have special
+	 * logic to perform here. For example, if process_payment() happens on a special request
+	 * and then the user is redirected to a page that displays the payment's status, this
+	 * should be called while loading the page that displays the payment's status. If the user is
+	 * sent to an offsite payment provider, this should be called upon returning from that offsite payment
+	 * provider.
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param bool               $update_txn whether or not to call
+	 *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @throws \EE_Error
+	 * @return EE_Payment
+	 * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
+	 *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
+	 */
+	public function finalize_payment_for($transaction, $update_txn = true)
+	{
+		/** @var $transaction EE_Transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$last_payment_method = $transaction->payment_method();
+		if ($last_payment_method instanceof EE_Payment_Method) {
+			$payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
+			$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			return $payment;
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param EE_Payment        $payment_to_refund
+	 * @param array             $refund_info
+	 * @return EE_Payment
+	 * @throws \EE_Error
+	 */
+	public function process_refund(
+		EE_Payment_Method $payment_method,
+		EE_Payment $payment_to_refund,
+		$refund_info = array()
+	) {
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
+			$payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
+			$this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
+		}
+		return $payment_to_refund;
+	}
+
+
+
+	/**
+	 * This should be called each time there may have been an update to a
+	 * payment on a transaction (ie, we asked for a payment to process a
+	 * payment for a transaction, or we told a payment method about an IPN, or
+	 * we told a payment method to
+	 * "finalize_payment_for" (a transaction), or we told a payment method to
+	 * process a refund. This should handle firing the correct hooks to
+	 * indicate
+	 * what exactly happened and updating the transaction appropriately). This
+	 * could be integrated directly into EE_Transaction upon save, but we want
+	 * this logic to be separate from 'normal' plain-jane saving and updating
+	 * of transactions and payments, and to be tied to payment processing.
+	 * Note: this method DOES NOT save the payment passed into it. It is the responsibility
+	 * of previous code to decide whether or not to save (because the payment passed into
+	 * this method might be a temporary, never-to-be-saved payment from an offline gateway,
+	 * in which case we only want that payment object for some temporary usage during this request,
+	 * but we don't want it to be saved).
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment         $payment
+	 * @param boolean            $update_txn
+	 *                        whether or not to call
+	 *                        EE_Transaction_Processor::
+	 *                        update_transaction_and_registrations_after_checkout_or_payment()
+	 *                        (you can save 1 DB query if you know you're going
+	 *                        to save it later instead)
+	 * @param bool               $IPN
+	 *                        if processing IPNs or other similar payment
+	 *                        related activities that occur in alternate
+	 *                        requests than the main one that is processing the
+	 *                        TXN, then set this to true to check whether the
+	 *                        TXN is locked before updating
+	 * @throws \EE_Error
+	 */
+	public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
+	{
+		$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
+		/** @type EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		// can we freely update the TXN at this moment?
+		if ($IPN && $transaction->is_locked()) {
+			// don't update the transaction at this exact moment
+			// because the TXN is active in another request
+			EE_Cron_Tasks::schedule_update_transaction_with_payment(
+				time(),
+				$transaction->ID(),
+				$payment->ID()
+			);
+		} else {
+			// verify payment and that it has been saved
+			if ($payment instanceof EE_Payment && $payment->ID()) {
+				if (
+					$payment->payment_method() instanceof EE_Payment_Method
+					&& $payment->payment_method()->type_obj() instanceof EE_PMT_Base
+				) {
+					$payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
+					// update TXN registrations with payment info
+					$this->process_registration_payments($transaction, $payment);
+				}
+				$do_action = $payment->just_approved()
+					? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
+					: $do_action;
+			} else {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
+			}
+			if ($payment->status() !== EEM_Payment::status_id_failed) {
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				// set new value for total paid
+				$transaction_payments->calculate_total_payments_and_update_status($transaction);
+				// call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
+				if ($update_txn) {
+					$this->_post_payment_processing($transaction, $payment, $IPN);
+				}
+			}
+			// granular hook for others to use.
+			do_action($do_action, $transaction, $payment);
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
+			//global hook for others to use.
+			do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
+		}
+	}
+
+
+
+	/**
+	 * update registrations REG_paid field after successful payment and link registrations with payment
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment        $payment
+	 * @param EE_Registration[] $registrations
+	 * @throws \EE_Error
+	 */
+	public function process_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		$registrations = array()
+	) {
+		// only process if payment was successful
+		if ($payment->status() !== EEM_Payment::status_id_approved) {
+			return;
+		}
+		//EEM_Registration::instance()->show_next_x_db_queries();
+		if (empty($registrations)) {
+			// find registrations with monies owing that can receive a payment
+			$registrations = $transaction->registrations(
+				array(
+					array(
+						// only these reg statuses can receive payments
+						'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
+						'REG_final_price'  => array('!=', 0),
+						'REG_final_price*' => array('!=', 'REG_paid', true),
+					),
+				)
+			);
+		}
+		// still nothing ??!??
+		if (empty($registrations)) {
+			return;
+		}
+		// todo: break out the following logic into a separate strategy class
+		// todo: named something like "Sequential_Reg_Payment_Strategy"
+		// todo: which would apply payments using the capitalist "first come first paid" approach
+		// todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
+		// todo: which would be the socialist "everybody gets a piece of pie" approach,
+		// todo: which would be better for deposits, where you want a bit of the payment applied to each registration
+		$refund = $payment->is_a_refund();
+		// how much is available to apply to registrations?
+		$available_payment_amount = abs($payment->amount());
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				// nothing left?
+				if ($available_payment_amount <= 0) {
+					break;
+				}
+				if ($refund) {
+					$available_payment_amount = $this->process_registration_refund($registration, $payment, $available_payment_amount);
+				} else {
+					$available_payment_amount = $this->process_registration_payment($registration, $payment, $available_payment_amount);
+				}
+			}
+		}
+		if ($available_payment_amount > 0 && apply_filters('FHEE__EE_Payment_Processor__process_registration_payments__display_notifications', false)) {
+			EE_Error::add_attention(
+				sprintf(
+					__('A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
+						'event_espresso'),
+					EEH_Template::format_currency($available_payment_amount),
+					implode(', ', array_keys($registrations)),
+					'<br/>',
+					EEH_Template::format_currency($payment->amount())
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+	}
+
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_payment_amount
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function process_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_payment_amount = 0.00
+	) {
+		$owing = $registration->final_price() - $registration->paid();
+		if ($owing > 0) {
+			// don't allow payment amount to exceed the available payment amount, OR the amount owing
+			$payment_amount = min($available_payment_amount, $owing);
+			// update $available_payment_amount
+			$available_payment_amount -= $payment_amount;
+			//calculate and set new REG_paid
+			$registration->set_paid($registration->paid() + $payment_amount);
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $payment_amount);
+		}
+		return $available_payment_amount;
+	}
+
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $payment_amount
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	protected function _apply_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$payment_amount = 0.00
+	) {
+		// find any existing reg payment records for this registration and payment
+		$existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
+			array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
+		);
+		// if existing registration payment exists
+		if ($existing_reg_payment instanceof EE_Registration_Payment) {
+			// then update that record
+			$existing_reg_payment->set_amount($payment_amount);
+			$existing_reg_payment->save();
+		} else {
+			// or add new relation between registration and payment and set amount
+			$registration->_add_relation_to($payment, 'Payment', array('RPY_amount' => $payment_amount));
+			// make it stick
+			$registration->save();
+		}
+	}
+
+
+
+	/**
+	 * update registration REG_paid field after refund and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
+	 * @return float
+	 * @throws \EE_Error
+	 */
+	public function process_registration_refund(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_refund_amount = 0.00
+	) {
+		//EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
+		if ($registration->paid() > 0) {
+			// ensure $available_refund_amount is NOT negative
+			$available_refund_amount = (float)abs($available_refund_amount);
+			// don't allow refund amount to exceed the available payment amount, OR the amount paid
+			$refund_amount = min($available_refund_amount, (float)$registration->paid());
+			// update $available_payment_amount
+			$available_refund_amount -= $refund_amount;
+			//calculate and set new REG_paid
+			$registration->set_paid($registration->paid() - $refund_amount);
+			// convert payment amount back to a negative value for storage in the db
+			$refund_amount = (float)abs($refund_amount) * -1;
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $refund_amount);
+		}
+		return $available_refund_amount;
+	}
+
+
+
+	/**
+	 * Process payments and transaction after payment process completed.
+	 * ultimately this will send the TXN and payment details off so that notifications can be sent out.
+	 * if this request happens to be processing an IPN,
+	 * then we will also set the Payment Options Reg Step to completed,
+	 * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $IPN
+	 * @throws \EE_Error
+	 */
+	protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
+	{
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// is the Payment Options Reg Step completed ?
+		$payment_options_step_completed = $transaction->reg_step_completed('payment_options');
+		// if the Payment Options Reg Step is completed...
+		$revisit = $payment_options_step_completed === true ? true : false;
+		// then this is kinda sorta a revisit with regards to payments at least
+		$transaction_processor->set_revisit($revisit);
+		// if this is an IPN, let's consider the Payment Options Reg Step completed if not already
+		if (
+			$IPN
+			&& $payment_options_step_completed !== true
+			&& ($payment->is_approved() || $payment->is_pending())
+		) {
+			$payment_options_step_completed = $transaction->set_reg_step_completed(
+				'payment_options'
+			);
+		}
+		// maybe update status, but don't save transaction just yet
+		$transaction->update_status_based_on_total_paid(false);
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		//  if this is an IPN and the final step has not been initiated
+		if ($IPN && $payment_options_step_completed && $finalized === false) {
+			// and if it hasn't already been set as being started...
+			$finalized = $transaction->set_reg_step_initiated('finalize_registration');
+		}
+		$transaction->save();
+		// because the above will return false if the final step was not fully completed, we need to check again...
+		if ($IPN && $finalized !== false) {
+			// and if we are all good to go, then send out notifications
+			add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			//ok, now process the transaction according to the payment
+			$transaction_processor->update_transaction_and_registrations_after_checkout_or_payment($transaction, $payment);
+		}
+		// DEBUG LOG
+		$payment_method = $payment->payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$payment_method_type_obj = $payment_method->type_obj();
+			if ($payment_method_type_obj instanceof EE_PMT_Base) {
+				$gateway = $payment_method_type_obj->get_gateway();
+				if ($gateway instanceof EE_Gateway) {
+					$gateway->log(
+						array(
+							'message'               => __('Post Payment Transaction Details', 'event_espresso'),
+							'transaction'           => $transaction->model_field_array(),
+							'finalized'             => $finalized,
+							'IPN'                   => $IPN,
+							'deliver_notifications' => has_filter(
+								'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+							),
+						),
+						$payment
+					);
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Force posts to PayPal to use TLS v1.2. See:
+	 * https://core.trac.wordpress.org/ticket/36320
+	 * https://core.trac.wordpress.org/ticket/34924#comment:15
+	 * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
+	 * This will affect paypal standard, pro, express, and payflow.
+	 */
+	public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
+	{
+		if (strstr($url, 'https://') && strstr($url, '.paypal.com')) {
+			//Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
+			//instead of the constant because it might not be defined
+			curl_setopt($handle, CURLOPT_SSLVERSION, 1);
+		}
+	}
 }

core/db_models/EEM_Registration.model.php

Indentation +749 added lines, -749 removed lines

@@ -2,7 +2,7 @@ 
 use EventEspresso\core\services\database\TableAnalysis;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -17,737 +17,737 @@ 
 class EEM_Registration extends EEM_Soft_Delete_Base
 {
 
-    // private instance of the Registration object
-    protected static $_instance = null;
-
-    /**
-     * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
-     * are status codes (eg, approved, cancelled, etc)
-     *
-     * @var array
-     */
-    private static $_reg_status;
-
-    /**
-     * The value of REG_count for a primary registrant
-     */
-    const PRIMARY_REGISTRANT_COUNT = 1;
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
-     * Initial status for registrations when they are first created
-     * Payments are NOT allowed.
-     * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
-     * information reg step NO space reserved. Registration is NOT active
-     */
-    const status_id_incomplete = 'RIC';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
-     * Payments are NOT allowed.
-     * Event Admin must manually toggle STS_ID for it to change
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_not_approved = 'RNA';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
-     * Payments are allowed.
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_pending_payment = 'RPP';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
-     * Payments are allowed.
-     * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
-     * No space reserved.
-     * Registration is active
-     */
-    const status_id_wait_list = 'RWL';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
-     * the TXN may or may not be completed ( paid in full )
-     * Payments are allowed.
-     * A space IS reserved.
-     * Registration is active
-     */
-    const status_id_approved = 'RAP';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
-     * Payments are NOT allowed.
-     * NO space reserved.
-     * Registration is NOT active
-     */
-    const status_id_cancelled = 'RCN';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
-     * Payments are NOT allowed.
-     * No space reserved.
-     * Registration is NOT active
-     */
-    const status_id_declined = 'RDC';
-
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-
-    /**
-     *    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)
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
-        $this->singular_item = __('Registration', 'event_espresso');
-        $this->plural_item = __('Registrations', 'event_espresso');
-        $this->_tables = array(
-            'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
-        );
-        $this->_fields = array(
-            'Registration' => array(
-                'REG_ID'           => new EE_Primary_Key_Int_Field('REG_ID', __('Registration ID', 'event_espresso')),
-                'EVT_ID'           => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID', __('Event ID', 'event_espresso'), false, 0, 'Event'
-                ),
-                'ATT_ID'           => new EE_Foreign_Key_Int_Field(
-                    'ATT_ID', __('Attendee ID', 'event_espresso'), false, 0, 'Attendee'
-                ),
-                'TXN_ID'           => new EE_Foreign_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso'),
-                    false, 0, 'Transaction'
-                ),
-                'TKT_ID'           => new EE_Foreign_Key_Int_Field('TKT_ID', __('Ticket ID', 'event_espresso'), false,
-                    0, 'Ticket'
-                ),
-                'STS_ID'           => new EE_Foreign_Key_String_Field('STS_ID', __('Status ID', 'event_espresso'),
-                    false, EEM_Registration::status_id_incomplete, 'Status'
-                ),
-                'REG_date'         => new EE_Datetime_Field('REG_date',
-                    __('Time registration occurred', 'event_espresso'), false, EE_Datetime_Field::now, $timezone
-                ),
-                'REG_final_price'  => new EE_Money_Field('REG_final_price',
-                    __('Registration\'s share of the transaction total', 'event_espresso'), false, 0
-                ),
-                'REG_paid'         => new EE_Money_Field('REG_paid',
-                    __('Amount paid to date towards registration', 'event_espresso'), false, 0
-                ),
-                'REG_session'      => new EE_Plain_Text_Field('REG_session',
-                    __('Session ID of registration', 'event_espresso'), false, ''
-                ),
-                'REG_code'         => new EE_Plain_Text_Field('REG_code',
-                    __('Unique Code for this registration', 'event_espresso'), false, ''
-                ),
-                'REG_url_link'     => new EE_Plain_Text_Field('REG_url_link',
-                    __('String to be used in URL for identifying registration', 'event_espresso'), false, ''
-                ),
-                'REG_count'        => new EE_Integer_Field('REG_count',
-                    __('Count of this registration in the group registration ', 'event_espresso'), true, 1
-                ),
-                'REG_group_size'   => new EE_Integer_Field('REG_group_size',
-                    __('Number of registrations on this group', 'event_espresso'), false, 1
-                ),
-                'REG_att_is_going' => new EE_Boolean_Field('REG_att_is_going',
-                    __('Flag indicating the registrant plans on attending', 'event_espresso'), false, false
-                ),
-                'REG_deleted'      => new EE_Trashed_Flag_Field(
-                    'REG_deleted', __('Flag indicating if registration has been archived or not.', 'event_espresso'),
-                    false, false
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Event'                => new EE_Belongs_To_Relation(),
-            'Attendee'             => new EE_Belongs_To_Relation(),
-            'Transaction'          => new EE_Belongs_To_Relation(),
-            'Ticket'               => new EE_Belongs_To_Relation(),
-            'Status'               => new EE_Belongs_To_Relation(),
-            'Answer'               => new EE_Has_Many_Relation(),
-            'Checkin'              => new EE_Has_Many_Relation(),
-            'Registration_Payment' => new EE_Has_Many_Relation(),
-            'Payment'              => new EE_HABTM_Relation('Registration_Payment'),
-            'Message'              => new EE_Has_Many_Any_Relation(false)
-            //allow deletes even if there are messages in the queue related
-        );
-        $this->_model_chain_to_wp_user = 'Event';
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * reg_statuses_that_allow_payment
-     * a filterable list of registration statuses that allow a registrant to make a payment
-     *
-     * @access public
-     * @return array
-     */
-    public static function reg_statuses_that_allow_payment()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
-            array(
-                EEM_Registration::status_id_approved,
-                EEM_Registration::status_id_pending_payment,
-                EEM_Registration::status_id_wait_list,
-            )
-        );
-    }
-
-
-
-    /**
-     * inactive_reg_statuses
-     * a filterable list of registration statuses that are considered active
-     *
-     * @access public
-     * @return array
-     */
-    public static function active_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
-            array(
-                EEM_Registration::status_id_approved,
-                EEM_Registration::status_id_pending_payment,
-                EEM_Registration::status_id_wait_list,
-                EEM_Registration::status_id_not_approved,
-            )
-        );
-    }
-
-
-
-    /**
-     * inactive_reg_statuses
-     * a filterable list of registration statuses that are not considered active
-     *
-     * @access public
-     * @return array
-     */
-    public static function inactive_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
-            array(
-                EEM_Registration::status_id_incomplete,
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-            )
-        );
-    }
-
-
-
-    /**
-     *    closed_reg_statuses
-     *    a filterable list of registration statuses that are considered "closed"
-     * meaning they should not be considered in any calculations involving monies owing
-     *
-     * @access public
-     * @return array
-     */
-    public static function closed_reg_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Registration__closed_reg_statuses',
-            array(
-                EEM_Registration::status_id_cancelled,
-                EEM_Registration::status_id_declined,
-            )
-        );
-    }
-
-
-
-    /**
-     *        get list of registration statuses
-     *
-     * @access public
-     * @param array $exclude    The status ids to exclude from the returned results
-     * @param bool  $translated If true will return the values as singular localized strings
-     * @return array
-     */
-    public static function reg_status_array($exclude = array(), $translated = false)
-    {
-        EEM_Registration::instance()->_get_registration_status_array($exclude);
-        return $translated ? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
-            : self::$_reg_status;
-    }
-
-
-
-    /**
-     *    get list of registration statuses
-     *
-     * @access private
-     * @param array $exclude
-     * @return array
-     */
-    private function _get_registration_status_array($exclude = array())
-    {
-        //in the very rare circumstance that we are deleting a model's table's data
-        //and the table hasn't actually been created, this could have an error
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
-            $results = $wpdb->get_results(
-                "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
-            );
-            self::$_reg_status = array();
-            foreach ($results as $status) {
-                if ( ! in_array($status->STS_ID, $exclude)) {
-                    self::$_reg_status[$status->STS_ID] = $status->STS_code;
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws \EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * This returns a wpdb->results array of all registration date month and years matching the incoming query params
-     * and grouped by month and year.
-     *
-     * @param  array $where_params Array of query_params as described in the comments for EEM_Base::get_all()
-     * @return array
-     * @throws \EE_Error
-     */
-    public function get_reg_months_and_years($where_params)
-    {
-        $query_params[0] = $where_params;
-        $query_params['group_by'] = array('reg_year', 'reg_month');
-        $query_params['order_by'] = array('REG_date' => 'DESC');
-        $columns_to_select = array(
-            'reg_year'  => array('YEAR(REG_date)', '%s'),
-            'reg_month' => array('MONTHNAME(REG_date)', '%s'),
-        );
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-
-    /**
-     *        retrieve ALL registrations for a particular Attendee from db
-     *
-     * @access        public
-     * @param        int $ATT_ID
-     * @return    EE_Registration[]
-     */
-    public function get_all_registrations_for_attendee($ATT_ID = 0)
-    {
-        if ( ! $ATT_ID) {
-            return false;
-        }
-        return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
-    }
-
-
-
-    /**
-     * Gets a registration given their REG_url_link. Yes, this should usually
-     * be passed via a GET parameter.
-     *
-     * @param string $REG_url_link
-     * @return EE_Registration
-     */
-    public function get_registration_for_reg_url_link($REG_url_link)
-    {
-        if ( ! $REG_url_link) {
-            return false;
-        }
-        return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
-    }
-
-
-
-    /**
-     *        retrieve registration for a specific transaction attendee from db
-     *
-     * @access        public
-     * @param    int $TXN_ID
-     * @param    int $ATT_ID
-     * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
-     *                         attendee number is required
-     * @return        mixed        array on success, FALSE on fail
-     */
-    public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
-    {
-        return $this->get_one(array(
-            array(
-                'TXN_ID' => $TXN_ID,
-                'ATT_ID' => $ATT_ID,
-            ),
-            'limit' => array(min(($att_nmbr - 1), 0), 1),
-        ));
-    }
-
-
-
-    /**
-     *        get the number of registrations per day  for the Registration Admin page Reports Tab.
-     *        (doesn't utilize models because it's a fairly specialized query)
-     *
-     * @access        public
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
-     * @return stdClass[] with properties regDate and total
-     */
-    public function get_registrations_per_day_report($period = '-1 month')
-    {
-        $sql_date = $this->convert_datetime_for_query('REG_date', date("Y-m-d H:i:s", strtotime($period)),
-            'Y-m-d H:i:s', 'UTC');
-        $where = array(
-            'REG_date' => array('>=', $sql_date),
-            'STS_ID'   => array('!=', EEM_Registration::status_id_incomplete),
-        );
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
-            $where['Event.EVT_wp_user'] = get_current_user_id();
-        }
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
-        $results = $this->_get_all_wpdb_results(
-            array(
-                $where,
-                'group_by' => 'regDate',
-                'order_by' => array('REG_date' => 'ASC'),
-            ),
-            OBJECT,
-            array(
-                'regDate' => array('DATE(' . $query_interval . ')', '%s'),
-                'total'   => array('count(REG_ID)', '%d'),
-            ));
-        return $results;
-    }
-
-
-
-    /**
-     * Get the number of registrations per day including the count of registrations for each Registration Status.
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
-     *
-     * @param string $period
-     * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
-     *                    (i.e. RAP)
-     */
-    public function get_registrations_per_day_and_per_status_report($period = '-1 month')
-    {
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $event_table = $wpdb->posts;
-        $sql_date = date("Y-m-d H:i:s", strtotime($period));
-        //prepare the query interval for displaying offset
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
-        //inner date query
-        $inner_date_query = "SELECT DISTINCT REG_date from $registration_table ";
-        $inner_where = " WHERE";
-        //exclude events not authored by user if permissions in effect
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
-            $inner_where .= " post_author = " . get_current_user_id() . " AND";
-        }
-        $inner_where .= " REG_date >= '$sql_date'";
-        $inner_date_query .= $inner_where;
-        //start main query
-        $select = "SELECT DATE($query_interval) as Registration_REG_date, ";
-        $join = '';
-        $join_parts = array();
-        $select_parts = array();
-        //loop through registration stati to do parts for each status.
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
-                continue;
-            }
-            $select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
-            $join_parts[] = "$registration_table AS $STS_code ON $STS_code.REG_date = dates.REG_date AND $STS_code.STS_ID = '$STS_ID'";
-        }
-        //setup the selects
-        $select .= implode(', ', $select_parts);
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
-        //setup the joins
-        $join .= implode(" LEFT JOIN ", $join_parts);
-        //now let's put it all together
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
-        //and execute it
-        $results = $wpdb->get_results($query, ARRAY_A);
-        return $results;
-    }
-
-
-
-    /**
-     *        get the number of registrations per event  for the Registration Admin page Reports Tab
-     *
-     * @access        public
-     * @param $period string which can be passed to php's strtotime function (eg "-1 month")
-     * @return stdClass[] each with properties event_name, reg_limit, and total
-     */
-    public function get_registrations_per_event_report($period = '-1 month')
-    {
-        $date_sql = $this->convert_datetime_for_query('REG_date', date("Y-m-d H:i:s", strtotime($period)),
-            'Y-m-d H:i:s', 'UTC');
-        $where = array(
-            'REG_date' => array('>=', $date_sql),
-            'STS_ID'   => array('!=', EEM_Registration::status_id_incomplete),
-        );
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $where['Event.EVT_wp_user'] = get_current_user_id();
-        }
-        $results = $this->_get_all_wpdb_results(array(
-            $where,
-            'group_by' => 'Event.EVT_name',
-            'order_by' => 'Event.EVT_name',
-            'limit'    => array(0, 24),
-        ),
-            OBJECT,
-            array(
-                'event_name' => array('Event_CPT.post_title', '%s'),
-                'total'      => array('COUNT(REG_ID)', '%s'),
-            )
-        );
-        return $results;
-    }
-
-
-
-    /**
-     * Get the number of registrations per event grouped by registration status.
-     * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
-     *
-     * @param string $period
-     * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
-     *                    (i.e. RAP)
-     */
-    public function get_registrations_per_event_and_per_status_report($period = '-1 month')
-    {
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $event_table = $wpdb->posts;
-        $sql_date = date("Y-m-d H:i:s", strtotime($period));
-        //inner date query
-        $inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
-        $inner_where = " WHERE";
-        //exclude events not authored by user if permissions in effect
-        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
-            $inner_where .= " post_author = " . get_current_user_id() . " AND";
-        }
-        $inner_where .= " REG_date >= '$sql_date'";
-        $inner_date_query .= $inner_where;
-        //build main query
-        $select = "SELECT Event.post_title as Registration_Event, ";
-        $join = '';
-        $join_parts = array();
-        $select_parts = array();
-        //loop through registration stati to do parts for each status.
-        foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
-            if ($STS_ID === EEM_Registration::status_id_incomplete) {
-                continue;
-            }
-            $select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
-            $join_parts[] = "$registration_table AS $STS_code ON $STS_code.EVT_ID = dates.EVT_ID AND $STS_code.STS_ID = '$STS_ID' AND $STS_code.REG_date = dates.REG_date";
-        }
-        //setup the selects
-        $select .= implode(', ', $select_parts);
-        $select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
-        //setup remaining joins
-        $join .= implode(" LEFT JOIN ", $join_parts);
-        //now put it all together
-        $query = $select . $join . ' GROUP BY Registration_Event';
-        //and execute
-        $results = $wpdb->get_results($query, ARRAY_A);
-        return $results;
-    }
-
-
-
-    /**
-     * Returns the EE_Registration of the primary attendee on the transaction id provided
-     *
-     * @param int $TXN_ID
-     * @return EE_Registration
-     */
-    public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
-    {
-        if ( ! $TXN_ID) {
-            return false;
-        }
-        return $this->get_one(array(
-            array(
-                'TXN_ID'    => $TXN_ID,
-                'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
-            ),
-        ));
-    }
-
-
-
-    /**
-     *        get_event_registration_count
-     *
-     * @access public
-     * @param int     $EVT_ID
-     * @param boolean $for_incomplete_payments
-     * @return int
-     */
-    public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false)
-    {
-        // we only count approved registrations towards registration limits
-        $query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved));
-        if ($for_incomplete_payments) {
-            $query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code);
-        }
-        return $this->count($query_params);
-    }
-
-
-
-    /**
-     * Deletes all registrations with no transactions. Note that this needs to be very efficient
-     * and so it uses wpdb directly
-     *
-     * @global WPDB $wpdb
-     * @return int number deleted
-     */
-    public function delete_registrations_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        return $wpdb->query(
-            'DELETE r FROM '
-            . $this->table()
-            . ' r LEFT JOIN '
-            . EEM_Transaction::instance()->table()
-            . ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL');
-    }
-
-
-
-    /**
-     *  Count registrations checked into (or out of) a datetime
-     *
-     * @param int     $DTT_ID     datetime ID
-     * @param boolean $checked_in whether to count registrations checked IN or OUT
-     * @return int
-     */
-    public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true)
-    {
-        global $wpdb;
-        //subquery to get latest checkin
-        $query = $wpdb->prepare(
-            'SELECT '
-            . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
-            . '( SELECT '
-            . 'max( CHK_timestamp ) AS latest_checkin, '
-            . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' '
-            . 'WHERE DTT_ID=%d '
-            . 'GROUP BY REG_ID'
-            . ') AS most_recent_checkin_per_reg '
-            . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
-            . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
-            . 'WHERE '
-            . 'checkins.CHK_in=%d',
-            $DTT_ID,
-            $checked_in
-        );
-        return (int)$wpdb->get_var($query);
-    }
-
-
-
-    /**
-     *  Count registrations checked into (or out of) an event.
-     *
-     * @param int     $EVT_ID     event ID
-     * @param boolean $checked_in whether to count registrations checked IN or OUT
-     * @return int
-     */
-    public function count_registrations_checked_into_event($EVT_ID, $checked_in = true)
-    {
-        global $wpdb;
-        //subquery to get latest checkin
-        $query = $wpdb->prepare(
-            'SELECT '
-            . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
-            . '( SELECT '
-            . 'max( CHK_timestamp ) AS latest_checkin, '
-            . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
-            . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
-            . 'ON c.DTT_ID=d.DTT_ID '
-            . 'WHERE d.EVT_ID=%d '
-            . 'GROUP BY REG_ID'
-            . ') AS most_recent_checkin_per_reg '
-            . 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
-            . 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
-            . 'WHERE '
-            . 'checkins.CHK_in=%d',
-            $EVT_ID,
-            $checked_in
-        );
-        return (int)$wpdb->get_var($query);
-    }
-
-
-
-    /**
-     * The purpose of this method is to retrieve an array of
-     * EE_Registration objects that represent the latest registration
-     * for each ATT_ID given in the function argument.
-     *
-     * @param array $attendee_ids
-     * @return EE_Registration[]
-     */
-    public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array())
-    {
-        //first do a native wp_query to get the latest REG_ID's matching these attendees.
-        global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
-        $attendee_table = $wpdb->posts;
-        $attendee_ids = is_array($attendee_ids)
-            ? array_map('absint', $attendee_ids)
-            : array((int)$attendee_ids);
-        $attendee_ids = implode(',', $attendee_ids);
-        //first we do a query to get the registration ids
-        // (because a group by before order by causes the order by to be ignored.)
-        $registration_id_query = "
+	// private instance of the Registration object
+	protected static $_instance = null;
+
+	/**
+	 * Keys are the status IDs for registrations (eg, RAP, RCN, etc), and the values
+	 * are status codes (eg, approved, cancelled, etc)
+	 *
+	 * @var array
+	 */
+	private static $_reg_status;
+
+	/**
+	 * The value of REG_count for a primary registrant
+	 */
+	const PRIMARY_REGISTRANT_COUNT = 1;
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an INCOMPLETE registration.
+	 * Initial status for registrations when they are first created
+	 * Payments are NOT allowed.
+	 * Automatically toggled to whatever the default Event registration status is upon completion of the attendee
+	 * information reg step NO space reserved. Registration is NOT active
+	 */
+	const status_id_incomplete = 'RIC';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an UNAPPROVED registration.
+	 * Payments are NOT allowed.
+	 * Event Admin must manually toggle STS_ID for it to change
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_not_approved = 'RNA';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate registration is PENDING_PAYMENT .
+	 * Payments are allowed.
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_pending_payment = 'RPP';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate registration is on the WAIT_LIST .
+	 * Payments are allowed.
+	 * STS_ID will automatically be toggled to RAP if payment is made in full by the attendee
+	 * No space reserved.
+	 * Registration is active
+	 */
+	const status_id_wait_list = 'RWL';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate an APPROVED registration.
+	 * the TXN may or may not be completed ( paid in full )
+	 * Payments are allowed.
+	 * A space IS reserved.
+	 * Registration is active
+	 */
+	const status_id_approved = 'RAP';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was CANCELLED by the attendee.
+	 * Payments are NOT allowed.
+	 * NO space reserved.
+	 * Registration is NOT active
+	 */
+	const status_id_cancelled = 'RCN';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a registration was DECLINED by the Event Admin
+	 * Payments are NOT allowed.
+	 * No space reserved.
+	 * Registration is NOT active
+	 */
+	const status_id_declined = 'RDC';
+
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+
+	/**
+	 *    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)
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->_table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
+		$this->singular_item = __('Registration', 'event_espresso');
+		$this->plural_item = __('Registrations', 'event_espresso');
+		$this->_tables = array(
+			'Registration' => new EE_Primary_Table('esp_registration', 'REG_ID'),
+		);
+		$this->_fields = array(
+			'Registration' => array(
+				'REG_ID'           => new EE_Primary_Key_Int_Field('REG_ID', __('Registration ID', 'event_espresso')),
+				'EVT_ID'           => new EE_Foreign_Key_Int_Field(
+					'EVT_ID', __('Event ID', 'event_espresso'), false, 0, 'Event'
+				),
+				'ATT_ID'           => new EE_Foreign_Key_Int_Field(
+					'ATT_ID', __('Attendee ID', 'event_espresso'), false, 0, 'Attendee'
+				),
+				'TXN_ID'           => new EE_Foreign_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso'),
+					false, 0, 'Transaction'
+				),
+				'TKT_ID'           => new EE_Foreign_Key_Int_Field('TKT_ID', __('Ticket ID', 'event_espresso'), false,
+					0, 'Ticket'
+				),
+				'STS_ID'           => new EE_Foreign_Key_String_Field('STS_ID', __('Status ID', 'event_espresso'),
+					false, EEM_Registration::status_id_incomplete, 'Status'
+				),
+				'REG_date'         => new EE_Datetime_Field('REG_date',
+					__('Time registration occurred', 'event_espresso'), false, EE_Datetime_Field::now, $timezone
+				),
+				'REG_final_price'  => new EE_Money_Field('REG_final_price',
+					__('Registration\'s share of the transaction total', 'event_espresso'), false, 0
+				),
+				'REG_paid'         => new EE_Money_Field('REG_paid',
+					__('Amount paid to date towards registration', 'event_espresso'), false, 0
+				),
+				'REG_session'      => new EE_Plain_Text_Field('REG_session',
+					__('Session ID of registration', 'event_espresso'), false, ''
+				),
+				'REG_code'         => new EE_Plain_Text_Field('REG_code',
+					__('Unique Code for this registration', 'event_espresso'), false, ''
+				),
+				'REG_url_link'     => new EE_Plain_Text_Field('REG_url_link',
+					__('String to be used in URL for identifying registration', 'event_espresso'), false, ''
+				),
+				'REG_count'        => new EE_Integer_Field('REG_count',
+					__('Count of this registration in the group registration ', 'event_espresso'), true, 1
+				),
+				'REG_group_size'   => new EE_Integer_Field('REG_group_size',
+					__('Number of registrations on this group', 'event_espresso'), false, 1
+				),
+				'REG_att_is_going' => new EE_Boolean_Field('REG_att_is_going',
+					__('Flag indicating the registrant plans on attending', 'event_espresso'), false, false
+				),
+				'REG_deleted'      => new EE_Trashed_Flag_Field(
+					'REG_deleted', __('Flag indicating if registration has been archived or not.', 'event_espresso'),
+					false, false
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Event'                => new EE_Belongs_To_Relation(),
+			'Attendee'             => new EE_Belongs_To_Relation(),
+			'Transaction'          => new EE_Belongs_To_Relation(),
+			'Ticket'               => new EE_Belongs_To_Relation(),
+			'Status'               => new EE_Belongs_To_Relation(),
+			'Answer'               => new EE_Has_Many_Relation(),
+			'Checkin'              => new EE_Has_Many_Relation(),
+			'Registration_Payment' => new EE_Has_Many_Relation(),
+			'Payment'              => new EE_HABTM_Relation('Registration_Payment'),
+			'Message'              => new EE_Has_Many_Any_Relation(false)
+			//allow deletes even if there are messages in the queue related
+		);
+		$this->_model_chain_to_wp_user = 'Event';
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * reg_statuses_that_allow_payment
+	 * a filterable list of registration statuses that allow a registrant to make a payment
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function reg_statuses_that_allow_payment()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
+			array(
+				EEM_Registration::status_id_approved,
+				EEM_Registration::status_id_pending_payment,
+				EEM_Registration::status_id_wait_list,
+			)
+		);
+	}
+
+
+
+	/**
+	 * inactive_reg_statuses
+	 * a filterable list of registration statuses that are considered active
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function active_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
+			array(
+				EEM_Registration::status_id_approved,
+				EEM_Registration::status_id_pending_payment,
+				EEM_Registration::status_id_wait_list,
+				EEM_Registration::status_id_not_approved,
+			)
+		);
+	}
+
+
+
+	/**
+	 * inactive_reg_statuses
+	 * a filterable list of registration statuses that are not considered active
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function inactive_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__reg_statuses_that_allow_payment',
+			array(
+				EEM_Registration::status_id_incomplete,
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+			)
+		);
+	}
+
+
+
+	/**
+	 *    closed_reg_statuses
+	 *    a filterable list of registration statuses that are considered "closed"
+	 * meaning they should not be considered in any calculations involving monies owing
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function closed_reg_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Registration__closed_reg_statuses',
+			array(
+				EEM_Registration::status_id_cancelled,
+				EEM_Registration::status_id_declined,
+			)
+		);
+	}
+
+
+
+	/**
+	 *        get list of registration statuses
+	 *
+	 * @access public
+	 * @param array $exclude    The status ids to exclude from the returned results
+	 * @param bool  $translated If true will return the values as singular localized strings
+	 * @return array
+	 */
+	public static function reg_status_array($exclude = array(), $translated = false)
+	{
+		EEM_Registration::instance()->_get_registration_status_array($exclude);
+		return $translated ? EEM_Status::instance()->localized_status(self::$_reg_status, false, 'sentence')
+			: self::$_reg_status;
+	}
+
+
+
+	/**
+	 *    get list of registration statuses
+	 *
+	 * @access private
+	 * @param array $exclude
+	 * @return array
+	 */
+	private function _get_registration_status_array($exclude = array())
+	{
+		//in the very rare circumstance that we are deleting a model's table's data
+		//and the table hasn't actually been created, this could have an error
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+			$results = $wpdb->get_results(
+				"SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
+			);
+			self::$_reg_status = array();
+			foreach ($results as $status) {
+				if ( ! in_array($status->STS_ID, $exclude)) {
+					self::$_reg_status[$status->STS_ID] = $status->STS_code;
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * This returns a wpdb->results array of all registration date month and years matching the incoming query params
+	 * and grouped by month and year.
+	 *
+	 * @param  array $where_params Array of query_params as described in the comments for EEM_Base::get_all()
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function get_reg_months_and_years($where_params)
+	{
+		$query_params[0] = $where_params;
+		$query_params['group_by'] = array('reg_year', 'reg_month');
+		$query_params['order_by'] = array('REG_date' => 'DESC');
+		$columns_to_select = array(
+			'reg_year'  => array('YEAR(REG_date)', '%s'),
+			'reg_month' => array('MONTHNAME(REG_date)', '%s'),
+		);
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+
+	/**
+	 *        retrieve ALL registrations for a particular Attendee from db
+	 *
+	 * @access        public
+	 * @param        int $ATT_ID
+	 * @return    EE_Registration[]
+	 */
+	public function get_all_registrations_for_attendee($ATT_ID = 0)
+	{
+		if ( ! $ATT_ID) {
+			return false;
+		}
+		return $this->get_all(array(array('ATT_ID' => $ATT_ID)));
+	}
+
+
+
+	/**
+	 * Gets a registration given their REG_url_link. Yes, this should usually
+	 * be passed via a GET parameter.
+	 *
+	 * @param string $REG_url_link
+	 * @return EE_Registration
+	 */
+	public function get_registration_for_reg_url_link($REG_url_link)
+	{
+		if ( ! $REG_url_link) {
+			return false;
+		}
+		return $this->get_one(array(array('REG_url_link' => $REG_url_link)));
+	}
+
+
+
+	/**
+	 *        retrieve registration for a specific transaction attendee from db
+	 *
+	 * @access        public
+	 * @param    int $TXN_ID
+	 * @param    int $ATT_ID
+	 * @param    int $att_nmbr in case the ATT_ID is the same for multiple registrations (same details used) then the
+	 *                         attendee number is required
+	 * @return        mixed        array on success, FALSE on fail
+	 */
+	public function get_registration_for_transaction_attendee($TXN_ID = 0, $ATT_ID = 0, $att_nmbr = 0)
+	{
+		return $this->get_one(array(
+			array(
+				'TXN_ID' => $TXN_ID,
+				'ATT_ID' => $ATT_ID,
+			),
+			'limit' => array(min(($att_nmbr - 1), 0), 1),
+		));
+	}
+
+
+
+	/**
+	 *        get the number of registrations per day  for the Registration Admin page Reports Tab.
+	 *        (doesn't utilize models because it's a fairly specialized query)
+	 *
+	 * @access        public
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
+	 * @return stdClass[] with properties regDate and total
+	 */
+	public function get_registrations_per_day_report($period = '-1 month')
+	{
+		$sql_date = $this->convert_datetime_for_query('REG_date', date("Y-m-d H:i:s", strtotime($period)),
+			'Y-m-d H:i:s', 'UTC');
+		$where = array(
+			'REG_date' => array('>=', $sql_date),
+			'STS_ID'   => array('!=', EEM_Registration::status_id_incomplete),
+		);
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_day_report')) {
+			$where['Event.EVT_wp_user'] = get_current_user_id();
+		}
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'REG_date');
+		$results = $this->_get_all_wpdb_results(
+			array(
+				$where,
+				'group_by' => 'regDate',
+				'order_by' => array('REG_date' => 'ASC'),
+			),
+			OBJECT,
+			array(
+				'regDate' => array('DATE(' . $query_interval . ')', '%s'),
+				'total'   => array('count(REG_ID)', '%d'),
+			));
+		return $results;
+	}
+
+
+
+	/**
+	 * Get the number of registrations per day including the count of registrations for each Registration Status.
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
+	 *
+	 * @param string $period
+	 * @return stdClass[] with properties Registration_REG_date and a column for each registration status as the STS_ID
+	 *                    (i.e. RAP)
+	 */
+	public function get_registrations_per_day_and_per_status_report($period = '-1 month')
+	{
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$event_table = $wpdb->posts;
+		$sql_date = date("Y-m-d H:i:s", strtotime($period));
+		//prepare the query interval for displaying offset
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'dates.REG_date');
+		//inner date query
+		$inner_date_query = "SELECT DISTINCT REG_date from $registration_table ";
+		$inner_where = " WHERE";
+		//exclude events not authored by user if permissions in effect
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
+			$inner_where .= " post_author = " . get_current_user_id() . " AND";
+		}
+		$inner_where .= " REG_date >= '$sql_date'";
+		$inner_date_query .= $inner_where;
+		//start main query
+		$select = "SELECT DATE($query_interval) as Registration_REG_date, ";
+		$join = '';
+		$join_parts = array();
+		$select_parts = array();
+		//loop through registration stati to do parts for each status.
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
+				continue;
+			}
+			$select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
+			$join_parts[] = "$registration_table AS $STS_code ON $STS_code.REG_date = dates.REG_date AND $STS_code.STS_ID = '$STS_ID'";
+		}
+		//setup the selects
+		$select .= implode(', ', $select_parts);
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN ";
+		//setup the joins
+		$join .= implode(" LEFT JOIN ", $join_parts);
+		//now let's put it all together
+		$query = $select . $join . ' GROUP BY Registration_REG_date';
+		//and execute it
+		$results = $wpdb->get_results($query, ARRAY_A);
+		return $results;
+	}
+
+
+
+	/**
+	 *        get the number of registrations per event  for the Registration Admin page Reports Tab
+	 *
+	 * @access        public
+	 * @param $period string which can be passed to php's strtotime function (eg "-1 month")
+	 * @return stdClass[] each with properties event_name, reg_limit, and total
+	 */
+	public function get_registrations_per_event_report($period = '-1 month')
+	{
+		$date_sql = $this->convert_datetime_for_query('REG_date', date("Y-m-d H:i:s", strtotime($period)),
+			'Y-m-d H:i:s', 'UTC');
+		$where = array(
+			'REG_date' => array('>=', $date_sql),
+			'STS_ID'   => array('!=', EEM_Registration::status_id_incomplete),
+		);
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$where['Event.EVT_wp_user'] = get_current_user_id();
+		}
+		$results = $this->_get_all_wpdb_results(array(
+			$where,
+			'group_by' => 'Event.EVT_name',
+			'order_by' => 'Event.EVT_name',
+			'limit'    => array(0, 24),
+		),
+			OBJECT,
+			array(
+				'event_name' => array('Event_CPT.post_title', '%s'),
+				'total'      => array('COUNT(REG_ID)', '%s'),
+			)
+		);
+		return $results;
+	}
+
+
+
+	/**
+	 * Get the number of registrations per event grouped by registration status.
+	 * Note: EEM_Registration::status_id_incomplete registrations are excluded from the results.
+	 *
+	 * @param string $period
+	 * @return stdClass[] with properties `Registration_Event` and a column for each registration status as the STS_ID
+	 *                    (i.e. RAP)
+	 */
+	public function get_registrations_per_event_and_per_status_report($period = '-1 month')
+	{
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$event_table = $wpdb->posts;
+		$sql_date = date("Y-m-d H:i:s", strtotime($period));
+		//inner date query
+		$inner_date_query = "SELECT DISTINCT EVT_ID, REG_date from $registration_table ";
+		$inner_where = " WHERE";
+		//exclude events not authored by user if permissions in effect
+		if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
+			$inner_where .= " post_author = " . get_current_user_id() . " AND";
+		}
+		$inner_where .= " REG_date >= '$sql_date'";
+		$inner_date_query .= $inner_where;
+		//build main query
+		$select = "SELECT Event.post_title as Registration_Event, ";
+		$join = '';
+		$join_parts = array();
+		$select_parts = array();
+		//loop through registration stati to do parts for each status.
+		foreach (EEM_Registration::reg_status_array() as $STS_ID => $STS_code) {
+			if ($STS_ID === EEM_Registration::status_id_incomplete) {
+				continue;
+			}
+			$select_parts[] = "COUNT($STS_code.REG_ID) as $STS_ID";
+			$join_parts[] = "$registration_table AS $STS_code ON $STS_code.EVT_ID = dates.EVT_ID AND $STS_code.STS_ID = '$STS_ID' AND $STS_code.REG_date = dates.REG_date";
+		}
+		//setup the selects
+		$select .= implode(', ', $select_parts);
+		$select .= " FROM ($inner_date_query) AS dates LEFT JOIN $event_table as Event ON Event.ID = dates.EVT_ID LEFT JOIN ";
+		//setup remaining joins
+		$join .= implode(" LEFT JOIN ", $join_parts);
+		//now put it all together
+		$query = $select . $join . ' GROUP BY Registration_Event';
+		//and execute
+		$results = $wpdb->get_results($query, ARRAY_A);
+		return $results;
+	}
+
+
+
+	/**
+	 * Returns the EE_Registration of the primary attendee on the transaction id provided
+	 *
+	 * @param int $TXN_ID
+	 * @return EE_Registration
+	 */
+	public function get_primary_registration_for_transaction_ID($TXN_ID = 0)
+	{
+		if ( ! $TXN_ID) {
+			return false;
+		}
+		return $this->get_one(array(
+			array(
+				'TXN_ID'    => $TXN_ID,
+				'REG_count' => EEM_Registration::PRIMARY_REGISTRANT_COUNT,
+			),
+		));
+	}
+
+
+
+	/**
+	 *        get_event_registration_count
+	 *
+	 * @access public
+	 * @param int     $EVT_ID
+	 * @param boolean $for_incomplete_payments
+	 * @return int
+	 */
+	public function get_event_registration_count($EVT_ID, $for_incomplete_payments = false)
+	{
+		// we only count approved registrations towards registration limits
+		$query_params = array(array('EVT_ID' => $EVT_ID, 'STS_ID' => self::status_id_approved));
+		if ($for_incomplete_payments) {
+			$query_params[0]['Transaction.STS_ID'] = array('!=', EEM_Transaction::complete_status_code);
+		}
+		return $this->count($query_params);
+	}
+
+
+
+	/**
+	 * Deletes all registrations with no transactions. Note that this needs to be very efficient
+	 * and so it uses wpdb directly
+	 *
+	 * @global WPDB $wpdb
+	 * @return int number deleted
+	 */
+	public function delete_registrations_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		return $wpdb->query(
+			'DELETE r FROM '
+			. $this->table()
+			. ' r LEFT JOIN '
+			. EEM_Transaction::instance()->table()
+			. ' t ON r.TXN_ID = t.TXN_ID WHERE t.TXN_ID IS NULL');
+	}
+
+
+
+	/**
+	 *  Count registrations checked into (or out of) a datetime
+	 *
+	 * @param int     $DTT_ID     datetime ID
+	 * @param boolean $checked_in whether to count registrations checked IN or OUT
+	 * @return int
+	 */
+	public function count_registrations_checked_into_datetime($DTT_ID, $checked_in = true)
+	{
+		global $wpdb;
+		//subquery to get latest checkin
+		$query = $wpdb->prepare(
+			'SELECT '
+			. 'COUNT( DISTINCT checkins.REG_ID ) '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+			. '( SELECT '
+			. 'max( CHK_timestamp ) AS latest_checkin, '
+			. 'REG_ID AS REG_ID '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' '
+			. 'WHERE DTT_ID=%d '
+			. 'GROUP BY REG_ID'
+			. ') AS most_recent_checkin_per_reg '
+			. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
+			. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
+			. 'WHERE '
+			. 'checkins.CHK_in=%d',
+			$DTT_ID,
+			$checked_in
+		);
+		return (int)$wpdb->get_var($query);
+	}
+
+
+
+	/**
+	 *  Count registrations checked into (or out of) an event.
+	 *
+	 * @param int     $EVT_ID     event ID
+	 * @param boolean $checked_in whether to count registrations checked IN or OUT
+	 * @return int
+	 */
+	public function count_registrations_checked_into_event($EVT_ID, $checked_in = true)
+	{
+		global $wpdb;
+		//subquery to get latest checkin
+		$query = $wpdb->prepare(
+			'SELECT '
+			. 'COUNT( DISTINCT checkins.REG_ID ) '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+			. '( SELECT '
+			. 'max( CHK_timestamp ) AS latest_checkin, '
+			. 'REG_ID AS REG_ID '
+			. 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
+			. 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
+			. 'ON c.DTT_ID=d.DTT_ID '
+			. 'WHERE d.EVT_ID=%d '
+			. 'GROUP BY REG_ID'
+			. ') AS most_recent_checkin_per_reg '
+			. 'ON checkins.REG_ID=most_recent_checkin_per_reg.REG_ID '
+			. 'AND checkins.CHK_timestamp = most_recent_checkin_per_reg.latest_checkin '
+			. 'WHERE '
+			. 'checkins.CHK_in=%d',
+			$EVT_ID,
+			$checked_in
+		);
+		return (int)$wpdb->get_var($query);
+	}
+
+
+
+	/**
+	 * The purpose of this method is to retrieve an array of
+	 * EE_Registration objects that represent the latest registration
+	 * for each ATT_ID given in the function argument.
+	 *
+	 * @param array $attendee_ids
+	 * @return EE_Registration[]
+	 */
+	public function get_latest_registration_for_each_of_given_contacts($attendee_ids = array())
+	{
+		//first do a native wp_query to get the latest REG_ID's matching these attendees.
+		global $wpdb;
+		$registration_table = $wpdb->prefix . 'esp_registration';
+		$attendee_table = $wpdb->posts;
+		$attendee_ids = is_array($attendee_ids)
+			? array_map('absint', $attendee_ids)
+			: array((int)$attendee_ids);
+		$attendee_ids = implode(',', $attendee_ids);
+		//first we do a query to get the registration ids
+		// (because a group by before order by causes the order by to be ignored.)
+		$registration_id_query = "
 			SELECT registrations.registration_ids as registration_id
 			FROM (
 				SELECT
@@ -761,23 +761,23 @@ 
 			  ) AS registrations
 			  GROUP BY registrations.attendee_ids
 		";
-        $registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
-        if (empty($registration_ids)) {
-            return array();
-        }
-        $ids_for_model_query = array();
-        //let's flatten the ids so they can be used in the model query.
-        foreach ($registration_ids as $registration_id) {
-            if (isset($registration_id['registration_id'])) {
-                $ids_for_model_query[] = $registration_id['registration_id'];
-            }
-        }
-        //construct query
-        $_where = array(
-            'REG_ID' => array('IN', $ids_for_model_query),
-        );
-        return $this->get_all(array($_where));
-    }
+		$registration_ids = $wpdb->get_results($registration_id_query, ARRAY_A);
+		if (empty($registration_ids)) {
+			return array();
+		}
+		$ids_for_model_query = array();
+		//let's flatten the ids so they can be used in the model query.
+		foreach ($registration_ids as $registration_id) {
+			if (isset($registration_id['registration_id'])) {
+				$ids_for_model_query[] = $registration_id['registration_id'];
+			}
+		}
+		//construct query
+		$_where = array(
+			'REG_ID' => array('IN', $ids_for_model_query),
+		);
+		return $this->get_all(array($_where));
+	}
 
 
 

Spacing +17 added lines, -17 removed lines

@@ -304,7 +304,7 @@ 
         //and the table hasn't actually been created, this could have an error
         /** @type WPDB $wpdb */
         global $wpdb;
-        if ($this->_get_table_analysis()->tableExists($wpdb->prefix . 'esp_status')) {
+        if ($this->_get_table_analysis()->tableExists($wpdb->prefix.'esp_status')) {
             $results = $wpdb->get_results(
                 "SELECT STS_ID, STS_code FROM {$wpdb->prefix}esp_status WHERE STS_type = 'registration'"
             );
@@ -448,7 +448,7 @@ 
             ),
             OBJECT,
             array(
-                'regDate' => array('DATE(' . $query_interval . ')', '%s'),
+                'regDate' => array('DATE('.$query_interval.')', '%s'),
                 'total'   => array('count(REG_ID)', '%d'),
             ));
         return $results;
@@ -467,7 +467,7 @@ 
     public function get_registrations_per_day_and_per_status_report($period = '-1 month')
     {
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $event_table = $wpdb->posts;
         $sql_date = date("Y-m-d H:i:s", strtotime($period));
         //prepare the query interval for displaying offset
@@ -478,7 +478,7 @@ 
         //exclude events not authored by user if permissions in effect
         if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
             $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
-            $inner_where .= " post_author = " . get_current_user_id() . " AND";
+            $inner_where .= " post_author = ".get_current_user_id()." AND";
         }
         $inner_where .= " REG_date >= '$sql_date'";
         $inner_date_query .= $inner_where;
@@ -501,7 +501,7 @@ 
         //setup the joins
         $join .= implode(" LEFT JOIN ", $join_parts);
         //now let's put it all together
-        $query = $select . $join . ' GROUP BY Registration_REG_date';
+        $query = $select.$join.' GROUP BY Registration_REG_date';
         //and execute it
         $results = $wpdb->get_results($query, ARRAY_A);
         return $results;
@@ -555,7 +555,7 @@ 
     public function get_registrations_per_event_and_per_status_report($period = '-1 month')
     {
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $event_table = $wpdb->posts;
         $sql_date = date("Y-m-d H:i:s", strtotime($period));
         //inner date query
@@ -564,7 +564,7 @@ 
         //exclude events not authored by user if permissions in effect
         if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
             $inner_date_query .= "LEFT JOIN $event_table ON ID = EVT_ID";
-            $inner_where .= " post_author = " . get_current_user_id() . " AND";
+            $inner_where .= " post_author = ".get_current_user_id()." AND";
         }
         $inner_where .= " REG_date >= '$sql_date'";
         $inner_date_query .= $inner_where;
@@ -587,7 +587,7 @@ 
         //setup remaining joins
         $join .= implode(" LEFT JOIN ", $join_parts);
         //now put it all together
-        $query = $select . $join . ' GROUP BY Registration_Event';
+        $query = $select.$join.' GROUP BY Registration_Event';
         //and execute
         $results = $wpdb->get_results($query, ARRAY_A);
         return $results;
@@ -671,11 +671,11 @@ 
         $query = $wpdb->prepare(
             'SELECT '
             . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+            . 'FROM '.EEM_Checkin::instance()->table().' AS checkins INNER JOIN'
             . '( SELECT '
             . 'max( CHK_timestamp ) AS latest_checkin, '
             . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' '
+            . 'FROM '.EEM_Checkin::instance()->table().' '
             . 'WHERE DTT_ID=%d '
             . 'GROUP BY REG_ID'
             . ') AS most_recent_checkin_per_reg '
@@ -686,7 +686,7 @@ 
             $DTT_ID,
             $checked_in
         );
-        return (int)$wpdb->get_var($query);
+        return (int) $wpdb->get_var($query);
     }
 
 
@@ -705,12 +705,12 @@ 
         $query = $wpdb->prepare(
             'SELECT '
             . 'COUNT( DISTINCT checkins.REG_ID ) '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS checkins INNER JOIN'
+            . 'FROM '.EEM_Checkin::instance()->table().' AS checkins INNER JOIN'
             . '( SELECT '
             . 'max( CHK_timestamp ) AS latest_checkin, '
             . 'REG_ID AS REG_ID '
-            . 'FROM ' . EEM_Checkin::instance()->table() . ' AS c '
-            . 'INNER JOIN ' . EEM_Datetime::instance()->table() . ' AS d '
+            . 'FROM '.EEM_Checkin::instance()->table().' AS c '
+            . 'INNER JOIN '.EEM_Datetime::instance()->table().' AS d '
             . 'ON c.DTT_ID=d.DTT_ID '
             . 'WHERE d.EVT_ID=%d '
             . 'GROUP BY REG_ID'
@@ -722,7 +722,7 @@ 
             $EVT_ID,
             $checked_in
         );
-        return (int)$wpdb->get_var($query);
+        return (int) $wpdb->get_var($query);
     }
 
 
@@ -739,11 +739,11 @@ 
     {
         //first do a native wp_query to get the latest REG_ID's matching these attendees.
         global $wpdb;
-        $registration_table = $wpdb->prefix . 'esp_registration';
+        $registration_table = $wpdb->prefix.'esp_registration';
         $attendee_table = $wpdb->posts;
         $attendee_ids = is_array($attendee_ids)
             ? array_map('absint', $attendee_ids)
-            : array((int)$attendee_ids);
+            : array((int) $attendee_ids);
         $attendee_ids = implode(',', $attendee_ids);
         //first we do a query to get the registration ids
         // (because a group by before order by causes the order by to be ignored.)

core/EE_Cron_Tasks.core.php

Indentation +444 added lines, -444 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -12,160 +12,160 @@ 
 class EE_Cron_Tasks extends EE_Base
 {
 
-    /**
-     * WordPress doesn't allow duplicate crons within 10 minutes of the original,
-     * so we'll set our retry time for just over 10 minutes to avoid that
-     */
-    const reschedule_timeout = 605;
-
-
-    /**
-     * @var EE_Cron_Tasks
-     */
-    private static $_instance;
-
-
-    /**
-     * @return EE_Cron_Tasks
-     */
-    public static function instance()
-    {
-        if ( ! self::$_instance instanceof EE_Cron_Tasks) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @access private
-     */
-    private function __construct()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // verify that WP Cron is enabled
-        if (
-            defined('DISABLE_WP_CRON')
-            && DISABLE_WP_CRON
-            && is_admin()
-            && ! get_option('ee_disabled_wp_cron_check')
-        ) {
-            /**
-             * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
-             * config is loaded.
-             * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
-             * wanting to not have this functionality can just register its own action at a priority after this one to
-             * reverse any changes.
-             */
-            add_action('AHEE__EE_System__load_core_configuration__complete', function () {
-                EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
-                EE_Registry::instance()->NET_CFG->update_config(true, false);
-                add_option('ee_disabled_wp_cron_check', 1, '', false);
-            });
-        }
-        // UPDATE TRANSACTION WITH PAYMENT
-        add_action(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-            array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
-            10, 2
-        );
-        // FINALIZE ABANDONED TRANSACTIONS
-        add_action(
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
-            array('EE_Cron_Tasks', 'check_for_abandoned_transactions'),
-            10, 1
-        );
+	/**
+	 * WordPress doesn't allow duplicate crons within 10 minutes of the original,
+	 * so we'll set our retry time for just over 10 minutes to avoid that
+	 */
+	const reschedule_timeout = 605;
+
+
+	/**
+	 * @var EE_Cron_Tasks
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @return EE_Cron_Tasks
+	 */
+	public static function instance()
+	{
+		if ( ! self::$_instance instanceof EE_Cron_Tasks) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @access private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// verify that WP Cron is enabled
+		if (
+			defined('DISABLE_WP_CRON')
+			&& DISABLE_WP_CRON
+			&& is_admin()
+			&& ! get_option('ee_disabled_wp_cron_check')
+		) {
+			/**
+			 * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
+			 * config is loaded.
+			 * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
+			 * wanting to not have this functionality can just register its own action at a priority after this one to
+			 * reverse any changes.
+			 */
+			add_action('AHEE__EE_System__load_core_configuration__complete', function () {
+				EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
+				EE_Registry::instance()->NET_CFG->update_config(true, false);
+				add_option('ee_disabled_wp_cron_check', 1, '', false);
+			});
+		}
+		// UPDATE TRANSACTION WITH PAYMENT
+		add_action(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+			array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
+			10, 2
+		);
+		// FINALIZE ABANDONED TRANSACTIONS
+		add_action(
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
+			array('EE_Cron_Tasks', 'check_for_abandoned_transactions'),
+			10, 1
+		);
 		// EXPIRED TRANSACTION CHECK
 		add_action(
 			'AHEE__EE_Cron_Tasks__expired_transaction_check',
 			array( 'EE_Cron_Tasks', 'expired_transaction_check' ),
 			10, 1
 		);
-        // CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
-        add_action(
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-            array('EE_Cron_Tasks', 'clean_out_junk_transactions')
-        );
-        // logging
-        add_action(
-            'AHEE__EE_System__load_core_configuration__complete',
-            array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
-        );
-        EE_Registry::instance()->load_lib('Messages_Scheduler');
-    }
-
-
-    /**
-     * @access protected
-     * @return void
-     */
-    public static function log_scheduled_ee_crons()
-    {
-        $ee_crons = array(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-        );
-        $crons = (array) get_option('cron');
-        if ( ! is_array($crons)) {
-            return;
-        }
-        foreach ($crons as $timestamp => $cron) {
-            foreach ($ee_crons as $ee_cron) {
-                if (isset($cron[$ee_cron]) && is_array($cron[$ee_cron])) {
-                    do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
-                    foreach ($cron[$ee_cron] as $ee_cron_details) {
-                        if ( ! empty($ee_cron_details['args'])) {
-                            do_action(
-                                'AHEE_log',
-                                __CLASS__,
-                                __FUNCTION__,
-                                print_r($ee_cron_details['args'], true),
-                                "{$ee_cron} args"
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * reschedule_cron_for_transactions_if_maintenance_mode
-     * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
-     *
-     * @param string $cron_task
-     * @param array  $TXN_IDs
-     * @return bool
-     * @throws \DomainException
-     */
+		// CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
+		add_action(
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+			array('EE_Cron_Tasks', 'clean_out_junk_transactions')
+		);
+		// logging
+		add_action(
+			'AHEE__EE_System__load_core_configuration__complete',
+			array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
+		);
+		EE_Registry::instance()->load_lib('Messages_Scheduler');
+	}
+
+
+	/**
+	 * @access protected
+	 * @return void
+	 */
+	public static function log_scheduled_ee_crons()
+	{
+		$ee_crons = array(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+		);
+		$crons = (array) get_option('cron');
+		if ( ! is_array($crons)) {
+			return;
+		}
+		foreach ($crons as $timestamp => $cron) {
+			foreach ($ee_crons as $ee_cron) {
+				if (isset($cron[$ee_cron]) && is_array($cron[$ee_cron])) {
+					do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
+					foreach ($cron[$ee_cron] as $ee_cron_details) {
+						if ( ! empty($ee_cron_details['args'])) {
+							do_action(
+								'AHEE_log',
+								__CLASS__,
+								__FUNCTION__,
+								print_r($ee_cron_details['args'], true),
+								"{$ee_cron} args"
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * reschedule_cron_for_transactions_if_maintenance_mode
+	 * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
+	 *
+	 * @param string $cron_task
+	 * @param array  $TXN_IDs
+	 * @return bool
+	 * @throws \DomainException
+	 */
 	public static function reschedule_cron_for_transactions_if_maintenance_mode( $cron_task, array $TXN_IDs ) {
-        if( ! method_exists('EE_Cron_Tasks', $cron_task)) {
-            throw new \DomainException(
-                sprintf(
-                    __('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
-                    $cron_task
-                )
-            );
-        }
+		if( ! method_exists('EE_Cron_Tasks', $cron_task)) {
+			throw new \DomainException(
+				sprintf(
+					__('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
+					$cron_task
+				)
+			);
+		}
 		// reschedule the cron if we can't hit the db right now
 		if ( ! EE_Maintenance_Mode::instance()->models_can_query() ) {
 			foreach( $TXN_IDs as $TXN_ID => $additional_vars ) {
-                // ensure $additional_vars is an array
-                $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
+				// ensure $additional_vars is an array
+				$additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
 				// reset cron job for the TXN
-                call_user_func_array(
-                    array('EE_Cron_Tasks', $cron_task),
-                    array_merge(
-                        array(
-                            time() + (10 * MINUTE_IN_SECONDS),
-                            $TXN_ID
-                        ),
-                        $additional_vars
-                    )
-                );
+				call_user_func_array(
+					array('EE_Cron_Tasks', $cron_task),
+					array_merge(
+						array(
+							time() + (10 * MINUTE_IN_SECONDS),
+							$TXN_ID
+						),
+						$additional_vars
+					)
+				);
 			}
 			return true;
 		}
@@ -175,85 +175,85 @@ 
 
 
 
-    /****************  UPDATE TRANSACTION WITH PAYMENT ****************/
-
-
-    /**
-     * array of TXN IDs and the payment
-     *
-     * @var array
-     */
-    protected static $_update_transactions_with_payment = array();
-
-
-    /**
-     * schedule_update_transaction_with_payment
-     * sets a wp_schedule_single_event() for updating any TXNs that may
-     * require updating due to recently received payments
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function schedule_update_transaction_with_payment(
-        $timestamp,
-        $TXN_ID,
-        $PAY_ID
-    ) {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // validate $TXN_ID and $timestamp
-        $TXN_ID    = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-                array($TXN_ID, $PAY_ID)
-            );
-        }
-    }
-
-
-    /**
-     * setup_update_for_transaction_with_payment
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
-     * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
-     * The passed TXN_ID and associated payment gets added to an array, and then
-     * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
-     * 'shutdown' which will actually handle the processing of any
-     * transactions requiring updating, because doing so now would be too early
-     * and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
-        if (absint($TXN_ID)) {
-            self::$_update_transactions_with_payment[$TXN_ID] = $PAY_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'update_transaction_with_payment'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * update_transaction_with_payment
-     * loops through the self::$_abandoned_transactions array
-     * and attempts to finalize any TXNs that have not been completed
-     * but have had their sessions expired, most likely due to a user not
-     * returning from an off-site payment gateway
-     *
-     * @throws \EE_Error
-     */
-    public static function update_transaction_with_payment()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
+	/****************  UPDATE TRANSACTION WITH PAYMENT ****************/
+
+
+	/**
+	 * array of TXN IDs and the payment
+	 *
+	 * @var array
+	 */
+	protected static $_update_transactions_with_payment = array();
+
+
+	/**
+	 * schedule_update_transaction_with_payment
+	 * sets a wp_schedule_single_event() for updating any TXNs that may
+	 * require updating due to recently received payments
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function schedule_update_transaction_with_payment(
+		$timestamp,
+		$TXN_ID,
+		$PAY_ID
+	) {
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// validate $TXN_ID and $timestamp
+		$TXN_ID    = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+				array($TXN_ID, $PAY_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * setup_update_for_transaction_with_payment
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
+	 * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
+	 * The passed TXN_ID and associated payment gets added to an array, and then
+	 * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
+	 * 'shutdown' which will actually handle the processing of any
+	 * transactions requiring updating, because doing so now would be too early
+	 * and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
+		if (absint($TXN_ID)) {
+			self::$_update_transactions_with_payment[$TXN_ID] = $PAY_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'update_transaction_with_payment'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * update_transaction_with_payment
+	 * loops through the self::$_abandoned_transactions array
+	 * and attempts to finalize any TXNs that have not been completed
+	 * but have had their sessions expired, most likely due to a user not
+	 * returning from an off-site payment gateway
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function update_transaction_with_payment()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
 		if (
 			// are there any TXNs that need cleaning up ?
 			empty( self::$_update_transactions_with_payment )
@@ -263,119 +263,119 @@ 
 				self::$_update_transactions_with_payment
 			)
 		) {
-            return;
-        }
-        /** @type EE_Payment_Processor $payment_processor */
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        // set revisit flag for payment processor
-        $payment_processor->set_revisit(false);
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
-            // reschedule the cron if we can't hit the db right now
-            if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
-                // reset cron job for updating the TXN
-                EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                    time() + EE_Cron_Tasks::reschedule_timeout,
-                    $TXN_ID,
-                    $PAY_ID
-                );
-                continue;
-            }
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $payment     = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            // verify transaction
-            if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
-                // now try to update the TXN with any payments
-                $payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
-            }
-            unset(self::$_update_transactions_with_payment[$TXN_ID]);
-        }
-    }
-
-
-
-    /************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
-
-
-    /*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
-
-
-    /**
-     * array of TXN IDs
-     *
-     * @var array
-     */
-    protected static $_abandoned_transactions = array();
-
-
-    /**
-     * schedule_finalize_abandoned_transactions_check
-     * sets a wp_schedule_single_event() for finalizing any TXNs that may
-     * have been abandoned during the registration process
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_finalize_abandoned_transactions_check(
-        $timestamp,
-        $TXN_ID
-    ) {
-        // validate $TXN_ID and $timestamp
-        $TXN_ID    = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
-                array($TXN_ID)
-            );
-        }
-    }
-
-
-    /**
-     * check_for_abandoned_transactions
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__espresso_finalize_abandoned_transactions'
-     * which is utilized by wp_schedule_single_event()
-     * in EE_SPCO_Reg_Step_Payment_Options::_post_payment_processing().
-     * The passed TXN_ID gets added to an array, and then the
-     * espresso_finalize_abandoned_transactions() function is hooked into
-     * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
-     * processing of any abandoned transactions, because doing so now would be
-     * too early and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     */
-    public static function check_for_abandoned_transactions($TXN_ID = 0)
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
-        if (absint($TXN_ID)) {
-            self::$_abandoned_transactions[] = $TXN_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'finalize_abandoned_transactions'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * finalize_abandoned_transactions
-     * loops through the self::$_abandoned_transactions array
-     * and attempts to finalize any TXNs that have not been completed
-     * but have had their sessions expired, most likely due to a user not
-     * returning from an off-site payment gateway
-     *
-     * @throws \EE_Error
-     */
-    public static function finalize_abandoned_transactions()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (
+			return;
+		}
+		/** @type EE_Payment_Processor $payment_processor */
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		// set revisit flag for payment processor
+		$payment_processor->set_revisit(false);
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
+			// reschedule the cron if we can't hit the db right now
+			if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
+				// reset cron job for updating the TXN
+				EE_Cron_Tasks::schedule_update_transaction_with_payment(
+					time() + EE_Cron_Tasks::reschedule_timeout,
+					$TXN_ID,
+					$PAY_ID
+				);
+				continue;
+			}
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$payment     = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			// verify transaction
+			if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
+				// now try to update the TXN with any payments
+				$payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
+			}
+			unset(self::$_update_transactions_with_payment[$TXN_ID]);
+		}
+	}
+
+
+
+	/************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
+
+
+	/*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
+
+
+	/**
+	 * array of TXN IDs
+	 *
+	 * @var array
+	 */
+	protected static $_abandoned_transactions = array();
+
+
+	/**
+	 * schedule_finalize_abandoned_transactions_check
+	 * sets a wp_schedule_single_event() for finalizing any TXNs that may
+	 * have been abandoned during the registration process
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_finalize_abandoned_transactions_check(
+		$timestamp,
+		$TXN_ID
+	) {
+		// validate $TXN_ID and $timestamp
+		$TXN_ID    = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
+				array($TXN_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * check_for_abandoned_transactions
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__espresso_finalize_abandoned_transactions'
+	 * which is utilized by wp_schedule_single_event()
+	 * in EE_SPCO_Reg_Step_Payment_Options::_post_payment_processing().
+	 * The passed TXN_ID gets added to an array, and then the
+	 * espresso_finalize_abandoned_transactions() function is hooked into
+	 * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
+	 * processing of any abandoned transactions, because doing so now would be
+	 * too early and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 */
+	public static function check_for_abandoned_transactions($TXN_ID = 0)
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
+		if (absint($TXN_ID)) {
+			self::$_abandoned_transactions[] = $TXN_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'finalize_abandoned_transactions'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * finalize_abandoned_transactions
+	 * loops through the self::$_abandoned_transactions array
+	 * and attempts to finalize any TXNs that have not been completed
+	 * but have had their sessions expired, most likely due to a user not
+	 * returning from an off-site payment gateway
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function finalize_abandoned_transactions()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (
 			// are there any TXNs that need cleaning up ?
 			empty( self::$_abandoned_transactions )
 			// reschedule the cron if we can't hit the db right now
@@ -384,45 +384,45 @@ 
 				self::$_abandoned_transactions
 			)
 		) {
-            return;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // set revisit flag for txn processor
-        $transaction_processor->set_revisit(false);
-        /** @type EE_Payment_Processor $payment_processor */
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_abandoned_transactions as $TXN_ID) {
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
-            // reschedule the cron if we can't hit the db right now
-            if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
-                // reset cron job for finalizing the TXN
-                EE_Cron_Tasks::schedule_finalize_abandoned_transactions_check(
-                    time() + EE_Cron_Tasks::reschedule_timeout,
-                    $TXN_ID
-                );
-                continue;
-            }
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            // verify transaction
-            if ($transaction instanceof EE_Transaction) {
-                // don't finalize the TXN if it has already been completed
-                if ($transaction->all_reg_steps_completed() === true) {
-                    continue;
-                }
-                // let's simulate an IPN here which will trigger any notifications that need to go out
-                $payment_processor->update_txn_based_on_payment($transaction, $transaction->last_payment(), true,
-                    true);
-            }
-            unset(self::$_abandoned_transactions[$TXN_ID]);
-        }
-    }
-
-
-
-    /*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
+			return;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// set revisit flag for txn processor
+		$transaction_processor->set_revisit(false);
+		/** @type EE_Payment_Processor $payment_processor */
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_abandoned_transactions as $TXN_ID) {
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
+			// reschedule the cron if we can't hit the db right now
+			if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
+				// reset cron job for finalizing the TXN
+				EE_Cron_Tasks::schedule_finalize_abandoned_transactions_check(
+					time() + EE_Cron_Tasks::reschedule_timeout,
+					$TXN_ID
+				);
+				continue;
+			}
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			// verify transaction
+			if ($transaction instanceof EE_Transaction) {
+				// don't finalize the TXN if it has already been completed
+				if ($transaction->all_reg_steps_completed() === true) {
+					continue;
+				}
+				// let's simulate an IPN here which will trigger any notifications that need to go out
+				$payment_processor->update_txn_based_on_payment($transaction, $transaction->last_payment(), true,
+					true);
+			}
+			unset(self::$_abandoned_transactions[$TXN_ID]);
+		}
+	}
+
+
+
+	/*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
 
 
 	/*****************  EXPIRED TRANSACTION CHECK *****************/
@@ -491,12 +491,12 @@ 
 
 
 
-    /**
-     * process_expired_transactions
-     * loops through the self::$_expired_transactions array and processes any failed TXNs
-     *
-     * @throws \EE_Error
-     */
+	/**
+	 * process_expired_transactions
+	 * loops through the self::$_expired_transactions array and processes any failed TXNs
+	 *
+	 * @throws \EE_Error
+	 */
 	public static function process_expired_transactions() {
 		if (
 			// are there any TXNs that need cleaning up ?
@@ -507,58 +507,58 @@ 
 				self::$_expired_transactions
 			)
 		) {
-            return;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
-        // set revisit flag for txn processor
-        $transaction_processor->set_revisit( false );
-         // load EEM_Transaction
-        EE_Registry::instance()->load_model( 'Transaction' );
-        foreach ( self::$_expired_transactions as $TXN_ID ) {
-            $transaction = EEM_Transaction::instance()->get_one_by_ID( $TXN_ID );
-            // verify transaction and whether it is failed or not
-            if ( $transaction instanceof EE_Transaction) {
-                switch( $transaction->status_ID() ) {
-                    // Completed TXNs
-                    case EEM_Transaction::complete_status_code :
-                        do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction', $transaction );
-                        break;
-                    // Overpaid TXNs
-                    case EEM_Transaction::overpaid_status_code :
-                        do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction', $transaction );
-                        break;
-                    // Incomplete TXNs
-                    case EEM_Transaction::incomplete_status_code :
-                        do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction', $transaction );
-                        // todo : merge the finalize_abandoned_transactions cron into this one...
-                        // todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
-                        break;
-                    // Failed TXNs
-                    case EEM_Transaction::failed_status_code :
-                        do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction', $transaction );
-                        // todo : perform garbage collection here and remove clean_out_junk_transactions()
-                        //$registrations = $transaction->registrations();
-                        //if ( ! empty( $registrations ) ) {
-                        //	foreach ( $registrations as $registration ) {
-                        //		if ( $registration instanceof EE_Registration ) {
-                        //$delete_registration = true;
-                        //if ( $registration->attendee() instanceof EE_Attendee ) {
-                        //	$delete_registration = false;
-                        //}
-                        //if ( $delete_registration ) {
-                        //	$registration->delete_permanently();
-                        //	$registration->delete_related_permanently();
-                        //}
-                        //		}
-                        //	}
-                        //}
-                        break;
-                }
-
-            }
-            unset( self::$_expired_transactions[ $TXN_ID ] );
-        }
+			return;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
+		// set revisit flag for txn processor
+		$transaction_processor->set_revisit( false );
+		 // load EEM_Transaction
+		EE_Registry::instance()->load_model( 'Transaction' );
+		foreach ( self::$_expired_transactions as $TXN_ID ) {
+			$transaction = EEM_Transaction::instance()->get_one_by_ID( $TXN_ID );
+			// verify transaction and whether it is failed or not
+			if ( $transaction instanceof EE_Transaction) {
+				switch( $transaction->status_ID() ) {
+					// Completed TXNs
+					case EEM_Transaction::complete_status_code :
+						do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction', $transaction );
+						break;
+					// Overpaid TXNs
+					case EEM_Transaction::overpaid_status_code :
+						do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction', $transaction );
+						break;
+					// Incomplete TXNs
+					case EEM_Transaction::incomplete_status_code :
+						do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction', $transaction );
+						// todo : merge the finalize_abandoned_transactions cron into this one...
+						// todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
+						break;
+					// Failed TXNs
+					case EEM_Transaction::failed_status_code :
+						do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction', $transaction );
+						// todo : perform garbage collection here and remove clean_out_junk_transactions()
+						//$registrations = $transaction->registrations();
+						//if ( ! empty( $registrations ) ) {
+						//	foreach ( $registrations as $registration ) {
+						//		if ( $registration instanceof EE_Registration ) {
+						//$delete_registration = true;
+						//if ( $registration->attendee() instanceof EE_Attendee ) {
+						//	$delete_registration = false;
+						//}
+						//if ( $delete_registration ) {
+						//	$registration->delete_permanently();
+						//	$registration->delete_related_permanently();
+						//}
+						//		}
+						//	}
+						//}
+						break;
+				}
+
+			}
+			unset( self::$_expired_transactions[ $TXN_ID ] );
+		}
 	}
 
 
@@ -566,18 +566,18 @@ 
 	/*************  END OF EXPIRED TRANSACTION CHECK  *************/
 
 
-    /************* START CLEAN UP BOT TRANSACTIONS **********************/
+	/************* START CLEAN UP BOT TRANSACTIONS **********************/
 
-    //when a transaction is initially made, schedule this check.
-    //if it has NO REG data by the time it has expired, forget about it
-    public static function clean_out_junk_transactions()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            EEM_Transaction::instance('')->delete_junk_transactions();
-            EEM_Registration::instance('')->delete_registrations_with_no_transaction();
-            EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
-        }
-    }
+	//when a transaction is initially made, schedule this check.
+	//if it has NO REG data by the time it has expired, forget about it
+	public static function clean_out_junk_transactions()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			EEM_Transaction::instance('')->delete_junk_transactions();
+			EEM_Registration::instance('')->delete_registrations_with_no_transaction();
+			EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
+		}
+	}
 
 
 }

Spacing +29 added lines, -29 removed lines

@@ -57,7 +57,7 @@ 
              * wanting to not have this functionality can just register its own action at a priority after this one to
              * reverse any changes.
              */
-            add_action('AHEE__EE_System__load_core_configuration__complete', function () {
+            add_action('AHEE__EE_System__load_core_configuration__complete', function() {
                 EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
                 EE_Registry::instance()->NET_CFG->update_config(true, false);
                 add_option('ee_disabled_wp_cron_check', 1, '', false);
@@ -78,7 +78,7 @@ 
 		// EXPIRED TRANSACTION CHECK
 		add_action(
 			'AHEE__EE_Cron_Tasks__expired_transaction_check',
-			array( 'EE_Cron_Tasks', 'expired_transaction_check' ),
+			array('EE_Cron_Tasks', 'expired_transaction_check'),
 			10, 1
 		);
         // CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
@@ -141,8 +141,8 @@ 
      * @return bool
      * @throws \DomainException
      */
-	public static function reschedule_cron_for_transactions_if_maintenance_mode( $cron_task, array $TXN_IDs ) {
-        if( ! method_exists('EE_Cron_Tasks', $cron_task)) {
+	public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs) {
+        if ( ! method_exists('EE_Cron_Tasks', $cron_task)) {
             throw new \DomainException(
                 sprintf(
                     __('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
@@ -151,8 +151,8 @@ 
             );
         }
 		// reschedule the cron if we can't hit the db right now
-		if ( ! EE_Maintenance_Mode::instance()->models_can_query() ) {
-			foreach( $TXN_IDs as $TXN_ID => $additional_vars ) {
+		if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
+			foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
                 // ensure $additional_vars is an array
                 $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
 				// reset cron job for the TXN
@@ -256,7 +256,7 @@ 
         do_action('AHEE_log', __CLASS__, __FUNCTION__);
 		if (
 			// are there any TXNs that need cleaning up ?
-			empty( self::$_update_transactions_with_payment )
+			empty(self::$_update_transactions_with_payment)
 			// reschedule the cron if we can't hit the db right now
 			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
 				'schedule_update_transaction_with_payment',
@@ -377,7 +377,7 @@ 
         do_action('AHEE_log', __CLASS__, __FUNCTION__);
         if (
 			// are there any TXNs that need cleaning up ?
-			empty( self::$_abandoned_transactions )
+			empty(self::$_abandoned_transactions)
 			// reschedule the cron if we can't hit the db right now
 			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
 				'schedule_finalize_abandoned_transactions_check',
@@ -450,13 +450,13 @@ 
 		$TXN_ID
 	) {
 		// validate $TXN_ID and $timestamp
-		$TXN_ID = absint( $TXN_ID );
-		$timestamp = absint( $timestamp );
-		if ( $TXN_ID && $timestamp ) {
+		$TXN_ID = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
 			wp_schedule_single_event(
 				$timestamp,
 				'AHEE__EE_Cron_Tasks__expired_transaction_check',
-				array( $TXN_ID )
+				array($TXN_ID)
 			);
 		}
 	}
@@ -478,12 +478,12 @@ 
 	 *
 	 * @param int $TXN_ID
 	 */
-	public static function expired_transaction_check( $TXN_ID = 0 ) {
-		if ( absint( $TXN_ID )) {
-			self::$_expired_transactions[ $TXN_ID ]  = $TXN_ID;
+	public static function expired_transaction_check($TXN_ID = 0) {
+		if (absint($TXN_ID)) {
+			self::$_expired_transactions[$TXN_ID] = $TXN_ID;
 			add_action(
 				'shutdown',
-				array( 'EE_Cron_Tasks', 'process_expired_transactions' ),
+				array('EE_Cron_Tasks', 'process_expired_transactions'),
 				5
 			);
 		}
@@ -500,7 +500,7 @@ 
 	public static function process_expired_transactions() {
 		if (
 			// are there any TXNs that need cleaning up ?
-			empty( self::$_expired_transactions )
+			empty(self::$_expired_transactions)
 			// reschedule the cron if we can't hit the db right now
 			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
 				'schedule_expired_transaction_check',
@@ -510,33 +510,33 @@ 
             return;
         }
         /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
+        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
         // set revisit flag for txn processor
-        $transaction_processor->set_revisit( false );
+        $transaction_processor->set_revisit(false);
          // load EEM_Transaction
-        EE_Registry::instance()->load_model( 'Transaction' );
-        foreach ( self::$_expired_transactions as $TXN_ID ) {
-            $transaction = EEM_Transaction::instance()->get_one_by_ID( $TXN_ID );
+        EE_Registry::instance()->load_model('Transaction');
+        foreach (self::$_expired_transactions as $TXN_ID) {
+            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
             // verify transaction and whether it is failed or not
-            if ( $transaction instanceof EE_Transaction) {
-                switch( $transaction->status_ID() ) {
+            if ($transaction instanceof EE_Transaction) {
+                switch ($transaction->status_ID()) {
                     // Completed TXNs
                     case EEM_Transaction::complete_status_code :
-                        do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction', $transaction );
+                        do_action('AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction', $transaction);
                         break;
                     // Overpaid TXNs
                     case EEM_Transaction::overpaid_status_code :
-                        do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction', $transaction );
+                        do_action('AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction', $transaction);
                         break;
                     // Incomplete TXNs
                     case EEM_Transaction::incomplete_status_code :
-                        do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction', $transaction );
+                        do_action('AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction', $transaction);
                         // todo : merge the finalize_abandoned_transactions cron into this one...
                         // todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
                         break;
                     // Failed TXNs
                     case EEM_Transaction::failed_status_code :
-                        do_action( 'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction', $transaction );
+                        do_action('AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction', $transaction);
                         // todo : perform garbage collection here and remove clean_out_junk_transactions()
                         //$registrations = $transaction->registrations();
                         //if ( ! empty( $registrations ) ) {
@@ -557,7 +557,7 @@ 
                 }
 
             }
-            unset( self::$_expired_transactions[ $TXN_ID ] );
+            unset(self::$_expired_transactions[$TXN_ID]);
         }
 	}
 

core/db_models/EEM_Attendee.model.php

Doc Comments +1 added lines, -1 removed lines

@@ -242,7 +242,7 @@
      *
      * @access        public
      * @param        $ATT_ID
-     * @return        mixed        array on success, FALSE on fail
+     * @return        EE_Base_Class|null        array on success, FALSE on fail
      * @deprecated
      */
     public function get_attendee_by_ID($ATT_ID = false)

Indentation +306 added lines, -306 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 require_once(EE_MODELS . 'EEM_Base.model.php');
 
@@ -15,319 +15,319 @@ 
 class EEM_Attendee extends EEM_CPT_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
-    /**
-     * QST_system for questions are strings not ints now,
-     * so these constants are deprecated.
-     * Please instead use the EEM_Attendee::system_question_* constants
-     *
-     * @deprecated
-     */
-    const fname_question_id = 1;
+	/**
+	 * QST_system for questions are strings not ints now,
+	 * so these constants are deprecated.
+	 * Please instead use the EEM_Attendee::system_question_* constants
+	 *
+	 * @deprecated
+	 */
+	const fname_question_id = 1;
 
-    /**
-     * @deprecated
-     */
-    const lname_question_id = 2;
+	/**
+	 * @deprecated
+	 */
+	const lname_question_id = 2;
 
 
-    /**
-     * @deprecated
-     */
-    const email_question_id = 3;
+	/**
+	 * @deprecated
+	 */
+	const email_question_id = 3;
 
 
-    /**
-     * @deprecated
-     */
-    const address_question_id = 4;
+	/**
+	 * @deprecated
+	 */
+	const address_question_id = 4;
 
 
-    /**
-     * @deprecated
-     */
-    const address2_question_id = 5;
-
-
-    /**
-     * @deprecated
-     */
-    const city_question_id = 6;
-
-
-    /**
-     * @deprecated
-     */
-    const state_question_id = 7;
-
-
-    /**
-     * @deprecated
-     */
-    const country_question_id = 8;
-
-
-    /**
-     * @deprecated
-     */
-    const zip_question_id = 9;
-
-
-    /**
-     * @deprecated
-     */
-    const phone_question_id = 10;
-
-    /**
-     * When looking for questions that correspond to attendee fields,
-     * look for the question with this QST_system value.
-     * These replace the old constants like EEM_Attendee::*_question_id
-     */
-    const system_question_fname    = 'fname';
-
-    const system_question_lname    = 'lname';
-
-    const system_question_email    = 'email';
-
-    const system_question_address  = 'address';
-
-    const system_question_address2 = 'address2';
-
-    const system_question_city     = 'city';
-
-    const system_question_state    = 'state';
-
-    const system_question_country  = 'country';
-
-    const system_question_zip      = 'zip';
-
-    const system_question_phone    = 'phone';
-
-    /**
-     * Keys are all the EEM_Attendee::system_question_* constants, which are
-     * also all the values of QST_system in the questions table, and values
-     * are their corresponding Attendee field names
-     *
-     * @var array
-     */
-    protected $_system_question_to_attendee_field_name = array(
-        EEM_Attendee::system_question_fname    => 'ATT_fname',
-        EEM_Attendee::system_question_lname    => 'ATT_lname',
-        EEM_Attendee::system_question_email    => 'ATT_email',
-        EEM_Attendee::system_question_address  => 'ATT_address',
-        EEM_Attendee::system_question_address2 => 'ATT_address2',
-        EEM_Attendee::system_question_city     => 'ATT_city',
-        EEM_Attendee::system_question_state    => 'STA_ID',
-        EEM_Attendee::system_question_country  => 'CNT_ISO',
-        EEM_Attendee::system_question_zip      => 'ATT_zip',
-        EEM_Attendee::system_question_phone    => 'ATT_phone',
-    );
-
-
-
-    /**
-     *        private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     * @param null $timezone
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Attendee', 'event_espresso');
-        $this->plural_item = __('Attendees', 'event_espresso');
-        $this->_tables = array(
-            'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Attendee_Meta' => new EE_Secondary_Table('esp_attendee_meta', 'ATTM_ID', 'ATT_ID'),
-        );
-        $this->_fields = array(
-            'Attendee_CPT'  => array(
-                'ATT_ID'        => new EE_Primary_Key_Int_Field('ID', __("Attendee ID", "event_espresso")),
-                'ATT_full_name' => new EE_Plain_Text_Field('post_title', __("Attendee Full Name", "event_espresso"),
-                    false, __("Unknown", "event_espresso")),
-                'ATT_bio'       => new EE_Post_Content_Field('post_content', __("Attendee Biography", "event_espresso"),
-                    false, __("No Biography Provided", "event_espresso")),
-                'ATT_slug'      => new EE_Slug_Field('post_name', __("Attendee URL Slug", "event_espresso"), false),
-                'ATT_created'   => new EE_Datetime_Field('post_date', __("Time Attendee Created", "event_espresso"),
-                    false, EE_Datetime_Field::now),
-                'ATT_short_bio' => new EE_Simple_HTML_Field('post_excerpt',
-                    __("Attendee Short Biography", "event_espresso"), true,
-                    __("No Biography Provided", "event_espresso")),
-                'ATT_modified'  => new EE_Datetime_Field('post_modified',
-                    __("Time Attendee Last Modified", "event_espresso"), false, EE_Datetime_Field::now),
-                'ATT_author'    => new EE_WP_User_Field('post_author',
-                    __("Creator ID of the first Event attended", "event_espresso"), false),
-                'ATT_parent'    => new EE_DB_Only_Int_Field('post_parent',
-                    __("Parent Attendee (unused)", "event_espresso"), false, 0),
-                'post_type'     => new EE_WP_Post_Type_Field('espresso_attendees'),
-                // EE_DB_Only_Text_Field('post_type', __("Post Type of Attendee", "event_espresso"), false,'espresso_attendees'),
-                'status'        => new EE_WP_Post_Status_Field('post_status', __('Attendee Status', 'event_espresso'),
-                    false, 'publish'),
-            ),
-            'Attendee_Meta' => array(
-                'ATTM_ID'      => new EE_DB_Only_Int_Field('ATTM_ID', __('Attendee Meta Row ID', 'event_espresso'),
-                    false),
-                'ATT_ID_fk'    => new EE_DB_Only_Int_Field('ATT_ID',
-                    __("Foreign Key to Attendee in Post Table", "event_espresso"), false),
-                'ATT_fname'    => new EE_Plain_Text_Field('ATT_fname', __('First Name', 'event_espresso'), true, ''),
-                'ATT_lname'    => new EE_Plain_Text_Field('ATT_lname', __('Last Name', 'event_espresso'), true, ''),
-                'ATT_address'  => new EE_Plain_Text_Field('ATT_address', __('Address Part 1', 'event_espresso'), true,
-                    ''),
-                'ATT_address2' => new EE_Plain_Text_Field('ATT_address2', __('Address Part 2', 'event_espresso'), true,
-                    ''),
-                'ATT_city'     => new EE_Plain_Text_Field('ATT_city', __('City', 'event_espresso'), true, ''),
-                'STA_ID'       => new EE_Foreign_Key_Int_Field('STA_ID', __('State', 'event_espresso'), true, 0,
-                    'State'),
-                'CNT_ISO'      => new EE_Foreign_Key_String_Field('CNT_ISO', __('Country', 'event_espresso'), true, '',
-                    'Country'),
-                'ATT_zip'      => new EE_Plain_Text_Field('ATT_zip', __('ZIP/Postal Code', 'event_espresso'), true, ''),
-                'ATT_email'    => new EE_Email_Field('ATT_email', __('Email Address', 'event_espresso'), true, ''),
-                'ATT_phone'    => new EE_Plain_Text_Field('ATT_phone', __('Phone', 'event_espresso'), true, ''),
-            ),
-        );
-        $this->_model_relations = array(
-            'Registration'      => new EE_Has_Many_Relation(),
-            'State'             => new EE_Belongs_To_Relation(),
-            'Country'           => new EE_Belongs_To_Relation(),
-            'Event'             => new EE_HABTM_Relation('Registration', false),
-            'WP_User'           => new EE_Belongs_To_Relation(),
-            'Message'           => new EE_Has_Many_Any_Relation(false),
-            //allow deletion of attendees even if they have messages in the queue for them.
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
-        );
-        $this->_caps_slug = 'contacts';
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Gets the name of the field on the attendee model corresponding to the system question string
-     * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
-     *
-     * @param string $system_question_string
-     * @return string|null if not found
-     */
-    public function get_attendee_field_for_system_question($system_question_string)
-    {
-        return isset($this->_system_question_to_attendee_field_name[$system_question_string])
-            ? $this->_system_question_to_attendee_field_name[$system_question_string] : null;
-    }
-
-
-
-    /**
-     * Gets all the attendees for a transaction (by using the esp_registration as a join table)
-     *
-     * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
-     * @return EE_Attendee[]
-     */
-    public function get_attendees_for_transaction($transaction_id_or_obj)
-    {
-        return $this->get_all(array(
-            array(
-                'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
-                    ? $transaction_id_or_obj->ID() : $transaction_id_or_obj,
-            ),
-        ));
-    }
-
-
-
-    /**
-     *        retrieve  a single attendee from db via their ID
-     *
-     * @access        public
-     * @param        $ATT_ID
-     * @return        mixed        array on success, FALSE on fail
-     * @deprecated
-     */
-    public function get_attendee_by_ID($ATT_ID = false)
-    {
-        // retrieve a particular EE_Attendee
-        return $this->get_one_by_ID($ATT_ID);
-    }
-
-
-
-    /**
-     *        retrieve  a single attendee from db via their ID
-     *
-     * @access        public
-     * @param        array $where_cols_n_values
-     * @return        mixed        array on success, FALSE on fail
-     */
-    public function get_attendee($where_cols_n_values = array())
-    {
-        if (empty($where_cols_n_values)) {
-            return false;
-        }
-        $attendee = $this->get_all(array($where_cols_n_values));
-        if ( ! empty($attendee)) {
-            return array_shift($attendee);
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     *        Search for an existing Attendee record in the DB
-     *
-     * @access        public
-     * @param array $where_cols_n_values
-     * @return bool|mixed
-     */
-    public function find_existing_attendee($where_cols_n_values = null)
-    {
-        // search by combo of first and last names plus the email address
-        $attendee_data_keys = array(
-            'ATT_fname' => $this->_ATT_fname,
-            'ATT_lname' => $this->_ATT_lname,
-            'ATT_email' => $this->_ATT_email,
-        );
-        // no search params means attendee object already exists.
-        $where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values) ? $where_cols_n_values
-            : $attendee_data_keys;
-        $valid_data = true;
-        // check for required values
-        $valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname'])
-            ? $valid_data : false;
-        $valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname'])
-            ? $valid_data : false;
-        $valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email'])
-            ? $valid_data : false;
-        if ($valid_data) {
-            $attendee = $this->get_attendee($where_cols_n_values);
-            if ($attendee instanceof EE_Attendee) {
-                return $attendee;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Takes an incoming array of EE_Registration ids and sends back a list of corresponding non duplicate
-     * EE_Attendee objects.
-     *
-     * @since    4.3.0
-     * @param  array $ids array of EE_Registration ids
-     * @return  EE_Attendee[]
-     */
-    public function get_array_of_contacts_from_reg_ids($ids)
-    {
-        $ids = (array)$ids;
-        $_where = array(
-            'Registration.REG_ID' => array('in', $ids),
-        );
-        return $this->get_all(array($_where));
-    }
+	/**
+	 * @deprecated
+	 */
+	const address2_question_id = 5;
+
+
+	/**
+	 * @deprecated
+	 */
+	const city_question_id = 6;
+
+
+	/**
+	 * @deprecated
+	 */
+	const state_question_id = 7;
+
+
+	/**
+	 * @deprecated
+	 */
+	const country_question_id = 8;
+
+
+	/**
+	 * @deprecated
+	 */
+	const zip_question_id = 9;
+
+
+	/**
+	 * @deprecated
+	 */
+	const phone_question_id = 10;
+
+	/**
+	 * When looking for questions that correspond to attendee fields,
+	 * look for the question with this QST_system value.
+	 * These replace the old constants like EEM_Attendee::*_question_id
+	 */
+	const system_question_fname    = 'fname';
+
+	const system_question_lname    = 'lname';
+
+	const system_question_email    = 'email';
+
+	const system_question_address  = 'address';
+
+	const system_question_address2 = 'address2';
+
+	const system_question_city     = 'city';
+
+	const system_question_state    = 'state';
+
+	const system_question_country  = 'country';
+
+	const system_question_zip      = 'zip';
+
+	const system_question_phone    = 'phone';
+
+	/**
+	 * Keys are all the EEM_Attendee::system_question_* constants, which are
+	 * also all the values of QST_system in the questions table, and values
+	 * are their corresponding Attendee field names
+	 *
+	 * @var array
+	 */
+	protected $_system_question_to_attendee_field_name = array(
+		EEM_Attendee::system_question_fname    => 'ATT_fname',
+		EEM_Attendee::system_question_lname    => 'ATT_lname',
+		EEM_Attendee::system_question_email    => 'ATT_email',
+		EEM_Attendee::system_question_address  => 'ATT_address',
+		EEM_Attendee::system_question_address2 => 'ATT_address2',
+		EEM_Attendee::system_question_city     => 'ATT_city',
+		EEM_Attendee::system_question_state    => 'STA_ID',
+		EEM_Attendee::system_question_country  => 'CNT_ISO',
+		EEM_Attendee::system_question_zip      => 'ATT_zip',
+		EEM_Attendee::system_question_phone    => 'ATT_phone',
+	);
+
+
+
+	/**
+	 *        private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 * @param null $timezone
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Attendee', 'event_espresso');
+		$this->plural_item = __('Attendees', 'event_espresso');
+		$this->_tables = array(
+			'Attendee_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Attendee_Meta' => new EE_Secondary_Table('esp_attendee_meta', 'ATTM_ID', 'ATT_ID'),
+		);
+		$this->_fields = array(
+			'Attendee_CPT'  => array(
+				'ATT_ID'        => new EE_Primary_Key_Int_Field('ID', __("Attendee ID", "event_espresso")),
+				'ATT_full_name' => new EE_Plain_Text_Field('post_title', __("Attendee Full Name", "event_espresso"),
+					false, __("Unknown", "event_espresso")),
+				'ATT_bio'       => new EE_Post_Content_Field('post_content', __("Attendee Biography", "event_espresso"),
+					false, __("No Biography Provided", "event_espresso")),
+				'ATT_slug'      => new EE_Slug_Field('post_name', __("Attendee URL Slug", "event_espresso"), false),
+				'ATT_created'   => new EE_Datetime_Field('post_date', __("Time Attendee Created", "event_espresso"),
+					false, EE_Datetime_Field::now),
+				'ATT_short_bio' => new EE_Simple_HTML_Field('post_excerpt',
+					__("Attendee Short Biography", "event_espresso"), true,
+					__("No Biography Provided", "event_espresso")),
+				'ATT_modified'  => new EE_Datetime_Field('post_modified',
+					__("Time Attendee Last Modified", "event_espresso"), false, EE_Datetime_Field::now),
+				'ATT_author'    => new EE_WP_User_Field('post_author',
+					__("Creator ID of the first Event attended", "event_espresso"), false),
+				'ATT_parent'    => new EE_DB_Only_Int_Field('post_parent',
+					__("Parent Attendee (unused)", "event_espresso"), false, 0),
+				'post_type'     => new EE_WP_Post_Type_Field('espresso_attendees'),
+				// EE_DB_Only_Text_Field('post_type', __("Post Type of Attendee", "event_espresso"), false,'espresso_attendees'),
+				'status'        => new EE_WP_Post_Status_Field('post_status', __('Attendee Status', 'event_espresso'),
+					false, 'publish'),
+			),
+			'Attendee_Meta' => array(
+				'ATTM_ID'      => new EE_DB_Only_Int_Field('ATTM_ID', __('Attendee Meta Row ID', 'event_espresso'),
+					false),
+				'ATT_ID_fk'    => new EE_DB_Only_Int_Field('ATT_ID',
+					__("Foreign Key to Attendee in Post Table", "event_espresso"), false),
+				'ATT_fname'    => new EE_Plain_Text_Field('ATT_fname', __('First Name', 'event_espresso'), true, ''),
+				'ATT_lname'    => new EE_Plain_Text_Field('ATT_lname', __('Last Name', 'event_espresso'), true, ''),
+				'ATT_address'  => new EE_Plain_Text_Field('ATT_address', __('Address Part 1', 'event_espresso'), true,
+					''),
+				'ATT_address2' => new EE_Plain_Text_Field('ATT_address2', __('Address Part 2', 'event_espresso'), true,
+					''),
+				'ATT_city'     => new EE_Plain_Text_Field('ATT_city', __('City', 'event_espresso'), true, ''),
+				'STA_ID'       => new EE_Foreign_Key_Int_Field('STA_ID', __('State', 'event_espresso'), true, 0,
+					'State'),
+				'CNT_ISO'      => new EE_Foreign_Key_String_Field('CNT_ISO', __('Country', 'event_espresso'), true, '',
+					'Country'),
+				'ATT_zip'      => new EE_Plain_Text_Field('ATT_zip', __('ZIP/Postal Code', 'event_espresso'), true, ''),
+				'ATT_email'    => new EE_Email_Field('ATT_email', __('Email Address', 'event_espresso'), true, ''),
+				'ATT_phone'    => new EE_Plain_Text_Field('ATT_phone', __('Phone', 'event_espresso'), true, ''),
+			),
+		);
+		$this->_model_relations = array(
+			'Registration'      => new EE_Has_Many_Relation(),
+			'State'             => new EE_Belongs_To_Relation(),
+			'Country'           => new EE_Belongs_To_Relation(),
+			'Event'             => new EE_HABTM_Relation('Registration', false),
+			'WP_User'           => new EE_Belongs_To_Relation(),
+			'Message'           => new EE_Has_Many_Any_Relation(false),
+			//allow deletion of attendees even if they have messages in the queue for them.
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
+		);
+		$this->_caps_slug = 'contacts';
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Gets the name of the field on the attendee model corresponding to the system question string
+	 * which should be one of the keys from EEM_Attendee::_system_question_to_attendee_field_name
+	 *
+	 * @param string $system_question_string
+	 * @return string|null if not found
+	 */
+	public function get_attendee_field_for_system_question($system_question_string)
+	{
+		return isset($this->_system_question_to_attendee_field_name[$system_question_string])
+			? $this->_system_question_to_attendee_field_name[$system_question_string] : null;
+	}
+
+
+
+	/**
+	 * Gets all the attendees for a transaction (by using the esp_registration as a join table)
+	 *
+	 * @param EE_Transaction /int $transaction_id_or_obj EE_Transaction or its ID
+	 * @return EE_Attendee[]
+	 */
+	public function get_attendees_for_transaction($transaction_id_or_obj)
+	{
+		return $this->get_all(array(
+			array(
+				'Registration.Transaction.TXN_ID' => $transaction_id_or_obj instanceof EE_Transaction
+					? $transaction_id_or_obj->ID() : $transaction_id_or_obj,
+			),
+		));
+	}
+
+
+
+	/**
+	 *        retrieve  a single attendee from db via their ID
+	 *
+	 * @access        public
+	 * @param        $ATT_ID
+	 * @return        mixed        array on success, FALSE on fail
+	 * @deprecated
+	 */
+	public function get_attendee_by_ID($ATT_ID = false)
+	{
+		// retrieve a particular EE_Attendee
+		return $this->get_one_by_ID($ATT_ID);
+	}
+
+
+
+	/**
+	 *        retrieve  a single attendee from db via their ID
+	 *
+	 * @access        public
+	 * @param        array $where_cols_n_values
+	 * @return        mixed        array on success, FALSE on fail
+	 */
+	public function get_attendee($where_cols_n_values = array())
+	{
+		if (empty($where_cols_n_values)) {
+			return false;
+		}
+		$attendee = $this->get_all(array($where_cols_n_values));
+		if ( ! empty($attendee)) {
+			return array_shift($attendee);
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 *        Search for an existing Attendee record in the DB
+	 *
+	 * @access        public
+	 * @param array $where_cols_n_values
+	 * @return bool|mixed
+	 */
+	public function find_existing_attendee($where_cols_n_values = null)
+	{
+		// search by combo of first and last names plus the email address
+		$attendee_data_keys = array(
+			'ATT_fname' => $this->_ATT_fname,
+			'ATT_lname' => $this->_ATT_lname,
+			'ATT_email' => $this->_ATT_email,
+		);
+		// no search params means attendee object already exists.
+		$where_cols_n_values = is_array($where_cols_n_values) && ! empty($where_cols_n_values) ? $where_cols_n_values
+			: $attendee_data_keys;
+		$valid_data = true;
+		// check for required values
+		$valid_data = isset($where_cols_n_values['ATT_fname']) && ! empty($where_cols_n_values['ATT_fname'])
+			? $valid_data : false;
+		$valid_data = isset($where_cols_n_values['ATT_lname']) && ! empty($where_cols_n_values['ATT_lname'])
+			? $valid_data : false;
+		$valid_data = isset($where_cols_n_values['ATT_email']) && ! empty($where_cols_n_values['ATT_email'])
+			? $valid_data : false;
+		if ($valid_data) {
+			$attendee = $this->get_attendee($where_cols_n_values);
+			if ($attendee instanceof EE_Attendee) {
+				return $attendee;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Takes an incoming array of EE_Registration ids and sends back a list of corresponding non duplicate
+	 * EE_Attendee objects.
+	 *
+	 * @since    4.3.0
+	 * @param  array $ids array of EE_Registration ids
+	 * @return  EE_Attendee[]
+	 */
+	public function get_array_of_contacts_from_reg_ids($ids)
+	{
+		$ids = (array)$ids;
+		$_where = array(
+			'Registration.REG_ID' => array('in', $ids),
+		);
+		return $this->get_all(array($_where));
+	}
 
 
 }

Spacing +2 added lines, -2 removed lines

@@ -1,7 +1,7 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
-require_once(EE_MODELS . 'EEM_Base.model.php');
+require_once(EE_MODELS.'EEM_Base.model.php');
 
 
 
@@ -322,7 +322,7 @@ 
      */
     public function get_array_of_contacts_from_reg_ids($ids)
     {
-        $ids = (array)$ids;
+        $ids = (array) $ids;
         $_where = array(
             'Registration.REG_ID' => array('in', $ids),
         );

core/helpers/EEH_Activation.helper.php

Doc Comments +3 added lines, -3 removed lines

@@ -620,7 +620,7 @@ 
      *
      * @since  4.6.0
      * @global WPDB $wpdb
-     * @return mixed null|int WP_user ID or NULL
+     * @return integer|null null|int WP_user ID or NULL
      */
     public static function get_default_creator_id()
     {
@@ -785,7 +785,7 @@ 
 	 * @static
 	 * @deprecated instead use TableManager::dropTable()
 	 * @param string $table_name
-	 * @return bool | int
+	 * @return integer | int
 	 */
 	public static function delete_unused_db_table( $table_name ) {
 		return \EEH_Activation::getTableManager()->dropTable( $table_name );
@@ -801,7 +801,7 @@ 
 	 * @deprecated instead use TableManager::dropIndex()
 	 * @param string $table_name
 	 * @param string $index_name
-	 * @return bool | int
+	 * @return integer | int
 	 */
 	public static function drop_index( $table_name, $index_name ) {
 		return \EEH_Activation::getTableManager()->dropIndex( $table_name, $index_name );

Indentation +915 added lines, -915 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -14,36 +14,36 @@ 
 class EEH_Activation
 {
 
-    /**
-     * constant used to indicate a cron task is no longer in use
-     */
-    const cron_task_no_longer_in_use = 'no_longer_in_use';
-
-    /**
-     * option name that will indicate whether or not we still
-     * need to create EE's folders in the uploads directory
-     * (because if EE was installed without file system access,
-     * we need to request credentials before we can create them)
-     */
-    const upload_directories_incomplete_option_name = 'ee_upload_directories_incomplete';
-
-    /**
-     * WP_User->ID
-     *
-     * @var int
-     */
-    private static $_default_creator_id;
-
-    /**
-     * indicates whether or not we've already verified core's default data during this request,
-     * because after migrations are done, any addons activated while in maintenance mode
-     * will want to setup their own default data, and they might hook into core's default data
-     * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
-     * This prevents doing that for EVERY single addon.
-     *
-     * @var boolean
-     */
-    protected static $_initialized_db_content_already_in_this_request = false;
+	/**
+	 * constant used to indicate a cron task is no longer in use
+	 */
+	const cron_task_no_longer_in_use = 'no_longer_in_use';
+
+	/**
+	 * option name that will indicate whether or not we still
+	 * need to create EE's folders in the uploads directory
+	 * (because if EE was installed without file system access,
+	 * we need to request credentials before we can create them)
+	 */
+	const upload_directories_incomplete_option_name = 'ee_upload_directories_incomplete';
+
+	/**
+	 * WP_User->ID
+	 *
+	 * @var int
+	 */
+	private static $_default_creator_id;
+
+	/**
+	 * indicates whether or not we've already verified core's default data during this request,
+	 * because after migrations are done, any addons activated while in maintenance mode
+	 * will want to setup their own default data, and they might hook into core's default data
+	 * and trigger core to setup its default data. In which case they might all ask for core to init its default data.
+	 * This prevents doing that for EVERY single addon.
+	 *
+	 * @var boolean
+	 */
+	protected static $_initialized_db_content_already_in_this_request = false;
 
 	/**
 	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
@@ -258,7 +258,7 @@ 
 			if ( is_array( $hooks_to_fire_at_time ) ) {
 				foreach ( $hooks_to_fire_at_time as $hook_name => $hook_actions ) {
 					if ( isset( $ee_cron_tasks_to_remove[ $hook_name ] )
-					     && is_array( $ee_cron_tasks_to_remove[ $hook_name ] )
+						 && is_array( $ee_cron_tasks_to_remove[ $hook_name ] )
 					) {
 						unset( $crons[ $timestamp ][ $hook_name ] );
 					}
@@ -290,26 +290,26 @@ 
 
 
 
-    /**
-     *    reset_and_update_config
-     * The following code was moved over from EE_Config so that it will no longer run on every request.
-     * If there is old calendar config data saved, then it will get converted on activation.
-     * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function reset_and_update_config()
-    {
-        do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
-        add_filter('FHEE__EE_Config___load_core_config__config_settings',
-            array('EEH_Activation', 'migrate_old_config_data'), 10, 3);
-        //EE_Config::reset();
-        if ( ! EE_Config::logging_enabled()) {
-            delete_option(EE_Config::LOG_NAME);
-        }
-    }
+	/**
+	 *    reset_and_update_config
+	 * The following code was moved over from EE_Config so that it will no longer run on every request.
+	 * If there is old calendar config data saved, then it will get converted on activation.
+	 * This was basically a DMS before we had DMS's, and will get removed after a few more versions.
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function reset_and_update_config()
+	{
+		do_action('AHEE__EE_Config___load_core_config__start', array('EEH_Activation', 'load_calendar_config'));
+		add_filter('FHEE__EE_Config___load_core_config__config_settings',
+			array('EEH_Activation', 'migrate_old_config_data'), 10, 3);
+		//EE_Config::reset();
+		if ( ! EE_Config::logging_enabled()) {
+			delete_option(EE_Config::LOG_NAME);
+		}
+	}
 
 
 	/**
@@ -349,34 +349,34 @@ 
 
 
 
-    /**
-     *    _migrate_old_config_data
-     *
-     * @access    public
-     * @param array|stdClass $settings
-     * @param string         $config
-     * @param \EE_Config     $EE_Config
-     * @return \stdClass
-     */
-    public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
-    {
-        $convert_from_array = array('addons');
-        // in case old settings were saved as an array
-        if (is_array($settings) && in_array($config, $convert_from_array)) {
-            // convert existing settings to an object
-            $config_array = $settings;
-            $settings = new stdClass();
-            foreach ($config_array as $key => $value) {
-                if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
-                    $EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
-                } else {
-                    $settings->{$key} = $value;
-                }
-            }
-            add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
-        }
-        return $settings;
-    }
+	/**
+	 *    _migrate_old_config_data
+	 *
+	 * @access    public
+	 * @param array|stdClass $settings
+	 * @param string         $config
+	 * @param \EE_Config     $EE_Config
+	 * @return \stdClass
+	 */
+	public static function migrate_old_config_data($settings = array(), $config = '', EE_Config $EE_Config)
+	{
+		$convert_from_array = array('addons');
+		// in case old settings were saved as an array
+		if (is_array($settings) && in_array($config, $convert_from_array)) {
+			// convert existing settings to an object
+			$config_array = $settings;
+			$settings = new stdClass();
+			foreach ($config_array as $key => $value) {
+				if ($key === 'calendar' && class_exists('EE_Calendar_Config')) {
+					$EE_Config->set_config('addons', 'EE_Calendar', 'EE_Calendar_Config', $value);
+				} else {
+					$settings->{$key} = $value;
+				}
+			}
+			add_filter('FHEE__EE_Config___load_core_config__update_espresso_config', '__return_true');
+		}
+		return $settings;
+	}
 
 
 
@@ -398,130 +398,130 @@ 
 
 
 
-    /**
-     * verify_default_pages_exist
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function verify_default_pages_exist()
-    {
-        $critical_page_problem = false;
-        $critical_pages = array(
-            array(
-                'id'   => 'reg_page_id',
-                'name' => __('Registration Checkout', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CHECKOUT',
-            ),
-            array(
-                'id'   => 'txn_page_id',
-                'name' => __('Transactions', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_TXN_PAGE',
-            ),
-            array(
-                'id'   => 'thank_you_page_id',
-                'name' => __('Thank You', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_THANK_YOU',
-            ),
-            array(
-                'id'   => 'cancel_page_id',
-                'name' => __('Registration Cancelled', 'event_espresso'),
-                'post' => null,
-                'code' => 'ESPRESSO_CANCELLED',
-            ),
-        );
-        $EE_Core_Config = EE_Registry::instance()->CFG->core;
-        foreach ($critical_pages as $critical_page) {
-            // is critical page ID set in config ?
-            if ($EE_Core_Config->{$critical_page['id']} !== false) {
-                // attempt to find post by ID
-                $critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
-            }
-            // no dice?
-            if ($critical_page['post'] === null) {
-                // attempt to find post by title
-                $critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
-                // still nothing?
-                if ($critical_page['post'] === null) {
-                    $critical_page = EEH_Activation::create_critical_page($critical_page);
-                    // REALLY? Still nothing ??!?!?
-                    if ($critical_page['post'] === null) {
-                        $msg = __('The Event Espresso critical page configuration settings could not be updated.',
-                            'event_espresso');
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        break;
-                    }
-                }
-            }
-            // track post_shortcodes
-            if ($critical_page['post']) {
-                EEH_Activation::_track_critical_page_post_shortcodes($critical_page);
-            }
-            // check that Post ID matches critical page ID in config
-            if (
-                isset($critical_page['post']->ID)
-                && $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
-            ) {
-                //update Config with post ID
-                $EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
-                if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
-                    $msg = __('The Event Espresso critical page configuration settings could not be updated.',
-                        'event_espresso');
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-            $critical_page_problem =
-                ! isset($critical_page['post']->post_status)
-                || $critical_page['post']->post_status !== 'publish'
-                || strpos($critical_page['post']->post_content, $critical_page['code']) === false
-                    ? true
-                    : $critical_page_problem;
-        }
-        if ($critical_page_problem) {
-            $msg = sprintf(
-                __('A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
-                    'event_espresso'),
-                '<a href="'
-                . admin_url('admin.php?page=espresso_general_settings&action=critical_pages')
-                . '">'
-                . __('Event Espresso Critical Pages Settings', 'event_espresso')
-                . '</a>'
-            );
-            EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
-        }
-        if (EE_Error::has_notices()) {
-            EE_Error::get_notices(false, true, true);
-        }
-    }
-
-
-
-    /**
-     * Returns the first post which uses the specified shortcode
-     *
-     * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
-     *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
-     *                             "[ESPRESSO_THANK_YOU"
-     *                             (we don't search for the closing shortcode bracket because they might have added
-     *                             parameter to the shortcode
-     * @return WP_Post or NULl
-     */
-    public static function get_page_by_ee_shortcode($ee_shortcode)
-    {
-        global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
-        $post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
-        if ($post_id) {
-            return get_post($post_id);
-        } else {
-            return null;
-        }
+	/**
+	 * verify_default_pages_exist
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function verify_default_pages_exist()
+	{
+		$critical_page_problem = false;
+		$critical_pages = array(
+			array(
+				'id'   => 'reg_page_id',
+				'name' => __('Registration Checkout', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CHECKOUT',
+			),
+			array(
+				'id'   => 'txn_page_id',
+				'name' => __('Transactions', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_TXN_PAGE',
+			),
+			array(
+				'id'   => 'thank_you_page_id',
+				'name' => __('Thank You', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_THANK_YOU',
+			),
+			array(
+				'id'   => 'cancel_page_id',
+				'name' => __('Registration Cancelled', 'event_espresso'),
+				'post' => null,
+				'code' => 'ESPRESSO_CANCELLED',
+			),
+		);
+		$EE_Core_Config = EE_Registry::instance()->CFG->core;
+		foreach ($critical_pages as $critical_page) {
+			// is critical page ID set in config ?
+			if ($EE_Core_Config->{$critical_page['id']} !== false) {
+				// attempt to find post by ID
+				$critical_page['post'] = get_post($EE_Core_Config->{$critical_page['id']});
+			}
+			// no dice?
+			if ($critical_page['post'] === null) {
+				// attempt to find post by title
+				$critical_page['post'] = self::get_page_by_ee_shortcode($critical_page['code']);
+				// still nothing?
+				if ($critical_page['post'] === null) {
+					$critical_page = EEH_Activation::create_critical_page($critical_page);
+					// REALLY? Still nothing ??!?!?
+					if ($critical_page['post'] === null) {
+						$msg = __('The Event Espresso critical page configuration settings could not be updated.',
+							'event_espresso');
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						break;
+					}
+				}
+			}
+			// track post_shortcodes
+			if ($critical_page['post']) {
+				EEH_Activation::_track_critical_page_post_shortcodes($critical_page);
+			}
+			// check that Post ID matches critical page ID in config
+			if (
+				isset($critical_page['post']->ID)
+				&& $critical_page['post']->ID !== $EE_Core_Config->{$critical_page['id']}
+			) {
+				//update Config with post ID
+				$EE_Core_Config->{$critical_page['id']} = $critical_page['post']->ID;
+				if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
+					$msg = __('The Event Espresso critical page configuration settings could not be updated.',
+						'event_espresso');
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+			$critical_page_problem =
+				! isset($critical_page['post']->post_status)
+				|| $critical_page['post']->post_status !== 'publish'
+				|| strpos($critical_page['post']->post_content, $critical_page['code']) === false
+					? true
+					: $critical_page_problem;
+		}
+		if ($critical_page_problem) {
+			$msg = sprintf(
+				__('A potential issue has been detected with one or more of your Event Espresso pages. Go to %s to view your Event Espresso pages.',
+					'event_espresso'),
+				'<a href="'
+				. admin_url('admin.php?page=espresso_general_settings&action=critical_pages')
+				. '">'
+				. __('Event Espresso Critical Pages Settings', 'event_espresso')
+				. '</a>'
+			);
+			EE_Error::add_persistent_admin_notice('critical_page_problem', $msg);
+		}
+		if (EE_Error::has_notices()) {
+			EE_Error::get_notices(false, true, true);
+		}
+	}
+
+
+
+	/**
+	 * Returns the first post which uses the specified shortcode
+	 *
+	 * @param string $ee_shortcode usually one of the critical pages shortcodes, eg
+	 *                             ESPRESSO_THANK_YOU. So we will search fora post with the content
+	 *                             "[ESPRESSO_THANK_YOU"
+	 *                             (we don't search for the closing shortcode bracket because they might have added
+	 *                             parameter to the shortcode
+	 * @return WP_Post or NULl
+	 */
+	public static function get_page_by_ee_shortcode($ee_shortcode)
+	{
+		global $wpdb;
+		$shortcode_and_opening_bracket = '[' . $ee_shortcode;
+		$post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
+		if ($post_id) {
+			return get_post($post_id);
+		} else {
+			return null;
+		}
 //		return $post_id;
-    }
+	}
 
 
 
@@ -569,163 +569,163 @@ 
 
 
 
-    /**
-     *    This function adds a critical page's shortcode to the post_shortcodes array
-     *
-     * @access private
-     * @static
-     * @param array $critical_page
-     * @return void
-     */
-    private static function _track_critical_page_post_shortcodes($critical_page = array())
-    {
-        // check the goods
-        if ( ! $critical_page['post'] instanceof WP_Post) {
-            $msg = sprintf(
-                __('The Event Espresso critical page shortcode for the page %s can not be tracked because it is not a WP_Post object.',
-                    'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return;
-        }
-        $EE_Core_Config = EE_Registry::instance()->CFG->core;
-        // map shortcode to post
-        $EE_Core_Config->post_shortcodes[$critical_page['post']->post_name][$critical_page['code']] = $critical_page['post']->ID;
-        // and make sure it's NOT added to the WP "Posts Page"
-        // name of the WP Posts Page
-        $posts_page = EE_Config::get_page_for_posts();
-        if (isset($EE_Core_Config->post_shortcodes[$posts_page])) {
-            unset($EE_Core_Config->post_shortcodes[$posts_page][$critical_page['code']]);
-        }
-        if ($posts_page !== 'posts' && isset($EE_Core_Config->post_shortcodes['posts'])) {
-            unset($EE_Core_Config->post_shortcodes['posts'][$critical_page['code']]);
-        }
-        // update post_shortcode CFG
-        if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
-            $msg = sprintf(
-                __('The Event Espresso critical page shortcode for the %s page could not be configured properly.',
-                    'event_espresso'),
-                $critical_page['name']
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-
-    /**
-     * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
-     * The role being used to check is filterable.
-     *
-     * @since  4.6.0
-     * @global WPDB $wpdb
-     * @return mixed null|int WP_user ID or NULL
-     */
-    public static function get_default_creator_id()
-    {
-        global $wpdb;
-        if ( ! empty(self::$_default_creator_id)) {
-            return self::$_default_creator_id;
-        }/**/
-        $role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
-        //let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
-        $pre_filtered_id = apply_filters('FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id', false,
-            $role_to_check);
-        if ($pre_filtered_id !== false) {
-            return (int)$pre_filtered_id;
-        }
-        $capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
-        $query = $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%');
-        $user_id = $wpdb->get_var($query);
-        $user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
-        if ($user_id && (int)$user_id) {
-            self::$_default_creator_id = (int)$user_id;
-            return self::$_default_creator_id;
-        } else {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * used by EE and EE addons during plugin activation to create tables.
-     * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
-     * but includes extra logic regarding activations.
-     *
-     * @access public
-     * @static
-     * @param string  $table_name              without the $wpdb->prefix
-     * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
-     *                                         table query)
-     * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
-     * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
-     *                                         and new once this function is done (ie, you really do want to CREATE a
-     *                                         table, and expect it to be empty once you're done) leave as FALSE when
-     *                                         you just want to verify the table exists and matches this definition
-     *                                         (and if it HAS data in it you want to leave it be)
-     * @return void
-     * @throws EE_Error if there are database errors
-     */
-    public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
-    {
-        if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
-            return;
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        if ( ! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
-        }
-        $tableAnalysis = \EEH_Activation::getTableAnalysis();
-        $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
-        // do we need to first delete an existing version of this table ?
-        if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
-            // ok, delete the table... but ONLY if it's empty
-            $deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
-            // table is NOT empty, are you SURE you want to delete this table ???
-            if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
-                \EEH_Activation::getTableManager()->dropTable($wp_table_name);
-            } else if ( ! $deleted_safely) {
-                // so we should be more cautious rather than just dropping tables so easily
-                EE_Error::add_persistent_admin_notice(
-                    'bad_table_' . $wp_table_name . '_detected',
-                    sprintf(__('Database table %1$s exists when it shouldn\'t, and may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend adding %2$s to your %3$s file then restore to that backup again. This will clear out the invalid data from %1$s. Afterwards you should undo that change from your %3$s file. %4$sIf you cannot edit %3$s, you should remove the data from %1$s manually then restore to the backup again.',
-                        'event_espresso'),
-                        $wp_table_name,
-                        "<pre>define( 'EE_DROP_BAD_TABLES', TRUE );</pre>",
-                        '<b>wp-config.php</b>',
-                        '<br/>'),
-                    true);
-            }
-        }
-        $engine = str_replace('ENGINE=', '', $engine);
-        \EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
-    }
-
-
-
-    /**
-     *    add_column_if_it_doesn't_exist
-     *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
-     *
-     * @access     public
-     * @static
-     * @deprecated instead use TableManager::addColumn()
-     * @param string $table_name  (without "wp_", eg "esp_attendee"
-     * @param string $column_name
-     * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
-     *                            'VARCHAR(10)'
-     * @return bool|int
-     */
-    public static function add_column_if_it_doesnt_exist(
-        $table_name,
-        $column_name,
-        $column_info = 'INT UNSIGNED NOT NULL'
-    ) {
-        return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
-    }
+	/**
+	 *    This function adds a critical page's shortcode to the post_shortcodes array
+	 *
+	 * @access private
+	 * @static
+	 * @param array $critical_page
+	 * @return void
+	 */
+	private static function _track_critical_page_post_shortcodes($critical_page = array())
+	{
+		// check the goods
+		if ( ! $critical_page['post'] instanceof WP_Post) {
+			$msg = sprintf(
+				__('The Event Espresso critical page shortcode for the page %s can not be tracked because it is not a WP_Post object.',
+					'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return;
+		}
+		$EE_Core_Config = EE_Registry::instance()->CFG->core;
+		// map shortcode to post
+		$EE_Core_Config->post_shortcodes[$critical_page['post']->post_name][$critical_page['code']] = $critical_page['post']->ID;
+		// and make sure it's NOT added to the WP "Posts Page"
+		// name of the WP Posts Page
+		$posts_page = EE_Config::get_page_for_posts();
+		if (isset($EE_Core_Config->post_shortcodes[$posts_page])) {
+			unset($EE_Core_Config->post_shortcodes[$posts_page][$critical_page['code']]);
+		}
+		if ($posts_page !== 'posts' && isset($EE_Core_Config->post_shortcodes['posts'])) {
+			unset($EE_Core_Config->post_shortcodes['posts'][$critical_page['code']]);
+		}
+		// update post_shortcode CFG
+		if ( ! EE_Config::instance()->update_espresso_config(false, false)) {
+			$msg = sprintf(
+				__('The Event Espresso critical page shortcode for the %s page could not be configured properly.',
+					'event_espresso'),
+				$critical_page['name']
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+
+	/**
+	 * Tries to find the oldest admin for this site.  If there are no admins for this site then return NULL.
+	 * The role being used to check is filterable.
+	 *
+	 * @since  4.6.0
+	 * @global WPDB $wpdb
+	 * @return mixed null|int WP_user ID or NULL
+	 */
+	public static function get_default_creator_id()
+	{
+		global $wpdb;
+		if ( ! empty(self::$_default_creator_id)) {
+			return self::$_default_creator_id;
+		}/**/
+		$role_to_check = apply_filters('FHEE__EEH_Activation__get_default_creator_id__role_to_check', 'administrator');
+		//let's allow pre_filtering for early exits by alternative methods for getting id.  We check for truthy result and if so then exit early.
+		$pre_filtered_id = apply_filters('FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id', false,
+			$role_to_check);
+		if ($pre_filtered_id !== false) {
+			return (int)$pre_filtered_id;
+		}
+		$capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
+		$query = $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
+			'%' . $role_to_check . '%');
+		$user_id = $wpdb->get_var($query);
+		$user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
+		if ($user_id && (int)$user_id) {
+			self::$_default_creator_id = (int)$user_id;
+			return self::$_default_creator_id;
+		} else {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * used by EE and EE addons during plugin activation to create tables.
+	 * Its a wrapper for EventEspresso\core\services\database\TableManager::createTable,
+	 * but includes extra logic regarding activations.
+	 *
+	 * @access public
+	 * @static
+	 * @param string  $table_name              without the $wpdb->prefix
+	 * @param string  $sql                     SQL for creating the table (contents between brackets in an SQL create
+	 *                                         table query)
+	 * @param string  $engine                  like 'ENGINE=MyISAM' or 'ENGINE=InnoDB'
+	 * @param boolean $drop_pre_existing_table set to TRUE when you want to make SURE the table is completely empty
+	 *                                         and new once this function is done (ie, you really do want to CREATE a
+	 *                                         table, and expect it to be empty once you're done) leave as FALSE when
+	 *                                         you just want to verify the table exists and matches this definition
+	 *                                         (and if it HAS data in it you want to leave it be)
+	 * @return void
+	 * @throws EE_Error if there are database errors
+	 */
+	public static function create_table($table_name, $sql, $engine = 'ENGINE=MyISAM ', $drop_pre_existing_table = false)
+	{
+		if (apply_filters('FHEE__EEH_Activation__create_table__short_circuit', false, $table_name, $sql)) {
+			return;
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		if ( ! function_exists('dbDelta')) {
+			require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+		}
+		$tableAnalysis = \EEH_Activation::getTableAnalysis();
+		$wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
+		// do we need to first delete an existing version of this table ?
+		if ($drop_pre_existing_table && $tableAnalysis->tableExists($wp_table_name)) {
+			// ok, delete the table... but ONLY if it's empty
+			$deleted_safely = EEH_Activation::delete_db_table_if_empty($wp_table_name);
+			// table is NOT empty, are you SURE you want to delete this table ???
+			if ( ! $deleted_safely && defined('EE_DROP_BAD_TABLES') && EE_DROP_BAD_TABLES) {
+				\EEH_Activation::getTableManager()->dropTable($wp_table_name);
+			} else if ( ! $deleted_safely) {
+				// so we should be more cautious rather than just dropping tables so easily
+				EE_Error::add_persistent_admin_notice(
+					'bad_table_' . $wp_table_name . '_detected',
+					sprintf(__('Database table %1$s exists when it shouldn\'t, and may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend adding %2$s to your %3$s file then restore to that backup again. This will clear out the invalid data from %1$s. Afterwards you should undo that change from your %3$s file. %4$sIf you cannot edit %3$s, you should remove the data from %1$s manually then restore to the backup again.',
+						'event_espresso'),
+						$wp_table_name,
+						"<pre>define( 'EE_DROP_BAD_TABLES', TRUE );</pre>",
+						'<b>wp-config.php</b>',
+						'<br/>'),
+					true);
+			}
+		}
+		$engine = str_replace('ENGINE=', '', $engine);
+		\EEH_Activation::getTableManager()->createTable($table_name, $sql, $engine);
+	}
+
+
+
+	/**
+	 *    add_column_if_it_doesn't_exist
+	 *    Checks if this column already exists on the specified table. Handy for addons which want to add a column
+	 *
+	 * @access     public
+	 * @static
+	 * @deprecated instead use TableManager::addColumn()
+	 * @param string $table_name  (without "wp_", eg "esp_attendee"
+	 * @param string $column_name
+	 * @param string $column_info if your SQL were 'ALTER TABLE table_name ADD price VARCHAR(10)', this would be
+	 *                            'VARCHAR(10)'
+	 * @return bool|int
+	 */
+	public static function add_column_if_it_doesnt_exist(
+		$table_name,
+		$column_name,
+		$column_info = 'INT UNSIGNED NOT NULL'
+	) {
+		return \EEH_Activation::getTableManager()->addColumn($table_name, $column_name, $column_info);
+	}
 
 
 
@@ -762,13 +762,13 @@ 
 
 
 /**
-	 * delete_db_table_if_empty
-	 *
-	 * @access public
-	 * @static
-	 * @param string $table_name
-	 * @return bool | int
-	 */
+ * delete_db_table_if_empty
+ *
+ * @access public
+ * @static
+ * @param string $table_name
+ * @return bool | int
+ */
 	public static function delete_db_table_if_empty( $table_name ) {
 		if ( \EEH_Activation::getTableAnalysis()->tableIsEmpty( $table_name ) ) {
 			return \EEH_Activation::getTableManager()->dropTable( $table_name );
@@ -809,344 +809,344 @@ 
 
 
 
-    /**
-     * create_database_tables
-     *
-     * @access public
-     * @static
-     * @throws EE_Error
-     * @return boolean success (whether database is setup properly or not)
-     */
-    public static function create_database_tables()
-    {
-        EE_Registry::instance()->load_core('Data_Migration_Manager');
-        //find the migration script that sets the database to be compatible with the code
-        $dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
-        if ($dms_name) {
-            $current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                if (WP_DEBUG) {
-                    foreach ($current_data_migration_script->get_errors() as $error) {
-                        EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                    }
-                } else {
-                    EE_Error::add_error(__('There were errors creating the Event Espresso database tables and Event Espresso has been deactivated. To view the errors, please enable WP_DEBUG in your wp-config.php file.',
-                        'event_espresso'));
-                }
-                return false;
-            }
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to();
-        } else {
-            EE_Error::add_error(__('Could not determine most up-to-date data migration script from which to pull database schema structure. So database is probably not setup properly',
-                'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return true;
-    }
-
-
-
-    /**
-     * initialize_system_questions
-     *
-     * @access public
-     * @static
-     * @return void
-     */
-    public static function initialize_system_questions()
-    {
-        // QUESTION GROUPS
-        global $wpdb;
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
-        $SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
-        // what we have
-        $question_groups = $wpdb->get_col($SQL);
-        // check the response
-        $question_groups = is_array($question_groups) ? $question_groups : array();
-        // what we should have
-        $QSG_systems = array(1, 2);
-        // loop thru what we should have and compare to what we have
-        foreach ($QSG_systems as $QSG_system) {
-            // reset values array
-            $QSG_values = array();
-            // if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
-            if ( ! in_array("$QSG_system", $question_groups)) {
-                // add it
-                switch ($QSG_system) {
-                    case 1:
-                        $QSG_values = array(
-                            'QSG_name'            => __('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 1,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_personal,
-                            'QSG_deleted'         => 0,
-                        );
-                        break;
-                    case 2:
-                        $QSG_values = array(
-                            'QSG_name'            => __('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
-                            'QSG_desc'            => '',
-                            'QSG_order'           => 2,
-                            'QSG_show_group_name' => 1,
-                            'QSG_show_group_desc' => 1,
-                            'QSG_system'          => EEM_Question_Group::system_address,
-                            'QSG_deleted'         => 0,
-                        );
-                        break;
-                }
-                // make sure we have some values before inserting them
-                if ( ! empty($QSG_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QSG_values,
-                        array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
-                    );
-                    $QSG_IDs[$QSG_system] = $wpdb->insert_id;
-                }
-            }
-        }
-        // QUESTIONS
-        global $wpdb;
-        $table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
-        $SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
-        // what we have
-        $questions = $wpdb->get_col($SQL);
-        // what we should have
-        $QST_systems = array(
-            'fname',
-            'lname',
-            'email',
-            'address',
-            'address2',
-            'city',
-            'country',
-            'state',
-            'zip',
-            'phone',
-        );
-        $order_for_group_1 = 1;
-        $order_for_group_2 = 1;
-        // loop thru what we should have and compare to what we have
-        foreach ($QST_systems as $QST_system) {
-            // reset values array
-            $QST_values = array();
-            // if we don't have what we should have
-            if ( ! in_array($QST_system, $questions)) {
-                // add it
-                switch ($QST_system) {
-                    case 'fname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('First Name', 'event_espresso'),
-                            'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'fname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 1,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'lname':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Last Name', 'event_espresso'),
-                            'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
-                            'QST_system'        => 'lname',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 2,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'email':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Email Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'email',
-                            'QST_type'          => 'EMAIL',
-                            'QST_required'      => 1,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 3,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'address':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address', 'event_espresso'),
-                            'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
-                            'QST_system'        => 'address',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 4,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'address2':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Address2', 'event_espresso'),
-                            'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
-                            'QST_system'        => 'address2',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 5,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'city':
-                        $QST_values = array(
-                            'QST_display_text'  => __('City', 'event_espresso'),
-                            'QST_admin_label'   => __('City - System Question', 'event_espresso'),
-                            'QST_system'        => 'city',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 6,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'country' :
-                        $QST_values = array(
-                            'QST_display_text'  => __('Country', 'event_espresso'),
-                            'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
-                            'QST_system'        => 'country',
-                            'QST_type'          => 'COUNTRY',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 7,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'state':
-                        $QST_values = array(
-                            'QST_display_text'  => __('State/Province', 'event_espresso'),
-                            'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
-                            'QST_system'        => 'state',
-                            'QST_type'          => 'STATE',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 8,
-                            'QST_admin_only'    => 0,
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'zip':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
-                            'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
-                            'QST_system'        => 'zip',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 9,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                    case 'phone':
-                        $QST_values = array(
-                            'QST_display_text'  => __('Phone Number', 'event_espresso'),
-                            'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
-                            'QST_system'        => 'phone',
-                            'QST_type'          => 'TEXT',
-                            'QST_required'      => 0,
-                            'QST_required_text' => __('This field is required', 'event_espresso'),
-                            'QST_order'         => 10,
-                            'QST_admin_only'    => 0,
-                            'QST_max'           => EEM_Question::instance()
-                                                               ->absolute_max_for_system_question($QST_system),
-                            'QST_wp_user'       => self::get_default_creator_id(),
-                            'QST_deleted'       => 0,
-                        );
-                        break;
-                }
-                if ( ! empty($QST_values)) {
-                    // insert system question
-                    $wpdb->insert(
-                        $table_name,
-                        $QST_values,
-                        array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
-                    );
-                    $QST_ID = $wpdb->insert_id;
-                    // QUESTION GROUP QUESTIONS
-                    if (in_array($QST_system, array('fname', 'lname', 'email'))) {
-                        $system_question_we_want = EEM_Question_Group::system_personal;
-                    } else {
-                        $system_question_we_want = EEM_Question_Group::system_address;
-                    }
-                    if (isset($QSG_IDs[$system_question_we_want])) {
-                        $QSG_ID = $QSG_IDs[$system_question_we_want];
-                    } else {
-                        $id_col = EEM_Question_Group::instance()
-                                                    ->get_col(array(array('QSG_system' => $system_question_we_want)));
-                        if (is_array($id_col)) {
-                            $QSG_ID = reset($id_col);
-                        } else {
-                            //ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
-                            EE_Log::instance()->log(
-                                __FILE__,
-                                __FUNCTION__,
-                                sprintf(
-                                    __('Could not associate question %1$s to a question group because no system question group existed',
-                                        'event_espresso'),
-                                    $QST_ID),
-                                'error');
-                            continue;
-                        }
-                    }
-                    // add system questions to groups
-                    $wpdb->insert(
-                        \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
-                        array(
-                            'QSG_ID'    => $QSG_ID,
-                            'QST_ID'    => $QST_ID,
-                            'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
-                        ),
-                        array('%d', '%d', '%d')
-                    );
-                }
-            }
-        }
-    }
+	/**
+	 * create_database_tables
+	 *
+	 * @access public
+	 * @static
+	 * @throws EE_Error
+	 * @return boolean success (whether database is setup properly or not)
+	 */
+	public static function create_database_tables()
+	{
+		EE_Registry::instance()->load_core('Data_Migration_Manager');
+		//find the migration script that sets the database to be compatible with the code
+		$dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms();
+		if ($dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				if (WP_DEBUG) {
+					foreach ($current_data_migration_script->get_errors() as $error) {
+						EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+					}
+				} else {
+					EE_Error::add_error(__('There were errors creating the Event Espresso database tables and Event Espresso has been deactivated. To view the errors, please enable WP_DEBUG in your wp-config.php file.',
+						'event_espresso'));
+				}
+				return false;
+			}
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to();
+		} else {
+			EE_Error::add_error(__('Could not determine most up-to-date data migration script from which to pull database schema structure. So database is probably not setup properly',
+				'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * initialize_system_questions
+	 *
+	 * @access public
+	 * @static
+	 * @return void
+	 */
+	public static function initialize_system_questions()
+	{
+		// QUESTION GROUPS
+		global $wpdb;
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group');
+		$SQL = "SELECT QSG_system FROM $table_name WHERE QSG_system != 0";
+		// what we have
+		$question_groups = $wpdb->get_col($SQL);
+		// check the response
+		$question_groups = is_array($question_groups) ? $question_groups : array();
+		// what we should have
+		$QSG_systems = array(1, 2);
+		// loop thru what we should have and compare to what we have
+		foreach ($QSG_systems as $QSG_system) {
+			// reset values array
+			$QSG_values = array();
+			// if we don't have what we should have (but use $QST_system as as string because that's what we got from the db)
+			if ( ! in_array("$QSG_system", $question_groups)) {
+				// add it
+				switch ($QSG_system) {
+					case 1:
+						$QSG_values = array(
+							'QSG_name'            => __('Personal Information', 'event_espresso'),
+							'QSG_identifier'      => 'personal-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 1,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_personal,
+							'QSG_deleted'         => 0,
+						);
+						break;
+					case 2:
+						$QSG_values = array(
+							'QSG_name'            => __('Address Information', 'event_espresso'),
+							'QSG_identifier'      => 'address-information-' . time(),
+							'QSG_desc'            => '',
+							'QSG_order'           => 2,
+							'QSG_show_group_name' => 1,
+							'QSG_show_group_desc' => 1,
+							'QSG_system'          => EEM_Question_Group::system_address,
+							'QSG_deleted'         => 0,
+						);
+						break;
+				}
+				// make sure we have some values before inserting them
+				if ( ! empty($QSG_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QSG_values,
+						array('%s', '%s', '%s', '%d', '%d', '%d', '%d', '%d')
+					);
+					$QSG_IDs[$QSG_system] = $wpdb->insert_id;
+				}
+			}
+		}
+		// QUESTIONS
+		global $wpdb;
+		$table_name = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question');
+		$SQL = "SELECT QST_system FROM $table_name WHERE QST_system != ''";
+		// what we have
+		$questions = $wpdb->get_col($SQL);
+		// what we should have
+		$QST_systems = array(
+			'fname',
+			'lname',
+			'email',
+			'address',
+			'address2',
+			'city',
+			'country',
+			'state',
+			'zip',
+			'phone',
+		);
+		$order_for_group_1 = 1;
+		$order_for_group_2 = 1;
+		// loop thru what we should have and compare to what we have
+		foreach ($QST_systems as $QST_system) {
+			// reset values array
+			$QST_values = array();
+			// if we don't have what we should have
+			if ( ! in_array($QST_system, $questions)) {
+				// add it
+				switch ($QST_system) {
+					case 'fname':
+						$QST_values = array(
+							'QST_display_text'  => __('First Name', 'event_espresso'),
+							'QST_admin_label'   => __('First Name - System Question', 'event_espresso'),
+							'QST_system'        => 'fname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 1,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'lname':
+						$QST_values = array(
+							'QST_display_text'  => __('Last Name', 'event_espresso'),
+							'QST_admin_label'   => __('Last Name - System Question', 'event_espresso'),
+							'QST_system'        => 'lname',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 2,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'email':
+						$QST_values = array(
+							'QST_display_text'  => __('Email Address', 'event_espresso'),
+							'QST_admin_label'   => __('Email Address - System Question', 'event_espresso'),
+							'QST_system'        => 'email',
+							'QST_type'          => 'EMAIL',
+							'QST_required'      => 1,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 3,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'address':
+						$QST_values = array(
+							'QST_display_text'  => __('Address', 'event_espresso'),
+							'QST_admin_label'   => __('Address - System Question', 'event_espresso'),
+							'QST_system'        => 'address',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 4,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'address2':
+						$QST_values = array(
+							'QST_display_text'  => __('Address2', 'event_espresso'),
+							'QST_admin_label'   => __('Address2 - System Question', 'event_espresso'),
+							'QST_system'        => 'address2',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 5,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'city':
+						$QST_values = array(
+							'QST_display_text'  => __('City', 'event_espresso'),
+							'QST_admin_label'   => __('City - System Question', 'event_espresso'),
+							'QST_system'        => 'city',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 6,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'country' :
+						$QST_values = array(
+							'QST_display_text'  => __('Country', 'event_espresso'),
+							'QST_admin_label'   => __('Country - System Question', 'event_espresso'),
+							'QST_system'        => 'country',
+							'QST_type'          => 'COUNTRY',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 7,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'state':
+						$QST_values = array(
+							'QST_display_text'  => __('State/Province', 'event_espresso'),
+							'QST_admin_label'   => __('State/Province - System Question', 'event_espresso'),
+							'QST_system'        => 'state',
+							'QST_type'          => 'STATE',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 8,
+							'QST_admin_only'    => 0,
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'zip':
+						$QST_values = array(
+							'QST_display_text'  => __('Zip/Postal Code', 'event_espresso'),
+							'QST_admin_label'   => __('Zip/Postal Code - System Question', 'event_espresso'),
+							'QST_system'        => 'zip',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 9,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+					case 'phone':
+						$QST_values = array(
+							'QST_display_text'  => __('Phone Number', 'event_espresso'),
+							'QST_admin_label'   => __('Phone Number - System Question', 'event_espresso'),
+							'QST_system'        => 'phone',
+							'QST_type'          => 'TEXT',
+							'QST_required'      => 0,
+							'QST_required_text' => __('This field is required', 'event_espresso'),
+							'QST_order'         => 10,
+							'QST_admin_only'    => 0,
+							'QST_max'           => EEM_Question::instance()
+															   ->absolute_max_for_system_question($QST_system),
+							'QST_wp_user'       => self::get_default_creator_id(),
+							'QST_deleted'       => 0,
+						);
+						break;
+				}
+				if ( ! empty($QST_values)) {
+					// insert system question
+					$wpdb->insert(
+						$table_name,
+						$QST_values,
+						array('%s', '%s', '%s', '%s', '%d', '%s', '%d', '%d', '%d', '%d')
+					);
+					$QST_ID = $wpdb->insert_id;
+					// QUESTION GROUP QUESTIONS
+					if (in_array($QST_system, array('fname', 'lname', 'email'))) {
+						$system_question_we_want = EEM_Question_Group::system_personal;
+					} else {
+						$system_question_we_want = EEM_Question_Group::system_address;
+					}
+					if (isset($QSG_IDs[$system_question_we_want])) {
+						$QSG_ID = $QSG_IDs[$system_question_we_want];
+					} else {
+						$id_col = EEM_Question_Group::instance()
+													->get_col(array(array('QSG_system' => $system_question_we_want)));
+						if (is_array($id_col)) {
+							$QSG_ID = reset($id_col);
+						} else {
+							//ok so we didn't find it in the db either?? that's weird because we should have inserted it at the start of this method
+							EE_Log::instance()->log(
+								__FILE__,
+								__FUNCTION__,
+								sprintf(
+									__('Could not associate question %1$s to a question group because no system question group existed',
+										'event_espresso'),
+									$QST_ID),
+								'error');
+							continue;
+						}
+					}
+					// add system questions to groups
+					$wpdb->insert(
+						\EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('esp_question_group_question'),
+						array(
+							'QSG_ID'    => $QSG_ID,
+							'QST_ID'    => $QST_ID,
+							'QGQ_order' => ($QSG_ID === 1) ? $order_for_group_1++ : $order_for_group_2++,
+						),
+						array('%d', '%d', '%d')
+					);
+				}
+			}
+		}
+	}
 
 
 
@@ -1332,111 +1332,111 @@ 
 
 
 
-    /**
-     * @param \EE_Message_Resource_Manager $message_resource_manager
-     * @return array|bool
-     * @throws \EE_Error
-     */
-    protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $active_messengers */
-        $active_messengers = $message_resource_manager->active_messengers();
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_created = false;
-        foreach ($active_messengers as $active_messenger) {
-            $default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
-            $default_message_type_names_to_activate = array();
-            // looping through each default message type reported by the messenger
-            // and setup the actual message types to activate.
-            foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
-                // if already active or has already been activated before we skip
-                // (otherwise we might reactivate something user's intentionally deactivated.)
-                // we also skip if the message type is not installed.
-                if (
-                    $message_resource_manager->has_message_type_been_activated_for_messenger($default_message_type_name_for_messenger,
-                        $active_messenger->name)
-                    || $message_resource_manager->is_message_type_active_for_messenger(
-                        $active_messenger->name,
-                        $default_message_type_name_for_messenger
-                    )
-                    || ! isset($installed_message_types[$default_message_type_name_for_messenger])
-                ) {
-                    continue;
-                }
-                $default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
-            }
-            //let's activate!
-            $message_resource_manager->ensure_message_types_are_active(
-                $default_message_type_names_to_activate,
-                $active_messenger->name,
-                false
-            );
-            //activate the templates for these message types
-            if ( ! empty($default_message_type_names_to_activate)) {
-                $templates_created = EEH_MSG_Template::generate_new_templates(
-                    $active_messenger->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_created;
-    }
-
-
-
-    /**
-     * This will activate and generate default messengers and default message types for those messengers.
-     *
-     * @param EE_message_Resource_Manager $message_resource_manager
-     * @return array|bool  True means there were default messengers and message type templates generated.
-     *                     False means that there were no templates generated
-     *                     (which could simply mean there are no default message types for a messenger).
-     * @throws EE_Error
-     */
-    protected static function _activate_and_generate_default_messengers_and_message_templates(
-        EE_Message_Resource_Manager $message_resource_manager
-    ) {
-        /** @type EE_messenger[] $messengers_to_generate */
-        $messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
-        $installed_message_types = $message_resource_manager->installed_message_types();
-        $templates_generated = false;
-        foreach ($messengers_to_generate as $messenger_to_generate) {
-            $default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
-            //verify the default message types match an installed message type.
-            foreach ($default_message_type_names_for_messenger as $key => $name) {
-                if (
-                    ! isset($installed_message_types[$name])
-                    || $message_resource_manager->has_message_type_been_activated_for_messenger($name,
-                        $messenger_to_generate->name)
-                ) {
-                    unset($default_message_type_names_for_messenger[$key]);
-                }
-            }
-            // in previous iterations, the active_messengers option in the db
-            // needed updated before calling create templates. however with the changes this may not be necessary.
-            // This comment is left here just in case we discover that we _do_ need to update before
-            // passing off to create templates (after the refactor is done).
-            // @todo remove this comment when determined not necessary.
-            $message_resource_manager->activate_messenger(
-                $messenger_to_generate->name,
-                $default_message_type_names_for_messenger,
-                false
-            );
-            //create any templates needing created (or will reactivate templates already generated as necessary).
-            if ( ! empty($default_message_type_names_for_messenger)) {
-                $templates_generated = EEH_MSG_Template::generate_new_templates(
-                    $messenger_to_generate->name,
-                    $default_message_type_names_for_messenger,
-                    '',
-                    true
-                );
-            }
-        }
-        return $templates_generated;
-    }
+	/**
+	 * @param \EE_Message_Resource_Manager $message_resource_manager
+	 * @return array|bool
+	 * @throws \EE_Error
+	 */
+	protected static function _activate_new_message_types_for_active_messengers_and_generate_default_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $active_messengers */
+		$active_messengers = $message_resource_manager->active_messengers();
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_created = false;
+		foreach ($active_messengers as $active_messenger) {
+			$default_message_type_names_for_messenger = $active_messenger->get_default_message_types();
+			$default_message_type_names_to_activate = array();
+			// looping through each default message type reported by the messenger
+			// and setup the actual message types to activate.
+			foreach ($default_message_type_names_for_messenger as $default_message_type_name_for_messenger) {
+				// if already active or has already been activated before we skip
+				// (otherwise we might reactivate something user's intentionally deactivated.)
+				// we also skip if the message type is not installed.
+				if (
+					$message_resource_manager->has_message_type_been_activated_for_messenger($default_message_type_name_for_messenger,
+						$active_messenger->name)
+					|| $message_resource_manager->is_message_type_active_for_messenger(
+						$active_messenger->name,
+						$default_message_type_name_for_messenger
+					)
+					|| ! isset($installed_message_types[$default_message_type_name_for_messenger])
+				) {
+					continue;
+				}
+				$default_message_type_names_to_activate[] = $default_message_type_name_for_messenger;
+			}
+			//let's activate!
+			$message_resource_manager->ensure_message_types_are_active(
+				$default_message_type_names_to_activate,
+				$active_messenger->name,
+				false
+			);
+			//activate the templates for these message types
+			if ( ! empty($default_message_type_names_to_activate)) {
+				$templates_created = EEH_MSG_Template::generate_new_templates(
+					$active_messenger->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_created;
+	}
+
+
+
+	/**
+	 * This will activate and generate default messengers and default message types for those messengers.
+	 *
+	 * @param EE_message_Resource_Manager $message_resource_manager
+	 * @return array|bool  True means there were default messengers and message type templates generated.
+	 *                     False means that there were no templates generated
+	 *                     (which could simply mean there are no default message types for a messenger).
+	 * @throws EE_Error
+	 */
+	protected static function _activate_and_generate_default_messengers_and_message_templates(
+		EE_Message_Resource_Manager $message_resource_manager
+	) {
+		/** @type EE_messenger[] $messengers_to_generate */
+		$messengers_to_generate = self::_get_default_messengers_to_generate_on_activation($message_resource_manager);
+		$installed_message_types = $message_resource_manager->installed_message_types();
+		$templates_generated = false;
+		foreach ($messengers_to_generate as $messenger_to_generate) {
+			$default_message_type_names_for_messenger = $messenger_to_generate->get_default_message_types();
+			//verify the default message types match an installed message type.
+			foreach ($default_message_type_names_for_messenger as $key => $name) {
+				if (
+					! isset($installed_message_types[$name])
+					|| $message_resource_manager->has_message_type_been_activated_for_messenger($name,
+						$messenger_to_generate->name)
+				) {
+					unset($default_message_type_names_for_messenger[$key]);
+				}
+			}
+			// in previous iterations, the active_messengers option in the db
+			// needed updated before calling create templates. however with the changes this may not be necessary.
+			// This comment is left here just in case we discover that we _do_ need to update before
+			// passing off to create templates (after the refactor is done).
+			// @todo remove this comment when determined not necessary.
+			$message_resource_manager->activate_messenger(
+				$messenger_to_generate->name,
+				$default_message_type_names_for_messenger,
+				false
+			);
+			//create any templates needing created (or will reactivate templates already generated as necessary).
+			if ( ! empty($default_message_type_names_for_messenger)) {
+				$templates_generated = EEH_MSG_Template::generate_new_templates(
+					$messenger_to_generate->name,
+					$default_message_type_names_for_messenger,
+					'',
+					true
+				);
+			}
+		}
+		return $templates_generated;
+	}
 
 
 
@@ -1604,111 +1604,111 @@ 
 
 
 
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @deprecated in 4.9.13. Instead use TableManager::dropTables()
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public static function drop_tables($table_names)
-    {
-        return \EEH_Activation::getTableManager()->dropTables($table_names);
-    }
-
-
-
-    /**
-     * plugin_uninstall
-     *
-     * @access public
-     * @static
-     * @param bool $remove_all
-     * @return void
-     */
-    public static function delete_all_espresso_tables_and_data($remove_all = true)
-    {
-        global $wpdb;
-        self::drop_espresso_tables();
-        $wp_options_to_delete = array(
-            'ee_no_ticket_prices'                => true,
-            'ee_active_messengers'               => true,
-            'ee_has_activated_messenger'         => true,
-            'ee_flush_rewrite_rules'             => true,
-            'ee_config'                          => false,
-            'ee_data_migration_current_db_state' => true,
-            'ee_data_migration_mapping_'         => false,
-            'ee_data_migration_script_'          => false,
-            'ee_data_migrations'                 => true,
-            'ee_dms_map'                         => false,
-            'ee_notices'                         => true,
-            'lang_file_check_'                   => false,
-            'ee_maintenance_mode'                => true,
-            'ee_ueip_optin'                      => true,
-            'ee_ueip_has_notified'               => true,
-            'ee_plugin_activation_errors'        => true,
-            'ee_id_mapping_from'                 => false,
-            'espresso_persistent_admin_notices'  => true,
-            'ee_encryption_key'                  => true,
-            'pue_force_upgrade_'                 => false,
-            'pue_json_error_'                    => false,
-            'pue_install_key_'                   => false,
-            'pue_verification_error_'            => false,
-            'pu_dismissed_upgrade_'              => false,
-            'external_updates-'                  => false,
-            'ee_extra_data'                      => true,
-            'ee_ssn_'                            => false,
-            'ee_rss_'                            => false,
-            'ee_rte_n_tx_'                       => false,
-            'ee_pers_admin_notices'              => true,
-            'ee_job_parameters_'                 => false,
-            'ee_upload_directories_incomplete'   => true,
-            'ee_verified_db_collations'          => true,
-        );
-        if (is_main_site()) {
-            $wp_options_to_delete['ee_network_config'] = true;
-        }
-        $undeleted_options = array();
-        foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
-            if ($no_wildcard) {
-                if ( ! delete_option($option_name)) {
-                    $undeleted_options[] = $option_name;
-                }
-            } else {
-                $option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
-                foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
-                    if ( ! delete_option($option_name_from_wildcard)) {
-                        $undeleted_options[] = $option_name_from_wildcard;
-                    }
-                }
-            }
-        }
-        //also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
-        remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
-        if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
-            $db_update_sans_ee4 = array();
-            foreach ($espresso_db_update as $version => $times_activated) {
-                if ((string)$version[0] === '3') {//if its NON EE4
-                    $db_update_sans_ee4[$version] = $times_activated;
-                }
-            }
-            update_option('espresso_db_update', $db_update_sans_ee4);
-        }
-        $errors = '';
-        if ( ! empty($undeleted_options)) {
-            $errors .= sprintf(
-                __('The following wp-options could not be deleted: %s%s', 'event_espresso'),
-                '<br/>',
-                implode(',<br/>', $undeleted_options)
-            );
-        }
-        if ( ! empty($errors)) {
-            EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @deprecated in 4.9.13. Instead use TableManager::dropTables()
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public static function drop_tables($table_names)
+	{
+		return \EEH_Activation::getTableManager()->dropTables($table_names);
+	}
+
+
+
+	/**
+	 * plugin_uninstall
+	 *
+	 * @access public
+	 * @static
+	 * @param bool $remove_all
+	 * @return void
+	 */
+	public static function delete_all_espresso_tables_and_data($remove_all = true)
+	{
+		global $wpdb;
+		self::drop_espresso_tables();
+		$wp_options_to_delete = array(
+			'ee_no_ticket_prices'                => true,
+			'ee_active_messengers'               => true,
+			'ee_has_activated_messenger'         => true,
+			'ee_flush_rewrite_rules'             => true,
+			'ee_config'                          => false,
+			'ee_data_migration_current_db_state' => true,
+			'ee_data_migration_mapping_'         => false,
+			'ee_data_migration_script_'          => false,
+			'ee_data_migrations'                 => true,
+			'ee_dms_map'                         => false,
+			'ee_notices'                         => true,
+			'lang_file_check_'                   => false,
+			'ee_maintenance_mode'                => true,
+			'ee_ueip_optin'                      => true,
+			'ee_ueip_has_notified'               => true,
+			'ee_plugin_activation_errors'        => true,
+			'ee_id_mapping_from'                 => false,
+			'espresso_persistent_admin_notices'  => true,
+			'ee_encryption_key'                  => true,
+			'pue_force_upgrade_'                 => false,
+			'pue_json_error_'                    => false,
+			'pue_install_key_'                   => false,
+			'pue_verification_error_'            => false,
+			'pu_dismissed_upgrade_'              => false,
+			'external_updates-'                  => false,
+			'ee_extra_data'                      => true,
+			'ee_ssn_'                            => false,
+			'ee_rss_'                            => false,
+			'ee_rte_n_tx_'                       => false,
+			'ee_pers_admin_notices'              => true,
+			'ee_job_parameters_'                 => false,
+			'ee_upload_directories_incomplete'   => true,
+			'ee_verified_db_collations'          => true,
+		);
+		if (is_main_site()) {
+			$wp_options_to_delete['ee_network_config'] = true;
+		}
+		$undeleted_options = array();
+		foreach ($wp_options_to_delete as $option_name => $no_wildcard) {
+			if ($no_wildcard) {
+				if ( ! delete_option($option_name)) {
+					$undeleted_options[] = $option_name;
+				}
+			} else {
+				$option_names_to_delete_from_wildcard = $wpdb->get_col("SELECT option_name FROM $wpdb->options WHERE option_name LIKE '%$option_name%'");
+				foreach ($option_names_to_delete_from_wildcard as $option_name_from_wildcard) {
+					if ( ! delete_option($option_name_from_wildcard)) {
+						$undeleted_options[] = $option_name_from_wildcard;
+					}
+				}
+			}
+		}
+		//also, let's make sure the "ee_config_option_names" wp option stays out by removing the action that adds it
+		remove_action('shutdown', array(EE_Config::instance(), 'shutdown'), 10);
+		if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
+			$db_update_sans_ee4 = array();
+			foreach ($espresso_db_update as $version => $times_activated) {
+				if ((string)$version[0] === '3') {//if its NON EE4
+					$db_update_sans_ee4[$version] = $times_activated;
+				}
+			}
+			update_option('espresso_db_update', $db_update_sans_ee4);
+		}
+		$errors = '';
+		if ( ! empty($undeleted_options)) {
+			$errors .= sprintf(
+				__('The following wp-options could not be deleted: %s%s', 'event_espresso'),
+				'<br/>',
+				implode(',<br/>', $undeleted_options)
+			);
+		}
+		if ( ! empty($errors)) {
+			EE_Error::add_attention($errors, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
 
 	/**
 	 * Gets the mysql error code from the last used query by wpdb

Spacing +130 added lines, -130 removed lines

@@ -61,8 +61,8 @@ 
 	 * @return \EventEspresso\core\services\database\TableAnalysis
 	 */
 	public static function getTableAnalysis() {
-		if ( ! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis ) {
-			self::$table_analysis = EE_Registry::instance()->create( 'TableAnalysis', array(), true );
+		if ( ! self::$table_analysis instanceof \EventEspresso\core\services\database\TableAnalysis) {
+			self::$table_analysis = EE_Registry::instance()->create('TableAnalysis', array(), true);
 		}
 		return self::$table_analysis;
 	}
@@ -73,8 +73,8 @@ 
 	 * @return \EventEspresso\core\services\database\TableManager
 	 */
 	public static function getTableManager() {
-		if ( ! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager ) {
-			self::$table_manager = EE_Registry::instance()->create( 'TableManager', array(), true );
+		if ( ! self::$table_manager instanceof \EventEspresso\core\services\database\TableManager) {
+			self::$table_manager = EE_Registry::instance()->create('TableManager', array(), true);
 		}
 		return self::$table_manager;
 	}
@@ -89,8 +89,8 @@ 
 	 * @param $table_name
 	 * @return string
 	 */
-	public static function ensure_table_name_has_prefix( $table_name ) {
-		return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix( $table_name );
+	public static function ensure_table_name_has_prefix($table_name) {
+		return \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix($table_name);
 	}
 
 
@@ -118,7 +118,7 @@ 
 	 * @return boolean success, whether the database and folders are setup properly
 	 * @throws \EE_Error
 	 */
-	public static function initialize_db_and_folders(){
+	public static function initialize_db_and_folders() {
 		$good_filesystem = EEH_Activation::create_upload_directories();
 		$good_db = EEH_Activation::create_database_tables();
 		return $good_filesystem && $good_db;
@@ -134,9 +134,9 @@ 
 	 *
 	 * @throws \EE_Error
 	 */
-	public static function initialize_db_content(){
+	public static function initialize_db_content() {
 		//let's avoid doing all this logic repeatedly, especially when addons are requesting it
-		if( EEH_Activation::$_initialized_db_content_already_in_this_request ) {
+		if (EEH_Activation::$_initialized_db_content_already_in_this_request) {
 			return;
 		}
 		EEH_Activation::$_initialized_db_content_already_in_this_request = true;
@@ -153,9 +153,9 @@ 
 		EEH_Activation::remove_cron_tasks();
 		EEH_Activation::create_cron_tasks();
 		// remove all TXN locks since that is being done via extra meta now
-		delete_option( 'ee_locked_transactions' );
+		delete_option('ee_locked_transactions');
 		//also, check for CAF default db content
-		do_action( 'AHEE__EEH_Activation__initialize_db_content' );
+		do_action('AHEE__EEH_Activation__initialize_db_content');
 		//also: EEM_Gateways::load_all_gateways() outputs a lot of success messages
 		//which users really won't care about on initial activation
 		EE_Error::overwrite_success();
@@ -175,7 +175,7 @@ 
 	 * @return array
 	 * @throws \EE_Error
 	 */
-	public static function get_cron_tasks( $which_to_include ) {
+	public static function get_cron_tasks($which_to_include) {
 		$cron_tasks = apply_filters(
 			'FHEE__EEH_Activation__get_cron_tasks',
 			array(
@@ -184,16 +184,16 @@ 
 				'AHEE__EE_Cron_Tasks__update_transaction_with_payment' => EEH_Activation::cron_task_no_longer_in_use, //there may have been a bug which prevented from these cron tasks from getting unscheduled, so we might want to remove these for a few updates
 			)
 		);
-		if ( $which_to_include === 'old' ) {
+		if ($which_to_include === 'old') {
 			$cron_tasks = array_filter(
 				$cron_tasks,
-				function ( $value ) {
+				function($value) {
 					return $value === EEH_Activation::cron_task_no_longer_in_use;
 				}
 			);
-		} elseif ( $which_to_include === 'current' ) {
-			$cron_tasks = array_filter( $cron_tasks );
-		} elseif ( WP_DEBUG && $which_to_include !== 'all' ) {
+		} elseif ($which_to_include === 'current') {
+			$cron_tasks = array_filter($cron_tasks);
+		} elseif (WP_DEBUG && $which_to_include !== 'all') {
 			throw new EE_Error(
 				sprintf(
 					__(
@@ -216,9 +216,9 @@ 
 	 */
 	public static function create_cron_tasks() {
 
-		foreach( EEH_Activation::get_cron_tasks( 'current' ) as $hook_name => $frequency ) {
-			if( ! wp_next_scheduled( $hook_name ) ) {
-				wp_schedule_event( time(), $frequency, $hook_name );
+		foreach (EEH_Activation::get_cron_tasks('current') as $hook_name => $frequency) {
+			if ( ! wp_next_scheduled($hook_name)) {
+				wp_schedule_event(time(), $frequency, $hook_name);
 			}
 		}
 
@@ -232,10 +232,10 @@ 
 	 * @param boolean $remove_all whether to only remove the old ones, or remove absolutely ALL the EE ones
 	 * @throws \EE_Error
 	 */
-	public static function remove_cron_tasks( $remove_all = true ) {
+	public static function remove_cron_tasks($remove_all = true) {
 		$cron_tasks_to_remove = $remove_all ? 'all' : 'old';
 		$crons = _get_cron_array();
-		$crons = is_array( $crons ) ? $crons : array();
+		$crons = is_array($crons) ? $crons : array();
 		/* reminder of what $crons look like:
 		 * Top-level keys are timestamps, and their values are arrays.
 		 * The 2nd level arrays have keys with each of the cron task hook names to run at that time
@@ -253,23 +253,23 @@ 
 		 *					...
 		 *      ...
 		 */
-		$ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks( $cron_tasks_to_remove );
-		foreach ( $crons as $timestamp => $hooks_to_fire_at_time ) {
-			if ( is_array( $hooks_to_fire_at_time ) ) {
-				foreach ( $hooks_to_fire_at_time as $hook_name => $hook_actions ) {
-					if ( isset( $ee_cron_tasks_to_remove[ $hook_name ] )
-					     && is_array( $ee_cron_tasks_to_remove[ $hook_name ] )
+		$ee_cron_tasks_to_remove = EEH_Activation::get_cron_tasks($cron_tasks_to_remove);
+		foreach ($crons as $timestamp => $hooks_to_fire_at_time) {
+			if (is_array($hooks_to_fire_at_time)) {
+				foreach ($hooks_to_fire_at_time as $hook_name => $hook_actions) {
+					if (isset($ee_cron_tasks_to_remove[$hook_name])
+					     && is_array($ee_cron_tasks_to_remove[$hook_name])
 					) {
-						unset( $crons[ $timestamp ][ $hook_name ] );
+						unset($crons[$timestamp][$hook_name]);
 					}
 				}
 				//also take care of any empty cron timestamps.
-				if ( empty( $hooks_to_fire_at_time ) ) {
-					unset( $crons[ $timestamp ] );
+				if (empty($hooks_to_fire_at_time)) {
+					unset($crons[$timestamp]);
 				}
 			}
 		}
-		_set_cron_array( $crons );
+		_set_cron_array($crons);
 	}
 
 
@@ -284,7 +284,7 @@ 
 	 */
 	public static function CPT_initialization() {
 		// register Custom Post Types
-		EE_Registry::instance()->load_core( 'Register_CPTs' );
+		EE_Registry::instance()->load_core('Register_CPTs');
 		flush_rewrite_rules();
 	}
 
@@ -320,28 +320,28 @@ 
 	 */
 	public static function load_calendar_config() {
 		// grab array of all plugin folders and loop thru it
-		$plugins = glob( WP_PLUGIN_DIR . DS . '*', GLOB_ONLYDIR );
-		if ( empty( $plugins ) ) {
+		$plugins = glob(WP_PLUGIN_DIR.DS.'*', GLOB_ONLYDIR);
+		if (empty($plugins)) {
 			return;
 		}
-		foreach ( $plugins as $plugin_path ) {
+		foreach ($plugins as $plugin_path) {
 			// grab plugin folder name from path
-			$plugin = basename( $plugin_path );
+			$plugin = basename($plugin_path);
 			// drill down to Espresso plugins
 			// then to calendar related plugins
 			if (
-				strpos( $plugin, 'espresso' ) !== FALSE
-				|| strpos( $plugin, 'Espresso' ) !== FALSE
-				|| strpos( $plugin, 'ee4' ) !== FALSE
-				|| strpos( $plugin, 'EE4' ) !== FALSE
-				|| strpos( $plugin, 'calendar' ) !== false
+				strpos($plugin, 'espresso') !== FALSE
+				|| strpos($plugin, 'Espresso') !== FALSE
+				|| strpos($plugin, 'ee4') !== FALSE
+				|| strpos($plugin, 'EE4') !== FALSE
+				|| strpos($plugin, 'calendar') !== false
 			) {
 				// this is what we are looking for
-				$calendar_config = $plugin_path . DS . 'EE_Calendar_Config.php';
+				$calendar_config = $plugin_path.DS.'EE_Calendar_Config.php';
 				// does it exist in this folder ?
-				if ( is_readable( $calendar_config )) {
+				if (is_readable($calendar_config)) {
 					// YEAH! let's load it
-					require_once( $calendar_config );
+					require_once($calendar_config);
 				}
 			}
 		}
@@ -389,8 +389,8 @@ 
 	 */
 	public static function deactivate_event_espresso() {
 		// check permissions
-		if ( current_user_can( 'activate_plugins' )) {
-			deactivate_plugins( EE_PLUGIN_BASENAME, TRUE );
+		if (current_user_can('activate_plugins')) {
+			deactivate_plugins(EE_PLUGIN_BASENAME, TRUE);
 		}
 	}
 
@@ -513,7 +513,7 @@ 
     public static function get_page_by_ee_shortcode($ee_shortcode)
     {
         global $wpdb;
-        $shortcode_and_opening_bracket = '[' . $ee_shortcode;
+        $shortcode_and_opening_bracket = '['.$ee_shortcode;
         $post_id = $wpdb->get_var("SELECT ID FROM {$wpdb->posts} WHERE post_content LIKE '%$shortcode_and_opening_bracket%' LIMIT 1");
         if ($post_id) {
             return get_post($post_id);
@@ -533,32 +533,32 @@ 
 	 * @param array $critical_page
 	 * @return array
 	 */
-	public static function create_critical_page( $critical_page ) {
+	public static function create_critical_page($critical_page) {
 
 		$post_args = array(
 			'post_title' => $critical_page['name'],
 			'post_status' => 'publish',
 			'post_type' => 'page',
 			'comment_status' => 'closed',
-			'post_content' => '[' . $critical_page['code'] . ']'
+			'post_content' => '['.$critical_page['code'].']'
 		);
 
-		$post_id = wp_insert_post( $post_args );
-		if ( ! $post_id ) {
+		$post_id = wp_insert_post($post_args);
+		if ( ! $post_id) {
 			$msg = sprintf(
-				__( 'The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso' ),
+				__('The Event Espresso  critical page entitled "%s" could not be created.', 'event_espresso'),
 				$critical_page['name']
 			);
-			EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
 			return $critical_page;
 		}
 		// get newly created post's details
-		if ( ! $critical_page['post'] = get_post( $post_id )) {
+		if ( ! $critical_page['post'] = get_post($post_id)) {
 			$msg = sprintf(
-				__( 'The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso' ),
+				__('The Event Espresso critical page entitled "%s" could not be retrieved.', 'event_espresso'),
 				$critical_page['name']
 			);
-			EE_Error::add_error( $msg, __FILE__, __FUNCTION__, __LINE__ );
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
 		}
 
 		return $critical_page;
@@ -633,15 +633,15 @@ 
         $pre_filtered_id = apply_filters('FHEE__EEH_Activation__get_default_creator_id__pre_filtered_id', false,
             $role_to_check);
         if ($pre_filtered_id !== false) {
-            return (int)$pre_filtered_id;
+            return (int) $pre_filtered_id;
         }
         $capabilities_key = \EEH_Activation::getTableAnalysis()->ensureTableNameHasPrefix('capabilities');
         $query = $wpdb->prepare("SELECT user_id FROM $wpdb->usermeta WHERE meta_key = '$capabilities_key' AND meta_value LIKE %s ORDER BY user_id ASC LIMIT 0,1",
-            '%' . $role_to_check . '%');
+            '%'.$role_to_check.'%');
         $user_id = $wpdb->get_var($query);
         $user_id = apply_filters('FHEE__EEH_Activation_Helper__get_default_creator_id__user_id', $user_id);
-        if ($user_id && (int)$user_id) {
-            self::$_default_creator_id = (int)$user_id;
+        if ($user_id && (int) $user_id) {
+            self::$_default_creator_id = (int) $user_id;
             return self::$_default_creator_id;
         } else {
             return null;
@@ -676,7 +676,7 @@ 
         }
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         if ( ! function_exists('dbDelta')) {
-            require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
+            require_once(ABSPATH.'wp-admin/includes/upgrade.php');
         }
         $tableAnalysis = \EEH_Activation::getTableAnalysis();
         $wp_table_name = $tableAnalysis->ensureTableNameHasPrefix($table_name);
@@ -690,7 +690,7 @@ 
             } else if ( ! $deleted_safely) {
                 // so we should be more cautious rather than just dropping tables so easily
                 EE_Error::add_persistent_admin_notice(
-                    'bad_table_' . $wp_table_name . '_detected',
+                    'bad_table_'.$wp_table_name.'_detected',
                     sprintf(__('Database table %1$s exists when it shouldn\'t, and may contain erroneous data. If you have previously restored your database from a backup that didn\'t remove the old tables, then we recommend adding %2$s to your %3$s file then restore to that backup again. This will clear out the invalid data from %1$s. Afterwards you should undo that change from your %3$s file. %4$sIf you cannot edit %3$s, you should remove the data from %1$s manually then restore to the backup again.',
                         'event_espresso'),
                         $wp_table_name,
@@ -740,8 +740,8 @@ 
 	 * @param string $table_name, without prefixed $wpdb->prefix
 	 * @return array of database column names
 	 */
-	public static function get_fields_on_table( $table_name = NULL ) {
-		return \EEH_Activation::getTableManager()->getTableColumns( $table_name );
+	public static function get_fields_on_table($table_name = NULL) {
+		return \EEH_Activation::getTableManager()->getTableColumns($table_name);
 	}
 
 
@@ -755,8 +755,8 @@ 
 	 * @param string $table_name
 	 * @return bool
 	 */
-	public static function db_table_is_empty( $table_name ) {
-		return \EEH_Activation::getTableAnalysis()->tableIsEmpty( $table_name );
+	public static function db_table_is_empty($table_name) {
+		return \EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name);
 }
 
 
@@ -769,9 +769,9 @@ 
 	 * @param string $table_name
 	 * @return bool | int
 	 */
-	public static function delete_db_table_if_empty( $table_name ) {
-		if ( \EEH_Activation::getTableAnalysis()->tableIsEmpty( $table_name ) ) {
-			return \EEH_Activation::getTableManager()->dropTable( $table_name );
+	public static function delete_db_table_if_empty($table_name) {
+		if (\EEH_Activation::getTableAnalysis()->tableIsEmpty($table_name)) {
+			return \EEH_Activation::getTableManager()->dropTable($table_name);
 		}
 		return false;
 	}
@@ -787,8 +787,8 @@ 
 	 * @param string $table_name
 	 * @return bool | int
 	 */
-	public static function delete_unused_db_table( $table_name ) {
-		return \EEH_Activation::getTableManager()->dropTable( $table_name );
+	public static function delete_unused_db_table($table_name) {
+		return \EEH_Activation::getTableManager()->dropTable($table_name);
 	}
 
 
@@ -803,8 +803,8 @@ 
 	 * @param string $index_name
 	 * @return bool | int
 	 */
-	public static function drop_index( $table_name, $index_name ) {
-		return \EEH_Activation::getTableManager()->dropIndex( $table_name, $index_name );
+	public static function drop_index($table_name, $index_name) {
+		return \EEH_Activation::getTableManager()->dropIndex($table_name, $index_name);
 	}
 
 
@@ -879,7 +879,7 @@ 
                     case 1:
                         $QSG_values = array(
                             'QSG_name'            => __('Personal Information', 'event_espresso'),
-                            'QSG_identifier'      => 'personal-information-' . time(),
+                            'QSG_identifier'      => 'personal-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 1,
                             'QSG_show_group_name' => 1,
@@ -891,7 +891,7 @@ 
                     case 2:
                         $QSG_values = array(
                             'QSG_name'            => __('Address Information', 'event_espresso'),
-                            'QSG_identifier'      => 'address-information-' . time(),
+                            'QSG_identifier'      => 'address-information-'.time(),
                             'QSG_desc'            => '',
                             'QSG_order'           => 2,
                             'QSG_show_group_name' => 1,
@@ -1156,11 +1156,11 @@ 
 	 *
 	 * @throws \EE_Error
 	 */
-	public static function insert_default_payment_methods(){
-		if( ! EEM_Payment_Method::instance()->count_active( EEM_Payment_Method::scope_cart ) ){
-			EE_Registry::instance()->load_lib( 'Payment_Method_Manager' );
-			EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type( 'Invoice' );
-		}else{
+	public static function insert_default_payment_methods() {
+		if ( ! EEM_Payment_Method::instance()->count_active(EEM_Payment_Method::scope_cart)) {
+			EE_Registry::instance()->load_lib('Payment_Method_Manager');
+			EE_Payment_Method_Manager::instance()->activate_a_payment_method_of_type('Invoice');
+		} else {
 			EEM_Payment_Method::instance()->verify_button_urls();
 		}
 	}
@@ -1176,7 +1176,7 @@ 
 
 		global $wpdb;
 
-		if ( \EEH_Activation::getTableAnalysis()->tableExists( EEM_Status::instance()->table() ) ) {
+		if (\EEH_Activation::getTableAnalysis()->tableExists(EEM_Status::instance()->table())) {
 
 			$table_name = EEM_Status::instance()->table();
 
@@ -1252,33 +1252,33 @@ 
 		$folders = array(
 				EVENT_ESPRESSO_TEMPLATE_DIR,
 				EVENT_ESPRESSO_GATEWAY_DIR,
-				EVENT_ESPRESSO_UPLOAD_DIR . 'logs/',
-				EVENT_ESPRESSO_UPLOAD_DIR . 'css/',
-				EVENT_ESPRESSO_UPLOAD_DIR . 'tickets/'
+				EVENT_ESPRESSO_UPLOAD_DIR.'logs/',
+				EVENT_ESPRESSO_UPLOAD_DIR.'css/',
+				EVENT_ESPRESSO_UPLOAD_DIR.'tickets/'
 		);
-		foreach ( $folders as $folder ) {
+		foreach ($folders as $folder) {
 			try {
-				EEH_File::ensure_folder_exists_and_is_writable( $folder );
-				@ chmod( $folder, 0755 );
-			} catch( EE_Error $e ){
+				EEH_File::ensure_folder_exists_and_is_writable($folder);
+				@ chmod($folder, 0755);
+			} catch (EE_Error $e) {
 				EE_Error::add_error(
 					sprintf(
-						__(  'Could not create the folder at "%1$s" because: %2$s', 'event_espresso' ),
+						__('Could not create the folder at "%1$s" because: %2$s', 'event_espresso'),
 						$folder,
-						'<br />' . $e->getMessage()
+						'<br />'.$e->getMessage()
 					),
 					__FILE__, __FUNCTION__, __LINE__
 				);
 				//indicate we'll need to fix this later
-				update_option( EEH_Activation::upload_directories_incomplete_option_name, true );
+				update_option(EEH_Activation::upload_directories_incomplete_option_name, true);
 				return FALSE;
 			}
 		}
 		//just add the .htaccess file to the logs directory to begin with. Even if logging
 		//is disabled, there might be activation errors recorded in there
-		EEH_File::add_htaccess_deny_from_all( EVENT_ESPRESSO_UPLOAD_DIR . 'logs/' );
+		EEH_File::add_htaccess_deny_from_all(EVENT_ESPRESSO_UPLOAD_DIR.'logs/');
 		//remember EE's folders are all good
-		delete_option( EEH_Activation::upload_directories_incomplete_option_name );
+		delete_option(EEH_Activation::upload_directories_incomplete_option_name);
 		return TRUE;
 	}
 
@@ -1291,7 +1291,7 @@ 
 	 * @return boolean
 	 */
 	public static function upload_directories_incomplete() {
-		return get_option( EEH_Activation::upload_directories_incomplete_option_name, false );
+		return get_option(EEH_Activation::upload_directories_incomplete_option_name, false);
 	}
 
 
@@ -1308,7 +1308,7 @@ 
 	 */
 	public static function generate_default_message_templates() {
 		/** @type EE_Message_Resource_Manager $message_resource_manager */
-		$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		/*
 		 * This first method is taking care of ensuring any default messengers
 		 * that should be made active and have templates generated are done.
@@ -1458,18 +1458,18 @@ 
 		$has_activated = $message_resource_manager->get_has_activated_messengers_option();
 
 		$messengers_to_generate = array();
-		foreach ( $installed_messengers as $installed_messenger ) {
+		foreach ($installed_messengers as $installed_messenger) {
 			//if installed messenger is a messenger that should be activated on install
 			//and is not already active
 			//and has never been activated
 			if (
 				! $installed_messenger->activate_on_install
-				|| isset( $active_messengers[ $installed_messenger->name ] )
-				|| isset( $has_activated[ $installed_messenger->name ] )
+				|| isset($active_messengers[$installed_messenger->name])
+				|| isset($has_activated[$installed_messenger->name])
 			) {
 				continue;
 			}
-			$messengers_to_generate[ $installed_messenger->name ] = $installed_messenger;
+			$messengers_to_generate[$installed_messenger->name] = $installed_messenger;
 		}
 		return $messengers_to_generate;
 	}
@@ -1494,9 +1494,9 @@ 
 	 */
 	public static function validate_messages_system() {
 		/** @type EE_Message_Resource_Manager $message_resource_manager */
-		$message_resource_manager = EE_Registry::instance()->load_lib( 'Message_Resource_Manager' );
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 		$message_resource_manager->validate_active_message_types_are_installed();
-		do_action( 'AHEE__EEH_Activation__validate_messages_system' );
+		do_action('AHEE__EEH_Activation__validate_messages_system');
 	}
 
 
@@ -1509,12 +1509,12 @@ 
 	 * 	@static
 	 * 	@return void
 	 */
-	public static function create_no_ticket_prices_array(){
+	public static function create_no_ticket_prices_array() {
 		// this creates an array for tracking events that have no active ticket prices created
 		// this allows us to warn admins of the situation so that it can be corrected
-		$espresso_no_ticket_prices = get_option( 'ee_no_ticket_prices', FALSE );
-		if ( ! $espresso_no_ticket_prices ) {
-			add_option( 'ee_no_ticket_prices', array(), '', FALSE );
+		$espresso_no_ticket_prices = get_option('ee_no_ticket_prices', FALSE);
+		if ( ! $espresso_no_ticket_prices) {
+			add_option('ee_no_ticket_prices', array(), '', FALSE);
 		}
 	}
 
@@ -1539,24 +1539,24 @@ 
 	 * @global wpdb $wpdb
 	 * @throws \EE_Error
 	 */
-	public static function delete_all_espresso_cpt_data(){
+	public static function delete_all_espresso_cpt_data() {
 		global $wpdb;
 		//get all the CPT post_types
 		$ee_post_types = array();
-		foreach(EE_Registry::instance()->non_abstract_db_models as $model_name){
-			if ( method_exists( $model_name, 'instance' )) {
-				$model_obj = call_user_func( array( $model_name, 'instance' ));
-				if ( $model_obj instanceof EEM_CPT_Base ) {
-					$ee_post_types[] = $wpdb->prepare("%s",$model_obj->post_type());
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_CPT_Base) {
+					$ee_post_types[] = $wpdb->prepare("%s", $model_obj->post_type());
 				}
 			}
 		}
 		//get all our CPTs
-		$query = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (".implode(",",$ee_post_types).")";
+		$query = "SELECT ID FROM {$wpdb->posts} WHERE post_type IN (".implode(",", $ee_post_types).")";
 		$cpt_ids = $wpdb->get_col($query);
 		//delete each post meta and term relations too
-		foreach($cpt_ids as $post_id){
-			wp_delete_post($post_id,true);
+		foreach ($cpt_ids as $post_id) {
+			wp_delete_post($post_id, true);
 		}
 	}
 
@@ -1568,12 +1568,12 @@ 
 	public static function drop_espresso_tables() {
 		$tables = array();
 		// load registry
-		foreach( EE_Registry::instance()->non_abstract_db_models as $model_name ){
-			if ( method_exists( $model_name, 'instance' )) {
-				$model_obj = call_user_func( array( $model_name, 'instance' ));
-				if ( $model_obj instanceof EEM_Base ) {
-					foreach ( $model_obj->get_tables() as $table ) {
-						if ( strpos( $table->get_table_name(), 'esp_' )
+		foreach (EE_Registry::instance()->non_abstract_db_models as $model_name) {
+			if (method_exists($model_name, 'instance')) {
+				$model_obj = call_user_func(array($model_name, 'instance'));
+				if ($model_obj instanceof EEM_Base) {
+					foreach ($model_obj->get_tables() as $table) {
+						if (strpos($table->get_table_name(), 'esp_')
 							&&
 							(
 								is_main_site()//main site? nuke them all
@@ -1596,10 +1596,10 @@ 
 			'esp_promotion_rule',
 			'esp_rule'
 		);
-		foreach( $tables_without_models as $table ){
+		foreach ($tables_without_models as $table) {
 			$tables[] = $table;
 		}
-		return \EEH_Activation::getTableManager()->dropTables( $tables );
+		return \EEH_Activation::getTableManager()->dropTables($tables);
 	}
 
 
@@ -1691,7 +1691,7 @@ 
         if ($remove_all && $espresso_db_update = get_option('espresso_db_update')) {
             $db_update_sans_ee4 = array();
             foreach ($espresso_db_update as $version => $times_activated) {
-                if ((string)$version[0] === '3') {//if its NON EE4
+                if ((string) $version[0] === '3') {//if its NON EE4
                     $db_update_sans_ee4[$version] = $times_activated;
                 }
             }
@@ -1716,10 +1716,10 @@ 
 	 */
 	public static function last_wpdb_error_code() {
 		global $wpdb;
-		if( $wpdb->use_mysqli ) {
-			return mysqli_errno( $wpdb->dbh );
+		if ($wpdb->use_mysqli) {
+			return mysqli_errno($wpdb->dbh);
 		} else {
-			return mysql_errno( $wpdb->dbh );
+			return mysql_errno($wpdb->dbh);
 		}
 	}
 
@@ -1730,14 +1730,14 @@ 
 	 * @param string $table_name with or without $wpdb->prefix
 	 * @return boolean
 	 */
-	public static function table_exists( $table_name ){
-		return \EEH_Activation::getTableAnalysis()->tableExists( $table_name );
+	public static function table_exists($table_name) {
+		return \EEH_Activation::getTableAnalysis()->tableExists($table_name);
 	}
 
 	/**
 	 * Resets the cache on EEH_Activation
 	 */
-	public static function reset(){
+	public static function reset() {
 		self::$_default_creator_id = NULL;
 		self::$_initialized_db_content_already_in_this_request = false;
 	}

core/services/database/TableManager.php

Indentation +205 added lines, -207 removed lines

@@ -17,214 +17,212 @@
 class TableManager extends \EE_Base
 {
 
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    private $table_analysis;
-
-
-
-    /**
-     * TableManager constructor.
-     *
-     * @param TableAnalysis $TableAnalysis
-     */
-    public function __construct(TableAnalysis $TableAnalysis)
-    {
-        $this->table_analysis = $TableAnalysis;
-    }
-
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws \EE_Error
-     */
-    protected function getTableAnalysis()
-    {
-        if ($this->table_analysis instanceof TableAnalysis) {
-            return $this->table_analysis;
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * @param string $table_name which can optionally start with $wpdb->prefix or not
-     * @param string $column_name
-     * @param string $column_info
-     * @return bool|false|int
-     */
-    public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
-    {
-        if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
-            return false;
-        }
-        global $wpdb;
-        $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $columns = $this->getTableColumns($table_name);
-        if ( ! in_array($column_name, $columns)) {
-            $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
-            return $wpdb->query($alter_query);
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Gets the name of all columns on the  table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return array
-     */
-    public function getTableColumns($table_name)
-    {
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $field_array = array();
-        if ( ! empty($table_name)) {
-            $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
-            if ($columns !== false) {
-                foreach ($columns as $column) {
-                    $field_array[] = $column->Field;
-                }
-            }
-        }
-        return $field_array;
-    }
-
-
-
-    /**
-     * Drops the specified table from the database. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return int
-     */
-    public function dropTable($table_name)
-    {
-        global $wpdb;
-        if ($this->getTableAnalysis()->tableExists($table_name)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
-        }
-        return 0;
-    }
-
-
-
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public function dropTables($table_names)
-    {
-        $tables_to_delete = array();
-        foreach ($table_names as $table_name) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[] = $table_name;
-            }
-        }
-        global $wpdb;
-        $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
-        return $tables_to_delete;
-    }
-
-
-
-    /**
-     * Drops the specified index from the specified table. $table_name can
-     * optionally start with $wpdb->prefix or not
-
-     *
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	private $table_analysis;
+
+
+
+	/**
+	 * TableManager constructor.
+	 *
+	 * @param TableAnalysis $TableAnalysis
+	 */
+	public function __construct(TableAnalysis $TableAnalysis)
+	{
+		$this->table_analysis = $TableAnalysis;
+	}
+
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws \EE_Error
+	 */
+	protected function getTableAnalysis()
+	{
+		if ($this->table_analysis instanceof TableAnalysis) {
+			return $this->table_analysis;
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * @param string $table_name which can optionally start with $wpdb->prefix or not
+	 * @param string $column_name
+	 * @param string $column_info
+	 * @return bool|false|int
+	 */
+	public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
+	{
+		if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
+			return false;
+		}
+		global $wpdb;
+		$full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$columns = $this->getTableColumns($table_name);
+		if ( ! in_array($column_name, $columns)) {
+			$alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
+			return $wpdb->query($alter_query);
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Gets the name of all columns on the  table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return array
+	 */
+	public function getTableColumns($table_name)
+	{
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$field_array = array();
+		if ( ! empty($table_name)) {
+			$columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
+			if ($columns !== false) {
+				foreach ($columns as $column) {
+					$field_array[] = $column->Field;
+				}
+			}
+		}
+		return $field_array;
+	}
+
+
+
+	/**
+	 * Drops the specified table from the database. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return int
+	 */
+	public function dropTable($table_name)
+	{
+		global $wpdb;
+		if ($this->getTableAnalysis()->tableExists($table_name)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
+		}
+		return 0;
+	}
+
+
+
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public function dropTables($table_names)
+	{
+		$tables_to_delete = array();
+		foreach ($table_names as $table_name) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			if ($this->getTableAnalysis()->tableExists($table_name)) {
+				$tables_to_delete[] = $table_name;
+			}
+		}
+		global $wpdb;
+		$wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+		return $tables_to_delete;
+	}
+
+
+
+	/**
+	 * Drops the specified index from the specified table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
 *@global \wpdb       $wpdb
-     * @param string $table_name
-     * @param string $index_name
-     * @return int
-     */
-    public function dropIndex($table_name, $index_name)
-    {
-        if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
-            return false;
-        }
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE Key_name = '{$index_name}'";
-        if (
-            $this->getTableAnalysis()->tableExists($table_name)
-            && $wpdb->get_var($index_exists_query)
-               === $table_name //using get_var with the $index_exists_query returns the table's name
-        ) {
-            return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
-        }
-        return 0;
-    }
-
-
-
-    /**
-     * Just creates the requested table. $table_name can
-     * optionally start with $wpdb->prefix or not
-
-     *
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return int
+	 */
+	public function dropIndex($table_name, $index_name)
+	{
+		if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
+			return false;
+		}
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM {$table_name} WHERE Key_name = '{$index_name}'";
+		if (
+			$this->getTableAnalysis()->tableExists($table_name)
+			&& $wpdb->get_var($index_exists_query)
+			   === $table_name //using get_var with the $index_exists_query returns the table's name
+		) {
+			return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
+		}
+		return 0;
+	}
+
+
+
+	/**
+	 * Just creates the requested table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
 *@param string       $table_name
-     * @param string $create_sql defining the table's columns and indexes
-     * @param string $engine     (no need to specify "ENGINE=", that's implied)
-     * @return void
-     * @throws \EE_Error
-     */
-    public function createTable($table_name, $create_sql, $engine = 'MyISAM')
-    {
-        // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
-        if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            /** @var \wpdb $wpdb */
-            global $wpdb;
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
-
-            //get $wpdb to echo errors, but buffer them. This way at least WE know an error
-            //happened. And then we can choose to tell the end user
-            $old_show_errors_policy = $wpdb->show_errors(true);
-            $old_error_suppression_policy = $wpdb->suppress_errors(false);
-            ob_start();
-            dbDelta($SQL);
-            $output = ob_get_contents();
-            ob_end_clean();
-            $wpdb->show_errors($old_show_errors_policy);
-            $wpdb->suppress_errors($old_error_suppression_policy);
-            if ( ! empty($output)) {
-                throw new \EE_Error($output);
-            }
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
-                        'event_espresso'),
-                    '<br />',
-                    $create_sql
-                )
-            );
-        }
-    }
+	 * @param string $create_sql defining the table's columns and indexes
+	 * @param string $engine     (no need to specify "ENGINE=", that's implied)
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function createTable($table_name, $create_sql, $engine = 'MyISAM')
+	{
+		// does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
+		if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			/** @var \wpdb $wpdb */
+			global $wpdb;
+			$SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
+
+			//get $wpdb to echo errors, but buffer them. This way at least WE know an error
+			//happened. And then we can choose to tell the end user
+			$old_show_errors_policy = $wpdb->show_errors(true);
+			$old_error_suppression_policy = $wpdb->suppress_errors(false);
+			ob_start();
+			dbDelta($SQL);
+			$output = ob_get_contents();
+			ob_end_clean();
+			$wpdb->show_errors($old_show_errors_policy);
+			$wpdb->suppress_errors($old_error_suppression_policy);
+			if ( ! empty($output)) {
+				throw new \EE_Error($output);
+			}
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
+						'event_espresso'),
+					'<br />',
+					$create_sql
+				)
+			);
+		}
+	}
 
 }

Spacing +2 added lines, -2 removed lines

@@ -146,7 +146,7 @@ 
             }
         }
         global $wpdb;
-        $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+        $wpdb->query('DROP TABLE '.implode(', ', $tables_to_delete));
         return $tables_to_delete;
     }
 
@@ -200,7 +200,7 @@ 
             $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
             /** @var \wpdb $wpdb */
             global $wpdb;
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
+            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} ".$wpdb->get_charset_collate();
 
             //get $wpdb to echo errors, but buffer them. This way at least WE know an error
             //happened. And then we can choose to tell the end user