eventespresso / event-espresso-core

core/libraries/line_item_filters/EE_Specific_Registrations_Line_Item_Filter.class.php

Indentation +217 added lines, -217 removed lines

@@ -14,245 +14,245 @@
  */
 class EE_Specific_Registrations_Line_Item_Filter extends EE_Line_Item_Filter_Base
 {
-    /**
-     * @var ExtraTxnFeesForLineItemsHandler
-     */
-    protected $extra_txn_fees_handler;
+	/**
+	 * @var ExtraTxnFeesForLineItemsHandler
+	 */
+	protected $extra_txn_fees_handler;
 
-    /**
-     * array of line item codes and their corresponding quantities for registrations
-     *
-     * @var array $_line_item_registrations
-     */
-    protected $_line_item_registrations = [];
+	/**
+	 * array of line item codes and their corresponding quantities for registrations
+	 *
+	 * @var array $_line_item_registrations
+	 */
+	protected $_line_item_registrations = [];
 
-    /**
-     * Just kept in case we want it someday. Currently unused
-     *
-     * @var EE_Registration[]
-     */
-    protected $_registrations = [];
+	/**
+	 * Just kept in case we want it someday. Currently unused
+	 *
+	 * @var EE_Registration[]
+	 */
+	protected $_registrations = [];
 
-    /**
-     * @var EE_Registration
-     */
-    protected $_current_registration;
+	/**
+	 * @var EE_Registration
+	 */
+	protected $_current_registration;
 
-    /**
-     * these reg statuses should NOT increment the line item quantity
-     *
-     * @var array
-     */
-    protected $_closed_reg_statuses = [];
+	/**
+	 * these reg statuses should NOT increment the line item quantity
+	 *
+	 * @var array
+	 */
+	protected $_closed_reg_statuses = [];
 
-    /**
-     * @var int
-     */
-    protected $total_reg_count = 0;
+	/**
+	 * @var int
+	 */
+	protected $total_reg_count = 0;
 
 
-    /**
-     * EE_Billable_Line_Item_Filter constructor.
-     *
-     * @param EE_Registration[] $registrations
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($registrations)
-    {
-        $this->_registrations = $registrations;
-        $this->total_reg_count = count($registrations);
-        $this->extra_txn_fees_handler = new ExtraTxnFeesForLineItemsHandler($registrations);
-        $this->calculateRegistrationsPerLineItemCode($registrations);
-        // these reg statuses should NOT increment the line item quantity
-        $this->_closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-    }
+	/**
+	 * EE_Billable_Line_Item_Filter constructor.
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($registrations)
+	{
+		$this->_registrations = $registrations;
+		$this->total_reg_count = count($registrations);
+		$this->extra_txn_fees_handler = new ExtraTxnFeesForLineItemsHandler($registrations);
+		$this->calculateRegistrationsPerLineItemCode($registrations);
+		// these reg statuses should NOT increment the line item quantity
+		$this->_closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+	}
 
 
-    /**
-     * Adjusts quantities for ticket line items according to the registrations provided upon construction,
-     * so if a TXN was for 2 of the same ticket, but we are only generating line items for a single registration,
-     * then this will change the quantity to 1, and update the total accordingly
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function adjustLineItemQuantity(EEI_Line_Item $line_item)
-    {
-        // is this a ticket ?
-        if ($line_item->type() === EEM_Line_Item::type_line_item && $line_item->OBJ_type() === 'Ticket') {
-            $this->_current_registration = null;
-            $quantity                    = 0;
-            // if this ticket is billable at this moment, then we should have a positive quantity
-            if (
-                isset($this->_line_item_registrations[ $line_item->code() ])
-                && is_array($this->_line_item_registrations[ $line_item->code() ])
-            ) {
-                // set quantity based on number of open registrations for this ticket
-                foreach ($this->_line_item_registrations[ $line_item->code() ] as $registration) {
-                    if (
-                        $registration instanceof EE_Registration
-                    ) {
-                        $quantity++;
-                        $this->_current_registration = $registration;
-                    }
-                }
-            }
+	/**
+	 * Adjusts quantities for ticket line items according to the registrations provided upon construction,
+	 * so if a TXN was for 2 of the same ticket, but we are only generating line items for a single registration,
+	 * then this will change the quantity to 1, and update the total accordingly
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function adjustLineItemQuantity(EEI_Line_Item $line_item)
+	{
+		// is this a ticket ?
+		if ($line_item->type() === EEM_Line_Item::type_line_item && $line_item->OBJ_type() === 'Ticket') {
+			$this->_current_registration = null;
+			$quantity                    = 0;
+			// if this ticket is billable at this moment, then we should have a positive quantity
+			if (
+				isset($this->_line_item_registrations[ $line_item->code() ])
+				&& is_array($this->_line_item_registrations[ $line_item->code() ])
+			) {
+				// set quantity based on number of open registrations for this ticket
+				foreach ($this->_line_item_registrations[ $line_item->code() ] as $registration) {
+					if (
+						$registration instanceof EE_Registration
+					) {
+						$quantity++;
+						$this->_current_registration = $registration;
+					}
+				}
+			}
 
-            $line_item->set_quantity($quantity);
-            $line_item->set_total($line_item->unit_price() * $line_item->quantity());
-        }
-        return $line_item;
-    }
+			$line_item->set_quantity($quantity);
+			$line_item->set_total($line_item->unit_price() * $line_item->quantity());
+		}
+		return $line_item;
+	}
 
 
-    /**
-     * @param EEI_Line_Item $line_item
-     * @param int           $running_total_for_specific_ticket
-     * @param int           $total_child_ticket_quantity
-     * @since   $VID:$
-     */
-    private function adjustLineItemTotalAndQty(
-        EEI_Line_Item $line_item,
-        $running_total_for_specific_ticket,
-        $total_child_ticket_quantity
-    ) {
-        $line_item->set_total($running_total_for_specific_ticket);
-        $new_unit_price = $line_item->quantity()
-            ? $running_total_for_specific_ticket / $line_item->quantity()
-            : 0;
+	/**
+	 * @param EEI_Line_Item $line_item
+	 * @param int           $running_total_for_specific_ticket
+	 * @param int           $total_child_ticket_quantity
+	 * @since   $VID:$
+	 */
+	private function adjustLineItemTotalAndQty(
+		EEI_Line_Item $line_item,
+		$running_total_for_specific_ticket,
+		$total_child_ticket_quantity
+	) {
+		$line_item->set_total($running_total_for_specific_ticket);
+		$new_unit_price = $line_item->quantity()
+			? $running_total_for_specific_ticket / $line_item->quantity()
+			: 0;
 
-        $line_item->set_unit_price($new_unit_price);
-        if ($line_item->OBJ_type() === 'Event') {
-            $line_item->set_quantity($total_child_ticket_quantity);
-        }
-    }
+		$line_item->set_unit_price($new_unit_price);
+		if ($line_item->OBJ_type() === 'Event') {
+			$line_item->set_quantity($total_child_ticket_quantity);
+		}
+	}
 
 
-    /**
-     * sets the _line_item_registrations from the provided registrations
-     *
-     * @param EE_Registration[] $registrations
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    private function calculateRegistrationsPerLineItemCode($registrations)
-    {
-        foreach ($registrations as $registration) {
-            $line_item_code = EEM_Line_Item::instance()->get_var(
-                EEM_Line_Item::instance()->line_item_for_registration_query_params(
-                    $registration,
-                    ['limit' => 1]
-                ),
-                'LIN_code'
-            );
-            if ($line_item_code) {
-                if (! isset($this->_line_item_registrations[ $line_item_code ])) {
-                    $this->_line_item_registrations[ $line_item_code ] = [];
-                }
-                $this->_line_item_registrations[ $line_item_code ][ $registration->ID() ] = $registration;
-            }
-        }
-    }
+	/**
+	 * sets the _line_item_registrations from the provided registrations
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	private function calculateRegistrationsPerLineItemCode($registrations)
+	{
+		foreach ($registrations as $registration) {
+			$line_item_code = EEM_Line_Item::instance()->get_var(
+				EEM_Line_Item::instance()->line_item_for_registration_query_params(
+					$registration,
+					['limit' => 1]
+				),
+				'LIN_code'
+			);
+			if ($line_item_code) {
+				if (! isset($this->_line_item_registrations[ $line_item_code ])) {
+					$this->_line_item_registrations[ $line_item_code ] = [];
+				}
+				$this->_line_item_registrations[ $line_item_code ][ $registration->ID() ] = $registration;
+			}
+		}
+	}
 
 
-    /**
-     * @param EEI_Line_Item $line_item
-     * @param EEI_Line_Item $child_line_item
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   $VID:$
-     */
-    private function isNonCancelledTicketLineItem(EEI_Line_Item $line_item, EEI_Line_Item $child_line_item)
-    {
-        return // make sure this item's quantity and total matches its parent
-            $line_item->type() === EEM_Line_Item::type_line_item
-            && $line_item->OBJ_type() === 'Ticket'
-            // but not if it's a percentage modifier
-            && ! $child_line_item->is_percent()
-            && ! (
-                // or a cancellation
-                $child_line_item->is_cancelled()
-                && ! (
-                    // unless it IS a cancellation and the current registration is cancelled
-                    $child_line_item->is_cancelled()
-                    && $this->_current_registration instanceof EE_Registration
-                    && in_array($this->_current_registration->status_ID(), $this->_closed_reg_statuses, true)
-                )
-            );
-    }
+	/**
+	 * @param EEI_Line_Item $line_item
+	 * @param EEI_Line_Item $child_line_item
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   $VID:$
+	 */
+	private function isNonCancelledTicketLineItem(EEI_Line_Item $line_item, EEI_Line_Item $child_line_item)
+	{
+		return // make sure this item's quantity and total matches its parent
+			$line_item->type() === EEM_Line_Item::type_line_item
+			&& $line_item->OBJ_type() === 'Ticket'
+			// but not if it's a percentage modifier
+			&& ! $child_line_item->is_percent()
+			&& ! (
+				// or a cancellation
+				$child_line_item->is_cancelled()
+				&& ! (
+					// unless it IS a cancellation and the current registration is cancelled
+					$child_line_item->is_cancelled()
+					&& $this->_current_registration instanceof EE_Registration
+					&& in_array($this->_current_registration->status_ID(), $this->_closed_reg_statuses, true)
+				)
+			);
+	}
 
 
-    /**
-     * @param EEI_Line_Item $line_item
-     * @return bool
-     * @since   $VID:$
-     */
-    private function isNonTicketLineItem(EEI_Line_Item $line_item)
-    {
-        return $line_item->type() === EEM_Line_Item::type_line_item && $line_item->OBJ_type() !== 'Ticket';
-    }
+	/**
+	 * @param EEI_Line_Item $line_item
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	private function isNonTicketLineItem(EEI_Line_Item $line_item)
+	{
+		return $line_item->type() === EEM_Line_Item::type_line_item && $line_item->OBJ_type() !== 'Ticket';
+	}
 
 
-    /**
-     * Creates a duplicate of the line item tree, except only includes billable items
-     * and the portion of line items attributed to billable things
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     * @throws EE_Error|ReflectionException
-     */
-    public function process(EEI_Line_Item $line_item)
-    {
-        $this->adjustLineItemQuantity($line_item);
-        if (! $line_item->children()) {
-            return $line_item;
-        }
-        // the original running total (taking ALL tickets into account)
-        $running_total_for_all_tickets = 0;
-        // the new running total (only taking the specified ticket quantities into account)
-        $running_total_for_specific_ticket = 0;
-        // let's also track the quantity of tickets that pertain to the registrations
-        $total_child_ticket_quantity = 0;
-        foreach ($line_item->children() as $child_line_item) {
-            $original_li_total = $child_line_item->is_percent()
-                ? $running_total_for_all_tickets * $child_line_item->percent() / 100
-                : $child_line_item->unit_price() * $child_line_item->quantity();
+	/**
+	 * Creates a duplicate of the line item tree, except only includes billable items
+	 * and the portion of line items attributed to billable things
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 * @throws EE_Error|ReflectionException
+	 */
+	public function process(EEI_Line_Item $line_item)
+	{
+		$this->adjustLineItemQuantity($line_item);
+		if (! $line_item->children()) {
+			return $line_item;
+		}
+		// the original running total (taking ALL tickets into account)
+		$running_total_for_all_tickets = 0;
+		// the new running total (only taking the specified ticket quantities into account)
+		$running_total_for_specific_ticket = 0;
+		// let's also track the quantity of tickets that pertain to the registrations
+		$total_child_ticket_quantity = 0;
+		foreach ($line_item->children() as $child_line_item) {
+			$original_li_total = $child_line_item->is_percent()
+				? $running_total_for_all_tickets * $child_line_item->percent() / 100
+				: $child_line_item->unit_price() * $child_line_item->quantity();
 
-            $this->process($child_line_item);
+			$this->process($child_line_item);
 
-            $applies_to_primary_registrant = $this->_current_registration instanceof EE_Registration
-                                             && $this->_current_registration->is_primary_registrant();
-            // If this line item is a normal line item that isn't for a ticket,
-            // we want to modify its total (and unit price if not a percentage line item)
-            // so it reflects only that portion of the surcharge/discount shared by these registrations
-            if ($this->isNonTicketLineItem($child_line_item)) {
-                $this->extra_txn_fees_handler->adjustUnitPriceForNonTicketLineItem(
-                    $line_item,
-                    $child_line_item,
-                    $original_li_total,
-                    $running_total_for_all_tickets,
-                    $running_total_for_specific_ticket,
-                    $applies_to_primary_registrant
-                );
-            } elseif ($this->isNonCancelledTicketLineItem($line_item, $child_line_item)) {
-                $this->extra_txn_fees_handler->adjustUnitPriceAndQtyForTicketLineItem(
-                    $line_item,
-                    $child_line_item,
-                    $applies_to_primary_registrant
-                );
-            }
-            $running_total_for_all_tickets += $original_li_total;
-            $running_total_for_specific_ticket += $child_line_item->total();
+			$applies_to_primary_registrant = $this->_current_registration instanceof EE_Registration
+											 && $this->_current_registration->is_primary_registrant();
+			// If this line item is a normal line item that isn't for a ticket,
+			// we want to modify its total (and unit price if not a percentage line item)
+			// so it reflects only that portion of the surcharge/discount shared by these registrations
+			if ($this->isNonTicketLineItem($child_line_item)) {
+				$this->extra_txn_fees_handler->adjustUnitPriceForNonTicketLineItem(
+					$line_item,
+					$child_line_item,
+					$original_li_total,
+					$running_total_for_all_tickets,
+					$running_total_for_specific_ticket,
+					$applies_to_primary_registrant
+				);
+			} elseif ($this->isNonCancelledTicketLineItem($line_item, $child_line_item)) {
+				$this->extra_txn_fees_handler->adjustUnitPriceAndQtyForTicketLineItem(
+					$line_item,
+					$child_line_item,
+					$applies_to_primary_registrant
+				);
+			}
+			$running_total_for_all_tickets += $original_li_total;
+			$running_total_for_specific_ticket += $child_line_item->total();
 
-            if ($child_line_item->OBJ_type() === 'Ticket') {
-                $total_child_ticket_quantity += $child_line_item->quantity();
-            }
-        }
-        $this->adjustLineItemTotalAndQty($line_item, $running_total_for_specific_ticket, $total_child_ticket_quantity);
-        return $line_item;
-    }
+			if ($child_line_item->OBJ_type() === 'Ticket') {
+				$total_child_ticket_quantity += $child_line_item->quantity();
+			}
+		}
+		$this->adjustLineItemTotalAndQty($line_item, $running_total_for_specific_ticket, $total_child_ticket_quantity);
+		return $line_item;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -87,11 +87,11 @@ 
             $quantity                    = 0;
             // if this ticket is billable at this moment, then we should have a positive quantity
             if (
-                isset($this->_line_item_registrations[ $line_item->code() ])
-                && is_array($this->_line_item_registrations[ $line_item->code() ])
+                isset($this->_line_item_registrations[$line_item->code()])
+                && is_array($this->_line_item_registrations[$line_item->code()])
             ) {
                 // set quantity based on number of open registrations for this ticket
-                foreach ($this->_line_item_registrations[ $line_item->code() ] as $registration) {
+                foreach ($this->_line_item_registrations[$line_item->code()] as $registration) {
                     if (
                         $registration instanceof EE_Registration
                     ) {
@@ -149,10 +149,10 @@ 
                 'LIN_code'
             );
             if ($line_item_code) {
-                if (! isset($this->_line_item_registrations[ $line_item_code ])) {
-                    $this->_line_item_registrations[ $line_item_code ] = [];
+                if ( ! isset($this->_line_item_registrations[$line_item_code])) {
+                    $this->_line_item_registrations[$line_item_code] = [];
                 }
-                $this->_line_item_registrations[ $line_item_code ][ $registration->ID() ] = $registration;
+                $this->_line_item_registrations[$line_item_code][$registration->ID()] = $registration;
             }
         }
     }
@@ -208,7 +208,7 @@ 
     public function process(EEI_Line_Item $line_item)
     {
         $this->adjustLineItemQuantity($line_item);
-        if (! $line_item->children()) {
+        if ( ! $line_item->children()) {
             return $line_item;
         }
         // the original running total (taking ALL tickets into account)

core/libraries/line_item_display/EE_Admin_Table_Registration_Line_Item_Display_Strategy.strategy.php

Indentation +233 added lines, -233 removed lines

@@ -13,237 +13,237 @@
 
 class EE_Admin_Table_Registration_Line_Item_Display_Strategy extends EE_Admin_Table_Line_Item_Display_Strategy
 {
-    /**
-     * @var EE_Registration
-     */
-    protected $registration;
-
-
-    /**
-     * EE_Admin_Table_Registration_Line_Item_Display_Strategy constructor.
-     */
-    public function __construct()
-    {
-        $this->registration = isset($options['EE_Registration'])
-                              && $options['EE_Registration'] instanceof EE_Registration
-            ? $options['EE_Registration']
-            : null;
-    }
-
-
-    /**
-     * Table header for display.
-     *
-     * @param array $options
-     * @return string
-     * @since   4.8
-     */
-    protected function _table_header($options)
-    {
-        $html = EEH_HTML::table('', '', $options['table_css_class']);
-        $html .= EEH_HTML::thead();
-        $html .= EEH_HTML::tr();
-        $html .= EEH_HTML::th(esc_html__('Name', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(esc_html__('Type', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(esc_html__('Date(s)', 'event_espresso'), '', 'jst-left');
-        $html .= EEH_HTML::th(esc_html__('Amount', 'event_espresso'), '', 'jst-cntr');
-        $html .= EEH_HTML::tbody();
-        return $html;
-    }
-
-
-    /**
-     *    _item_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _item_row(EE_Line_Item $line_item, $options = [])
-    {
-        if ($line_item->quantity() === 0) {
-            return '';
-        }
-        $line_item_related_object        = $line_item->get_object();
-        $parent_line_item_related_object = $line_item->parent() instanceof EE_Line_Item
-            ? $line_item->parent()->get_object()
-            : null;
-        // start of row
-        $row_class = $options['odd'] ? 'item odd' : 'item';
-        $html      = EEH_HTML::tr('', '', $row_class);
-
-
-        // Name Column
-        $name_link =
-            $line_item_related_object instanceof EEI_Admin_Links
-                ? $line_item_related_object->get_admin_details_link()
-                : '';
-
-        // related object scope.
-        $parent_related_object_name = $parent_line_item_related_object instanceof EEI_Line_Item_Object
-            ? $parent_line_item_related_object->name()
-            : '';
-        $parent_related_object_name = empty($parent_related_object_name) && $line_item->parent() instanceof EE_Line_Item
-            ? $line_item->parent()->name()
-            : $parent_related_object_name;
-        $parent_related_object_link = $parent_line_item_related_object instanceof EEI_Admin_Links
-            ? $parent_line_item_related_object->get_admin_details_link()
-            : '';
-
-        $name_html = $line_item_related_object instanceof EEI_Line_Item_Object
-            ? $line_item_related_object->name()
-            : $line_item->name();
-        $name_html = $name_link
-            ? '<a href="' . $name_link . '">' . $name_html . '</a>'
-            : $name_html;
-        $name_html .= $line_item->is_taxable() ? ' *' : '';
-
-        // maybe preface with icon?
-        $name_html = $line_item_related_object instanceof EEI_Has_Icon
-            ? $line_item_related_object->get_icon() . $name_html
-            : $name_html;
-
-        $name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
-        $name_html .= sprintf(
-            esc_html_x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
-            '<span class="ee-line-item-related-parent-object">',
-            $line_item->parent() instanceof EE_Line_Item
-                ? $line_item->parent()->OBJ_type_i18n()
-                : esc_html__('Item:', 'event_espresso'),
-            $parent_related_object_link
-                ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
-                : $parent_related_object_name,
-            '</span>'
-        );
-
-        $name_html = apply_filters(
-            'FHEE__EE_Admin_Table_Registration_Line_Item_Display_Strategy___item_row__name_html',
-            $name_html,
-            $line_item,
-            $options
-        );
-
-        $html .= EEH_HTML::td($name_html, '', 'jst-left');
-        // Type Column
-        $type_html = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() : '';
-        $type_html .= $this->_get_cancellations($line_item);
-        $type_html .= $line_item->OBJ_type() ? '<br />' : '';
-        $code      = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
-        $type_html .= ! empty($code)
-            ? '<span class="ee-line-item-id">' . sprintf(esc_html__('Code: %s', 'event_espresso'), $code) . '</span>'
-            : '';
-        $html      .= EEH_HTML::td($type_html, '', 'jst-left');
-
-        // Date column
-        $datetime_content = '';
-        if ($line_item_related_object instanceof EE_Ticket) {
-            $datetimes = $line_item_related_object->datetimes();
-            foreach ($datetimes as $datetime) {
-                if ($datetime instanceof EE_Datetime) {
-                    $datetime_content .= $datetime->get_dtt_display_name() . '<br>';
-                }
-            }
-        }
-        $html .= EEH_HTML::td($datetime_content, '', 'jst-left');
-
-        // Amount Column
-        if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
-        } else {
-            $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
-        }
-
-
-        // finish things off and return
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-    /**
-     *  _tax_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _tax_row(EE_Line_Item $line_item, $options = [])
-    {
-        // start of row
-        $html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
-        // name th
-        $html .= EEH_HTML::th(
-            $line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)',
-            '',
-            'jst-rght',
-            '',
-            ' colspan="3"'
-        );
-        // total th
-        $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
-
-
-    /**
-     *  _total_row
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $options
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _total_row(EE_Line_Item $line_item, $options = [])
-    {
-        $registration_total = $this->registration instanceof EE_Registration
-            ? $this->registration->pretty_final_price()
-            : 0;
-        // if no valid registration object then we're not going to show the approximate text.
-        $total_match = $this->registration instanceof EE_Registration
-            ? $this->registration->final_price() === $line_item->total()
-            : true;
-
-        // start of row
-        $html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
-        // Total th label
-        if ($total_match) {
-            $total_label =
-                sprintf(
-                    esc_html__('This registration\'s total %s:', 'event_espresso'),
-                    '(' . EE_Registry::instance()->CFG->currency->code . ')'
-                );
-        } else {
-            $total_label =
-                sprintf(
-                    esc_html__('This registration\'s approximate total %s', 'event_espresso'),
-                    '(' . EE_Registry::instance()->CFG->currency->code . ')'
-                );
-            $total_label .= '<br>';
-            $total_label .= '<p class="ee-footnote-text">'
-                            . sprintf(
-                                esc_html__(
-                                    'The registrations\' share of the transaction total is approximate because it might not be possible to evenly divide the transaction total among each registration, and so some registrations may need to pay a penny more than others.  This registration\'s final share is actually %1$s%2$s%3$s.',
-                                    'event_espresso'
-                                ),
-                                '<strong>',
-                                $registration_total,
-                                '</strong>'
-                            )
-                            . '</p>';
-        }
-        $html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="3"');
-        // total th
-
-        $html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
-        // end of row
-        $html .= EEH_HTML::trx();
-        return $html;
-    }
+	/**
+	 * @var EE_Registration
+	 */
+	protected $registration;
+
+
+	/**
+	 * EE_Admin_Table_Registration_Line_Item_Display_Strategy constructor.
+	 */
+	public function __construct()
+	{
+		$this->registration = isset($options['EE_Registration'])
+							  && $options['EE_Registration'] instanceof EE_Registration
+			? $options['EE_Registration']
+			: null;
+	}
+
+
+	/**
+	 * Table header for display.
+	 *
+	 * @param array $options
+	 * @return string
+	 * @since   4.8
+	 */
+	protected function _table_header($options)
+	{
+		$html = EEH_HTML::table('', '', $options['table_css_class']);
+		$html .= EEH_HTML::thead();
+		$html .= EEH_HTML::tr();
+		$html .= EEH_HTML::th(esc_html__('Name', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(esc_html__('Type', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(esc_html__('Date(s)', 'event_espresso'), '', 'jst-left');
+		$html .= EEH_HTML::th(esc_html__('Amount', 'event_espresso'), '', 'jst-cntr');
+		$html .= EEH_HTML::tbody();
+		return $html;
+	}
+
+
+	/**
+	 *    _item_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _item_row(EE_Line_Item $line_item, $options = [])
+	{
+		if ($line_item->quantity() === 0) {
+			return '';
+		}
+		$line_item_related_object        = $line_item->get_object();
+		$parent_line_item_related_object = $line_item->parent() instanceof EE_Line_Item
+			? $line_item->parent()->get_object()
+			: null;
+		// start of row
+		$row_class = $options['odd'] ? 'item odd' : 'item';
+		$html      = EEH_HTML::tr('', '', $row_class);
+
+
+		// Name Column
+		$name_link =
+			$line_item_related_object instanceof EEI_Admin_Links
+				? $line_item_related_object->get_admin_details_link()
+				: '';
+
+		// related object scope.
+		$parent_related_object_name = $parent_line_item_related_object instanceof EEI_Line_Item_Object
+			? $parent_line_item_related_object->name()
+			: '';
+		$parent_related_object_name = empty($parent_related_object_name) && $line_item->parent() instanceof EE_Line_Item
+			? $line_item->parent()->name()
+			: $parent_related_object_name;
+		$parent_related_object_link = $parent_line_item_related_object instanceof EEI_Admin_Links
+			? $parent_line_item_related_object->get_admin_details_link()
+			: '';
+
+		$name_html = $line_item_related_object instanceof EEI_Line_Item_Object
+			? $line_item_related_object->name()
+			: $line_item->name();
+		$name_html = $name_link
+			? '<a href="' . $name_link . '">' . $name_html . '</a>'
+			: $name_html;
+		$name_html .= $line_item->is_taxable() ? ' *' : '';
+
+		// maybe preface with icon?
+		$name_html = $line_item_related_object instanceof EEI_Has_Icon
+			? $line_item_related_object->get_icon() . $name_html
+			: $name_html;
+
+		$name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
+		$name_html .= sprintf(
+			esc_html_x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
+			'<span class="ee-line-item-related-parent-object">',
+			$line_item->parent() instanceof EE_Line_Item
+				? $line_item->parent()->OBJ_type_i18n()
+				: esc_html__('Item:', 'event_espresso'),
+			$parent_related_object_link
+				? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
+				: $parent_related_object_name,
+			'</span>'
+		);
+
+		$name_html = apply_filters(
+			'FHEE__EE_Admin_Table_Registration_Line_Item_Display_Strategy___item_row__name_html',
+			$name_html,
+			$line_item,
+			$options
+		);
+
+		$html .= EEH_HTML::td($name_html, '', 'jst-left');
+		// Type Column
+		$type_html = $line_item->OBJ_type() ? $line_item->OBJ_type_i18n() : '';
+		$type_html .= $this->_get_cancellations($line_item);
+		$type_html .= $line_item->OBJ_type() ? '<br />' : '';
+		$code      = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
+		$type_html .= ! empty($code)
+			? '<span class="ee-line-item-id">' . sprintf(esc_html__('Code: %s', 'event_espresso'), $code) . '</span>'
+			: '';
+		$html      .= EEH_HTML::td($type_html, '', 'jst-left');
+
+		// Date column
+		$datetime_content = '';
+		if ($line_item_related_object instanceof EE_Ticket) {
+			$datetimes = $line_item_related_object->datetimes();
+			foreach ($datetimes as $datetime) {
+				if ($datetime instanceof EE_Datetime) {
+					$datetime_content .= $datetime->get_dtt_display_name() . '<br>';
+				}
+			}
+		}
+		$html .= EEH_HTML::td($datetime_content, '', 'jst-left');
+
+		// Amount Column
+		if ($line_item->is_percent()) {
+			$html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
+		} else {
+			$html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
+		}
+
+
+		// finish things off and return
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+	/**
+	 *  _tax_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _tax_row(EE_Line_Item $line_item, $options = [])
+	{
+		// start of row
+		$html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
+		// name th
+		$html .= EEH_HTML::th(
+			$line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)',
+			'',
+			'jst-rght',
+			'',
+			' colspan="3"'
+		);
+		// total th
+		$html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
+
+
+	/**
+	 *  _total_row
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $options
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _total_row(EE_Line_Item $line_item, $options = [])
+	{
+		$registration_total = $this->registration instanceof EE_Registration
+			? $this->registration->pretty_final_price()
+			: 0;
+		// if no valid registration object then we're not going to show the approximate text.
+		$total_match = $this->registration instanceof EE_Registration
+			? $this->registration->final_price() === $line_item->total()
+			: true;
+
+		// start of row
+		$html = EEH_HTML::tr('', '', 'admin-primary-mbox-total-tr');
+		// Total th label
+		if ($total_match) {
+			$total_label =
+				sprintf(
+					esc_html__('This registration\'s total %s:', 'event_espresso'),
+					'(' . EE_Registry::instance()->CFG->currency->code . ')'
+				);
+		} else {
+			$total_label =
+				sprintf(
+					esc_html__('This registration\'s approximate total %s', 'event_espresso'),
+					'(' . EE_Registry::instance()->CFG->currency->code . ')'
+				);
+			$total_label .= '<br>';
+			$total_label .= '<p class="ee-footnote-text">'
+							. sprintf(
+								esc_html__(
+									'The registrations\' share of the transaction total is approximate because it might not be possible to evenly divide the transaction total among each registration, and so some registrations may need to pay a penny more than others.  This registration\'s final share is actually %1$s%2$s%3$s.',
+									'event_espresso'
+								),
+								'<strong>',
+								$registration_total,
+								'</strong>'
+							)
+							. '</p>';
+		}
+		$html .= EEH_HTML::th($total_label, '', 'jst-rght', '', ' colspan="3"');
+		// total th
+
+		$html .= EEH_HTML::th(EEH_Template::format_currency($line_item->total(), false, false), '', 'jst-rght');
+		// end of row
+		$html .= EEH_HTML::trx();
+		return $html;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -96,16 +96,16 @@ 
             ? $line_item_related_object->name()
             : $line_item->name();
         $name_html = $name_link
-            ? '<a href="' . $name_link . '">' . $name_html . '</a>'
+            ? '<a href="'.$name_link.'">'.$name_html.'</a>'
             : $name_html;
         $name_html .= $line_item->is_taxable() ? ' *' : '';
 
         // maybe preface with icon?
         $name_html = $line_item_related_object instanceof EEI_Has_Icon
-            ? $line_item_related_object->get_icon() . $name_html
+            ? $line_item_related_object->get_icon().$name_html
             : $name_html;
 
-        $name_html = '<span class="ee-line-item-name linked">' . $name_html . '</span><br>';
+        $name_html = '<span class="ee-line-item-name linked">'.$name_html.'</span><br>';
         $name_html .= sprintf(
             esc_html_x('%1$sfor the %2$s: %3$s%4$s', 'eg. "for the Event: My Cool Event"', 'event_espresso'),
             '<span class="ee-line-item-related-parent-object">',
@@ -113,7 +113,7 @@ 
                 ? $line_item->parent()->OBJ_type_i18n()
                 : esc_html__('Item:', 'event_espresso'),
             $parent_related_object_link
-                ? '<a href="' . $parent_related_object_link . '">' . $parent_related_object_name . '</a>'
+                ? '<a href="'.$parent_related_object_link.'">'.$parent_related_object_name.'</a>'
                 : $parent_related_object_name,
             '</span>'
         );
@@ -132,7 +132,7 @@ 
         $type_html .= $line_item->OBJ_type() ? '<br />' : '';
         $code      = $line_item_related_object instanceof EEI_Has_Code ? $line_item_related_object->code() : '';
         $type_html .= ! empty($code)
-            ? '<span class="ee-line-item-id">' . sprintf(esc_html__('Code: %s', 'event_espresso'), $code) . '</span>'
+            ? '<span class="ee-line-item-id">'.sprintf(esc_html__('Code: %s', 'event_espresso'), $code).'</span>'
             : '';
         $html      .= EEH_HTML::td($type_html, '', 'jst-left');
 
@@ -142,7 +142,7 @@ 
             $datetimes = $line_item_related_object->datetimes();
             foreach ($datetimes as $datetime) {
                 if ($datetime instanceof EE_Datetime) {
-                    $datetime_content .= $datetime->get_dtt_display_name() . '<br>';
+                    $datetime_content .= $datetime->get_dtt_display_name().'<br>';
                 }
             }
         }
@@ -150,7 +150,7 @@ 
 
         // Amount Column
         if ($line_item->is_percent()) {
-            $html .= EEH_HTML::td($line_item->percent() . '%', '', 'jst-rght');
+            $html .= EEH_HTML::td($line_item->percent().'%', '', 'jst-rght');
         } else {
             $html .= EEH_HTML::td($line_item->unit_price_no_code(), '', 'jst-rght');
         }
@@ -177,7 +177,7 @@ 
         $html = EEH_HTML::tr('', 'admin-primary-mbox-taxes-tr');
         // name th
         $html .= EEH_HTML::th(
-            $line_item->name() . '(' . $line_item->get_pretty('LIN_percent') . '%)',
+            $line_item->name().'('.$line_item->get_pretty('LIN_percent').'%)',
             '',
             'jst-rght',
             '',
@@ -217,13 +217,13 @@ 
             $total_label =
                 sprintf(
                     esc_html__('This registration\'s total %s:', 'event_espresso'),
-                    '(' . EE_Registry::instance()->CFG->currency->code . ')'
+                    '('.EE_Registry::instance()->CFG->currency->code.')'
                 );
         } else {
             $total_label =
                 sprintf(
                     esc_html__('This registration\'s approximate total %s', 'event_espresso'),
-                    '(' . EE_Registry::instance()->CFG->currency->code . ')'
+                    '('.EE_Registry::instance()->CFG->currency->code.')'
                 );
             $total_label .= '<br>';
             $total_label .= '<p class="ee-footnote-text">'

core/helpers/EEH_Line_Item.helper.php

Spacing +42 added lines, -42 removed lines

@@ -58,7 +58,7 @@ 
             $items_subtotal_children = $items_subtotal->children();
             $order = count($items_subtotal_children);
         }
-        $line_item      = EE_Line_Item::new_instance(
+        $line_item = EE_Line_Item::new_instance(
             [
                 'LIN_name'       => $name,
                 'LIN_desc'       => $description,
@@ -72,7 +72,7 @@ 
                 'LIN_code'       => $code,
             ]
         );
-        $line_item      = apply_filters(
+        $line_item = apply_filters(
             'FHEE__EEH_Line_Item__add_unrelated_item__line_item',
             $line_item,
             $parent_line_item
@@ -148,7 +148,7 @@ 
      */
     public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
     {
-        if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
+        if ( ! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -163,7 +163,7 @@ 
         // either increment the qty for an existing ticket
         $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
         // or add a new one
-        if (! $line_item instanceof EE_Line_Item) {
+        if ( ! $line_item instanceof EE_Line_Item) {
             $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
         }
         $total_line_item->recalculate_total_including_taxes();
@@ -225,7 +225,7 @@ 
      */
     public static function increment_quantity(EE_Line_Item $line_item, $qty = 1)
     {
-        if (! $line_item->is_percent()) {
+        if ( ! $line_item->is_percent()) {
             $qty += $line_item->quantity();
             $line_item->set_quantity($qty);
             $line_item->set_total($line_item->unit_price() * $qty);
@@ -254,7 +254,7 @@ 
      */
     public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1)
     {
-        if (! $line_item->is_percent()) {
+        if ( ! $line_item->is_percent()) {
             $qty = $line_item->quantity() - $qty;
             $qty = max($qty, 0);
             $line_item->set_quantity($qty);
@@ -283,7 +283,7 @@ 
      */
     public static function update_quantity(EE_Line_Item $line_item, $new_quantity)
     {
-        if (! $line_item->is_percent()) {
+        if ( ! $line_item->is_percent()) {
             $line_item->set_quantity($new_quantity);
             $line_item->set_total($line_item->unit_price() * $new_quantity);
             $line_item->save();
@@ -324,7 +324,7 @@ 
         $line_item = EE_Line_Item::new_instance(
             [
                 'LIN_name'       => $ticket->name(),
-                'LIN_desc'       => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
+                'LIN_desc'       => $ticket->description() !== '' ? $ticket->description().' '.$event : $event,
                 'LIN_unit_price' => $ticket->price(),
                 'LIN_quantity'   => $qty,
                 'LIN_is_taxable' => $ticket->taxable(),
@@ -479,7 +479,7 @@ 
                             'event_espresso'
                         ),
                         $ticket_line_item->name(),
-                        current_time(get_option('date_format') . ' ' . get_option('time_format'))
+                        current_time(get_option('date_format').' '.get_option('time_format'))
                     ),
                     'LIN_unit_price' => 0, // $ticket_line_item->unit_price()
                     'LIN_quantity'   => $qty,
@@ -543,7 +543,7 @@ 
         );
         $cancellation_line_item = reset($cancellation_line_item);
         // verify that this ticket was indeed previously cancelled
-        if (! $cancellation_line_item instanceof EE_Line_Item) {
+        if ( ! $cancellation_line_item instanceof EE_Line_Item) {
             return false;
         }
         if ($cancellation_line_item->quantity() > $qty) {
@@ -754,7 +754,7 @@ 
                 'LIN_code'  => 'taxes',
                 'LIN_name'  => esc_html__('Taxes', 'event_espresso'),
                 'LIN_type'  => EEM_Line_Item::type_tax_sub_total,
-                'LIN_order' => 1000,// this should always come last
+                'LIN_order' => 1000, // this should always come last
             ]
         );
         $tax_line_item = apply_filters(
@@ -813,7 +813,7 @@ 
      */
     public static function get_event_code($event)
     {
-        return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0');
+        return 'event-'.($event instanceof EE_Event ? $event->ID() : '0');
     }
 
 
@@ -862,7 +862,7 @@ 
     public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket)
     {
         $first_datetime = $ticket->first_datetime();
-        if (! $first_datetime instanceof EE_Datetime) {
+        if ( ! $first_datetime instanceof EE_Datetime) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'),
@@ -871,7 +871,7 @@ 
             );
         }
         $event = $first_datetime->event();
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -883,7 +883,7 @@ 
             );
         }
         $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
-        if (! $events_sub_total instanceof EE_Line_Item) {
+        if ( ! $events_sub_total instanceof EE_Line_Item) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -919,7 +919,7 @@ 
         $found           = false;
         foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) {
             // default event subtotal, we should only ever find this the first time this method is called
-            if (! $event_line_item->OBJ_ID()) {
+            if ( ! $event_line_item->OBJ_ID()) {
                 // let's use this! but first... set the event details
                 EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
                 $found = true;
@@ -931,7 +931,7 @@ 
                 break;
             }
         }
-        if (! $found) {
+        if ( ! $found) {
             // there is no event sub-total yet, so add it
             $pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total);
             // create a new "event" subtotal below that
@@ -1018,7 +1018,7 @@ 
                         'FHEE__EEH_Line_Item__apply_taxes__tax_line_item',
                         $tax_line_item
                     );
-                    $updates       = $taxes_line_item->add_child_line_item($tax_line_item)
+                    $updates = $taxes_line_item->add_child_line_item($tax_line_item)
                         ? true
                         : $updates;
                 }
@@ -1048,7 +1048,7 @@ 
     public static function ensure_taxes_applied($total_line_item)
     {
         $taxes_subtotal = self::get_taxes_subtotal($total_line_item);
-        if (! $taxes_subtotal->children()) {
+        if ( ! $taxes_subtotal->children()) {
             self::apply_taxes($total_line_item);
         }
         return $taxes_subtotal->total();
@@ -1114,7 +1114,7 @@ 
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
 
         // check if only a single line_item_id was passed
-        if (! empty($line_item_codes) && ! is_array($line_item_codes)) {
+        if ( ! empty($line_item_codes) && ! is_array($line_item_codes)) {
             // place single line_item_id in an array to appear as multiple line_item_ids
             $line_item_codes = [$line_item_codes];
         }
@@ -1223,7 +1223,7 @@ 
         if ($code_substring_for_whitelist !== null) {
             $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false;
         }
-        if (! $whitelisted && $line_item->is_line_item()) {
+        if ( ! $whitelisted && $line_item->is_line_item()) {
             $line_item->set_is_taxable($taxable);
         }
         foreach ($line_item->children() as $child_line_item) {
@@ -1584,7 +1584,7 @@ 
     {
         $linebreak = defined('EE_TESTS_DIR') ? "\n" : '<br />';
         echo $linebreak;
-        if (! $indentation) {
+        if ( ! $indentation) {
             echo $linebreak;
         }
         for ($i = 0; $i < $indentation; $i++) {
@@ -1595,12 +1595,12 @@ 
             if ($line_item->is_percent()) {
                 $breakdown = "{$line_item->percent()}%";
             } else {
-                $breakdown = ' $' . "{$line_item->unit_price()} x {$line_item->quantity()}";
+                $breakdown = ' $'."{$line_item->unit_price()} x {$line_item->quantity()}";
             }
         }
         echo wp_kses($line_item->name(), AllowedTags::getAllowedTags());
         echo " [ ID: {$line_item->ID()} · qty: {$line_item->quantity()} ] {$line_item->type()} : ";
-        echo ' $' . (string) $line_item->total();
+        echo ' $'.(string) $line_item->total();
         if ($breakdown) {
             echo " ( {$breakdown} )";
         }
@@ -1613,7 +1613,7 @@ 
             }
         }
         if ($line_item->is_total()) {
-            echo $linebreak . $linebreak;
+            echo $linebreak.$linebreak;
         }
     }
 
@@ -1694,8 +1694,8 @@ 
                         if ($line_item_id === 'taxable') {
                             continue;
                         }
-                        $taxable_total                   = $running_totals['taxable'][ $line_item_id ];
-                        $running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal);
+                        $taxable_total = $running_totals['taxable'][$line_item_id];
+                        $running_totals[$line_item_id] += ($taxable_total * $tax_percent_decimal);
                     }
                     break;
 
@@ -1703,7 +1703,7 @@ 
                     // ticket line items or ????
                     if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
                         // kk it's a ticket
-                        if (isset($running_totals[ $child_line_item->ID() ])) {
+                        if (isset($running_totals[$child_line_item->ID()])) {
                             // huh? that shouldn't happen.
                             $running_totals['total'] += $child_line_item->total();
                         } else {
@@ -1714,19 +1714,19 @@ 
                                 $taxable_amount = 0;
                             }
                             // are we only calculating totals for some tickets?
-                            if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) {
+                            if (isset($billable_ticket_quantities[$child_line_item->OBJ_ID()])) {
                                 $quantity                                            =
-                                    $billable_ticket_quantities[ $child_line_item->OBJ_ID() ];
-                                $running_totals[ $child_line_item->ID() ]            = $quantity
+                                    $billable_ticket_quantities[$child_line_item->OBJ_ID()];
+                                $running_totals[$child_line_item->ID()]            = $quantity
                                     ? $child_line_item->unit_price()
                                     : 0;
-                                $running_totals['taxable'][ $child_line_item->ID() ] = $quantity
+                                $running_totals['taxable'][$child_line_item->ID()] = $quantity
                                     ? $taxable_amount
                                     : 0;
                             } else {
                                 $quantity                                            = $child_line_item->quantity();
-                                $running_totals[ $child_line_item->ID() ]            = $child_line_item->unit_price();
-                                $running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount;
+                                $running_totals[$child_line_item->ID()]            = $child_line_item->unit_price();
+                                $running_totals['taxable'][$child_line_item->ID()] = $taxable_amount;
                             }
                             $running_totals['taxable']['total'] += $taxable_amount * $quantity;
                             $running_totals['total']            += $child_line_item->unit_price() * $quantity;
@@ -1746,12 +1746,12 @@ 
                             }
                             // update the running totals
                             // yes this actually even works for the running grand total!
-                            $running_totals[ $line_item_id ] =
+                            $running_totals[$line_item_id] =
                                 $line_items_percent_of_running_total * $this_running_total;
 
                             if ($child_line_item->is_taxable()) {
-                                $running_totals['taxable'][ $line_item_id ] =
-                                    $line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ];
+                                $running_totals['taxable'][$line_item_id] =
+                                    $line_items_percent_of_running_total * $running_totals['taxable'][$line_item_id];
                             }
                         }
                     }
@@ -1779,16 +1779,16 @@ 
     ) {
         static $final_prices_per_ticket_line_item = [];
         if (empty($final_prices_per_ticket_line_item)
-            || empty($final_prices_per_ticket_line_item[ $total_line_item->ID() ])
+            || empty($final_prices_per_ticket_line_item[$total_line_item->ID()])
         ) {
-            $final_prices_per_ticket_line_item[ $total_line_item->ID() ] =
+            $final_prices_per_ticket_line_item[$total_line_item->ID()] =
                 EEH_Line_Item::calculate_reg_final_prices_per_line_item(
                     $total_line_item
                 );
         }
         // ok now find this new registration's final price
-        if (isset($final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ])) {
-            return $final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ];
+        if (isset($final_prices_per_ticket_line_item[$total_line_item->ID()][$ticket_line_item->ID()])) {
+            return $final_prices_per_ticket_line_item[$total_line_item->ID()][$ticket_line_item->ID()];
         }
         $message = sprintf(
             esc_html__(
@@ -1798,7 +1798,7 @@ 
             $ticket_line_item->ID()
         );
         if (WP_DEBUG) {
-            $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true);
+            $message .= '<br>'.print_r($final_prices_per_ticket_line_item, true);
             throw new OutOfRangeException($message);
         }
         EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);

Indentation +2084 added lines, -2084 removed lines

@@ -21,2088 +21,2088 @@
  */
 class EEH_Line_Item
 {
-    /**
-     * Adds a simple item (unrelated to any other model object) to the provided PARENT line item.
-     * Does NOT automatically re-calculate the line item totals or update the related transaction.
-     * You should call recalculate_total_including_taxes() on the grant total line item after this
-     * to update the subtotals, and EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param string       $name
-     * @param float        $unit_price
-     * @param string       $description
-     * @param int          $quantity
-     * @param boolean      $taxable
-     * @param boolean      $code if set to a value, ensures there is only one line item with that code
-     * @return boolean success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function add_unrelated_item(
-        EE_Line_Item $parent_line_item,
-        $name,
-        $unit_price,
-        $description = '',
-        $quantity = 1,
-        $taxable = false,
-        $code = null
-    ) {
-        $items_subtotal = self::get_pre_tax_subtotal($parent_line_item);
-        $order = 0;
-        if ($items_subtotal instanceof EE_Line_Item) {
-            $items_subtotal_children = $items_subtotal->children();
-            $order = count($items_subtotal_children);
-        }
-        $line_item      = EE_Line_Item::new_instance(
-            [
-                'LIN_name'       => $name,
-                'LIN_desc'       => $description,
-                'LIN_unit_price' => $unit_price,
-                'LIN_quantity'   => $quantity,
-                'LIN_percent'    => null,
-                'LIN_is_taxable' => $taxable,
-                'LIN_order'      => $order,
-                'LIN_total'      => (float) $unit_price * (int) $quantity,
-                'LIN_type'       => EEM_Line_Item::type_line_item,
-                'LIN_code'       => $code,
-            ]
-        );
-        $line_item      = apply_filters(
-            'FHEE__EEH_Line_Item__add_unrelated_item__line_item',
-            $line_item,
-            $parent_line_item
-        );
-        return self::add_item($parent_line_item, $line_item);
-    }
-
-
-    /**
-     * Adds a simple item ( unrelated to any other model object) to the total line item,
-     * in the correct spot in the line item tree. Does not automatically
-     * re-calculate the line item totals, nor update the related transaction, nor upgrade the transaction's
-     * registrations' final prices (which should probably change because of this).
-     * You should call recalculate_total_including_taxes() on the grand total line item, then
-     * update the transaction's total, and EE_Registration_Processor::update_registration_final_prices()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @param string       $name
-     * @param float        $percentage_amount
-     * @param string       $description
-     * @param boolean      $taxable
-     * @return boolean success
-     * @throws EE_Error|ReflectionException
-     */
-    public static function add_percentage_based_item(
-        EE_Line_Item $parent_line_item,
-        $name,
-        $percentage_amount,
-        $description = '',
-        $taxable = false
-    ) {
-        $line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_name'       => $name,
-                'LIN_desc'       => $description,
-                'LIN_unit_price' => 0,
-                'LIN_percent'    => $percentage_amount,
-                'LIN_quantity'   => 1,
-                'LIN_is_taxable' => $taxable,
-                'LIN_total'      => (float) ($percentage_amount * ($parent_line_item->total() / 100)),
-                'LIN_type'       => EEM_Line_Item::type_line_item,
-                'LIN_parent'     => $parent_line_item->ID(),
-            ]
-        );
-        $line_item = apply_filters(
-            'FHEE__EEH_Line_Item__add_percentage_based_item__line_item',
-            $line_item
-        );
-        return $parent_line_item->add_child_line_item($line_item, false);
-    }
-
-
-    /**
-     * Returns the new line item created by adding a purchase of the ticket
-     * ensures that ticket line item is saved, and that cart total has been recalculated.
-     * If this ticket has already been purchased, just increments its count.
-     * Automatically re-calculates the line item totals and updates the related transaction. But
-     * DOES NOT automatically upgrade the transaction's registrations' final prices (which
-     * should probably change because of this).
-     * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $total_line_item grand total line item of type EEM_Line_Item::type_total
-     * @param EE_Ticket    $ticket
-     * @param int          $qty
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
-    {
-        if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'A valid line item total is required in order to add tickets. A line item of type "%s" was passed.',
-                        'event_espresso'
-                    ),
-                    $ticket->ID(),
-                    $total_line_item->ID()
-                )
-            );
-        }
-        // either increment the qty for an existing ticket
-        $line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
-        // or add a new one
-        if (! $line_item instanceof EE_Line_Item) {
-            $line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
-        }
-        $total_line_item->recalculate_total_including_taxes();
-        return $line_item;
-    }
-
-
-    /**
-     * Returns the new line item created by adding a purchase of the ticket
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Ticket    $ticket
-     * @param int          $qty
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function increment_ticket_qty_if_already_in_cart(
-        EE_Line_Item $total_line_item,
-        EE_Ticket $ticket,
-        $qty = 1
-    ) {
-        $line_item = null;
-        if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) {
-            $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
-            foreach ((array) $ticket_line_items as $ticket_line_item) {
-                if (
-                    $ticket_line_item instanceof EE_Line_Item
-                    && (int) $ticket_line_item->OBJ_ID() === (int) $ticket->ID()
-                ) {
-                    $line_item = $ticket_line_item;
-                    break;
-                }
-            }
-        }
-        if ($line_item instanceof EE_Line_Item) {
-            EEH_Line_Item::increment_quantity($line_item, $qty);
-            return $line_item;
-        }
-        return null;
-    }
-
-
-    /**
-     * Increments the line item and all its children's quantity by $qty (but percent line items are unaffected).
-     * Does NOT save or recalculate other line items totals
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function increment_quantity(EE_Line_Item $line_item, $qty = 1)
-    {
-        if (! $line_item->is_percent()) {
-            $qty += $line_item->quantity();
-            $line_item->set_quantity($qty);
-            $line_item->set_total($line_item->unit_price() * $qty);
-            $line_item->save();
-        }
-        foreach ($line_item->children() as $child) {
-            if ($child->is_sub_line_item()) {
-                EEH_Line_Item::update_quantity($child, $qty);
-            }
-        }
-    }
-
-
-    /**
-     * Decrements the line item and all its children's quantity by $qty (but percent line items are unaffected).
-     * Does NOT save or recalculate other line items totals
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $qty
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1)
-    {
-        if (! $line_item->is_percent()) {
-            $qty = $line_item->quantity() - $qty;
-            $qty = max($qty, 0);
-            $line_item->set_quantity($qty);
-            $line_item->set_total($line_item->unit_price() * $qty);
-            $line_item->save();
-        }
-        foreach ($line_item->children() as $child) {
-            if ($child->is_sub_line_item()) {
-                EEH_Line_Item::update_quantity($child, $qty);
-            }
-        }
-    }
-
-
-    /**
-     * Updates the line item and its children's quantities to the specified number.
-     * Does NOT save them or recalculate totals.
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $new_quantity
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function update_quantity(EE_Line_Item $line_item, $new_quantity)
-    {
-        if (! $line_item->is_percent()) {
-            $line_item->set_quantity($new_quantity);
-            $line_item->set_total($line_item->unit_price() * $new_quantity);
-            $line_item->save();
-        }
-        foreach ($line_item->children() as $child) {
-            if ($child->is_sub_line_item()) {
-                EEH_Line_Item::update_quantity($child, $new_quantity);
-            }
-        }
-    }
-
-
-    /**
-     * Returns the new line item created by adding a purchase of the ticket
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @param EE_Ticket    $ticket
-     * @param int          $qty
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function create_ticket_line_item(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
-    {
-        $datetimes           = $ticket->datetimes();
-        $first_datetime      = reset($datetimes);
-        $first_datetime_name = esc_html__('Event', 'event_espresso');
-        if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) {
-            $first_datetime_name = $first_datetime->event()->name();
-        }
-        $event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name);
-        // get event subtotal line
-        $events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket);
-        // add $ticket to cart
-        $line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_name'       => $ticket->name(),
-                'LIN_desc'       => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
-                'LIN_unit_price' => $ticket->price(),
-                'LIN_quantity'   => $qty,
-                'LIN_is_taxable' => $ticket->taxable(),
-                'LIN_order'      => count($events_sub_total->children()),
-                'LIN_total'      => $ticket->price() * $qty,
-                'LIN_type'       => EEM_Line_Item::type_line_item,
-                'OBJ_ID'         => $ticket->ID(),
-                'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_TICKET,
-            ]
-        );
-        $line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_ticket_line_item__line_item',
-            $line_item
-        );
-        $events_sub_total->add_child_line_item($line_item);
-        // now add the sub-line items
-        $running_total_for_ticket = 0;
-        foreach ($ticket->prices(['order_by' => ['PRC_order' => 'ASC']]) as $price) {
-            $sign          = $price->is_discount() ? -1 : 1;
-            $price_total   = $price->is_percent()
-                ? $running_total_for_ticket * $price->amount() / 100
-                : $price->amount() * $qty;
-            $sub_line_item = EE_Line_Item::new_instance(
-                [
-                    'LIN_name'       => $price->name(),
-                    'LIN_desc'       => $price->desc(),
-                    'LIN_quantity'   => $price->is_percent() ? null : $qty,
-                    'LIN_is_taxable' => false,
-                    'LIN_order'      => $price->order(),
-                    'LIN_total'      => $sign * $price_total,
-                    'LIN_type'       => EEM_Line_Item::type_sub_line_item,
-                    'OBJ_ID'         => $price->ID(),
-                    'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_PRICE,
-                ]
-            );
-            $sub_line_item = apply_filters(
-                'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item',
-                $sub_line_item
-            );
-            if ($price->is_percent()) {
-                $sub_line_item->set_percent($sign * $price->amount());
-            } else {
-                $sub_line_item->set_unit_price($sign * $price->amount());
-            }
-            $running_total_for_ticket += $price_total;
-            $line_item->add_child_line_item($sub_line_item);
-        }
-        return $line_item;
-    }
-
-
-    /**
-     * Adds the specified item under the pre-tax-sub-total line item. Automatically
-     * re-calculates the line item totals and updates the related transaction. But
-     * DOES NOT automatically upgrade the transaction's registrations' final prices (which
-     * should probably change because of this).
-     * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Line_Item $item to be added
-     * @return boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function add_item(EE_Line_Item $total_line_item, EE_Line_Item $item)
-    {
-        $pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item);
-        if ($pre_tax_subtotal instanceof EE_Line_Item) {
-            $success = $pre_tax_subtotal->add_child_line_item($item);
-        } else {
-            return false;
-        }
-        $total_line_item->recalculate_total_including_taxes();
-        return $success;
-    }
-
-
-    /**
-     * cancels an existing ticket line item,
-     * by decrementing it's quantity by 1 and adding a new "type_cancellation" sub-line-item.
-     * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
-     *
-     * @param EE_Line_Item $ticket_line_item
-     * @param int          $qty
-     * @return bool success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1)
-    {
-        // validate incoming line_item
-        if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The supplied line item must have an Object Type of "Ticket", not %1$s.',
-                        'event_espresso'
-                    ),
-                    $ticket_line_item->type()
-                )
-            );
-        }
-        if ($ticket_line_item->quantity() < $qty) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.',
-                        'event_espresso'
-                    ),
-                    $qty,
-                    $ticket_line_item->quantity()
-                )
-            );
-        }
-        // decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this
-        $ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty);
-        foreach ($ticket_line_item->children() as $child_line_item) {
-            if (
-                $child_line_item->is_sub_line_item()
-                && ! $child_line_item->is_percent()
-                && ! $child_line_item->is_cancellation()
-            ) {
-                $child_line_item->set_quantity($child_line_item->quantity() - $qty);
-            }
-        }
-        // get cancellation sub line item
-        $cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
-            $ticket_line_item,
-            EEM_Line_Item::type_cancellation
-        );
-        $cancellation_line_item = reset($cancellation_line_item);
-        // verify that this ticket was indeed previously cancelled
-        if ($cancellation_line_item instanceof EE_Line_Item) {
-            // increment cancelled quantity
-            $cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty);
-        } else {
-            // create cancellation sub line item
-            $cancellation_line_item = EE_Line_Item::new_instance(
-                [
-                    'LIN_name'       => esc_html__('Cancellation', 'event_espresso'),
-                    'LIN_desc'       => sprintf(
-                        esc_html_x(
-                            'Cancelled %1$s : %2$s',
-                            'Cancelled Ticket Name : 2015-01-01 11:11',
-                            'event_espresso'
-                        ),
-                        $ticket_line_item->name(),
-                        current_time(get_option('date_format') . ' ' . get_option('time_format'))
-                    ),
-                    'LIN_unit_price' => 0, // $ticket_line_item->unit_price()
-                    'LIN_quantity'   => $qty,
-                    'LIN_is_taxable' => $ticket_line_item->is_taxable(),
-                    'LIN_order'      => count($ticket_line_item->children()),
-                    'LIN_total'      => 0, // $ticket_line_item->unit_price()
-                    'LIN_type'       => EEM_Line_Item::type_cancellation,
-                ]
-            );
-            $ticket_line_item->add_child_line_item($cancellation_line_item);
-        }
-        if ($ticket_line_item->save_this_and_descendants() > 0) {
-            // decrement parent line item quantity
-            $event_line_item = $ticket_line_item->parent();
-            if (
-                $event_line_item instanceof EE_Line_Item
-                && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
-            ) {
-                $event_line_item->set_quantity($event_line_item->quantity() - $qty);
-                $event_line_item->save();
-            }
-            EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * reinstates (un-cancels?) a previously canceled ticket line item,
-     * by incrementing it's quantity by 1, and decrementing it's "type_cancellation" sub-line-item.
-     * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
-     *
-     * @param EE_Line_Item $ticket_line_item
-     * @param int          $qty
-     * @return bool success
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1)
-    {
-        // validate incoming line_item
-        if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The supplied line item must have an Object Type of "Ticket", not %1$s.',
-                        'event_espresso'
-                    ),
-                    $ticket_line_item->type()
-                )
-            );
-        }
-        // get cancellation sub line item
-        $cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
-            $ticket_line_item,
-            EEM_Line_Item::type_cancellation
-        );
-        $cancellation_line_item = reset($cancellation_line_item);
-        // verify that this ticket was indeed previously cancelled
-        if (! $cancellation_line_item instanceof EE_Line_Item) {
-            return false;
-        }
-        if ($cancellation_line_item->quantity() > $qty) {
-            // decrement cancelled quantity
-            $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
-        } elseif ($cancellation_line_item->quantity() === $qty) {
-            // decrement cancelled quantity in case anyone still has the object kicking around
-            $cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
-            // delete because quantity will end up as 0
-            $cancellation_line_item->delete();
-            // and attempt to destroy the object,
-            // even though PHP won't actually destroy it until it needs the memory
-            unset($cancellation_line_item);
-        } else {
-            // what ?!?! negative quantity ?!?!
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.',
-                        'event_espresso'
-                    ),
-                    $qty,
-                    $cancellation_line_item->quantity()
-                )
-            );
-        }
-        // increment ticket quantity
-        $ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty);
-        if ($ticket_line_item->save_this_and_descendants() > 0) {
-            // increment parent line item quantity
-            $event_line_item = $ticket_line_item->parent();
-            if (
-                $event_line_item instanceof EE_Line_Item
-                && $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
-            ) {
-                $event_line_item->set_quantity($event_line_item->quantity() + $qty);
-            }
-            EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * calls EEH_Line_Item::find_transaction_grand_total_for_line_item()
-     * then EE_Line_Item::recalculate_total_including_taxes() on the result
-     *
-     * @param EE_Line_Item $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item)
-    {
-        $grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item);
-        return $grand_total_line_item->recalculate_total_including_taxes();
-    }
-
-
-    /**
-     * Gets the line item which contains the subtotal of all the items
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function get_pre_tax_subtotal(EE_Line_Item $total_line_item)
-    {
-        $pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal');
-        return $pre_tax_subtotal instanceof EE_Line_Item
-            ? $pre_tax_subtotal
-            : self::create_pre_tax_subtotal($total_line_item);
-    }
-
-
-    /**
-     * Gets the line item for the taxes subtotal
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function get_taxes_subtotal(EE_Line_Item $total_line_item)
-    {
-        $taxes = $total_line_item->get_child_line_item('taxes');
-        return $taxes ? $taxes : self::create_taxes_subtotal($total_line_item);
-    }
-
-
-    /**
-     * sets the TXN ID on an EE_Line_Item if passed a valid EE_Transaction object
-     *
-     * @param EE_Line_Item   $line_item
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function set_TXN_ID(EE_Line_Item $line_item, $transaction = null)
-    {
-        if ($transaction) {
-            /** @type EEM_Transaction $EEM_Transaction */
-            $EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
-            $TXN_ID          = $EEM_Transaction->ensure_is_ID($transaction);
-            $line_item->set_TXN_ID($TXN_ID);
-        }
-    }
-
-
-    /**
-     * Creates a new default total line item for the transaction,
-     * and its tickets subtotal and taxes subtotal line items (and adds the
-     * existing taxes as children of the taxes subtotal line item)
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item of type total
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function create_total_line_item($transaction = null)
-    {
-        $total_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_code' => 'total',
-                'LIN_name' => esc_html__('Grand Total', 'event_espresso'),
-                'LIN_type' => EEM_Line_Item::type_total,
-                'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TRANSACTION,
-            ]
-        );
-        $total_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_total_line_item__total_line_item',
-            $total_line_item
-        );
-        self::set_TXN_ID($total_line_item, $transaction);
-        self::create_pre_tax_subtotal($total_line_item, $transaction);
-        self::create_taxes_subtotal($total_line_item, $transaction);
-        return $total_line_item;
-    }
-
-
-    /**
-     * Creates a default items subtotal line item
-     *
-     * @param EE_Line_Item   $total_line_item
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected static function create_pre_tax_subtotal(EE_Line_Item $total_line_item, $transaction = null)
-    {
-        $pre_tax_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_code' => 'pre-tax-subtotal',
-                'LIN_name' => esc_html__('Pre-Tax Subtotal', 'event_espresso'),
-                'LIN_type' => EEM_Line_Item::type_sub_total,
-            ]
-        );
-        $pre_tax_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item',
-            $pre_tax_line_item
-        );
-        self::set_TXN_ID($pre_tax_line_item, $transaction);
-        $total_line_item->add_child_line_item($pre_tax_line_item);
-        self::create_event_subtotal($pre_tax_line_item, $transaction);
-        return $pre_tax_line_item;
-    }
-
-
-    /**
-     * Creates a line item for the taxes subtotal and finds all the tax prices
-     * and applies taxes to it
-     *
-     * @param EE_Line_Item   $total_line_item of type EEM_Line_Item::type_total
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected static function create_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null)
-    {
-        $tax_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_code'  => 'taxes',
-                'LIN_name'  => esc_html__('Taxes', 'event_espresso'),
-                'LIN_type'  => EEM_Line_Item::type_tax_sub_total,
-                'LIN_order' => 1000,// this should always come last
-            ]
-        );
-        $tax_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item',
-            $tax_line_item
-        );
-        self::set_TXN_ID($tax_line_item, $transaction);
-        $total_line_item->add_child_line_item($tax_line_item);
-        // and lastly, add the actual taxes
-        self::apply_taxes($total_line_item);
-        return $tax_line_item;
-    }
-
-
-    /**
-     * Creates a default items subtotal line item
-     *
-     * @param EE_Line_Item   $pre_tax_line_item
-     * @param EE_Transaction $transaction
-     * @param EE_Event       $event
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function create_event_subtotal(EE_Line_Item $pre_tax_line_item, $transaction = null, $event = null)
-    {
-        $event_line_item = EE_Line_Item::new_instance(
-            [
-                'LIN_code' => self::get_event_code($event),
-                'LIN_name' => self::get_event_name($event),
-                'LIN_desc' => self::get_event_desc($event),
-                'LIN_type' => EEM_Line_Item::type_sub_total,
-                'OBJ_type' => EEM_Line_Item::OBJ_TYPE_EVENT,
-                'OBJ_ID'   => $event instanceof EE_Event ? $event->ID() : 0,
-            ]
-        );
-        $event_line_item = apply_filters(
-            'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item',
-            $event_line_item
-        );
-        self::set_TXN_ID($event_line_item, $transaction);
-        $pre_tax_line_item->add_child_line_item($event_line_item);
-        return $event_line_item;
-    }
-
-
-    /**
-     * Gets what the event ticket's code SHOULD be
-     *
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error|ReflectionException
-     */
-    public static function get_event_code($event)
-    {
-        return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0');
-    }
-
-
-    /**
-     * Gets the event name
-     *
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_event_name($event)
-    {
-        return $event instanceof EE_Event
-            ? mb_substr($event->name(), 0, 245)
-            : esc_html__('Event', 'event_espresso');
-    }
-
-
-    /**
-     * Gets the event excerpt
-     *
-     * @param EE_Event $event
-     * @return string
-     * @throws EE_Error
-     */
-    public static function get_event_desc($event)
-    {
-        return $event instanceof EE_Event ? $event->short_description() : '';
-    }
-
-
-    /**
-     * Given the grand total line item and a ticket, finds the event sub-total
-     * line item the ticket's purchase should be added onto
-     *
-     * @access public
-     * @param EE_Line_Item $grand_total the grand total line item
-     * @param EE_Ticket    $ticket
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket)
-    {
-        $first_datetime = $ticket->first_datetime();
-        if (! $first_datetime instanceof EE_Datetime) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'),
-                    $ticket->ID()
-                )
-            );
-        }
-        $event = $first_datetime->event();
-        if (! $event instanceof EE_Event) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The supplied ticket (ID %d) has no event data associated with it.',
-                        'event_espresso'
-                    ),
-                    $ticket->ID()
-                )
-            );
-        }
-        $events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
-        if (! $events_sub_total instanceof EE_Line_Item) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'There is no events sub-total for ticket %s on total line item %d',
-                        'event_espresso'
-                    ),
-                    $ticket->ID(),
-                    $grand_total->ID()
-                )
-            );
-        }
-        return $events_sub_total;
-    }
-
-
-    /**
-     * Gets the event line item
-     *
-     * @param EE_Line_Item $grand_total
-     * @param EE_Event     $event
-     * @return EE_Line_Item for the event subtotal which is a child of $grand_total
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function get_event_line_item(EE_Line_Item $grand_total, $event)
-    {
-        /** @type EE_Event $event */
-        $event           = EEM_Event::instance()->ensure_is_obj($event, true);
-        $event_line_item = null;
-        $found           = false;
-        foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) {
-            // default event subtotal, we should only ever find this the first time this method is called
-            if (! $event_line_item->OBJ_ID()) {
-                // let's use this! but first... set the event details
-                EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
-                $found = true;
-                break;
-            }
-            if ($event_line_item->OBJ_ID() === $event->ID()) {
-                // found existing line item for this event in the cart, so break out of loop and use this one
-                $found = true;
-                break;
-            }
-        }
-        if (! $found) {
-            // there is no event sub-total yet, so add it
-            $pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total);
-            // create a new "event" subtotal below that
-            $event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, null, $event);
-            // and set the event details
-            EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
-        }
-        return $event_line_item;
-    }
-
-
-    /**
-     * Creates a default items subtotal line item
-     *
-     * @param EE_Line_Item   $event_line_item
-     * @param EE_Event       $event
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function set_event_subtotal_details(
-        EE_Line_Item $event_line_item,
-        EE_Event $event,
-        $transaction = null
-    ) {
-        if ($event instanceof EE_Event) {
-            $event_line_item->set_code(self::get_event_code($event));
-            $event_line_item->set_name(self::get_event_name($event));
-            $event_line_item->set_desc(self::get_event_desc($event));
-            $event_line_item->set_OBJ_ID($event->ID());
-        }
-        self::set_TXN_ID($event_line_item, $transaction);
-    }
-
-
-    /**
-     * Finds what taxes should apply, adds them as tax line items under the taxes sub-total,
-     * and recalculates the taxes sub-total and the grand total. Resets the taxes, so
-     * any old taxes are removed
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @param bool         $update_txn_status
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function apply_taxes(EE_Line_Item $total_line_item, $update_txn_status = false)
-    {
-        /** @type EEM_Price $EEM_Price */
-        $EEM_Price = EE_Registry::instance()->load_model('Price');
-        // get array of taxes via Price Model
-        $ordered_taxes = $EEM_Price->get_all_prices_that_are_taxes();
-        ksort($ordered_taxes);
-        $taxes_line_item = self::get_taxes_subtotal($total_line_item);
-        // just to be safe, remove its old tax line items
-        $deleted = $taxes_line_item->delete_children_line_items();
-        $updates = false;
-        // loop thru taxes
-        foreach ($ordered_taxes as $order => $taxes) {
-            foreach ($taxes as $tax) {
-                if ($tax instanceof EE_Price) {
-                    $tax_line_item = EE_Line_Item::new_instance(
-                        [
-                            'LIN_name'       => $tax->name(),
-                            'LIN_desc'       => $tax->desc(),
-                            'LIN_percent'    => $tax->amount(),
-                            'LIN_is_taxable' => false,
-                            'LIN_order'      => $order,
-                            'LIN_total'      => 0,
-                            'LIN_type'       => EEM_Line_Item::type_tax,
-                            'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_PRICE,
-                            'OBJ_ID'         => $tax->ID(),
-                        ]
-                    );
-                    $tax_line_item = apply_filters(
-                        'FHEE__EEH_Line_Item__apply_taxes__tax_line_item',
-                        $tax_line_item
-                    );
-                    $updates       = $taxes_line_item->add_child_line_item($tax_line_item)
-                        ? true
-                        : $updates;
-                }
-            }
-        }
-        // only recalculate totals if something changed
-        if ($deleted || $updates) {
-            $total_line_item->recalculate_total_including_taxes($update_txn_status);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Ensures that taxes have been applied to the order, if not applies them.
-     * Returns the total amount of tax
-     *
-     * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function ensure_taxes_applied($total_line_item)
-    {
-        $taxes_subtotal = self::get_taxes_subtotal($total_line_item);
-        if (! $taxes_subtotal->children()) {
-            self::apply_taxes($total_line_item);
-        }
-        return $taxes_subtotal->total();
-    }
-
-
-    /**
-     * Deletes ALL children of the passed line item
-     *
-     * @param EE_Line_Item $parent_line_item
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function delete_all_child_items(EE_Line_Item $parent_line_item)
-    {
-        $deleted = 0;
-        foreach ($parent_line_item->children() as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                $deleted += EEH_Line_Item::delete_all_child_items($child_line_item);
-                if ($child_line_item->ID()) {
-                    $child_line_item->delete();
-                    unset($child_line_item);
-                } else {
-                    $parent_line_item->delete_child_line_item($child_line_item->code());
-                }
-                $deleted++;
-            }
-        }
-        return $deleted;
-    }
-
-
-    /**
-     * Deletes the line items as indicated by the line item code(s) provided,
-     * regardless of where they're found in the line item tree. Automatically
-     * re-calculates the line item totals and updates the related transaction. But
-     * DOES NOT automatically upgrade the transaction's registrations' final prices (which
-     * should probably change because of this).
-     * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
-     * after using this, to keep the registration final prices in-sync with the transaction's total.
-     *
-     * @param EE_Line_Item      $total_line_item of type EEM_Line_Item::type_total
-     * @param array|bool|string $line_item_codes
-     * @return int number of items successfully removed
-     * @throws EE_Error|ReflectionException
-     */
-    public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = false)
-    {
-        if ($total_line_item->type() !== EEM_Line_Item::type_total) {
-            EE_Error::doing_it_wrong(
-                'EEH_Line_Item::delete_items',
-                esc_html__(
-                    'This static method should only be called with a TOTAL line item, otherwise we won\'t recalculate the totals correctly',
-                    'event_espresso'
-                ),
-                '4.6.18'
-            );
-        }
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-
-        // check if only a single line_item_id was passed
-        if (! empty($line_item_codes) && ! is_array($line_item_codes)) {
-            // place single line_item_id in an array to appear as multiple line_item_ids
-            $line_item_codes = [$line_item_codes];
-        }
-        $removals = 0;
-        // cycle thru line_item_ids
-        foreach ($line_item_codes as $line_item_id) {
-            $removals += $total_line_item->delete_child_line_item($line_item_id);
-        }
-
-        if ($removals > 0) {
-            $total_line_item->recalculate_taxes_and_tax_total();
-            return $removals;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Overwrites the previous tax by clearing out the old taxes, and creates a new
-     * tax and updates the total line item accordingly
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param float        $amount
-     * @param string       $name
-     * @param string       $description
-     * @param string       $code
-     * @param boolean      $add_to_existing_line_item
-     *                          if true, and a duplicate line item with the same code is found,
-     *                          $amount will be added onto it; otherwise will simply set the taxes to match $amount
-     * @return EE_Line_Item the new tax line item created
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function set_total_tax_to(
-        EE_Line_Item $total_line_item,
-        $amount,
-        $name = null,
-        $description = null,
-        $code = null,
-        $add_to_existing_line_item = false
-    ) {
-        $tax_subtotal  = self::get_taxes_subtotal($total_line_item);
-        $taxable_total = $total_line_item->taxable_total();
-
-        if ($add_to_existing_line_item) {
-            $new_tax = $tax_subtotal->get_child_line_item($code);
-            EEM_Line_Item::instance()->delete(
-                [['LIN_code' => ['!=', $code], 'LIN_parent' => $tax_subtotal->ID()]]
-            );
-        } else {
-            $new_tax = null;
-            $tax_subtotal->delete_children_line_items();
-        }
-        if ($new_tax) {
-            $new_tax->set_total($new_tax->total() + $amount);
-            $new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0);
-        } else {
-            // no existing tax item. Create it
-            $new_tax = EE_Line_Item::new_instance(
-                [
-                    'TXN_ID'      => $total_line_item->TXN_ID(),
-                    'LIN_name'    => $name ? $name : esc_html__('Tax', 'event_espresso'),
-                    'LIN_desc'    => $description ? $description : '',
-                    'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0,
-                    'LIN_total'   => $amount,
-                    'LIN_parent'  => $tax_subtotal->ID(),
-                    'LIN_type'    => EEM_Line_Item::type_tax,
-                    'LIN_code'    => $code,
-                ]
-            );
-        }
-
-        $new_tax = apply_filters(
-            'FHEE__EEH_Line_Item__set_total_tax_to__new_tax_subtotal',
-            $new_tax,
-            $total_line_item
-        );
-        $new_tax->save();
-        $tax_subtotal->set_total($new_tax->total());
-        $tax_subtotal->save();
-        $total_line_item->recalculate_total_including_taxes();
-        return $new_tax;
-    }
-
-
-    /**
-     * Makes all the line items which are children of $line_item taxable (or not).
-     * Does NOT save the line items
-     *
-     * @param EE_Line_Item $line_item
-     * @param boolean      $taxable
-     * @param string       $code_substring_for_whitelist if this string is part of the line item's code
-     *                                                   it will be whitelisted (ie, except from becoming taxable)
-     * @throws EE_Error|ReflectionException
-     */
-    public static function set_line_items_taxable(
-        EE_Line_Item $line_item,
-        $taxable = true,
-        $code_substring_for_whitelist = null
-    ) {
-        $whitelisted = false;
-        if ($code_substring_for_whitelist !== null) {
-            $whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false;
-        }
-        if (! $whitelisted && $line_item->is_line_item()) {
-            $line_item->set_is_taxable($taxable);
-        }
-        foreach ($line_item->children() as $child_line_item) {
-            EEH_Line_Item::set_line_items_taxable(
-                $child_line_item,
-                $taxable,
-                $code_substring_for_whitelist
-            );
-        }
-    }
-
-
-    /**
-     * Gets all descendants that are event subtotals
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     * @uses  EEH_Line_Item::get_subtotals_of_object_type()
-     */
-    public static function get_event_subtotals(EE_Line_Item $parent_line_item)
-    {
-        return self::get_subtotals_of_object_type($parent_line_item, EEM_Line_Item::OBJ_TYPE_EVENT);
-    }
-
-
-    /**
-     * Gets all descendants subtotals that match the supplied object type
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $obj_type
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     */
-    public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '')
-    {
-        return self::_get_descendants_by_type_and_object_type(
-            $parent_line_item,
-            EEM_Line_Item::type_sub_total,
-            $obj_type
-        );
-    }
-
-
-    /**
-     * Gets all descendants that are tickets
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     * @uses  EEH_Line_Item::get_line_items_of_object_type()
-     */
-    public static function get_ticket_line_items(EE_Line_Item $parent_line_item)
-    {
-        return self::get_line_items_of_object_type(
-            $parent_line_item,
-            EEM_Line_Item::OBJ_TYPE_TICKET
-        );
-    }
-
-
-    /**
-     * Gets all descendants subtotals that match the supplied object type
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $obj_type
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     */
-    public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '')
-    {
-        return self::_get_descendants_by_type_and_object_type(
-            $parent_line_item,
-            EEM_Line_Item::type_line_item,
-            $obj_type
-        );
-    }
-
-
-    /**
-     * Gets all the descendants (ie, children or children of children etc) that are of the type 'tax'
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     * @uses  EEH_Line_Item::get_descendants_of_type()
-     */
-    public static function get_tax_descendants(EE_Line_Item $parent_line_item)
-    {
-        return EEH_Line_Item::get_descendants_of_type(
-            $parent_line_item,
-            EEM_Line_Item::type_tax
-        );
-    }
-
-
-    /**
-     * Gets all the real items purchased which are children of this item
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     * @uses  EEH_Line_Item::get_descendants_of_type()
-     */
-    public static function get_line_item_descendants(EE_Line_Item $parent_line_item)
-    {
-        return EEH_Line_Item::get_descendants_of_type(
-            $parent_line_item,
-            EEM_Line_Item::type_line_item
-        );
-    }
-
-
-    /**
-     * Gets all descendants of supplied line item that match the supplied line item type
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $line_item_type   one of the EEM_Line_Item constants
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     */
-    public static function get_descendants_of_type(EE_Line_Item $parent_line_item, $line_item_type)
-    {
-        return self::_get_descendants_by_type_and_object_type(
-            $parent_line_item,
-            $line_item_type,
-            null
-        );
-    }
-
-
-    /**
-     * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type
-     * as well
-     *
-     * @param EE_Line_Item  $parent_line_item - the line item to find descendants of
-     * @param string        $line_item_type   one of the EEM_Line_Item constants
-     * @param string | NULL $obj_type         object model class name (minus prefix) or NULL to ignore object type when
-     *                                        searching
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     */
-    protected static function _get_descendants_by_type_and_object_type(
-        EE_Line_Item $parent_line_item,
-        $line_item_type,
-        $obj_type = null
-    ) {
-        $objects = [];
-        $child_objects = [];
-        foreach ($parent_line_item->children() as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                if (
-                    $child_line_item->type() === $line_item_type
-                    && (
-                        $child_line_item->OBJ_type() === $obj_type || $obj_type === null
-                    )
-                ) {
-                    $objects[] = $child_line_item;
-                } else {
-                    // go-through-all-its children looking for more matches
-                    $child_objects[] = self::_get_descendants_by_type_and_object_type(
-                        $child_line_item,
-                        $line_item_type,
-                        $obj_type
-                    );
-                }
-            }
-        }
-        return array_merge([], $objects, ...$child_objects);
-    }
-
-
-    /**
-     * Gets all descendants subtotals that match the supplied object type
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $OBJ_type         object type (like Event)
-     * @param array        $OBJ_IDs          array of OBJ_IDs
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
-     */
-    public static function get_line_items_by_object_type_and_IDs(
-        EE_Line_Item $parent_line_item,
-        $OBJ_type = '',
-        $OBJ_IDs = []
-    ) {
-        return self::_get_descendants_by_object_type_and_object_ID(
-            $parent_line_item,
-            $OBJ_type,
-            $OBJ_IDs
-        );
-    }
-
-
-    /**
-     * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type
-     * as well
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $OBJ_type         object type (like Event)
-     * @param array        $OBJ_IDs          array of OBJ_IDs
-     * @return EE_Line_Item[]
-     * @throws EE_Error|ReflectionException
-     */
-    protected static function _get_descendants_by_object_type_and_object_ID(
-        EE_Line_Item $parent_line_item,
-        $OBJ_type,
-        $OBJ_IDs
-    ) {
-        $objects = [];
-        $child_objects = [];
-        foreach ($parent_line_item->children() as $child_line_item) {
-            if ($child_line_item instanceof EE_Line_Item) {
-                if (
-                    $child_line_item->OBJ_type() === $OBJ_type
-                    && is_array($OBJ_IDs)
-                    && in_array($child_line_item->OBJ_ID(), $OBJ_IDs)
-                ) {
-                    $objects[] = $child_line_item;
-                } else {
-                    // go-through-all-its children looking for more matches
-                    $child_objects[] = self::_get_descendants_by_object_type_and_object_ID(
-                        $child_line_item,
-                        $OBJ_type,
-                        $OBJ_IDs
-                    );
-                }
-            }
-        }
-        return array_merge([], $objects, ...$child_objects);
-    }
-
-
-    /**
-     * Uses a breadth-first-search in order to find the nearest descendant of
-     * the specified type and returns it, else NULL
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $type             like one of the EEM_Line_Item::type_*
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::_get_nearest_descendant()
-     */
-    public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, $type)
-    {
-        return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type);
-    }
-
-
-    /**
-     * Uses a breadth-first-search in order to find the nearest descendant
-     * having the specified LIN_code and returns it, else NULL
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $code             any value used for LIN_code
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @uses  EEH_Line_Item::_get_nearest_descendant()
-     */
-    public static function get_nearest_descendant_having_code(EE_Line_Item $parent_line_item, $code)
-    {
-        return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code);
-    }
-
-
-    /**
-     * Uses a breadth-first-search in order to find the nearest descendant
-     * having the specified LIN_code and returns it, else NULL
-     *
-     * @param EE_Line_Item $parent_line_item - the line item to find descendants of
-     * @param string       $search_field     name of EE_Line_Item property
-     * @param string       $value            any value stored in $search_field
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    protected static function _get_nearest_descendant(EE_Line_Item $parent_line_item, $search_field, $value)
-    {
-        foreach ($parent_line_item->children() as $child) {
-            if ($child->get($search_field) == $value) {
-                return $child;
-            }
-        }
-        foreach ($parent_line_item->children() as $child) {
-            $descendant_found = self::_get_nearest_descendant(
-                $child,
-                $search_field,
-                $value
-            );
-            if ($descendant_found) {
-                return $descendant_found;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * if passed line item has a TXN ID, uses that to jump directly to the grand total line item for the transaction,
-     * else recursively walks up the line item tree until a parent of type total is found,
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Line_Item
-     * @throws EE_Error|ReflectionException
-     */
-    public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item)
-    {
-        if ($line_item->TXN_ID()) {
-            $total_line_item = $line_item->transaction()->total_line_item(false);
-            if ($total_line_item instanceof EE_Line_Item) {
-                return $total_line_item;
-            }
-        } else {
-            $line_item_parent = $line_item->parent();
-            if ($line_item_parent instanceof EE_Line_Item) {
-                if ($line_item_parent->is_total()) {
-                    return $line_item_parent;
-                }
-                return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent);
-            }
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'A valid grand total for line item %1$d was not found.',
-                    'event_espresso'
-                ),
-                $line_item->ID()
-            )
-        );
-    }
-
-
-    /**
-     * Prints out a representation of the line item tree
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $indentation
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    public static function visualize(EE_Line_Item $line_item, $indentation = 0)
-    {
-        $linebreak = defined('EE_TESTS_DIR') ? "\n" : '<br />';
-        echo $linebreak;
-        if (! $indentation) {
-            echo $linebreak;
-        }
-        for ($i = 0; $i < $indentation; $i++) {
-            echo ' . ';
-        }
-        $breakdown = '';
-        if ($line_item->is_line_item()) {
-            if ($line_item->is_percent()) {
-                $breakdown = "{$line_item->percent()}%";
-            } else {
-                $breakdown = ' $' . "{$line_item->unit_price()} x {$line_item->quantity()}";
-            }
-        }
-        echo wp_kses($line_item->name(), AllowedTags::getAllowedTags());
-        echo " [ ID: {$line_item->ID()} · qty: {$line_item->quantity()} ] {$line_item->type()} : ";
-        echo ' $' . (string) $line_item->total();
-        if ($breakdown) {
-            echo " ( {$breakdown} )";
-        }
-        if ($line_item->is_taxable()) {
-            echo '  * taxable';
-        }
-        if ($line_item->children()) {
-            foreach ($line_item->children() as $child) {
-                self::visualize($child, $indentation + 1);
-            }
-        }
-        if ($line_item->is_total()) {
-            echo $linebreak . $linebreak;
-        }
-    }
-
-
-    /**
-     * Calculates the registration's final price, taking into account that they
-     * need to not only help pay for their OWN ticket, but also any transaction-wide surcharges and taxes,
-     * and receive a portion of any transaction-wide discounts.
-     * eg1, if I buy a $1 ticket and brent buys a $9 ticket, and we receive a $5 discount
-     * then I'll get 1/10 of that $5 discount, which is $0.50, and brent will get
-     * 9/10ths of that $5 discount, which is $4.50. So my final price should be $0.50
-     * and brent's final price should be $5.50.
-     * In order to do this, we basically need to traverse the line item tree calculating
-     * the running totals (just as if we were recalculating the total), but when we identify
-     * regular line items, we need to keep track of their share of the grand total.
-     * Also, we need to keep track of the TAXABLE total for each ticket purchase, so
-     * we can know how to apply taxes to it. (Note: "taxable total" does not equal the "pretax total"
-     * when there are non-taxable items; otherwise they would be the same)
-     *
-     * @param EE_Line_Item $line_item
-     * @param array        $billable_ticket_quantities  array of EE_Ticket IDs and their corresponding quantity
-     *                                                  that can be included in price calculations at this moment
-     * @return array                                    keys are line items for tickets IDs and values are their share
-     *                                                  of the running total, plus the key 'total',
-     *                                                  and 'taxable' which also has keys of all the ticket IDs.
-     *                                                      ex:
-     *                                                      [
-     *                                                          12 => 4.3,
-     *                                                          23 => 8.0,
-     *                                                          'total' => 16.6,
-     *                                                          'taxable' => [
-     *                                                              12 => 10,
-     *                                                              23 => 4
-     *                                                          ]
-     *                                                      ]
-     *                                                  So to find which registrations have which final price,
-     *                                                  we need to find which line item is theirs, via:
-     *                                                  `EEM_Line_Item::instance()->get_line_item_for_registration(
-     *                                                      $registration
-     *                                                  );`
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function calculate_reg_final_prices_per_line_item(
-        EE_Line_Item $line_item,
-        $billable_ticket_quantities = []
-    ) {
-        $running_totals = [
-            'total'   => 0,
-            'taxable' => ['total' => 0],
-        ];
-        foreach ($line_item->children() as $child_line_item) {
-            switch ($child_line_item->type()) {
-                case EEM_Line_Item::type_sub_total:
-                    $running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
-                        $child_line_item,
-                        $billable_ticket_quantities
-                    );
-                    // combine arrays but preserve numeric keys
-                    $running_totals = array_replace_recursive($running_totals_from_subtotal, $running_totals);
-                    $running_totals['total']            += $running_totals_from_subtotal['total'];
-                    $running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total'];
-                    break;
-
-                case EEM_Line_Item::type_tax_sub_total:
-                    // find how much the taxes percentage is
-                    if ($child_line_item->percent() !== 0) {
-                        $tax_percent_decimal = $child_line_item->percent() / 100;
-                    } else {
-                        $tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100;
-                    }
-                    // and apply to all the taxable totals, and add to the pretax totals
-                    foreach ($running_totals as $line_item_id => $this_running_total) {
-                        // "total" and "taxable" array key is an exception
-                        if ($line_item_id === 'taxable') {
-                            continue;
-                        }
-                        $taxable_total                   = $running_totals['taxable'][ $line_item_id ];
-                        $running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal);
-                    }
-                    break;
-
-                case EEM_Line_Item::type_line_item:
-                    // ticket line items or ????
-                    if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
-                        // kk it's a ticket
-                        if (isset($running_totals[ $child_line_item->ID() ])) {
-                            // huh? that shouldn't happen.
-                            $running_totals['total'] += $child_line_item->total();
-                        } else {
-                            // its not in our running totals yet. great.
-                            if ($child_line_item->is_taxable()) {
-                                $taxable_amount = $child_line_item->unit_price();
-                            } else {
-                                $taxable_amount = 0;
-                            }
-                            // are we only calculating totals for some tickets?
-                            if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) {
-                                $quantity                                            =
-                                    $billable_ticket_quantities[ $child_line_item->OBJ_ID() ];
-                                $running_totals[ $child_line_item->ID() ]            = $quantity
-                                    ? $child_line_item->unit_price()
-                                    : 0;
-                                $running_totals['taxable'][ $child_line_item->ID() ] = $quantity
-                                    ? $taxable_amount
-                                    : 0;
-                            } else {
-                                $quantity                                            = $child_line_item->quantity();
-                                $running_totals[ $child_line_item->ID() ]            = $child_line_item->unit_price();
-                                $running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount;
-                            }
-                            $running_totals['taxable']['total'] += $taxable_amount * $quantity;
-                            $running_totals['total']            += $child_line_item->unit_price() * $quantity;
-                        }
-                    } else {
-                        // it's some other type of item added to the cart
-                        // it should affect the running totals
-                        // basically we want to convert it into a PERCENT modifier. Because
-                        // more clearly affect all registration's final price equally
-                        $line_items_percent_of_running_total = $running_totals['total'] > 0
-                            ? ($child_line_item->total() / $running_totals['total']) + 1
-                            : 1;
-                        foreach ($running_totals as $line_item_id => $this_running_total) {
-                            // the "taxable" array key is an exception
-                            if ($line_item_id === 'taxable') {
-                                continue;
-                            }
-                            // update the running totals
-                            // yes this actually even works for the running grand total!
-                            $running_totals[ $line_item_id ] =
-                                $line_items_percent_of_running_total * $this_running_total;
-
-                            if ($child_line_item->is_taxable()) {
-                                $running_totals['taxable'][ $line_item_id ] =
-                                    $line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ];
-                            }
-                        }
-                    }
-                    break;
-            }
-        }
-        return $running_totals;
-    }
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @param EE_Line_Item $ticket_line_item
-     * @return float | null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws OutOfRangeException
-     * @throws ReflectionException
-     */
-    public static function calculate_final_price_for_ticket_line_item(
-        EE_Line_Item $total_line_item,
-        EE_Line_Item $ticket_line_item
-    ) {
-        static $final_prices_per_ticket_line_item = [];
-        if (empty($final_prices_per_ticket_line_item)
-            || empty($final_prices_per_ticket_line_item[ $total_line_item->ID() ])
-        ) {
-            $final_prices_per_ticket_line_item[ $total_line_item->ID() ] =
-                EEH_Line_Item::calculate_reg_final_prices_per_line_item(
-                    $total_line_item
-                );
-        }
-        // ok now find this new registration's final price
-        if (isset($final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ])) {
-            return $final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ];
-        }
-        $message = sprintf(
-            esc_html__(
-                'The final price for the ticket line item (ID:%1$d) could not be calculated.',
-                'event_espresso'
-            ),
-            $ticket_line_item->ID()
-        );
-        if (WP_DEBUG) {
-            $message .= '<br>' . print_r($final_prices_per_ticket_line_item, true);
-            throw new OutOfRangeException($message);
-        }
-        EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);
-        return null;
-    }
-
-
-    /**
-     * Creates a duplicate of the line item tree, except only includes billable items
-     * and the portion of line items attributed to billable things
-     *
-     * @param EE_Line_Item      $line_item
-     * @param EE_Registration[] $registrations
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function billable_line_item_tree(EE_Line_Item $line_item, $registrations)
-    {
-        $copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations);
-        foreach ($line_item->children() as $child_li) {
-            $copy_li->add_child_line_item(
-                EEH_Line_Item::billable_line_item_tree($child_li, $registrations)
-            );
-        }
-        // if this is the grand total line item, make sure the totals all add up
-        // (we could have duplicated this logic AS we copied the line items, but
-        // it seems DRYer this way)
-        if ($copy_li->type() === EEM_Line_Item::type_total) {
-            $copy_li->recalculate_total_including_taxes();
-        }
-        return $copy_li;
-    }
-
-
-    /**
-     * Creates a new, unsaved line item from $line_item that factors in the
-     * number of billable registrations on $registrations.
-     *
-     * @param EE_Line_Item      $line_item
-     * @param EE_Registration[] $registrations
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function billable_line_item(EE_Line_Item $line_item, $registrations)
-    {
-        $new_li_fields = $line_item->model_field_array();
-        if (
-            $line_item->type() === EEM_Line_Item::type_line_item &&
-            $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
-        ) {
-            $count = 0;
-            foreach ($registrations as $registration) {
-                if (
-                    $line_item->OBJ_ID() === $registration->ticket_ID() &&
-                    in_array(
-                        $registration->status_ID(),
-                        EEM_Registration::reg_statuses_that_allow_payment(),
-                        true
-                    )
-                ) {
-                    $count++;
-                }
-            }
-            $new_li_fields['LIN_quantity'] = $count;
-        }
-        // don't set the total. We'll leave that up to the code that calculates it
-        unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']);
-        return EE_Line_Item::new_instance($new_li_fields);
-    }
-
-
-    /**
-     * Returns a modified line item tree where all the subtotals which have a total of 0
-     * are removed, and line items with a quantity of 0
-     *
-     * @param EE_Line_Item $line_item |null
-     * @return EE_Line_Item|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function non_empty_line_items(EE_Line_Item $line_item)
-    {
-        $copied_li = EEH_Line_Item::non_empty_line_item($line_item);
-        if ($copied_li === null) {
-            return null;
-        }
-        // if this is an event subtotal, we want to only include it if it
-        // has a non-zero total and at least one ticket line item child
-        $ticket_children = 0;
-        foreach ($line_item->children() as $child_li) {
-            $child_li_copy = EEH_Line_Item::non_empty_line_items($child_li);
-            if ($child_li_copy !== null) {
-                $copied_li->add_child_line_item($child_li_copy);
-                if (
-                    $child_li_copy->type() === EEM_Line_Item::type_line_item &&
-                    $child_li_copy->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
-                ) {
-                    $ticket_children++;
-                }
-            }
-        }
-        // if this is an event subtotal with NO ticket children
-        // we basically want to ignore it
-        if (
-            $ticket_children === 0
-            && $line_item->type() === EEM_Line_Item::type_sub_total
-            && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
-            && $line_item->total() === 0
-        ) {
-            return null;
-        }
-        return $copied_li;
-    }
-
-
-    /**
-     * Creates a new, unsaved line item, but if it's a ticket line item
-     * with a total of 0, or a subtotal of 0, returns null instead
-     *
-     * @param EE_Line_Item $line_item
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public static function non_empty_line_item(EE_Line_Item $line_item)
-    {
-        if (
-            $line_item->type() === EEM_Line_Item::type_line_item
-            && $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
-            && $line_item->quantity() === 0
-        ) {
-            return null;
-        }
-        $new_li_fields = $line_item->model_field_array();
-        // don't set the total. We'll leave that up to the code that calculates it
-        unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']);
-        return EE_Line_Item::new_instance($new_li_fields);
-    }
-
-
-    /**
-     * Cycles through all of the ticket line items for the supplied total line item
-     * and ensures that the line item's "is_taxable" field matches that of its corresponding ticket
-     *
-     * @param EE_Line_Item $total_line_item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @since 4.9.79.p
-     */
-    public static function resetIsTaxableForTickets(EE_Line_Item $total_line_item)
-    {
-        $ticket_line_items = self::get_ticket_line_items($total_line_item);
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof EE_Line_Item
-                && $ticket_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
-            ) {
-                $ticket = $ticket_line_item->ticket();
-                if ($ticket instanceof EE_Ticket && $ticket->taxable() !== $ticket_line_item->is_taxable()) {
-                    $ticket_line_item->set_is_taxable($ticket->taxable());
-                    $ticket_line_item->save();
-                }
-            }
-        }
-    }
-
-
-
-    /**************************************** @DEPRECATED METHODS *************************************** */
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function get_items_subtotal(EE_Line_Item $total_line_item)
-    {
-        EE_Error::doing_it_wrong(
-            'EEH_Line_Item::get_items_subtotal()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::get_pre_tax_subtotal()'
-            ),
-            '4.6.0'
-        );
-        return self::get_pre_tax_subtotal($total_line_item);
-    }
-
-
-    /**
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function create_default_total_line_item($transaction = null)
-    {
-        EE_Error::doing_it_wrong(
-            'EEH_Line_Item::create_default_total_line_item()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::create_total_line_item()'
-            ),
-            '4.6.0'
-        );
-        return self::create_total_line_item($transaction);
-    }
-
-
-    /**
-     * @param EE_Line_Item   $total_line_item
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function create_default_tickets_subtotal(EE_Line_Item $total_line_item, $transaction = null)
-    {
-        EE_Error::doing_it_wrong(
-            'EEH_Line_Item::create_default_tickets_subtotal()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::create_pre_tax_subtotal()'
-            ),
-            '4.6.0'
-        );
-        return self::create_pre_tax_subtotal($total_line_item, $transaction);
-    }
-
-
-    /**
-     * @param EE_Line_Item   $total_line_item
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function create_default_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null)
-    {
-        EE_Error::doing_it_wrong(
-            'EEH_Line_Item::create_default_taxes_subtotal()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::create_taxes_subtotal()'
-            ),
-            '4.6.0'
-        );
-        return self::create_taxes_subtotal($total_line_item, $transaction);
-    }
-
-
-    /**
-     * @param EE_Line_Item   $total_line_item
-     * @param EE_Transaction $transaction
-     * @return EE_Line_Item
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function create_default_event_subtotal(EE_Line_Item $total_line_item, $transaction = null)
-    {
-        EE_Error::doing_it_wrong(
-            'EEH_Line_Item::create_default_event_subtotal()',
-            sprintf(
-                esc_html__('Method replaced with %1$s', 'event_espresso'),
-                'EEH_Line_Item::create_event_subtotal()'
-            ),
-            '4.6.0'
-        );
-        return self::create_event_subtotal($total_line_item, $transaction);
-    }
+	/**
+	 * Adds a simple item (unrelated to any other model object) to the provided PARENT line item.
+	 * Does NOT automatically re-calculate the line item totals or update the related transaction.
+	 * You should call recalculate_total_including_taxes() on the grant total line item after this
+	 * to update the subtotals, and EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param string       $name
+	 * @param float        $unit_price
+	 * @param string       $description
+	 * @param int          $quantity
+	 * @param boolean      $taxable
+	 * @param boolean      $code if set to a value, ensures there is only one line item with that code
+	 * @return boolean success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function add_unrelated_item(
+		EE_Line_Item $parent_line_item,
+		$name,
+		$unit_price,
+		$description = '',
+		$quantity = 1,
+		$taxable = false,
+		$code = null
+	) {
+		$items_subtotal = self::get_pre_tax_subtotal($parent_line_item);
+		$order = 0;
+		if ($items_subtotal instanceof EE_Line_Item) {
+			$items_subtotal_children = $items_subtotal->children();
+			$order = count($items_subtotal_children);
+		}
+		$line_item      = EE_Line_Item::new_instance(
+			[
+				'LIN_name'       => $name,
+				'LIN_desc'       => $description,
+				'LIN_unit_price' => $unit_price,
+				'LIN_quantity'   => $quantity,
+				'LIN_percent'    => null,
+				'LIN_is_taxable' => $taxable,
+				'LIN_order'      => $order,
+				'LIN_total'      => (float) $unit_price * (int) $quantity,
+				'LIN_type'       => EEM_Line_Item::type_line_item,
+				'LIN_code'       => $code,
+			]
+		);
+		$line_item      = apply_filters(
+			'FHEE__EEH_Line_Item__add_unrelated_item__line_item',
+			$line_item,
+			$parent_line_item
+		);
+		return self::add_item($parent_line_item, $line_item);
+	}
+
+
+	/**
+	 * Adds a simple item ( unrelated to any other model object) to the total line item,
+	 * in the correct spot in the line item tree. Does not automatically
+	 * re-calculate the line item totals, nor update the related transaction, nor upgrade the transaction's
+	 * registrations' final prices (which should probably change because of this).
+	 * You should call recalculate_total_including_taxes() on the grand total line item, then
+	 * update the transaction's total, and EE_Registration_Processor::update_registration_final_prices()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @param string       $name
+	 * @param float        $percentage_amount
+	 * @param string       $description
+	 * @param boolean      $taxable
+	 * @return boolean success
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function add_percentage_based_item(
+		EE_Line_Item $parent_line_item,
+		$name,
+		$percentage_amount,
+		$description = '',
+		$taxable = false
+	) {
+		$line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_name'       => $name,
+				'LIN_desc'       => $description,
+				'LIN_unit_price' => 0,
+				'LIN_percent'    => $percentage_amount,
+				'LIN_quantity'   => 1,
+				'LIN_is_taxable' => $taxable,
+				'LIN_total'      => (float) ($percentage_amount * ($parent_line_item->total() / 100)),
+				'LIN_type'       => EEM_Line_Item::type_line_item,
+				'LIN_parent'     => $parent_line_item->ID(),
+			]
+		);
+		$line_item = apply_filters(
+			'FHEE__EEH_Line_Item__add_percentage_based_item__line_item',
+			$line_item
+		);
+		return $parent_line_item->add_child_line_item($line_item, false);
+	}
+
+
+	/**
+	 * Returns the new line item created by adding a purchase of the ticket
+	 * ensures that ticket line item is saved, and that cart total has been recalculated.
+	 * If this ticket has already been purchased, just increments its count.
+	 * Automatically re-calculates the line item totals and updates the related transaction. But
+	 * DOES NOT automatically upgrade the transaction's registrations' final prices (which
+	 * should probably change because of this).
+	 * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $total_line_item grand total line item of type EEM_Line_Item::type_total
+	 * @param EE_Ticket    $ticket
+	 * @param int          $qty
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function add_ticket_purchase(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
+	{
+		if (! $total_line_item instanceof EE_Line_Item || ! $total_line_item->is_total()) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'A valid line item total is required in order to add tickets. A line item of type "%s" was passed.',
+						'event_espresso'
+					),
+					$ticket->ID(),
+					$total_line_item->ID()
+				)
+			);
+		}
+		// either increment the qty for an existing ticket
+		$line_item = self::increment_ticket_qty_if_already_in_cart($total_line_item, $ticket, $qty);
+		// or add a new one
+		if (! $line_item instanceof EE_Line_Item) {
+			$line_item = self::create_ticket_line_item($total_line_item, $ticket, $qty);
+		}
+		$total_line_item->recalculate_total_including_taxes();
+		return $line_item;
+	}
+
+
+	/**
+	 * Returns the new line item created by adding a purchase of the ticket
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Ticket    $ticket
+	 * @param int          $qty
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function increment_ticket_qty_if_already_in_cart(
+		EE_Line_Item $total_line_item,
+		EE_Ticket $ticket,
+		$qty = 1
+	) {
+		$line_item = null;
+		if ($total_line_item instanceof EE_Line_Item && $total_line_item->is_total()) {
+			$ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
+			foreach ((array) $ticket_line_items as $ticket_line_item) {
+				if (
+					$ticket_line_item instanceof EE_Line_Item
+					&& (int) $ticket_line_item->OBJ_ID() === (int) $ticket->ID()
+				) {
+					$line_item = $ticket_line_item;
+					break;
+				}
+			}
+		}
+		if ($line_item instanceof EE_Line_Item) {
+			EEH_Line_Item::increment_quantity($line_item, $qty);
+			return $line_item;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Increments the line item and all its children's quantity by $qty (but percent line items are unaffected).
+	 * Does NOT save or recalculate other line items totals
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function increment_quantity(EE_Line_Item $line_item, $qty = 1)
+	{
+		if (! $line_item->is_percent()) {
+			$qty += $line_item->quantity();
+			$line_item->set_quantity($qty);
+			$line_item->set_total($line_item->unit_price() * $qty);
+			$line_item->save();
+		}
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $qty);
+			}
+		}
+	}
+
+
+	/**
+	 * Decrements the line item and all its children's quantity by $qty (but percent line items are unaffected).
+	 * Does NOT save or recalculate other line items totals
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $qty
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function decrement_quantity(EE_Line_Item $line_item, $qty = 1)
+	{
+		if (! $line_item->is_percent()) {
+			$qty = $line_item->quantity() - $qty;
+			$qty = max($qty, 0);
+			$line_item->set_quantity($qty);
+			$line_item->set_total($line_item->unit_price() * $qty);
+			$line_item->save();
+		}
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $qty);
+			}
+		}
+	}
+
+
+	/**
+	 * Updates the line item and its children's quantities to the specified number.
+	 * Does NOT save them or recalculate totals.
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $new_quantity
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function update_quantity(EE_Line_Item $line_item, $new_quantity)
+	{
+		if (! $line_item->is_percent()) {
+			$line_item->set_quantity($new_quantity);
+			$line_item->set_total($line_item->unit_price() * $new_quantity);
+			$line_item->save();
+		}
+		foreach ($line_item->children() as $child) {
+			if ($child->is_sub_line_item()) {
+				EEH_Line_Item::update_quantity($child, $new_quantity);
+			}
+		}
+	}
+
+
+	/**
+	 * Returns the new line item created by adding a purchase of the ticket
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @param EE_Ticket    $ticket
+	 * @param int          $qty
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function create_ticket_line_item(EE_Line_Item $total_line_item, EE_Ticket $ticket, $qty = 1)
+	{
+		$datetimes           = $ticket->datetimes();
+		$first_datetime      = reset($datetimes);
+		$first_datetime_name = esc_html__('Event', 'event_espresso');
+		if ($first_datetime instanceof EE_Datetime && $first_datetime->event() instanceof EE_Event) {
+			$first_datetime_name = $first_datetime->event()->name();
+		}
+		$event = sprintf(_x('(For %1$s)', '(For Event Name)', 'event_espresso'), $first_datetime_name);
+		// get event subtotal line
+		$events_sub_total = self::get_event_line_item_for_ticket($total_line_item, $ticket);
+		// add $ticket to cart
+		$line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_name'       => $ticket->name(),
+				'LIN_desc'       => $ticket->description() !== '' ? $ticket->description() . ' ' . $event : $event,
+				'LIN_unit_price' => $ticket->price(),
+				'LIN_quantity'   => $qty,
+				'LIN_is_taxable' => $ticket->taxable(),
+				'LIN_order'      => count($events_sub_total->children()),
+				'LIN_total'      => $ticket->price() * $qty,
+				'LIN_type'       => EEM_Line_Item::type_line_item,
+				'OBJ_ID'         => $ticket->ID(),
+				'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_TICKET,
+			]
+		);
+		$line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_ticket_line_item__line_item',
+			$line_item
+		);
+		$events_sub_total->add_child_line_item($line_item);
+		// now add the sub-line items
+		$running_total_for_ticket = 0;
+		foreach ($ticket->prices(['order_by' => ['PRC_order' => 'ASC']]) as $price) {
+			$sign          = $price->is_discount() ? -1 : 1;
+			$price_total   = $price->is_percent()
+				? $running_total_for_ticket * $price->amount() / 100
+				: $price->amount() * $qty;
+			$sub_line_item = EE_Line_Item::new_instance(
+				[
+					'LIN_name'       => $price->name(),
+					'LIN_desc'       => $price->desc(),
+					'LIN_quantity'   => $price->is_percent() ? null : $qty,
+					'LIN_is_taxable' => false,
+					'LIN_order'      => $price->order(),
+					'LIN_total'      => $sign * $price_total,
+					'LIN_type'       => EEM_Line_Item::type_sub_line_item,
+					'OBJ_ID'         => $price->ID(),
+					'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_PRICE,
+				]
+			);
+			$sub_line_item = apply_filters(
+				'FHEE__EEH_Line_Item__create_ticket_line_item__sub_line_item',
+				$sub_line_item
+			);
+			if ($price->is_percent()) {
+				$sub_line_item->set_percent($sign * $price->amount());
+			} else {
+				$sub_line_item->set_unit_price($sign * $price->amount());
+			}
+			$running_total_for_ticket += $price_total;
+			$line_item->add_child_line_item($sub_line_item);
+		}
+		return $line_item;
+	}
+
+
+	/**
+	 * Adds the specified item under the pre-tax-sub-total line item. Automatically
+	 * re-calculates the line item totals and updates the related transaction. But
+	 * DOES NOT automatically upgrade the transaction's registrations' final prices (which
+	 * should probably change because of this).
+	 * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Line_Item $item to be added
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function add_item(EE_Line_Item $total_line_item, EE_Line_Item $item)
+	{
+		$pre_tax_subtotal = self::get_pre_tax_subtotal($total_line_item);
+		if ($pre_tax_subtotal instanceof EE_Line_Item) {
+			$success = $pre_tax_subtotal->add_child_line_item($item);
+		} else {
+			return false;
+		}
+		$total_line_item->recalculate_total_including_taxes();
+		return $success;
+	}
+
+
+	/**
+	 * cancels an existing ticket line item,
+	 * by decrementing it's quantity by 1 and adding a new "type_cancellation" sub-line-item.
+	 * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
+	 *
+	 * @param EE_Line_Item $ticket_line_item
+	 * @param int          $qty
+	 * @return bool success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function cancel_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1)
+	{
+		// validate incoming line_item
+		if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The supplied line item must have an Object Type of "Ticket", not %1$s.',
+						'event_espresso'
+					),
+					$ticket_line_item->type()
+				)
+			);
+		}
+		if ($ticket_line_item->quantity() < $qty) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Can not cancel %1$d ticket(s) because the supplied line item has a quantity of %2$d.',
+						'event_espresso'
+					),
+					$qty,
+					$ticket_line_item->quantity()
+				)
+			);
+		}
+		// decrement ticket quantity; don't rely on auto-fixing when recalculating totals to do this
+		$ticket_line_item->set_quantity($ticket_line_item->quantity() - $qty);
+		foreach ($ticket_line_item->children() as $child_line_item) {
+			if (
+				$child_line_item->is_sub_line_item()
+				&& ! $child_line_item->is_percent()
+				&& ! $child_line_item->is_cancellation()
+			) {
+				$child_line_item->set_quantity($child_line_item->quantity() - $qty);
+			}
+		}
+		// get cancellation sub line item
+		$cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
+			$ticket_line_item,
+			EEM_Line_Item::type_cancellation
+		);
+		$cancellation_line_item = reset($cancellation_line_item);
+		// verify that this ticket was indeed previously cancelled
+		if ($cancellation_line_item instanceof EE_Line_Item) {
+			// increment cancelled quantity
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() + $qty);
+		} else {
+			// create cancellation sub line item
+			$cancellation_line_item = EE_Line_Item::new_instance(
+				[
+					'LIN_name'       => esc_html__('Cancellation', 'event_espresso'),
+					'LIN_desc'       => sprintf(
+						esc_html_x(
+							'Cancelled %1$s : %2$s',
+							'Cancelled Ticket Name : 2015-01-01 11:11',
+							'event_espresso'
+						),
+						$ticket_line_item->name(),
+						current_time(get_option('date_format') . ' ' . get_option('time_format'))
+					),
+					'LIN_unit_price' => 0, // $ticket_line_item->unit_price()
+					'LIN_quantity'   => $qty,
+					'LIN_is_taxable' => $ticket_line_item->is_taxable(),
+					'LIN_order'      => count($ticket_line_item->children()),
+					'LIN_total'      => 0, // $ticket_line_item->unit_price()
+					'LIN_type'       => EEM_Line_Item::type_cancellation,
+				]
+			);
+			$ticket_line_item->add_child_line_item($cancellation_line_item);
+		}
+		if ($ticket_line_item->save_this_and_descendants() > 0) {
+			// decrement parent line item quantity
+			$event_line_item = $ticket_line_item->parent();
+			if (
+				$event_line_item instanceof EE_Line_Item
+				&& $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
+			) {
+				$event_line_item->set_quantity($event_line_item->quantity() - $qty);
+				$event_line_item->save();
+			}
+			EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * reinstates (un-cancels?) a previously canceled ticket line item,
+	 * by incrementing it's quantity by 1, and decrementing it's "type_cancellation" sub-line-item.
+	 * ALL totals and subtotals will NEED TO BE UPDATED after performing this action
+	 *
+	 * @param EE_Line_Item $ticket_line_item
+	 * @param int          $qty
+	 * @return bool success
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function reinstate_canceled_ticket_line_item(EE_Line_Item $ticket_line_item, $qty = 1)
+	{
+		// validate incoming line_item
+		if ($ticket_line_item->OBJ_type() !== EEM_Line_Item::OBJ_TYPE_TICKET) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The supplied line item must have an Object Type of "Ticket", not %1$s.',
+						'event_espresso'
+					),
+					$ticket_line_item->type()
+				)
+			);
+		}
+		// get cancellation sub line item
+		$cancellation_line_item = EEH_Line_Item::get_descendants_of_type(
+			$ticket_line_item,
+			EEM_Line_Item::type_cancellation
+		);
+		$cancellation_line_item = reset($cancellation_line_item);
+		// verify that this ticket was indeed previously cancelled
+		if (! $cancellation_line_item instanceof EE_Line_Item) {
+			return false;
+		}
+		if ($cancellation_line_item->quantity() > $qty) {
+			// decrement cancelled quantity
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
+		} elseif ($cancellation_line_item->quantity() === $qty) {
+			// decrement cancelled quantity in case anyone still has the object kicking around
+			$cancellation_line_item->set_quantity($cancellation_line_item->quantity() - $qty);
+			// delete because quantity will end up as 0
+			$cancellation_line_item->delete();
+			// and attempt to destroy the object,
+			// even though PHP won't actually destroy it until it needs the memory
+			unset($cancellation_line_item);
+		} else {
+			// what ?!?! negative quantity ?!?!
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Can not reinstate %1$d cancelled ticket(s) because the cancelled ticket quantity is only %2$d.',
+						'event_espresso'
+					),
+					$qty,
+					$cancellation_line_item->quantity()
+				)
+			);
+		}
+		// increment ticket quantity
+		$ticket_line_item->set_quantity($ticket_line_item->quantity() + $qty);
+		if ($ticket_line_item->save_this_and_descendants() > 0) {
+			// increment parent line item quantity
+			$event_line_item = $ticket_line_item->parent();
+			if (
+				$event_line_item instanceof EE_Line_Item
+				&& $event_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
+			) {
+				$event_line_item->set_quantity($event_line_item->quantity() + $qty);
+			}
+			EEH_Line_Item::get_grand_total_and_recalculate_everything($ticket_line_item);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * calls EEH_Line_Item::find_transaction_grand_total_for_line_item()
+	 * then EE_Line_Item::recalculate_total_including_taxes() on the result
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function get_grand_total_and_recalculate_everything(EE_Line_Item $line_item)
+	{
+		$grand_total_line_item = EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item);
+		return $grand_total_line_item->recalculate_total_including_taxes();
+	}
+
+
+	/**
+	 * Gets the line item which contains the subtotal of all the items
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function get_pre_tax_subtotal(EE_Line_Item $total_line_item)
+	{
+		$pre_tax_subtotal = $total_line_item->get_child_line_item('pre-tax-subtotal');
+		return $pre_tax_subtotal instanceof EE_Line_Item
+			? $pre_tax_subtotal
+			: self::create_pre_tax_subtotal($total_line_item);
+	}
+
+
+	/**
+	 * Gets the line item for the taxes subtotal
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function get_taxes_subtotal(EE_Line_Item $total_line_item)
+	{
+		$taxes = $total_line_item->get_child_line_item('taxes');
+		return $taxes ? $taxes : self::create_taxes_subtotal($total_line_item);
+	}
+
+
+	/**
+	 * sets the TXN ID on an EE_Line_Item if passed a valid EE_Transaction object
+	 *
+	 * @param EE_Line_Item   $line_item
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function set_TXN_ID(EE_Line_Item $line_item, $transaction = null)
+	{
+		if ($transaction) {
+			/** @type EEM_Transaction $EEM_Transaction */
+			$EEM_Transaction = EE_Registry::instance()->load_model('Transaction');
+			$TXN_ID          = $EEM_Transaction->ensure_is_ID($transaction);
+			$line_item->set_TXN_ID($TXN_ID);
+		}
+	}
+
+
+	/**
+	 * Creates a new default total line item for the transaction,
+	 * and its tickets subtotal and taxes subtotal line items (and adds the
+	 * existing taxes as children of the taxes subtotal line item)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item of type total
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function create_total_line_item($transaction = null)
+	{
+		$total_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_code' => 'total',
+				'LIN_name' => esc_html__('Grand Total', 'event_espresso'),
+				'LIN_type' => EEM_Line_Item::type_total,
+				'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TRANSACTION,
+			]
+		);
+		$total_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_total_line_item__total_line_item',
+			$total_line_item
+		);
+		self::set_TXN_ID($total_line_item, $transaction);
+		self::create_pre_tax_subtotal($total_line_item, $transaction);
+		self::create_taxes_subtotal($total_line_item, $transaction);
+		return $total_line_item;
+	}
+
+
+	/**
+	 * Creates a default items subtotal line item
+	 *
+	 * @param EE_Line_Item   $total_line_item
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected static function create_pre_tax_subtotal(EE_Line_Item $total_line_item, $transaction = null)
+	{
+		$pre_tax_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_code' => 'pre-tax-subtotal',
+				'LIN_name' => esc_html__('Pre-Tax Subtotal', 'event_espresso'),
+				'LIN_type' => EEM_Line_Item::type_sub_total,
+			]
+		);
+		$pre_tax_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_pre_tax_subtotal__pre_tax_line_item',
+			$pre_tax_line_item
+		);
+		self::set_TXN_ID($pre_tax_line_item, $transaction);
+		$total_line_item->add_child_line_item($pre_tax_line_item);
+		self::create_event_subtotal($pre_tax_line_item, $transaction);
+		return $pre_tax_line_item;
+	}
+
+
+	/**
+	 * Creates a line item for the taxes subtotal and finds all the tax prices
+	 * and applies taxes to it
+	 *
+	 * @param EE_Line_Item   $total_line_item of type EEM_Line_Item::type_total
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected static function create_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null)
+	{
+		$tax_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_code'  => 'taxes',
+				'LIN_name'  => esc_html__('Taxes', 'event_espresso'),
+				'LIN_type'  => EEM_Line_Item::type_tax_sub_total,
+				'LIN_order' => 1000,// this should always come last
+			]
+		);
+		$tax_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_taxes_subtotal__tax_line_item',
+			$tax_line_item
+		);
+		self::set_TXN_ID($tax_line_item, $transaction);
+		$total_line_item->add_child_line_item($tax_line_item);
+		// and lastly, add the actual taxes
+		self::apply_taxes($total_line_item);
+		return $tax_line_item;
+	}
+
+
+	/**
+	 * Creates a default items subtotal line item
+	 *
+	 * @param EE_Line_Item   $pre_tax_line_item
+	 * @param EE_Transaction $transaction
+	 * @param EE_Event       $event
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function create_event_subtotal(EE_Line_Item $pre_tax_line_item, $transaction = null, $event = null)
+	{
+		$event_line_item = EE_Line_Item::new_instance(
+			[
+				'LIN_code' => self::get_event_code($event),
+				'LIN_name' => self::get_event_name($event),
+				'LIN_desc' => self::get_event_desc($event),
+				'LIN_type' => EEM_Line_Item::type_sub_total,
+				'OBJ_type' => EEM_Line_Item::OBJ_TYPE_EVENT,
+				'OBJ_ID'   => $event instanceof EE_Event ? $event->ID() : 0,
+			]
+		);
+		$event_line_item = apply_filters(
+			'FHEE__EEH_Line_Item__create_event_subtotal__event_line_item',
+			$event_line_item
+		);
+		self::set_TXN_ID($event_line_item, $transaction);
+		$pre_tax_line_item->add_child_line_item($event_line_item);
+		return $event_line_item;
+	}
+
+
+	/**
+	 * Gets what the event ticket's code SHOULD be
+	 *
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function get_event_code($event)
+	{
+		return 'event-' . ($event instanceof EE_Event ? $event->ID() : '0');
+	}
+
+
+	/**
+	 * Gets the event name
+	 *
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_event_name($event)
+	{
+		return $event instanceof EE_Event
+			? mb_substr($event->name(), 0, 245)
+			: esc_html__('Event', 'event_espresso');
+	}
+
+
+	/**
+	 * Gets the event excerpt
+	 *
+	 * @param EE_Event $event
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function get_event_desc($event)
+	{
+		return $event instanceof EE_Event ? $event->short_description() : '';
+	}
+
+
+	/**
+	 * Given the grand total line item and a ticket, finds the event sub-total
+	 * line item the ticket's purchase should be added onto
+	 *
+	 * @access public
+	 * @param EE_Line_Item $grand_total the grand total line item
+	 * @param EE_Ticket    $ticket
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function get_event_line_item_for_ticket(EE_Line_Item $grand_total, EE_Ticket $ticket)
+	{
+		$first_datetime = $ticket->first_datetime();
+		if (! $first_datetime instanceof EE_Datetime) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The supplied ticket (ID %d) has no datetimes', 'event_espresso'),
+					$ticket->ID()
+				)
+			);
+		}
+		$event = $first_datetime->event();
+		if (! $event instanceof EE_Event) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The supplied ticket (ID %d) has no event data associated with it.',
+						'event_espresso'
+					),
+					$ticket->ID()
+				)
+			);
+		}
+		$events_sub_total = EEH_Line_Item::get_event_line_item($grand_total, $event);
+		if (! $events_sub_total instanceof EE_Line_Item) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'There is no events sub-total for ticket %s on total line item %d',
+						'event_espresso'
+					),
+					$ticket->ID(),
+					$grand_total->ID()
+				)
+			);
+		}
+		return $events_sub_total;
+	}
+
+
+	/**
+	 * Gets the event line item
+	 *
+	 * @param EE_Line_Item $grand_total
+	 * @param EE_Event     $event
+	 * @return EE_Line_Item for the event subtotal which is a child of $grand_total
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function get_event_line_item(EE_Line_Item $grand_total, $event)
+	{
+		/** @type EE_Event $event */
+		$event           = EEM_Event::instance()->ensure_is_obj($event, true);
+		$event_line_item = null;
+		$found           = false;
+		foreach (EEH_Line_Item::get_event_subtotals($grand_total) as $event_line_item) {
+			// default event subtotal, we should only ever find this the first time this method is called
+			if (! $event_line_item->OBJ_ID()) {
+				// let's use this! but first... set the event details
+				EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
+				$found = true;
+				break;
+			}
+			if ($event_line_item->OBJ_ID() === $event->ID()) {
+				// found existing line item for this event in the cart, so break out of loop and use this one
+				$found = true;
+				break;
+			}
+		}
+		if (! $found) {
+			// there is no event sub-total yet, so add it
+			$pre_tax_subtotal = EEH_Line_Item::get_pre_tax_subtotal($grand_total);
+			// create a new "event" subtotal below that
+			$event_line_item = EEH_Line_Item::create_event_subtotal($pre_tax_subtotal, null, $event);
+			// and set the event details
+			EEH_Line_Item::set_event_subtotal_details($event_line_item, $event);
+		}
+		return $event_line_item;
+	}
+
+
+	/**
+	 * Creates a default items subtotal line item
+	 *
+	 * @param EE_Line_Item   $event_line_item
+	 * @param EE_Event       $event
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function set_event_subtotal_details(
+		EE_Line_Item $event_line_item,
+		EE_Event $event,
+		$transaction = null
+	) {
+		if ($event instanceof EE_Event) {
+			$event_line_item->set_code(self::get_event_code($event));
+			$event_line_item->set_name(self::get_event_name($event));
+			$event_line_item->set_desc(self::get_event_desc($event));
+			$event_line_item->set_OBJ_ID($event->ID());
+		}
+		self::set_TXN_ID($event_line_item, $transaction);
+	}
+
+
+	/**
+	 * Finds what taxes should apply, adds them as tax line items under the taxes sub-total,
+	 * and recalculates the taxes sub-total and the grand total. Resets the taxes, so
+	 * any old taxes are removed
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @param bool         $update_txn_status
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function apply_taxes(EE_Line_Item $total_line_item, $update_txn_status = false)
+	{
+		/** @type EEM_Price $EEM_Price */
+		$EEM_Price = EE_Registry::instance()->load_model('Price');
+		// get array of taxes via Price Model
+		$ordered_taxes = $EEM_Price->get_all_prices_that_are_taxes();
+		ksort($ordered_taxes);
+		$taxes_line_item = self::get_taxes_subtotal($total_line_item);
+		// just to be safe, remove its old tax line items
+		$deleted = $taxes_line_item->delete_children_line_items();
+		$updates = false;
+		// loop thru taxes
+		foreach ($ordered_taxes as $order => $taxes) {
+			foreach ($taxes as $tax) {
+				if ($tax instanceof EE_Price) {
+					$tax_line_item = EE_Line_Item::new_instance(
+						[
+							'LIN_name'       => $tax->name(),
+							'LIN_desc'       => $tax->desc(),
+							'LIN_percent'    => $tax->amount(),
+							'LIN_is_taxable' => false,
+							'LIN_order'      => $order,
+							'LIN_total'      => 0,
+							'LIN_type'       => EEM_Line_Item::type_tax,
+							'OBJ_type'       => EEM_Line_Item::OBJ_TYPE_PRICE,
+							'OBJ_ID'         => $tax->ID(),
+						]
+					);
+					$tax_line_item = apply_filters(
+						'FHEE__EEH_Line_Item__apply_taxes__tax_line_item',
+						$tax_line_item
+					);
+					$updates       = $taxes_line_item->add_child_line_item($tax_line_item)
+						? true
+						: $updates;
+				}
+			}
+		}
+		// only recalculate totals if something changed
+		if ($deleted || $updates) {
+			$total_line_item->recalculate_total_including_taxes($update_txn_status);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Ensures that taxes have been applied to the order, if not applies them.
+	 * Returns the total amount of tax
+	 *
+	 * @param EE_Line_Item $total_line_item of type EEM_Line_Item::type_total
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function ensure_taxes_applied($total_line_item)
+	{
+		$taxes_subtotal = self::get_taxes_subtotal($total_line_item);
+		if (! $taxes_subtotal->children()) {
+			self::apply_taxes($total_line_item);
+		}
+		return $taxes_subtotal->total();
+	}
+
+
+	/**
+	 * Deletes ALL children of the passed line item
+	 *
+	 * @param EE_Line_Item $parent_line_item
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function delete_all_child_items(EE_Line_Item $parent_line_item)
+	{
+		$deleted = 0;
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				$deleted += EEH_Line_Item::delete_all_child_items($child_line_item);
+				if ($child_line_item->ID()) {
+					$child_line_item->delete();
+					unset($child_line_item);
+				} else {
+					$parent_line_item->delete_child_line_item($child_line_item->code());
+				}
+				$deleted++;
+			}
+		}
+		return $deleted;
+	}
+
+
+	/**
+	 * Deletes the line items as indicated by the line item code(s) provided,
+	 * regardless of where they're found in the line item tree. Automatically
+	 * re-calculates the line item totals and updates the related transaction. But
+	 * DOES NOT automatically upgrade the transaction's registrations' final prices (which
+	 * should probably change because of this).
+	 * You should call EE_Registration_Processor::calculate_reg_final_prices_per_line_item()
+	 * after using this, to keep the registration final prices in-sync with the transaction's total.
+	 *
+	 * @param EE_Line_Item      $total_line_item of type EEM_Line_Item::type_total
+	 * @param array|bool|string $line_item_codes
+	 * @return int number of items successfully removed
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function delete_items(EE_Line_Item $total_line_item, $line_item_codes = false)
+	{
+		if ($total_line_item->type() !== EEM_Line_Item::type_total) {
+			EE_Error::doing_it_wrong(
+				'EEH_Line_Item::delete_items',
+				esc_html__(
+					'This static method should only be called with a TOTAL line item, otherwise we won\'t recalculate the totals correctly',
+					'event_espresso'
+				),
+				'4.6.18'
+			);
+		}
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+
+		// check if only a single line_item_id was passed
+		if (! empty($line_item_codes) && ! is_array($line_item_codes)) {
+			// place single line_item_id in an array to appear as multiple line_item_ids
+			$line_item_codes = [$line_item_codes];
+		}
+		$removals = 0;
+		// cycle thru line_item_ids
+		foreach ($line_item_codes as $line_item_id) {
+			$removals += $total_line_item->delete_child_line_item($line_item_id);
+		}
+
+		if ($removals > 0) {
+			$total_line_item->recalculate_taxes_and_tax_total();
+			return $removals;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Overwrites the previous tax by clearing out the old taxes, and creates a new
+	 * tax and updates the total line item accordingly
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param float        $amount
+	 * @param string       $name
+	 * @param string       $description
+	 * @param string       $code
+	 * @param boolean      $add_to_existing_line_item
+	 *                          if true, and a duplicate line item with the same code is found,
+	 *                          $amount will be added onto it; otherwise will simply set the taxes to match $amount
+	 * @return EE_Line_Item the new tax line item created
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function set_total_tax_to(
+		EE_Line_Item $total_line_item,
+		$amount,
+		$name = null,
+		$description = null,
+		$code = null,
+		$add_to_existing_line_item = false
+	) {
+		$tax_subtotal  = self::get_taxes_subtotal($total_line_item);
+		$taxable_total = $total_line_item->taxable_total();
+
+		if ($add_to_existing_line_item) {
+			$new_tax = $tax_subtotal->get_child_line_item($code);
+			EEM_Line_Item::instance()->delete(
+				[['LIN_code' => ['!=', $code], 'LIN_parent' => $tax_subtotal->ID()]]
+			);
+		} else {
+			$new_tax = null;
+			$tax_subtotal->delete_children_line_items();
+		}
+		if ($new_tax) {
+			$new_tax->set_total($new_tax->total() + $amount);
+			$new_tax->set_percent($taxable_total ? $new_tax->total() / $taxable_total * 100 : 0);
+		} else {
+			// no existing tax item. Create it
+			$new_tax = EE_Line_Item::new_instance(
+				[
+					'TXN_ID'      => $total_line_item->TXN_ID(),
+					'LIN_name'    => $name ? $name : esc_html__('Tax', 'event_espresso'),
+					'LIN_desc'    => $description ? $description : '',
+					'LIN_percent' => $taxable_total ? ($amount / $taxable_total * 100) : 0,
+					'LIN_total'   => $amount,
+					'LIN_parent'  => $tax_subtotal->ID(),
+					'LIN_type'    => EEM_Line_Item::type_tax,
+					'LIN_code'    => $code,
+				]
+			);
+		}
+
+		$new_tax = apply_filters(
+			'FHEE__EEH_Line_Item__set_total_tax_to__new_tax_subtotal',
+			$new_tax,
+			$total_line_item
+		);
+		$new_tax->save();
+		$tax_subtotal->set_total($new_tax->total());
+		$tax_subtotal->save();
+		$total_line_item->recalculate_total_including_taxes();
+		return $new_tax;
+	}
+
+
+	/**
+	 * Makes all the line items which are children of $line_item taxable (or not).
+	 * Does NOT save the line items
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param boolean      $taxable
+	 * @param string       $code_substring_for_whitelist if this string is part of the line item's code
+	 *                                                   it will be whitelisted (ie, except from becoming taxable)
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function set_line_items_taxable(
+		EE_Line_Item $line_item,
+		$taxable = true,
+		$code_substring_for_whitelist = null
+	) {
+		$whitelisted = false;
+		if ($code_substring_for_whitelist !== null) {
+			$whitelisted = strpos($line_item->code(), $code_substring_for_whitelist) !== false;
+		}
+		if (! $whitelisted && $line_item->is_line_item()) {
+			$line_item->set_is_taxable($taxable);
+		}
+		foreach ($line_item->children() as $child_line_item) {
+			EEH_Line_Item::set_line_items_taxable(
+				$child_line_item,
+				$taxable,
+				$code_substring_for_whitelist
+			);
+		}
+	}
+
+
+	/**
+	 * Gets all descendants that are event subtotals
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 * @uses  EEH_Line_Item::get_subtotals_of_object_type()
+	 */
+	public static function get_event_subtotals(EE_Line_Item $parent_line_item)
+	{
+		return self::get_subtotals_of_object_type($parent_line_item, EEM_Line_Item::OBJ_TYPE_EVENT);
+	}
+
+
+	/**
+	 * Gets all descendants subtotals that match the supplied object type
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $obj_type
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 */
+	public static function get_subtotals_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '')
+	{
+		return self::_get_descendants_by_type_and_object_type(
+			$parent_line_item,
+			EEM_Line_Item::type_sub_total,
+			$obj_type
+		);
+	}
+
+
+	/**
+	 * Gets all descendants that are tickets
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 * @uses  EEH_Line_Item::get_line_items_of_object_type()
+	 */
+	public static function get_ticket_line_items(EE_Line_Item $parent_line_item)
+	{
+		return self::get_line_items_of_object_type(
+			$parent_line_item,
+			EEM_Line_Item::OBJ_TYPE_TICKET
+		);
+	}
+
+
+	/**
+	 * Gets all descendants subtotals that match the supplied object type
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $obj_type
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 */
+	public static function get_line_items_of_object_type(EE_Line_Item $parent_line_item, $obj_type = '')
+	{
+		return self::_get_descendants_by_type_and_object_type(
+			$parent_line_item,
+			EEM_Line_Item::type_line_item,
+			$obj_type
+		);
+	}
+
+
+	/**
+	 * Gets all the descendants (ie, children or children of children etc) that are of the type 'tax'
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 * @uses  EEH_Line_Item::get_descendants_of_type()
+	 */
+	public static function get_tax_descendants(EE_Line_Item $parent_line_item)
+	{
+		return EEH_Line_Item::get_descendants_of_type(
+			$parent_line_item,
+			EEM_Line_Item::type_tax
+		);
+	}
+
+
+	/**
+	 * Gets all the real items purchased which are children of this item
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 * @uses  EEH_Line_Item::get_descendants_of_type()
+	 */
+	public static function get_line_item_descendants(EE_Line_Item $parent_line_item)
+	{
+		return EEH_Line_Item::get_descendants_of_type(
+			$parent_line_item,
+			EEM_Line_Item::type_line_item
+		);
+	}
+
+
+	/**
+	 * Gets all descendants of supplied line item that match the supplied line item type
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $line_item_type   one of the EEM_Line_Item constants
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 */
+	public static function get_descendants_of_type(EE_Line_Item $parent_line_item, $line_item_type)
+	{
+		return self::_get_descendants_by_type_and_object_type(
+			$parent_line_item,
+			$line_item_type,
+			null
+		);
+	}
+
+
+	/**
+	 * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type
+	 * as well
+	 *
+	 * @param EE_Line_Item  $parent_line_item - the line item to find descendants of
+	 * @param string        $line_item_type   one of the EEM_Line_Item constants
+	 * @param string | NULL $obj_type         object model class name (minus prefix) or NULL to ignore object type when
+	 *                                        searching
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected static function _get_descendants_by_type_and_object_type(
+		EE_Line_Item $parent_line_item,
+		$line_item_type,
+		$obj_type = null
+	) {
+		$objects = [];
+		$child_objects = [];
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				if (
+					$child_line_item->type() === $line_item_type
+					&& (
+						$child_line_item->OBJ_type() === $obj_type || $obj_type === null
+					)
+				) {
+					$objects[] = $child_line_item;
+				} else {
+					// go-through-all-its children looking for more matches
+					$child_objects[] = self::_get_descendants_by_type_and_object_type(
+						$child_line_item,
+						$line_item_type,
+						$obj_type
+					);
+				}
+			}
+		}
+		return array_merge([], $objects, ...$child_objects);
+	}
+
+
+	/**
+	 * Gets all descendants subtotals that match the supplied object type
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $OBJ_type         object type (like Event)
+	 * @param array        $OBJ_IDs          array of OBJ_IDs
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 * @uses  EEH_Line_Item::_get_descendants_by_type_and_object_type()
+	 */
+	public static function get_line_items_by_object_type_and_IDs(
+		EE_Line_Item $parent_line_item,
+		$OBJ_type = '',
+		$OBJ_IDs = []
+	) {
+		return self::_get_descendants_by_object_type_and_object_ID(
+			$parent_line_item,
+			$OBJ_type,
+			$OBJ_IDs
+		);
+	}
+
+
+	/**
+	 * Gets all descendants of supplied line item that match the supplied line item type and possibly the object type
+	 * as well
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $OBJ_type         object type (like Event)
+	 * @param array        $OBJ_IDs          array of OBJ_IDs
+	 * @return EE_Line_Item[]
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected static function _get_descendants_by_object_type_and_object_ID(
+		EE_Line_Item $parent_line_item,
+		$OBJ_type,
+		$OBJ_IDs
+	) {
+		$objects = [];
+		$child_objects = [];
+		foreach ($parent_line_item->children() as $child_line_item) {
+			if ($child_line_item instanceof EE_Line_Item) {
+				if (
+					$child_line_item->OBJ_type() === $OBJ_type
+					&& is_array($OBJ_IDs)
+					&& in_array($child_line_item->OBJ_ID(), $OBJ_IDs)
+				) {
+					$objects[] = $child_line_item;
+				} else {
+					// go-through-all-its children looking for more matches
+					$child_objects[] = self::_get_descendants_by_object_type_and_object_ID(
+						$child_line_item,
+						$OBJ_type,
+						$OBJ_IDs
+					);
+				}
+			}
+		}
+		return array_merge([], $objects, ...$child_objects);
+	}
+
+
+	/**
+	 * Uses a breadth-first-search in order to find the nearest descendant of
+	 * the specified type and returns it, else NULL
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $type             like one of the EEM_Line_Item::type_*
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::_get_nearest_descendant()
+	 */
+	public static function get_nearest_descendant_of_type(EE_Line_Item $parent_line_item, $type)
+	{
+		return self::_get_nearest_descendant($parent_line_item, 'LIN_type', $type);
+	}
+
+
+	/**
+	 * Uses a breadth-first-search in order to find the nearest descendant
+	 * having the specified LIN_code and returns it, else NULL
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $code             any value used for LIN_code
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @uses  EEH_Line_Item::_get_nearest_descendant()
+	 */
+	public static function get_nearest_descendant_having_code(EE_Line_Item $parent_line_item, $code)
+	{
+		return self::_get_nearest_descendant($parent_line_item, 'LIN_code', $code);
+	}
+
+
+	/**
+	 * Uses a breadth-first-search in order to find the nearest descendant
+	 * having the specified LIN_code and returns it, else NULL
+	 *
+	 * @param EE_Line_Item $parent_line_item - the line item to find descendants of
+	 * @param string       $search_field     name of EE_Line_Item property
+	 * @param string       $value            any value stored in $search_field
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	protected static function _get_nearest_descendant(EE_Line_Item $parent_line_item, $search_field, $value)
+	{
+		foreach ($parent_line_item->children() as $child) {
+			if ($child->get($search_field) == $value) {
+				return $child;
+			}
+		}
+		foreach ($parent_line_item->children() as $child) {
+			$descendant_found = self::_get_nearest_descendant(
+				$child,
+				$search_field,
+				$value
+			);
+			if ($descendant_found) {
+				return $descendant_found;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * if passed line item has a TXN ID, uses that to jump directly to the grand total line item for the transaction,
+	 * else recursively walks up the line item tree until a parent of type total is found,
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Line_Item
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function find_transaction_grand_total_for_line_item(EE_Line_Item $line_item)
+	{
+		if ($line_item->TXN_ID()) {
+			$total_line_item = $line_item->transaction()->total_line_item(false);
+			if ($total_line_item instanceof EE_Line_Item) {
+				return $total_line_item;
+			}
+		} else {
+			$line_item_parent = $line_item->parent();
+			if ($line_item_parent instanceof EE_Line_Item) {
+				if ($line_item_parent->is_total()) {
+					return $line_item_parent;
+				}
+				return EEH_Line_Item::find_transaction_grand_total_for_line_item($line_item_parent);
+			}
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'A valid grand total for line item %1$d was not found.',
+					'event_espresso'
+				),
+				$line_item->ID()
+			)
+		);
+	}
+
+
+	/**
+	 * Prints out a representation of the line item tree
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $indentation
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	public static function visualize(EE_Line_Item $line_item, $indentation = 0)
+	{
+		$linebreak = defined('EE_TESTS_DIR') ? "\n" : '<br />';
+		echo $linebreak;
+		if (! $indentation) {
+			echo $linebreak;
+		}
+		for ($i = 0; $i < $indentation; $i++) {
+			echo ' . ';
+		}
+		$breakdown = '';
+		if ($line_item->is_line_item()) {
+			if ($line_item->is_percent()) {
+				$breakdown = "{$line_item->percent()}%";
+			} else {
+				$breakdown = ' $' . "{$line_item->unit_price()} x {$line_item->quantity()}";
+			}
+		}
+		echo wp_kses($line_item->name(), AllowedTags::getAllowedTags());
+		echo " [ ID: {$line_item->ID()} · qty: {$line_item->quantity()} ] {$line_item->type()} : ";
+		echo ' $' . (string) $line_item->total();
+		if ($breakdown) {
+			echo " ( {$breakdown} )";
+		}
+		if ($line_item->is_taxable()) {
+			echo '  * taxable';
+		}
+		if ($line_item->children()) {
+			foreach ($line_item->children() as $child) {
+				self::visualize($child, $indentation + 1);
+			}
+		}
+		if ($line_item->is_total()) {
+			echo $linebreak . $linebreak;
+		}
+	}
+
+
+	/**
+	 * Calculates the registration's final price, taking into account that they
+	 * need to not only help pay for their OWN ticket, but also any transaction-wide surcharges and taxes,
+	 * and receive a portion of any transaction-wide discounts.
+	 * eg1, if I buy a $1 ticket and brent buys a $9 ticket, and we receive a $5 discount
+	 * then I'll get 1/10 of that $5 discount, which is $0.50, and brent will get
+	 * 9/10ths of that $5 discount, which is $4.50. So my final price should be $0.50
+	 * and brent's final price should be $5.50.
+	 * In order to do this, we basically need to traverse the line item tree calculating
+	 * the running totals (just as if we were recalculating the total), but when we identify
+	 * regular line items, we need to keep track of their share of the grand total.
+	 * Also, we need to keep track of the TAXABLE total for each ticket purchase, so
+	 * we can know how to apply taxes to it. (Note: "taxable total" does not equal the "pretax total"
+	 * when there are non-taxable items; otherwise they would be the same)
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param array        $billable_ticket_quantities  array of EE_Ticket IDs and their corresponding quantity
+	 *                                                  that can be included in price calculations at this moment
+	 * @return array                                    keys are line items for tickets IDs and values are their share
+	 *                                                  of the running total, plus the key 'total',
+	 *                                                  and 'taxable' which also has keys of all the ticket IDs.
+	 *                                                      ex:
+	 *                                                      [
+	 *                                                          12 => 4.3,
+	 *                                                          23 => 8.0,
+	 *                                                          'total' => 16.6,
+	 *                                                          'taxable' => [
+	 *                                                              12 => 10,
+	 *                                                              23 => 4
+	 *                                                          ]
+	 *                                                      ]
+	 *                                                  So to find which registrations have which final price,
+	 *                                                  we need to find which line item is theirs, via:
+	 *                                                  `EEM_Line_Item::instance()->get_line_item_for_registration(
+	 *                                                      $registration
+	 *                                                  );`
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function calculate_reg_final_prices_per_line_item(
+		EE_Line_Item $line_item,
+		$billable_ticket_quantities = []
+	) {
+		$running_totals = [
+			'total'   => 0,
+			'taxable' => ['total' => 0],
+		];
+		foreach ($line_item->children() as $child_line_item) {
+			switch ($child_line_item->type()) {
+				case EEM_Line_Item::type_sub_total:
+					$running_totals_from_subtotal = EEH_Line_Item::calculate_reg_final_prices_per_line_item(
+						$child_line_item,
+						$billable_ticket_quantities
+					);
+					// combine arrays but preserve numeric keys
+					$running_totals = array_replace_recursive($running_totals_from_subtotal, $running_totals);
+					$running_totals['total']            += $running_totals_from_subtotal['total'];
+					$running_totals['taxable']['total'] += $running_totals_from_subtotal['taxable']['total'];
+					break;
+
+				case EEM_Line_Item::type_tax_sub_total:
+					// find how much the taxes percentage is
+					if ($child_line_item->percent() !== 0) {
+						$tax_percent_decimal = $child_line_item->percent() / 100;
+					} else {
+						$tax_percent_decimal = EE_Taxes::get_total_taxes_percentage() / 100;
+					}
+					// and apply to all the taxable totals, and add to the pretax totals
+					foreach ($running_totals as $line_item_id => $this_running_total) {
+						// "total" and "taxable" array key is an exception
+						if ($line_item_id === 'taxable') {
+							continue;
+						}
+						$taxable_total                   = $running_totals['taxable'][ $line_item_id ];
+						$running_totals[ $line_item_id ] += ($taxable_total * $tax_percent_decimal);
+					}
+					break;
+
+				case EEM_Line_Item::type_line_item:
+					// ticket line items or ????
+					if ($child_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET) {
+						// kk it's a ticket
+						if (isset($running_totals[ $child_line_item->ID() ])) {
+							// huh? that shouldn't happen.
+							$running_totals['total'] += $child_line_item->total();
+						} else {
+							// its not in our running totals yet. great.
+							if ($child_line_item->is_taxable()) {
+								$taxable_amount = $child_line_item->unit_price();
+							} else {
+								$taxable_amount = 0;
+							}
+							// are we only calculating totals for some tickets?
+							if (isset($billable_ticket_quantities[ $child_line_item->OBJ_ID() ])) {
+								$quantity                                            =
+									$billable_ticket_quantities[ $child_line_item->OBJ_ID() ];
+								$running_totals[ $child_line_item->ID() ]            = $quantity
+									? $child_line_item->unit_price()
+									: 0;
+								$running_totals['taxable'][ $child_line_item->ID() ] = $quantity
+									? $taxable_amount
+									: 0;
+							} else {
+								$quantity                                            = $child_line_item->quantity();
+								$running_totals[ $child_line_item->ID() ]            = $child_line_item->unit_price();
+								$running_totals['taxable'][ $child_line_item->ID() ] = $taxable_amount;
+							}
+							$running_totals['taxable']['total'] += $taxable_amount * $quantity;
+							$running_totals['total']            += $child_line_item->unit_price() * $quantity;
+						}
+					} else {
+						// it's some other type of item added to the cart
+						// it should affect the running totals
+						// basically we want to convert it into a PERCENT modifier. Because
+						// more clearly affect all registration's final price equally
+						$line_items_percent_of_running_total = $running_totals['total'] > 0
+							? ($child_line_item->total() / $running_totals['total']) + 1
+							: 1;
+						foreach ($running_totals as $line_item_id => $this_running_total) {
+							// the "taxable" array key is an exception
+							if ($line_item_id === 'taxable') {
+								continue;
+							}
+							// update the running totals
+							// yes this actually even works for the running grand total!
+							$running_totals[ $line_item_id ] =
+								$line_items_percent_of_running_total * $this_running_total;
+
+							if ($child_line_item->is_taxable()) {
+								$running_totals['taxable'][ $line_item_id ] =
+									$line_items_percent_of_running_total * $running_totals['taxable'][ $line_item_id ];
+							}
+						}
+					}
+					break;
+			}
+		}
+		return $running_totals;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @param EE_Line_Item $ticket_line_item
+	 * @return float | null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws OutOfRangeException
+	 * @throws ReflectionException
+	 */
+	public static function calculate_final_price_for_ticket_line_item(
+		EE_Line_Item $total_line_item,
+		EE_Line_Item $ticket_line_item
+	) {
+		static $final_prices_per_ticket_line_item = [];
+		if (empty($final_prices_per_ticket_line_item)
+			|| empty($final_prices_per_ticket_line_item[ $total_line_item->ID() ])
+		) {
+			$final_prices_per_ticket_line_item[ $total_line_item->ID() ] =
+				EEH_Line_Item::calculate_reg_final_prices_per_line_item(
+					$total_line_item
+				);
+		}
+		// ok now find this new registration's final price
+		if (isset($final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ])) {
+			return $final_prices_per_ticket_line_item[ $total_line_item->ID() ][ $ticket_line_item->ID() ];
+		}
+		$message = sprintf(
+			esc_html__(
+				'The final price for the ticket line item (ID:%1$d) could not be calculated.',
+				'event_espresso'
+			),
+			$ticket_line_item->ID()
+		);
+		if (WP_DEBUG) {
+			$message .= '<br>' . print_r($final_prices_per_ticket_line_item, true);
+			throw new OutOfRangeException($message);
+		}
+		EE_Log::instance()->log(__CLASS__, __FUNCTION__, $message);
+		return null;
+	}
+
+
+	/**
+	 * Creates a duplicate of the line item tree, except only includes billable items
+	 * and the portion of line items attributed to billable things
+	 *
+	 * @param EE_Line_Item      $line_item
+	 * @param EE_Registration[] $registrations
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function billable_line_item_tree(EE_Line_Item $line_item, $registrations)
+	{
+		$copy_li = EEH_Line_Item::billable_line_item($line_item, $registrations);
+		foreach ($line_item->children() as $child_li) {
+			$copy_li->add_child_line_item(
+				EEH_Line_Item::billable_line_item_tree($child_li, $registrations)
+			);
+		}
+		// if this is the grand total line item, make sure the totals all add up
+		// (we could have duplicated this logic AS we copied the line items, but
+		// it seems DRYer this way)
+		if ($copy_li->type() === EEM_Line_Item::type_total) {
+			$copy_li->recalculate_total_including_taxes();
+		}
+		return $copy_li;
+	}
+
+
+	/**
+	 * Creates a new, unsaved line item from $line_item that factors in the
+	 * number of billable registrations on $registrations.
+	 *
+	 * @param EE_Line_Item      $line_item
+	 * @param EE_Registration[] $registrations
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function billable_line_item(EE_Line_Item $line_item, $registrations)
+	{
+		$new_li_fields = $line_item->model_field_array();
+		if (
+			$line_item->type() === EEM_Line_Item::type_line_item &&
+			$line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
+		) {
+			$count = 0;
+			foreach ($registrations as $registration) {
+				if (
+					$line_item->OBJ_ID() === $registration->ticket_ID() &&
+					in_array(
+						$registration->status_ID(),
+						EEM_Registration::reg_statuses_that_allow_payment(),
+						true
+					)
+				) {
+					$count++;
+				}
+			}
+			$new_li_fields['LIN_quantity'] = $count;
+		}
+		// don't set the total. We'll leave that up to the code that calculates it
+		unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent'], $new_li_fields['LIN_total']);
+		return EE_Line_Item::new_instance($new_li_fields);
+	}
+
+
+	/**
+	 * Returns a modified line item tree where all the subtotals which have a total of 0
+	 * are removed, and line items with a quantity of 0
+	 *
+	 * @param EE_Line_Item $line_item |null
+	 * @return EE_Line_Item|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function non_empty_line_items(EE_Line_Item $line_item)
+	{
+		$copied_li = EEH_Line_Item::non_empty_line_item($line_item);
+		if ($copied_li === null) {
+			return null;
+		}
+		// if this is an event subtotal, we want to only include it if it
+		// has a non-zero total and at least one ticket line item child
+		$ticket_children = 0;
+		foreach ($line_item->children() as $child_li) {
+			$child_li_copy = EEH_Line_Item::non_empty_line_items($child_li);
+			if ($child_li_copy !== null) {
+				$copied_li->add_child_line_item($child_li_copy);
+				if (
+					$child_li_copy->type() === EEM_Line_Item::type_line_item &&
+					$child_li_copy->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
+				) {
+					$ticket_children++;
+				}
+			}
+		}
+		// if this is an event subtotal with NO ticket children
+		// we basically want to ignore it
+		if (
+			$ticket_children === 0
+			&& $line_item->type() === EEM_Line_Item::type_sub_total
+			&& $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_EVENT
+			&& $line_item->total() === 0
+		) {
+			return null;
+		}
+		return $copied_li;
+	}
+
+
+	/**
+	 * Creates a new, unsaved line item, but if it's a ticket line item
+	 * with a total of 0, or a subtotal of 0, returns null instead
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public static function non_empty_line_item(EE_Line_Item $line_item)
+	{
+		if (
+			$line_item->type() === EEM_Line_Item::type_line_item
+			&& $line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
+			&& $line_item->quantity() === 0
+		) {
+			return null;
+		}
+		$new_li_fields = $line_item->model_field_array();
+		// don't set the total. We'll leave that up to the code that calculates it
+		unset($new_li_fields['LIN_ID'], $new_li_fields['LIN_parent']);
+		return EE_Line_Item::new_instance($new_li_fields);
+	}
+
+
+	/**
+	 * Cycles through all of the ticket line items for the supplied total line item
+	 * and ensures that the line item's "is_taxable" field matches that of its corresponding ticket
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @since 4.9.79.p
+	 */
+	public static function resetIsTaxableForTickets(EE_Line_Item $total_line_item)
+	{
+		$ticket_line_items = self::get_ticket_line_items($total_line_item);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === EEM_Line_Item::OBJ_TYPE_TICKET
+			) {
+				$ticket = $ticket_line_item->ticket();
+				if ($ticket instanceof EE_Ticket && $ticket->taxable() !== $ticket_line_item->is_taxable()) {
+					$ticket_line_item->set_is_taxable($ticket->taxable());
+					$ticket_line_item->save();
+				}
+			}
+		}
+	}
+
+
+
+	/**************************************** @DEPRECATED METHODS *************************************** */
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function get_items_subtotal(EE_Line_Item $total_line_item)
+	{
+		EE_Error::doing_it_wrong(
+			'EEH_Line_Item::get_items_subtotal()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::get_pre_tax_subtotal()'
+			),
+			'4.6.0'
+		);
+		return self::get_pre_tax_subtotal($total_line_item);
+	}
+
+
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function create_default_total_line_item($transaction = null)
+	{
+		EE_Error::doing_it_wrong(
+			'EEH_Line_Item::create_default_total_line_item()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::create_total_line_item()'
+			),
+			'4.6.0'
+		);
+		return self::create_total_line_item($transaction);
+	}
+
+
+	/**
+	 * @param EE_Line_Item   $total_line_item
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function create_default_tickets_subtotal(EE_Line_Item $total_line_item, $transaction = null)
+	{
+		EE_Error::doing_it_wrong(
+			'EEH_Line_Item::create_default_tickets_subtotal()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::create_pre_tax_subtotal()'
+			),
+			'4.6.0'
+		);
+		return self::create_pre_tax_subtotal($total_line_item, $transaction);
+	}
+
+
+	/**
+	 * @param EE_Line_Item   $total_line_item
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function create_default_taxes_subtotal(EE_Line_Item $total_line_item, $transaction = null)
+	{
+		EE_Error::doing_it_wrong(
+			'EEH_Line_Item::create_default_taxes_subtotal()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::create_taxes_subtotal()'
+			),
+			'4.6.0'
+		);
+		return self::create_taxes_subtotal($total_line_item, $transaction);
+	}
+
+
+	/**
+	 * @param EE_Line_Item   $total_line_item
+	 * @param EE_Transaction $transaction
+	 * @return EE_Line_Item
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function create_default_event_subtotal(EE_Line_Item $total_line_item, $transaction = null)
+	{
+		EE_Error::doing_it_wrong(
+			'EEH_Line_Item::create_default_event_subtotal()',
+			sprintf(
+				esc_html__('Method replaced with %1$s', 'event_espresso'),
+				'EEH_Line_Item::create_event_subtotal()'
+			),
+			'4.6.0'
+		);
+		return self::create_event_subtotal($total_line_item, $transaction);
+	}
 }

core/helpers/EEH_Debug_Tools.helper.php

Spacing +42 added lines, -42 removed lines

@@ -39,7 +39,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
+        if ( ! self::$_instance instanceof EEH_Debug_Tools) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -56,14 +56,14 @@ 
         if (
             defined('EE_LOAD_KINT')
             && ! class_exists('Kint')
-            && file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')
+            && file_exists(EE_PLUGIN_DIR_PATH.'tests/kint/Kint.class.php')
         ) {
             // despite EE4 having a check for an existing copy of the Kint debugging class,
             // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
             // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
             // so we've moved it to our test folder so that it is not included with production releases
             // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
+            require_once(EE_PLUGIN_DIR_PATH.'tests/kint/Kint.class.php');
         }
         $plugin = basename(EE_PLUGIN_DIR_PATH);
         add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
@@ -80,7 +80,7 @@ 
      */
     public static function show_db_name()
     {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+        if ( ! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
             echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
                  . DB_NAME
                  . '</p>';
@@ -130,12 +130,12 @@ 
         global $wp_filter;
         echo '<br/><br/><br/><h3>Hooked Functions</h3>';
         if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
+            $hook[$tag] = $wp_filter[$tag];
+            if ( ! is_array($hook[$tag])) {
                 trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
                 return;
             }
-            echo '<h5>For Tag: ' . esc_html($tag) . '</h5>';
+            echo '<h5>For Tag: '.esc_html($tag).'</h5>';
         } else {
             $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
             ksort($hook);
@@ -165,12 +165,12 @@ 
     {
         $filters = array();
         global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
+        if (isset($wp_filter[$hook_name])) {
+            $filters[$hook_name] = array();
+            foreach ($wp_filter[$hook_name] as $priority => $callbacks) {
+                $filters[$hook_name][$priority] = array();
                 foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
+                    $filters[$hook_name][$priority][] = $callback['function'];
                 }
             }
         }
@@ -189,17 +189,17 @@ 
     {
         if (WP_DEBUG) {
             $activation_errors = ob_get_contents();
-            if (! empty($activation_errors)) {
-                $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
+            if ( ! empty($activation_errors)) {
+                $activation_errors = date('Y-m-d H:i:s')."\n".$activation_errors;
             }
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+            espresso_load_required('EEH_File', EE_HELPERS.'EEH_File.helper.php');
             if (class_exists('EEH_File')) {
                 try {
                     EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html'
                     );
                     EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+                        EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html',
                         $activation_errors
                     );
                 } catch (EE_Error $e) {
@@ -219,11 +219,11 @@ 
             } else {
                 // old school attempt
                 file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+                    EVENT_ESPRESSO_UPLOAD_DIR.'logs/espresso_plugin_activation_errors.html',
                     $activation_errors
                 );
             }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+            $activation_errors = get_option('ee_plugin_activation_errors', '').$activation_errors;
             update_option('ee_plugin_activation_errors', $activation_errors);
         }
     }
@@ -283,7 +283,7 @@ 
         // don't trigger error if doing ajax,
         // instead we'll add a transient EE_Error notice that in theory should show on the next request.
         if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
+            $error_message .= ' '.esc_html__(
                 'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
                 'event_espresso'
             );
@@ -326,18 +326,18 @@ 
         $debug_key = 'EE_DEBUG_SPCO'
     ) {
         if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
+            $debug_key = $debug_key.'_'.EE_Session::instance()->id();
             $debug_data = get_option($debug_key, array());
             $default_data = array(
-                $class => $func . '() : ' . $line,
+                $class => $func.'() : '.$line,
             );
             // don't serialize objects
             $info = self::strip_objects($info);
             $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
+            if ( ! isset($debug_data[$index])) {
+                $debug_data[$index] = array();
             }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+            $debug_data[$index][microtime()] = array_merge($default_data, $info);
             update_option($debug_key, $debug_data);
         }
     }
@@ -354,20 +354,20 @@ 
     {
         foreach ($info as $key => $value) {
             if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
+                $info[$key] = self::strip_objects($value);
             } elseif (is_object($value)) {
                 $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+                $info[$object_class] = array();
+                $info[$object_class]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
                 if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
+                    $info[$object_class]['ID'] = $value->ID();
                 }
                 if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
+                    $info[$object_class]['status'] = $value->status();
                 } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
+                    $info[$object_class]['status'] = $value->status_ID();
                 }
-                unset($info[ $key ]);
+                unset($info[$key]);
             }
         }
         return (array) $info;
@@ -401,8 +401,8 @@ 
         $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
         $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+            ? EEH_Debug_Tools::grey_span('::').EEH_Debug_Tools::orange_span($var.'()')
+            : EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span($var);
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
         $result .= EEH_Debug_Tools::headingX($heading_tag);
         if ($die) {
@@ -457,11 +457,11 @@ 
             if ($heading_tag === 'h1' || $heading_tag === 'h2') {
                 $heading .= self::lineBreak();
             }
-            $heading .= self::lineBreak() . "{$line}) {$var_name}";
+            $heading .= self::lineBreak()."{$line}) {$var_name}";
             return $heading;
         }
         $margin = "25px 0 0 {$margin}";
-        return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
+        return '<'.$heading_tag.' style="color:#2EA2CC; margin:'.$margin.';"><b>'.$var_name.'</b>';
     }
 
 
@@ -475,7 +475,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return '';
         }
-        return '</' . $heading_tag . '>';
+        return '</'.$heading_tag.'>';
     }
 
 
@@ -489,7 +489,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#999">' . $content . '</span>';
+        return '<span style="color:#999">'.$content.'</span>';
     }
 
 
@@ -529,7 +529,7 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return $content;
         }
-        return '<span style="color:#E76700">' . $content . '</span>';
+        return '<span style="color:#E76700">'.$content.'</span>';
     }
 
 
@@ -546,8 +546,8 @@ 
         if (EEH_Debug_Tools::plainOutput()) {
             return str_replace("\n", '', $var);
         }
-        return '<pre style="background: #fff; color:#999; display: inline-block; margin: 0 1em; padding: 0;">' .
-               $var . '</pre>';
+        return '<pre style="background: #fff; color:#999; display: inline-block; margin: 0 1em; padding: 0;">'.
+               $var.'</pre>';
     }
 
 
@@ -588,7 +588,7 @@ 
         $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
         $result = EEH_Debug_Tools::headingSpacer($heading_tag);
         $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+        $result .= EEH_Debug_Tools::grey_span(' : ').EEH_Debug_Tools::orange_span(
             EEH_Debug_Tools::pre_span($var)
         );
         $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);

Indentation +683 added lines, -683 removed lines

@@ -15,674 +15,674 @@ 
  */
 class EEH_Debug_Tools
 {
-    /**
-     *    instance of the EEH_Autoloader object
-     *
-     * @var    $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @var array
-     */
-    protected $_memory_usage_points = array();
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EEH_Debug_Tools
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EEH_Debug_Tools) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * private class constructor
-     */
-    private function __construct()
-    {
-        // load Kint PHP debugging library
-        if (
-            defined('EE_LOAD_KINT')
-            && ! class_exists('Kint')
-            && file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')
-        ) {
-            // despite EE4 having a check for an existing copy of the Kint debugging class,
-            // if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
-            // then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
-            // so we've moved it to our test folder so that it is not included with production releases
-            // plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
-            require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
-        }
-        $plugin = basename(EE_PLUGIN_DIR_PATH);
-        add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
-        add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
-    }
-
-
-
-    /**
-     *    show_db_name
-     *
-     * @return void
-     */
-    public static function show_db_name()
-    {
-        if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
-            echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
-                 . DB_NAME
-                 . '</p>';
-        }
-        if (EE_DEBUG) {
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    dump EE_Session object at bottom of page after everything else has happened
-     *
-     * @return void
-     */
-    public function espresso_session_footer_dump()
-    {
-        if (
-            (defined('WP_DEBUG') && WP_DEBUG)
-            && ! defined('DOING_AJAX')
-            && class_exists('Kint')
-            && function_exists('wp_get_current_user')
-            && current_user_can('update_core')
-            && class_exists('EE_Registry')
-        ) {
-            Kint::dump(EE_Registry::instance()->SSN->id());
-            Kint::dump(EE_Registry::instance()->SSN);
-            //          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
-            $this->espresso_list_hooked_functions();
-            Benchmark::displayResults();
-        }
-    }
-
-
-
-    /**
-     *    List All Hooked Functions
-     *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
-     *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
-     *
-     * @param string $tag
-     * @return void
-     */
-    public function espresso_list_hooked_functions($tag = '')
-    {
-        global $wp_filter;
-        echo '<br/><br/><br/><h3>Hooked Functions</h3>';
-        if ($tag) {
-            $hook[ $tag ] = $wp_filter[ $tag ];
-            if (! is_array($hook[ $tag ])) {
-                trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
-                return;
-            }
-            echo '<h5>For Tag: ' . esc_html($tag) . '</h5>';
-        } else {
-            $hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
-            ksort($hook);
-        }
-        foreach ($hook as $tag_name => $priorities) {
-            echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>esc_html($tag_name)</strong><br />";
-            ksort($priorities);
-            foreach ($priorities as $priority => $function) {
-                echo esc_html($priority);
-                foreach ($function as $name => $properties) {
-                    $name = esc_html($name);
-                    echo "\t$name<br />";
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     *    registered_filter_callbacks
-     *
-     * @param string $hook_name
-     * @return array
-     */
-    public static function registered_filter_callbacks($hook_name = '')
-    {
-        $filters = array();
-        global $wp_filter;
-        if (isset($wp_filter[ $hook_name ])) {
-            $filters[ $hook_name ] = array();
-            foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
-                $filters[ $hook_name ][ $priority ] = array();
-                foreach ($callbacks as $callback) {
-                    $filters[ $hook_name ][ $priority ][] = $callback['function'];
-                }
-            }
-        }
-        return $filters;
-    }
-
-
-
-    /**
-     *    captures plugin activation errors for debugging
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public static function ee_plugin_activation_errors()
-    {
-        if (WP_DEBUG) {
-            $activation_errors = ob_get_contents();
-            if (! empty($activation_errors)) {
-                $activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
-            }
-            espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
-            if (class_exists('EEH_File')) {
-                try {
-                    EEH_File::ensure_file_exists_and_is_writable(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
-                    );
-                    EEH_File::write_to_file(
-                        EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
-                        $activation_errors
-                    );
-                } catch (EE_Error $e) {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The Event Espresso activation errors file could not be setup because: %s',
-                                'event_espresso'
-                            ),
-                            $e->getMessage()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                // old school attempt
-                file_put_contents(
-                    EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
-                    $activation_errors
-                );
-            }
-            $activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
-            update_option('ee_plugin_activation_errors', $activation_errors);
-        }
-    }
-
-
-
-    /**
-     * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
-     * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
-     * or we want to make sure they use something the right way.
-     *
-     * @access public
-     * @param string $function      The function that was called
-     * @param string $message       A message explaining what has been done incorrectly
-     * @param string $version       The version of Event Espresso where the error was added
-     * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
-     *                              for a deprecated function. This allows deprecation to occur during one version,
-     *                              but not have any notices appear until a later version. This allows developers
-     *                              extra time to update their code before notices appear.
-     * @param int    $error_type
-     * @uses   trigger_error()
-     */
-    public function doing_it_wrong(
-        $function,
-        $message,
-        $version,
-        $applies_when = '',
-        $error_type = null
-    ) {
-        $applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
-        $error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
-        // because we swapped the parameter order around for the last two params,
-        // let's verify that some third party isn't still passing an error type value for the third param
-        if (is_int($applies_when)) {
-            $error_type = $applies_when;
-            $applies_when = espresso_version();
-        }
-        // if not displaying notices yet, then just leave
-        if (version_compare(espresso_version(), $applies_when, '<')) {
-            return;
-        }
-        do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
-        $version = $version === null
-            ? ''
-            : sprintf(
-                esc_html__('(This message was added in version %s of Event Espresso)', 'event_espresso'),
-                $version
-            );
-        $error_message = sprintf(
-            esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
-            $function,
-            '<strong>',
-            '</strong>',
-            $message,
-            $version
-        );
-        // don't trigger error if doing ajax,
-        // instead we'll add a transient EE_Error notice that in theory should show on the next request.
-        if (defined('DOING_AJAX') && DOING_AJAX) {
-            $error_message .= ' ' . esc_html__(
-                'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
-                'event_espresso'
-            );
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $error_message .= '<ul><li>';
-            $error_message .= implode('</li><li>', $request->requestParams());
-            $error_message .= '</ul>';
-            EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
-            // now we set this on the transient so it shows up on the next request.
-            EE_Error::get_notices(false, true);
-        } else {
-            trigger_error($error_message, $error_type);
-        }
-    }
-
-
-
-
-    /**
-     * Logger helpers
-     */
-    /**
-     * debug
-     *
-     * @param string $class
-     * @param string $func
-     * @param string $line
-     * @param array  $info
-     * @param bool   $display_request
-     * @param string $debug_index
-     * @param string $debug_key
-     */
-    public static function log(
-        $class = '',
-        $func = '',
-        $line = '',
-        $info = array(),
-        $display_request = false,
-        $debug_index = '',
-        $debug_key = 'EE_DEBUG_SPCO'
-    ) {
-        if (WP_DEBUG) {
-            $debug_key = $debug_key . '_' . EE_Session::instance()->id();
-            $debug_data = get_option($debug_key, array());
-            $default_data = array(
-                $class => $func . '() : ' . $line,
-            );
-            // don't serialize objects
-            $info = self::strip_objects($info);
-            $index = ! empty($debug_index) ? $debug_index : 0;
-            if (! isset($debug_data[ $index ])) {
-                $debug_data[ $index ] = array();
-            }
-            $debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
-            update_option($debug_key, $debug_data);
-        }
-    }
-
-
-
-    /**
-     * strip_objects
-     *
-     * @param array $info
-     * @return array
-     */
-    public static function strip_objects($info = array())
-    {
-        foreach ($info as $key => $value) {
-            if (is_array($value)) {
-                $info[ $key ] = self::strip_objects($value);
-            } elseif (is_object($value)) {
-                $object_class = get_class($value);
-                $info[ $object_class ] = array();
-                $info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
-                if (method_exists($value, 'ID')) {
-                    $info[ $object_class ]['ID'] = $value->ID();
-                }
-                if (method_exists($value, 'status')) {
-                    $info[ $object_class ]['status'] = $value->status();
-                } elseif (method_exists($value, 'status_ID')) {
-                    $info[ $object_class ]['status'] = $value->status_ID();
-                }
-                unset($info[ $key ]);
-            }
-        }
-        return (array) $info;
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     * @param string     $margin
-     */
-    public static function printv(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false,
-        $margin = ''
-    ) {
-        $var_name = ! $var_name ? 'string' : $var_name;
-        $var_name = ucwords(str_replace('$', '', $var_name));
-        $is_method = method_exists($var_name, $var);
-        $var_name = ucwords(str_replace('_', ' ', $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= $is_method
-            ? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
-            : EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo wp_kses($result, AllowedTags::getWithFormTags());
-    }
-
-
-    protected static function headingTag($heading_tag)
-    {
-        $heading_tag = absint($heading_tag);
-        return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
-    }
-
-    protected static function headingSpacer($heading_tag)
-    {
-        return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
-            ? self::lineBreak()
-            : '';
-    }
-
-
-    protected static function lineBreak()
-    {
-        return defined('DOING_AJAX') && DOING_AJAX ? '<br />' : "\n";
-    }
-
-
-    protected static function plainOutput()
-    {
-        return defined('EE_TESTS_DIR')
-               || (defined('DOING_AJAX') && DOING_AJAX)
-               || (
-                   isset($_SERVER['REQUEST_URI'])
-                   && strpos(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), 'wp-json') !== false
-               );
-    }
-
-
-    /**
-     * @param string $var_name
-     * @param string $heading_tag
-     * @param string $margin
-     * @param int    $line
-     * @return string
-     */
-    protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            $heading = '';
-            if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                $heading .= self::lineBreak();
-            }
-            $heading .= self::lineBreak() . "{$line}) {$var_name}";
-            return $heading;
-        }
-        $margin = "25px 0 0 {$margin}";
-        return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
-    }
-
-
-
-    /**
-     * @param string $heading_tag
-     * @return string
-     */
-    protected static function headingX($heading_tag = 'h5')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return '';
-        }
-        return '</' . $heading_tag . '>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function grey_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#999">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param string $file
-     * @param int    $line
-     * @return string
-     */
-    protected static function file_and_line($file, $line, $heading_tag)
-    {
-        if ($file === '' || $line === '') {
-            return '';
-        }
-        $file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
-        if (EEH_Debug_Tools::plainOutput()) {
-            if ($heading_tag === 'h1' || $heading_tag === 'h2') {
-                return " ({$file})";
-            }
-            return '';
-        }
-        return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
-               . $file
-               . '<br />line no: '
-               . $line
-               . '</span>';
-    }
-
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    protected static function orange_span($content = '')
-    {
-        if (EEH_Debug_Tools::plainOutput()) {
-            return $content;
-        }
-        return '<span style="color:#E76700">' . $content . '</span>';
-    }
-
-
-
-    /**
-     * @param mixed $var
-     * @return string
-     */
-    protected static function pre_span($var)
-    {
-        ob_start();
-        var_dump($var);
-        $var = ob_get_clean();
-        if (EEH_Debug_Tools::plainOutput()) {
-            return str_replace("\n", '', $var);
-        }
-        return '<pre style="background: #fff; color:#999; display: inline-block; margin: 0 1em; padding: 0;">' .
-               $var . '</pre>';
-    }
-
-
-
-    /**
-     * @param mixed      $var
-     * @param string     $var_name
-     * @param string     $file
-     * @param int|string $line
-     * @param int|string $heading_tag
-     * @param bool       $die
-     */
-    public static function printr(
-        $var,
-        $var_name = '',
-        $file = '',
-        $line = '',
-        $heading_tag = 5,
-        $die = false
-    ) {
-        // return;
-        $file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
-        $margin = is_admin() ? ' 180px' : '0';
-        if (is_string($var)) {
-            EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
-            return;
-        }
-        if (is_object($var)) {
-            $var_name = ! $var_name ? 'object' : $var_name;
-        } elseif (is_array($var)) {
-            $var_name = ! $var_name ? 'array' : $var_name;
-        } elseif (is_numeric($var)) {
-            $var_name = ! $var_name ? 'numeric' : $var_name;
-        } elseif ($var === null) {
-            $var_name = ! $var_name ? 'null' : $var_name;
-        }
-        $var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
-        $heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
-        $result = EEH_Debug_Tools::headingSpacer($heading_tag);
-        $result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
-        $result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
-            EEH_Debug_Tools::pre_span($var)
-        );
-        $result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
-        $result .= EEH_Debug_Tools::headingX($heading_tag);
-        if ($die) {
-            die($result);
-        }
-        echo wp_kses($result, AllowedTags::getWithFormTags());
-    }
-
-
-
-    /******************** deprecated ********************/
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     */
-    public function reset_times()
-    {
-        Benchmark::resetTimes();
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param null $timer_name
-     */
-    public function start_timer($timer_name = null)
-    {
-        Benchmark::startTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     */
-    public function stop_timer($timer_name = '')
-    {
-        Benchmark::stopTimer($timer_name);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
-     * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
-     * @return void
-     */
-    public function measure_memory($label, $output_now = false)
-    {
-        Benchmark::measureMemory($label, $output_now);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param int $size
-     * @return string
-     */
-    public function convert($size)
-    {
-        return Benchmark::convert($size);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param bool $output_now
-     * @return string
-     */
-    public function show_times($output_now = true)
-    {
-        return Benchmark::displayResults($output_now);
-    }
-
-
-
-    /**
-     * @deprecated 4.9.39.rc.034
-     * @param string $timer_name
-     * @param float  $total_time
-     * @return string
-     */
-    public function format_time($timer_name, $total_time)
-    {
-        return Benchmark::formatTime($timer_name, $total_time);
-    }
+	/**
+	 *    instance of the EEH_Autoloader object
+	 *
+	 * @var    $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @var array
+	 */
+	protected $_memory_usage_points = array();
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EEH_Debug_Tools
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EEH_Debug_Tools) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * private class constructor
+	 */
+	private function __construct()
+	{
+		// load Kint PHP debugging library
+		if (
+			defined('EE_LOAD_KINT')
+			&& ! class_exists('Kint')
+			&& file_exists(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php')
+		) {
+			// despite EE4 having a check for an existing copy of the Kint debugging class,
+			// if another plugin was loaded AFTER EE4 and they did NOT perform a similar check,
+			// then hilarity would ensue as PHP throws a "Cannot redeclare class Kint" error
+			// so we've moved it to our test folder so that it is not included with production releases
+			// plz use https://wordpress.org/plugins/kint-debugger/  if testing production versions of EE
+			require_once(EE_PLUGIN_DIR_PATH . 'tests/kint/Kint.class.php');
+		}
+		$plugin = basename(EE_PLUGIN_DIR_PATH);
+		add_action("activate_{$plugin}", array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('activated_plugin', array('EEH_Debug_Tools', 'ee_plugin_activation_errors'));
+		add_action('shutdown', array('EEH_Debug_Tools', 'show_db_name'));
+	}
+
+
+
+	/**
+	 *    show_db_name
+	 *
+	 * @return void
+	 */
+	public static function show_db_name()
+	{
+		if (! defined('DOING_AJAX') && (defined('EE_ERROR_EMAILS') && EE_ERROR_EMAILS)) {
+			echo '<p style="font-size:10px;font-weight:normal;color:#E76700;margin: 1em 2em; text-align: right;">DB_NAME: '
+				 . DB_NAME
+				 . '</p>';
+		}
+		if (EE_DEBUG) {
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    dump EE_Session object at bottom of page after everything else has happened
+	 *
+	 * @return void
+	 */
+	public function espresso_session_footer_dump()
+	{
+		if (
+			(defined('WP_DEBUG') && WP_DEBUG)
+			&& ! defined('DOING_AJAX')
+			&& class_exists('Kint')
+			&& function_exists('wp_get_current_user')
+			&& current_user_can('update_core')
+			&& class_exists('EE_Registry')
+		) {
+			Kint::dump(EE_Registry::instance()->SSN->id());
+			Kint::dump(EE_Registry::instance()->SSN);
+			//          Kint::dump( EE_Registry::instance()->SSN->get_session_data('cart')->get_tickets() );
+			$this->espresso_list_hooked_functions();
+			Benchmark::displayResults();
+		}
+	}
+
+
+
+	/**
+	 *    List All Hooked Functions
+	 *    to list all functions for a specific hook, add ee_list_hooks={hook-name} to URL
+	 *    http://wp.smashingmagazine.com/2009/08/18/10-useful-wordpress-hook-hacks/
+	 *
+	 * @param string $tag
+	 * @return void
+	 */
+	public function espresso_list_hooked_functions($tag = '')
+	{
+		global $wp_filter;
+		echo '<br/><br/><br/><h3>Hooked Functions</h3>';
+		if ($tag) {
+			$hook[ $tag ] = $wp_filter[ $tag ];
+			if (! is_array($hook[ $tag ])) {
+				trigger_error("Nothing found for '$tag' hook", E_USER_WARNING);
+				return;
+			}
+			echo '<h5>For Tag: ' . esc_html($tag) . '</h5>';
+		} else {
+			$hook = is_array($wp_filter) ? $wp_filter : array($wp_filter);
+			ksort($hook);
+		}
+		foreach ($hook as $tag_name => $priorities) {
+			echo "<br />&gt;&gt;&gt;&gt;&gt;\t<strong>esc_html($tag_name)</strong><br />";
+			ksort($priorities);
+			foreach ($priorities as $priority => $function) {
+				echo esc_html($priority);
+				foreach ($function as $name => $properties) {
+					$name = esc_html($name);
+					echo "\t$name<br />";
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 *    registered_filter_callbacks
+	 *
+	 * @param string $hook_name
+	 * @return array
+	 */
+	public static function registered_filter_callbacks($hook_name = '')
+	{
+		$filters = array();
+		global $wp_filter;
+		if (isset($wp_filter[ $hook_name ])) {
+			$filters[ $hook_name ] = array();
+			foreach ($wp_filter[ $hook_name ] as $priority => $callbacks) {
+				$filters[ $hook_name ][ $priority ] = array();
+				foreach ($callbacks as $callback) {
+					$filters[ $hook_name ][ $priority ][] = $callback['function'];
+				}
+			}
+		}
+		return $filters;
+	}
+
+
+
+	/**
+	 *    captures plugin activation errors for debugging
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function ee_plugin_activation_errors()
+	{
+		if (WP_DEBUG) {
+			$activation_errors = ob_get_contents();
+			if (! empty($activation_errors)) {
+				$activation_errors = date('Y-m-d H:i:s') . "\n" . $activation_errors;
+			}
+			espresso_load_required('EEH_File', EE_HELPERS . 'EEH_File.helper.php');
+			if (class_exists('EEH_File')) {
+				try {
+					EEH_File::ensure_file_exists_and_is_writable(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html'
+					);
+					EEH_File::write_to_file(
+						EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+						$activation_errors
+					);
+				} catch (EE_Error $e) {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The Event Espresso activation errors file could not be setup because: %s',
+								'event_espresso'
+							),
+							$e->getMessage()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				// old school attempt
+				file_put_contents(
+					EVENT_ESPRESSO_UPLOAD_DIR . 'logs/espresso_plugin_activation_errors.html',
+					$activation_errors
+				);
+			}
+			$activation_errors = get_option('ee_plugin_activation_errors', '') . $activation_errors;
+			update_option('ee_plugin_activation_errors', $activation_errors);
+		}
+	}
+
+
+
+	/**
+	 * This basically mimics the WordPress _doing_it_wrong() function except adds our own messaging etc.
+	 * Very useful for providing helpful messages to developers when the method of doing something has been deprecated,
+	 * or we want to make sure they use something the right way.
+	 *
+	 * @access public
+	 * @param string $function      The function that was called
+	 * @param string $message       A message explaining what has been done incorrectly
+	 * @param string $version       The version of Event Espresso where the error was added
+	 * @param string $applies_when  a version string for when you want the doing_it_wrong notice to begin appearing
+	 *                              for a deprecated function. This allows deprecation to occur during one version,
+	 *                              but not have any notices appear until a later version. This allows developers
+	 *                              extra time to update their code before notices appear.
+	 * @param int    $error_type
+	 * @uses   trigger_error()
+	 */
+	public function doing_it_wrong(
+		$function,
+		$message,
+		$version,
+		$applies_when = '',
+		$error_type = null
+	) {
+		$applies_when = ! empty($applies_when) ? $applies_when : espresso_version();
+		$error_type = $error_type !== null ? $error_type : E_USER_NOTICE;
+		// because we swapped the parameter order around for the last two params,
+		// let's verify that some third party isn't still passing an error type value for the third param
+		if (is_int($applies_when)) {
+			$error_type = $applies_when;
+			$applies_when = espresso_version();
+		}
+		// if not displaying notices yet, then just leave
+		if (version_compare(espresso_version(), $applies_when, '<')) {
+			return;
+		}
+		do_action('AHEE__EEH_Debug_Tools__doing_it_wrong_run', $function, $message, $version);
+		$version = $version === null
+			? ''
+			: sprintf(
+				esc_html__('(This message was added in version %s of Event Espresso)', 'event_espresso'),
+				$version
+			);
+		$error_message = sprintf(
+			esc_html__('%1$s was called %2$sincorrectly%3$s. %4$s %5$s', 'event_espresso'),
+			$function,
+			'<strong>',
+			'</strong>',
+			$message,
+			$version
+		);
+		// don't trigger error if doing ajax,
+		// instead we'll add a transient EE_Error notice that in theory should show on the next request.
+		if (defined('DOING_AJAX') && DOING_AJAX) {
+			$error_message .= ' ' . esc_html__(
+				'This is a doing_it_wrong message that was triggered during an ajax request.  The request params on this request were: ',
+				'event_espresso'
+			);
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$error_message .= '<ul><li>';
+			$error_message .= implode('</li><li>', $request->requestParams());
+			$error_message .= '</ul>';
+			EE_Error::add_error($error_message, 'debug::doing_it_wrong', $function, '42');
+			// now we set this on the transient so it shows up on the next request.
+			EE_Error::get_notices(false, true);
+		} else {
+			trigger_error($error_message, $error_type);
+		}
+	}
+
+
+
+
+	/**
+	 * Logger helpers
+	 */
+	/**
+	 * debug
+	 *
+	 * @param string $class
+	 * @param string $func
+	 * @param string $line
+	 * @param array  $info
+	 * @param bool   $display_request
+	 * @param string $debug_index
+	 * @param string $debug_key
+	 */
+	public static function log(
+		$class = '',
+		$func = '',
+		$line = '',
+		$info = array(),
+		$display_request = false,
+		$debug_index = '',
+		$debug_key = 'EE_DEBUG_SPCO'
+	) {
+		if (WP_DEBUG) {
+			$debug_key = $debug_key . '_' . EE_Session::instance()->id();
+			$debug_data = get_option($debug_key, array());
+			$default_data = array(
+				$class => $func . '() : ' . $line,
+			);
+			// don't serialize objects
+			$info = self::strip_objects($info);
+			$index = ! empty($debug_index) ? $debug_index : 0;
+			if (! isset($debug_data[ $index ])) {
+				$debug_data[ $index ] = array();
+			}
+			$debug_data[ $index ][ microtime() ] = array_merge($default_data, $info);
+			update_option($debug_key, $debug_data);
+		}
+	}
+
+
+
+	/**
+	 * strip_objects
+	 *
+	 * @param array $info
+	 * @return array
+	 */
+	public static function strip_objects($info = array())
+	{
+		foreach ($info as $key => $value) {
+			if (is_array($value)) {
+				$info[ $key ] = self::strip_objects($value);
+			} elseif (is_object($value)) {
+				$object_class = get_class($value);
+				$info[ $object_class ] = array();
+				$info[ $object_class ]['ID'] = method_exists($value, 'ID') ? $value->ID() : spl_object_hash($value);
+				if (method_exists($value, 'ID')) {
+					$info[ $object_class ]['ID'] = $value->ID();
+				}
+				if (method_exists($value, 'status')) {
+					$info[ $object_class ]['status'] = $value->status();
+				} elseif (method_exists($value, 'status_ID')) {
+					$info[ $object_class ]['status'] = $value->status_ID();
+				}
+				unset($info[ $key ]);
+			}
+		}
+		return (array) $info;
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 * @param string     $margin
+	 */
+	public static function printv(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false,
+		$margin = ''
+	) {
+		$var_name = ! $var_name ? 'string' : $var_name;
+		$var_name = ucwords(str_replace('$', '', $var_name));
+		$is_method = method_exists($var_name, $var);
+		$var_name = ucwords(str_replace('_', ' ', $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		$result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= $is_method
+			? EEH_Debug_Tools::grey_span('::') . EEH_Debug_Tools::orange_span($var . '()')
+			: EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span($var);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo wp_kses($result, AllowedTags::getWithFormTags());
+	}
+
+
+	protected static function headingTag($heading_tag)
+	{
+		$heading_tag = absint($heading_tag);
+		return $heading_tag > 0 && $heading_tag < 7 ? "h{$heading_tag}" : 'h5';
+	}
+
+	protected static function headingSpacer($heading_tag)
+	{
+		return EEH_Debug_Tools::plainOutput() && ($heading_tag === 'h1' || $heading_tag === 'h2')
+			? self::lineBreak()
+			: '';
+	}
+
+
+	protected static function lineBreak()
+	{
+		return defined('DOING_AJAX') && DOING_AJAX ? '<br />' : "\n";
+	}
+
+
+	protected static function plainOutput()
+	{
+		return defined('EE_TESTS_DIR')
+			   || (defined('DOING_AJAX') && DOING_AJAX)
+			   || (
+				   isset($_SERVER['REQUEST_URI'])
+				   && strpos(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), 'wp-json') !== false
+			   );
+	}
+
+
+	/**
+	 * @param string $var_name
+	 * @param string $heading_tag
+	 * @param string $margin
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function heading($var_name = '', $heading_tag = 'h5', $margin = '', $line = 0)
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			$heading = '';
+			if ($heading_tag === 'h1' || $heading_tag === 'h2') {
+				$heading .= self::lineBreak();
+			}
+			$heading .= self::lineBreak() . "{$line}) {$var_name}";
+			return $heading;
+		}
+		$margin = "25px 0 0 {$margin}";
+		return '<' . $heading_tag . ' style="color:#2EA2CC; margin:' . $margin . ';"><b>' . $var_name . '</b>';
+	}
+
+
+
+	/**
+	 * @param string $heading_tag
+	 * @return string
+	 */
+	protected static function headingX($heading_tag = 'h5')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return '';
+		}
+		return '</' . $heading_tag . '>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function grey_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#999">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $file
+	 * @param int    $line
+	 * @return string
+	 */
+	protected static function file_and_line($file, $line, $heading_tag)
+	{
+		if ($file === '' || $line === '') {
+			return '';
+		}
+		$file = str_replace(EE_PLUGIN_DIR_PATH, '/', $file);
+		if (EEH_Debug_Tools::plainOutput()) {
+			if ($heading_tag === 'h1' || $heading_tag === 'h2') {
+				return " ({$file})";
+			}
+			return '';
+		}
+		return '<br /><span style="font-size:9px;font-weight:normal;color:#666;line-height: 12px;">'
+			   . $file
+			   . '<br />line no: '
+			   . $line
+			   . '</span>';
+	}
+
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	protected static function orange_span($content = '')
+	{
+		if (EEH_Debug_Tools::plainOutput()) {
+			return $content;
+		}
+		return '<span style="color:#E76700">' . $content . '</span>';
+	}
+
+
+
+	/**
+	 * @param mixed $var
+	 * @return string
+	 */
+	protected static function pre_span($var)
+	{
+		ob_start();
+		var_dump($var);
+		$var = ob_get_clean();
+		if (EEH_Debug_Tools::plainOutput()) {
+			return str_replace("\n", '', $var);
+		}
+		return '<pre style="background: #fff; color:#999; display: inline-block; margin: 0 1em; padding: 0;">' .
+			   $var . '</pre>';
+	}
+
+
+
+	/**
+	 * @param mixed      $var
+	 * @param string     $var_name
+	 * @param string     $file
+	 * @param int|string $line
+	 * @param int|string $heading_tag
+	 * @param bool       $die
+	 */
+	public static function printr(
+		$var,
+		$var_name = '',
+		$file = '',
+		$line = '',
+		$heading_tag = 5,
+		$die = false
+	) {
+		// return;
+		$file = str_replace(rtrim(ABSPATH, '\\/'), '', $file);
+		$margin = is_admin() ? ' 180px' : '0';
+		if (is_string($var)) {
+			EEH_Debug_Tools::printv($var, $var_name, $file, $line, $heading_tag, $die, $margin);
+			return;
+		}
+		if (is_object($var)) {
+			$var_name = ! $var_name ? 'object' : $var_name;
+		} elseif (is_array($var)) {
+			$var_name = ! $var_name ? 'array' : $var_name;
+		} elseif (is_numeric($var)) {
+			$var_name = ! $var_name ? 'numeric' : $var_name;
+		} elseif ($var === null) {
+			$var_name = ! $var_name ? 'null' : $var_name;
+		}
+		$var_name = ucwords(str_replace(array('$', '_'), array('', ' '), $var_name));
+		$heading_tag = EEH_Debug_Tools::headingTag($heading_tag);
+		$result = EEH_Debug_Tools::headingSpacer($heading_tag);
+		$result .= EEH_Debug_Tools::heading($var_name, $heading_tag, $margin, $line);
+		$result .= EEH_Debug_Tools::grey_span(' : ') . EEH_Debug_Tools::orange_span(
+			EEH_Debug_Tools::pre_span($var)
+		);
+		$result .= EEH_Debug_Tools::file_and_line($file, $line, $heading_tag);
+		$result .= EEH_Debug_Tools::headingX($heading_tag);
+		if ($die) {
+			die($result);
+		}
+		echo wp_kses($result, AllowedTags::getWithFormTags());
+	}
+
+
+
+	/******************** deprecated ********************/
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 */
+	public function reset_times()
+	{
+		Benchmark::resetTimes();
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param null $timer_name
+	 */
+	public function start_timer($timer_name = null)
+	{
+		Benchmark::startTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 */
+	public function stop_timer($timer_name = '')
+	{
+		Benchmark::stopTimer($timer_name);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string  $label      The label to show for this time eg "Start of calling Some_Class::some_function"
+	 * @param boolean $output_now whether to echo now, or wait until EEH_Debug_Tools::show_times() is called
+	 * @return void
+	 */
+	public function measure_memory($label, $output_now = false)
+	{
+		Benchmark::measureMemory($label, $output_now);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param int $size
+	 * @return string
+	 */
+	public function convert($size)
+	{
+		return Benchmark::convert($size);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param bool $output_now
+	 * @return string
+	 */
+	public function show_times($output_now = true)
+	{
+		return Benchmark::displayResults($output_now);
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.39.rc.034
+	 * @param string $timer_name
+	 * @param float  $total_time
+	 * @return string
+	 */
+	public function format_time($timer_name, $total_time)
+	{
+		return Benchmark::formatTime($timer_name, $total_time);
+	}
 }
 
 
@@ -692,31 +692,31 @@ 
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp_query')) {
-    function dump_wp_query()
-    {
-        global $wp_query;
-        d($wp_query);
-    }
+	function dump_wp_query()
+	{
+		global $wp_query;
+		d($wp_query);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_wp')) {
-    function dump_wp()
-    {
-        global $wp;
-        d($wp);
-    }
+	function dump_wp()
+	{
+		global $wp;
+		d($wp);
+	}
 }
 /**
  * borrowed from Kint Debugger
  * Plugin URI: http://upthemes.com/plugins/kint-debugger/
  */
 if (class_exists('Kint') && ! function_exists('dump_post')) {
-    function dump_post()
-    {
-        global $post;
-        d($post);
-    }
+	function dump_post()
+	{
+		global $post;
+		d($post);
+	}
 }

core/interfaces/line_items/EEI_Line_Item.interface.php

Indentation +175 added lines, -175 removed lines

@@ -10,238 +10,238 @@
  */
 interface EEI_Line_Item
 {
-    /**
-     * Gets item_id
-     *
-     * @return string
-     */
-    public function ID();
+	/**
+	 * Gets item_id
+	 *
+	 * @return string
+	 */
+	public function ID();
 
-    /**
-     * generic setter
-     * @param    string $field_name
-     * @param    mixed  $field_value
-     * @param bool      $use_default
-     */
-    public function set($field_name, $field_value, $use_default = false);
+	/**
+	 * generic setter
+	 * @param    string $field_name
+	 * @param    mixed  $field_value
+	 * @param bool      $use_default
+	 */
+	public function set($field_name, $field_value, $use_default = false);
 
 
 
-    /**
-     * @return string
-     */
-    public function name();
+	/**
+	 * @return string
+	 */
+	public function name();
 
 
 
-    /**
-     * @return string
-     */
-    public function desc();
+	/**
+	 * @return string
+	 */
+	public function desc();
 
 
 
-    /**
-     * The unit price for the items of this line item
-     * @return float
-     */
-    public function unit_price();
+	/**
+	 * The unit price for the items of this line item
+	 * @return float
+	 */
+	public function unit_price();
 
 
 
-    /**
-     * Returns the number of items in this line item
-     * @return int
-     */
-    public function quantity();
+	/**
+	 * Returns the number of items in this line item
+	 * @return int
+	 */
+	public function quantity();
 
 
 
-    /**
-     * Sets quantity
-     * @param int $quantity
-     */
-    public function set_quantity($quantity);
+	/**
+	 * Sets quantity
+	 * @param int $quantity
+	 */
+	public function set_quantity($quantity);
 
 
 
-    /**
-     * Returns the total amount due for this line item
-     * (usually quantity x unit_price)
-     * @return float
-     */
-    public function total();
+	/**
+	 * Returns the total amount due for this line item
+	 * (usually quantity x unit_price)
+	 * @return float
+	 */
+	public function total();
 
 
 
-    /**
-     * Gets all teh children line items of type 'line-item'
-     * @return EEI_Line_Item[]
-     */
-    public function get_items();
+	/**
+	 * Gets all teh children line items of type 'line-item'
+	 * @return EEI_Line_Item[]
+	 */
+	public function get_items();
 
 
 
-    /**
-     * Gets the total for all the items purchased only
-     * @return float
-     */
-    public function get_items_total();
+	/**
+	 * Gets the total for all the items purchased only
+	 * @return float
+	 */
+	public function get_items_total();
 
 
 
-    /**
-     * Gets all the children line items of type 'tax'
-     * @return EEI_Line_Item[]
-     */
-    public function tax_descendants();
+	/**
+	 * Gets all the children line items of type 'tax'
+	 * @return EEI_Line_Item[]
+	 */
+	public function tax_descendants();
 
 
 
-    /**
-     * Gets the total amount of the tax sub-line items
-     * @return float
-     */
-    public function get_total_tax();
+	/**
+	 * Gets the total amount of the tax sub-line items
+	 * @return float
+	 */
+	public function get_total_tax();
 
 
 
-    /**
-     * Returns the name of the event the ticket is for
-     * @return string
-     */
-    public function ticket_event_name();
+	/**
+	 * Returns the name of the event the ticket is for
+	 * @return string
+	 */
+	public function ticket_event_name();
 
 
 
-    /**
-     * Saves this line item to the DB, and recursively saves its descendants.
-     * Also sets the transaction on this line item and all its descendants before saving
-     * @param int $txn_id if none is provided, assumes $this->TXN_ID()
-     * @return int count of items saved
-     */
-    public function save_this_and_descendants_to_txn($txn_id = null);
+	/**
+	 * Saves this line item to the DB, and recursively saves its descendants.
+	 * Also sets the transaction on this line item and all its descendants before saving
+	 * @param int $txn_id if none is provided, assumes $this->TXN_ID()
+	 * @return int count of items saved
+	 */
+	public function save_this_and_descendants_to_txn($txn_id = null);
 
 
 
-    /**
-     * Indicates whether or not taxes should apply to this line item
-     * @return boolean
-     */
-    public function is_taxable();
+	/**
+	 * Indicates whether or not taxes should apply to this line item
+	 * @return boolean
+	 */
+	public function is_taxable();
 
 
 
-    /**
-     * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
-     * @return EEI_Line_Item[]
-     */
-    public function children();
+	/**
+	 * Gets ALL the children of this line item (ie, all the parts that contribute towards this total).
+	 * @return EEI_Line_Item[]
+	 */
+	public function children();
 
 
 
-    /**
-     * Adds the line item as a child to this line item. If there is another child line
-     * item with the same LIN_code, it is overwritten by this new one
-     * @param EEI_Line_Item $line_item
-     * @param bool         $set_order
-     * @return bool true for success, false for fail
-     */
-    public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true);
+	/**
+	 * Adds the line item as a child to this line item. If there is another child line
+	 * item with the same LIN_code, it is overwritten by this new one
+	 * @param EEI_Line_Item $line_item
+	 * @param bool         $set_order
+	 * @return bool true for success, false for fail
+	 */
+	public function add_child_line_item(EEI_Line_Item $line_item, $set_order = true);
 
 
 
-    /**
-     * Gets the line item type
-     * @return string
-     */
-    public function type();
+	/**
+	 * Gets the line item type
+	 * @return string
+	 */
+	public function type();
 
 
 
-    /**
-     * Gets item_id
-     * @return string
-     */
-    public function OBJ_ID();
+	/**
+	 * Gets item_id
+	 * @return string
+	 */
+	public function OBJ_ID();
 
 
 
-    /**
-     * Gets the related item type ( like: Ticket or Event )
-     * @return string
-     */
-    public function OBJ_type();
+	/**
+	 * Gets the related item type ( like: Ticket or Event )
+	 * @return string
+	 */
+	public function OBJ_type();
 
 
 
-    /**
-     * Gets the final total on this item, taking taxes into account.
-     * Has the side-effect of setting the sub-total as it was just calculated.
-     * If this is used on a grand-total line item, also updates the transaction's
-     * TXN_total
-     * @return float
-     */
-    public function recalculate_total_including_taxes();
+	/**
+	 * Gets the final total on this item, taking taxes into account.
+	 * Has the side-effect of setting the sub-total as it was just calculated.
+	 * If this is used on a grand-total line item, also updates the transaction's
+	 * TXN_total
+	 * @return float
+	 */
+	public function recalculate_total_including_taxes();
 
-    /**
-     * Checks if this item is a percentage modifier or not
-     * @throws EE_Error
-     * @return boolean
-     */
-    public function is_percent();
-
-    /**
-     * Gets percent (between 100-.001)
-     * @return float
-     */
-    public function percent();
-
-    /**
-     * Sets total
-     * @param float $total
-     * @return boolean
-     */
-    public function set_total($total);
-
-    /**
-     * Sets unit_price
-     * @param float $unit_price
-     * @return boolean
-     */
-    public function set_unit_price($unit_price);
-
-    /**
-     * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
-     * HAS NOT been saved to the DB, removes the child line item with index $code.
-     * Also searches through the child's children for a matching line item. However, once a line item has been found
-     * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be deleted)
-     * @param string $code
-     * @param bool $stop_search_once_found
-     * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to the DB yet)
-     */
-    public function delete_child_line_item($code, $stop_search_once_found = true);
-
-    /**
-     * Forgets the cached model of the given relation Name. So the next time we request it,
-     * we will fetch it again from the database. (Handy if you know it's changed somehow).
-     * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
-     * then only remove that one object from our cached array. Otherwise, clear the entire list
-     * @param string $relationName                         one of the keys in the _model_relations array on the model. Eg 'Registration'
-     * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
-     * if you intend to use $clear_all = TRUE, or the relation only has 1 object anyways (ie, it's a BelongsToRelation)
-     * @param bool   $clear_all                            This flags clearing the entire cache relation property if this is HasMany or HABTM.
-     * @throws EE_Error
-     * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a relation from all
-     */
-    public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false);
-
-    /**
-     * Sets whether or not this model object should be allowed to be saved to the DB.
-     * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
-     * you got new information that somehow made you change your mind.
-     * @param boolean $allow_persist
-     * @return boolean
-     */
-    public function set_allow_persist($allow_persist);
+	/**
+	 * Checks if this item is a percentage modifier or not
+	 * @throws EE_Error
+	 * @return boolean
+	 */
+	public function is_percent();
+
+	/**
+	 * Gets percent (between 100-.001)
+	 * @return float
+	 */
+	public function percent();
+
+	/**
+	 * Sets total
+	 * @param float $total
+	 * @return boolean
+	 */
+	public function set_total($total);
+
+	/**
+	 * Sets unit_price
+	 * @param float $unit_price
+	 * @return boolean
+	 */
+	public function set_unit_price($unit_price);
+
+	/**
+	 * If this line item has been saved to the DB, deletes its child with LIN_code == $code. If this line
+	 * HAS NOT been saved to the DB, removes the child line item with index $code.
+	 * Also searches through the child's children for a matching line item. However, once a line item has been found
+	 * and deleted, stops searching (so if there are line items with duplicate codes, only the first one found will be deleted)
+	 * @param string $code
+	 * @param bool $stop_search_once_found
+	 * @return int count of items deleted (or simply removed from the line item's cache, if not has not been saved to the DB yet)
+	 */
+	public function delete_child_line_item($code, $stop_search_once_found = true);
+
+	/**
+	 * Forgets the cached model of the given relation Name. So the next time we request it,
+	 * we will fetch it again from the database. (Handy if you know it's changed somehow).
+	 * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
+	 * then only remove that one object from our cached array. Otherwise, clear the entire list
+	 * @param string $relationName                         one of the keys in the _model_relations array on the model. Eg 'Registration'
+	 * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
+	 * if you intend to use $clear_all = TRUE, or the relation only has 1 object anyways (ie, it's a BelongsToRelation)
+	 * @param bool   $clear_all                            This flags clearing the entire cache relation property if this is HasMany or HABTM.
+	 * @throws EE_Error
+	 * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a relation from all
+	 */
+	public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false);
+
+	/**
+	 * Sets whether or not this model object should be allowed to be saved to the DB.
+	 * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
+	 * you got new information that somehow made you change your mind.
+	 * @param boolean $allow_persist
+	 * @return boolean
+	 */
+	public function set_allow_persist($allow_persist);
 }

core/libraries/line_item_filters/EE_Single_Registration_Line_Item_Filter.class.php

Indentation +10 added lines, -10 removed lines

@@ -15,14 +15,14 @@
  */
 class EE_Single_Registration_Line_Item_Filter extends EE_Specific_Registrations_Line_Item_Filter
 {
-    /**
-     *
-     * @param EE_Registration $registration
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($registration)
-    {
-        parent::__construct([$registration]);
-    }
+	/**
+	 *
+	 * @param EE_Registration $registration
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($registration)
+	{
+		parent::__construct([$registration]);
+	}
 }

core/libraries/line_item_filters/EE_Billable_Line_Item_Filter.class.php

Indentation +47 added lines, -47 removed lines

@@ -15,53 +15,53 @@
  */
 class EE_Billable_Line_Item_Filter extends EE_Specific_Registrations_Line_Item_Filter
 {
-    /**
-     * EE_Billable_Line_Item_Filter constructor.
-     *
-     * @param EE_Registration[] $registrations
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($registrations)
-    {
-        parent::__construct($this->_remove_unbillable_registrations($registrations));
-    }
+	/**
+	 * EE_Billable_Line_Item_Filter constructor.
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($registrations)
+	{
+		parent::__construct($this->_remove_unbillable_registrations($registrations));
+	}
 
 
-    /**
-     *    _calculate_billable_ticket_quantities_from_registrations
-     * compiles a list of EE_Tickets for each event in the passed array
-     *
-     * @access protected
-     * @param EE_Registration[] $registrations
-     * @return mixed
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _remove_unbillable_registrations($registrations = array())
-    {
-        if (! empty($registrations)) {
-            // these reg statuses require payment (if event is not free)
-            $requires_payment = EEM_Registration::reg_statuses_that_allow_payment();
-            foreach ($registrations as $key => $registration) {
-                if (! $registration instanceof EE_Registration) {
-                    continue;
-                }
-                // are we billing for this registration at this moment ?
-                if (
-                    !
-                    $registration->owes_monies_and_can_pay($requires_payment) &&
-                    ! (
-                        // free registration with valid reg status
-                        $registration->final_price() == 0 &&
-                        in_array($registration->status_ID(), $requires_payment)
-                    )
-                ) {
-                    // not billable. remove it
-                    unset($registrations[ $key ]);
-                }
-            }
-        }
-        return $registrations;
-    }
+	/**
+	 *    _calculate_billable_ticket_quantities_from_registrations
+	 * compiles a list of EE_Tickets for each event in the passed array
+	 *
+	 * @access protected
+	 * @param EE_Registration[] $registrations
+	 * @return mixed
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _remove_unbillable_registrations($registrations = array())
+	{
+		if (! empty($registrations)) {
+			// these reg statuses require payment (if event is not free)
+			$requires_payment = EEM_Registration::reg_statuses_that_allow_payment();
+			foreach ($registrations as $key => $registration) {
+				if (! $registration instanceof EE_Registration) {
+					continue;
+				}
+				// are we billing for this registration at this moment ?
+				if (
+					!
+					$registration->owes_monies_and_can_pay($requires_payment) &&
+					! (
+						// free registration with valid reg status
+						$registration->final_price() == 0 &&
+						in_array($registration->status_ID(), $requires_payment)
+					)
+				) {
+					// not billable. remove it
+					unset($registrations[ $key ]);
+				}
+			}
+		}
+		return $registrations;
+	}
 }

core/libraries/line_item_filters/EE_Line_Item_Filter_Processor.class.php

Indentation +77 added lines, -77 removed lines

@@ -35,90 +35,90 @@
  */
 class EE_Line_Item_Filter_Processor
 {
-    /**
-     * @type EE_Line_Item_Filter_Collection $line_item_filters
-     */
-    protected $line_item_filters;
+	/**
+	 * @type EE_Line_Item_Filter_Collection $line_item_filters
+	 */
+	protected $line_item_filters;
 
-    /**
-     * @type EEI_Line_Item $grand_total_line_item
-     */
-    protected $grand_total_line_item;
+	/**
+	 * @type EEI_Line_Item $grand_total_line_item
+	 */
+	protected $grand_total_line_item;
 
 
-    /**
-     * EE_Line_Item_Filter_Processor constructor.
-     *
-     * @param EE_Line_Item_Filter_Collection $line_item_filters
-     * @param EEI_Line_Item                  $grand_total_line_item
-     * @throws EE_Error
-     */
-    public function __construct(EE_Line_Item_Filter_Collection $line_item_filters, EEI_Line_Item $grand_total_line_item)
-    {
-        $this->line_item_filters = $line_item_filters;
-        if ($grand_total_line_item->type() !== EEM_Line_Item::type_total) {
-            throw new EE_Error(esc_html__('A Line Item of the type total is required', 'event_espresso'));
-        }
-        $this->grand_total_line_item = $this->clone_and_reset_line_item_tree($grand_total_line_item);
-    }
+	/**
+	 * EE_Line_Item_Filter_Processor constructor.
+	 *
+	 * @param EE_Line_Item_Filter_Collection $line_item_filters
+	 * @param EEI_Line_Item                  $grand_total_line_item
+	 * @throws EE_Error
+	 */
+	public function __construct(EE_Line_Item_Filter_Collection $line_item_filters, EEI_Line_Item $grand_total_line_item)
+	{
+		$this->line_item_filters = $line_item_filters;
+		if ($grand_total_line_item->type() !== EEM_Line_Item::type_total) {
+			throw new EE_Error(esc_html__('A Line Item of the type total is required', 'event_espresso'));
+		}
+		$this->grand_total_line_item = $this->clone_and_reset_line_item_tree($grand_total_line_item);
+	}
 
 
-    /**
-     * clone_and_reset_line_item_tree
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     * @throws EE_Error
-     */
-    protected function clone_and_reset_line_item_tree(EEI_Line_Item $line_item)
-    {
-        $cloned_line_item = $this->clone_and_reset_line_item($line_item);
-        foreach ($line_item->children() as $child_line_item) {
-            $cloned_line_item->add_child_line_item($this->clone_and_reset_line_item_tree($child_line_item));
-        }
-        return $cloned_line_item;
-    }
+	/**
+	 * clone_and_reset_line_item_tree
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 * @throws EE_Error
+	 */
+	protected function clone_and_reset_line_item_tree(EEI_Line_Item $line_item)
+	{
+		$cloned_line_item = $this->clone_and_reset_line_item($line_item);
+		foreach ($line_item->children() as $child_line_item) {
+			$cloned_line_item->add_child_line_item($this->clone_and_reset_line_item_tree($child_line_item));
+		}
+		return $cloned_line_item;
+	}
 
 
-    /**
-     * clone_and_reset_line_item
-     *
-     * clones the incoming object
-     * resets any fields that represent database primary keys
-     * resets total
-     *
-     * @param EEI_Line_Item $line_item
-     * @return EEI_Line_Item
-     * @throws EE_Error
-     */
-    protected function clone_and_reset_line_item(EEI_Line_Item $line_item)
-    {
-        // we don't actually want to work with the original line item, so clone it
-        $cloned_line_item = clone $line_item;
-        $cloned_line_item->set('LIN_ID', null);
-        $cloned_line_item->set('LIN_parent', null);
-        $cloned_line_item->clear_related_line_item_cache();
-        foreach (array_keys(EEM_Line_Item::instance()->relation_settings()) as $relation_name) {
-            $cloned_line_item->clear_cache($relation_name, null, true);
-        }
-        $cloned_line_item->set_allow_persist(false);
-        return $cloned_line_item;
-    }
+	/**
+	 * clone_and_reset_line_item
+	 *
+	 * clones the incoming object
+	 * resets any fields that represent database primary keys
+	 * resets total
+	 *
+	 * @param EEI_Line_Item $line_item
+	 * @return EEI_Line_Item
+	 * @throws EE_Error
+	 */
+	protected function clone_and_reset_line_item(EEI_Line_Item $line_item)
+	{
+		// we don't actually want to work with the original line item, so clone it
+		$cloned_line_item = clone $line_item;
+		$cloned_line_item->set('LIN_ID', null);
+		$cloned_line_item->set('LIN_parent', null);
+		$cloned_line_item->clear_related_line_item_cache();
+		foreach (array_keys(EEM_Line_Item::instance()->relation_settings()) as $relation_name) {
+			$cloned_line_item->clear_cache($relation_name, null, true);
+		}
+		$cloned_line_item->set_allow_persist(false);
+		return $cloned_line_item;
+	}
 
 
-    /**
-     * process
-     *
-     * @return EEI_Line_Item
-     */
-    public function process()
-    {
-        $this->line_item_filters->rewind();
-        while ($this->line_item_filters->valid()) {
-            $this->grand_total_line_item = $this->line_item_filters->current()->process($this->grand_total_line_item);
-            $this->line_item_filters->next();
-        }
-        $this->grand_total_line_item->recalculate_total_including_taxes();
-        return $this->grand_total_line_item;
-    }
+	/**
+	 * process
+	 *
+	 * @return EEI_Line_Item
+	 */
+	public function process()
+	{
+		$this->line_item_filters->rewind();
+		while ($this->line_item_filters->valid()) {
+			$this->grand_total_line_item = $this->line_item_filters->current()->process($this->grand_total_line_item);
+			$this->line_item_filters->next();
+		}
+		$this->grand_total_line_item->recalculate_total_including_taxes();
+		return $this->grand_total_line_item;
+	}
 }

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

Indentation +2827 added lines, -2827 removed lines

@@ -20,2831 +20,2831 @@
  */
 class EE_SPCO_Reg_Step_Payment_Options extends EE_SPCO_Reg_Step
 {
-    /**
-     * @var EE_Line_Item_Display $Line_Item_Display
-     */
-    protected $line_item_display;
-
-    /**
-     * @var boolean $handle_IPN_in_this_request
-     */
-    protected $handle_IPN_in_this_request = false;
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        add_filter(
-            'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters']
-        );
-        add_action(
-            'wp_ajax_switch_spco_billing_form',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
-        );
-        add_action(
-            'wp_ajax_nopriv_switch_spco_billing_form',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
-        );
-        add_action('wp_ajax_save_payer_details', ['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']);
-        add_action(
-            'wp_ajax_nopriv_save_payer_details',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']
-        );
-        add_action(
-            'wp_ajax_get_transaction_details_for_gateways',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
-        );
-        add_action(
-            'wp_ajax_nopriv_get_transaction_details_for_gateways',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
-        );
-        add_filter(
-            'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
-            ['EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'],
-            10,
-            1
-        );
-    }
-
-
-    /**
-     *    ajax switch_spco_billing_form
-     *
-     */
-    public static function switch_spco_billing_form()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
-    }
-
-
-    /**
-     *    ajax save_payer_details
-     *
-     */
-    public static function save_payer_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
-    }
-
-
-    /**
-     *    ajax get_transaction_details
-     *
-     */
-    public static function get_transaction_details()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
-    }
-
-
-    /**
-     * bypass_recaptcha_for_load_payment_method
-     *
-     * @access public
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function bypass_recaptcha_for_load_payment_method()
-    {
-        return [
-            'EESID'  => EE_Registry::instance()->SSN->id(),
-            'step'   => 'payment_options',
-            'action' => 'spco_billing_form',
-        ];
-    }
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->request   = EED_Single_Page_Checkout::getRequest();
-        $this->_slug     = 'payment_options';
-        $this->_name     = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
-        $this->checkout  = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__(
-                'Please select a method of payment and provide any necessary billing information before proceeding.',
-                'event_espresso'
-            )
-        );
-    }
-
-
-    /**
-     * @return null
-     */
-    public function line_item_display()
-    {
-        return $this->line_item_display;
-    }
-
-
-    /**
-     * @param null $line_item_display
-     */
-    public function set_line_item_display($line_item_display)
-    {
-        $this->line_item_display = $line_item_display;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function handle_IPN_in_this_request()
-    {
-        return $this->handle_IPN_in_this_request;
-    }
-
-
-    /**
-     * @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);
-    }
-
-
-    /**
-     * translate_js_strings
-     *
-     * @return void
-     */
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
-            'Please select a method of payment in order to continue.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
-            'A valid method of payment could not be determined. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
-            'Forwarding to Secure Payment Provider.',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * enqueue_styles_and_scripts
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    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)) {
-            return;
-        }
-        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) {
-                    $billing_form->enqueue_js();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * initialize_reg_step
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function initialize_reg_step()
-    {
-        // TODO: if /when we implement donations, then this will need overriding
-        if (
-            // don't need payment options for:
-            // registrations made via the admin
-            // completed transactions
-            // overpaid transactions
-            // $ 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([$this, $this->checkout->action])
-            && ! $this->completed()
-        ) {
-            // and if so, then we no longer need the Payment Options step
-            if ($this->is_current_step()) {
-                $this->checkout->generate_reg_form = false;
-            }
-            $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');
-        // get all active payment methods
-        $this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
-            $this->checkout->transaction,
-            EEM_Payment_Method::scope_cart
-        );
-        return true;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    public function generate_reg_form()
-    {
-        // reset in case someone changes their mind
-        $this->_reset_selected_method_of_payment();
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'payments_closed';
-        $registrations_requiring_payment            = [];
-        $registrations_for_free_events              = [];
-        $registrations_requiring_pre_approval       = [];
-        $sold_out_events                            = [];
-        $insufficient_spaces_available              = [];
-        $no_payment_required                        = true;
-        // loop thru registrations to gather info
-        $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
-        );
-        $extra_txn_fees_handler = new ExtraTxnFeesForRegistrantsHandler($registrations);
-        $extra_txn_fees_handler->applyExtraFeesToRegistrants();
-        foreach ($registrations as $REG_ID => $registration) {
-            /** @var $registration EE_Registration */
-            // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
-                if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
-                } else {
-                    $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 (
-                $this->checkout->revisit
-                && $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;
-            }
-            // are they allowed to pay now and is there monies owing?
-            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(),
-                    $this
-                );
-            } elseif (
-                ! $this->checkout->revisit
-                      && $registration->status_ID() !== EEM_Registration::status_id_not_approved
-                      && $registration->ticket()->is_free()
-            ) {
-                $registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
-            }
-        }
-        $subsections = [];
-        // now decide which template to load
-        if (! empty($sold_out_events)) {
-            $subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
-        }
-        if (! empty($insufficient_spaces_available)) {
-            $subsections['insufficient_space'] = $this->_insufficient_spaces_available(
-                $insufficient_spaces_available
-            );
-        }
-        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_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(
-                    apply_filters(
-                        'FHEE__SPCO__EE_Line_Item_Filter_Collection',
-                        new EE_Line_Item_Filter_Collection()
-                    ),
-                    $this->checkout->cart->get_grand_total()
-                );
-                /** @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'));
-                $subsections['payment_options'] = $this->_display_payment_options(
-                    $this->line_item_display->display_line_item(
-                        $filtered_line_item_tree,
-                        ['registrations' => $registrations]
-                    )
-                );
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
-                $this->_apply_registration_payments_to_amount_owing($registrations);
-            }
-            $no_payment_required = false;
-        } else {
-            $this->_hide_reg_step_submit_button_if_revisit();
-        }
-        $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);
-
-        return new EE_Form_Section_Proper(
-            [
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => new EE_No_Layout(),
-            ]
-        );
-    }
-
-
-    /**
-     * add line item filters required for this reg step
-     * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
-     *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
-     *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
-     *        payment options reg step, can apply these filters via the following: apply_filters(
-     *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
-     *        filter collection by passing that instead of instantiating a new collection
-     *
-     * @param EE_Line_Item_Filter_Collection $line_item_filter_collection
-     * @return EE_Line_Item_Filter_Collection
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    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
-            || ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout
-            || ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction
-        ) {
-            return $line_item_filter_collection;
-        }
-        $line_item_filter_collection->add(
-            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
-                    )
-                )
-            )
-        );
-        $line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
-        return $line_item_filter_collection;
-    }
-
-
-    /**
-     * remove_ejected_registrations
-     * if a registrant has lost their potential space at an event due to lack of payment,
-     * then this method removes them from the list of registrations being paid for during this request
-     *
-     * @param EE_Registration[] $registrations
-     * @return EE_Registration[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    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) {
-            // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
-                unset($registrations[ $REG_ID ]);
-            }
-        }
-        return $registrations;
-    }
-
-
-    /**
-     * find_registrations_that_lost_their_space
-     * If a registrant chooses an offline payment method like Invoice,
-     * then no space is reserved for them at the event until they fully pay fo that site
-     * (unless the event's default reg status is set to APPROVED)
-     * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
-     * then this method will determine which registrations have lost the ability to complete the reg process.
-     *
-     * @param EE_Registration[] $registrations
-     * @param bool              $revisit
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
-    {
-        // registrations per event
-        $event_reg_count = [];
-        // spaces left per event
-        $event_spaces_remaining = [];
-        // tickets left sorted by ID
-        $tickets_remaining = [];
-        // registrations that have lost their space
-        $ejected_registrations = [];
-        foreach ($registrations as $REG_ID => $registration) {
-            if (
-                $registration->status_ID() === EEM_Registration::status_id_approved
-                || apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
-                    false,
-                    $registration,
-                    $revisit
-                )
-            ) {
-                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();
-                }
-            }
-            if (
-                $revisit
-                && ($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) {
-                    /** @type EE_Registration_Processor $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,
-                        EEM_Registration::status_id_wait_list
-                    );
-                }
-            }
-        }
-        return $ejected_registrations;
-    }
-
-
-    /**
-     * _hide_reg_step_submit_button
-     * removes the html for the reg step submit button
-     * by replacing it with an empty string via filter callback
-     *
-     * @return void
-     */
-    protected function _adjust_registration_status_if_event_old_sold()
-    {
-    }
-
-
-    /**
-     * _hide_reg_step_submit_button
-     * removes the html for the reg step submit button
-     * by replacing it with an empty string via filter callback
-     *
-     * @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');
-        }
-    }
-
-
-    /**
-     * sold_out_events
-     * displays notices regarding events that have sold out since hte registrant first signed up
-     *
-     * @param EE_Event[] $sold_out_events_array
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    private function _sold_out_events($sold_out_events_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) {
-            $sold_out_events .= EEH_HTML::li(
-                EEH_HTML::span(
-                    '  ' . $sold_out_event->name(),
-                    '',
-                    'dashicons dashicons-marker ee-icon-size-16 pink-text'
-                )
-            );
-        }
-        return new EE_Form_Section_Proper(
-            [
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . '/sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            [
-                                'sold_out_events'     => $sold_out_events,
-                                'sold_out_events_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
-                                    sprintf(
-                                        esc_html__(
-                                            '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 />'
-                                    )
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * _insufficient_spaces_available
-     * displays notices regarding events that do not have enough remaining spaces
-     * to satisfy the current number of registrations looking to pay
-     *
-     * @param EE_Event[] $insufficient_spaces_events_array
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _insufficient_spaces_available($insufficient_spaces_events_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) {
-                $insufficient_space_events .= EEH_HTML::li(
-                    EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
-                );
-            }
-        }
-        return new EE_Form_Section_Proper(
-            [
-                'subsections'     => [
-                    'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
-                    'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
-                ],
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . '/sold_out_events.template.php',
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
-                            [
-                                'sold_out_events'     => $insufficient_space_events,
-                                'sold_out_events_msg' => apply_filters(
-                                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
-                                    esc_html__(
-                                        'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
-                                        'event_espresso'
-                                    )
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * registrations_requiring_pre_approval
-     *
-     * @param array $registrations_requiring_pre_approval
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws ReflectionException
-     */
-    private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = [])
-    {
-        $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(
-                    EEH_HTML::span(
-                        '',
-                        '',
-                        'dashicons dashicons-marker ee-icon-size-16 orange-text'
-                    )
-                    . EEH_HTML::span($registration->event()->name(), '', 'orange-text')
-                );
-            }
-        }
-        return new EE_Form_Section_Proper(
-            [
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . '/events_requiring_pre_approval.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
-                            [
-                                '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',
-                                    esc_html__(
-                                        'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
-                                        'event_espresso'
-                                    )
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * _no_payment_required
-     *
-     * @param EE_Event[] $registrations_for_free_events
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     */
-    private function _no_payment_required($registrations_for_free_events = [])
-    {
-        // set some defaults
-        $this->checkout->selected_method_of_payment = 'no_payment_required';
-        // generate no_payment_required form
-        return new EE_Form_Section_Proper(
-            [
-                'layout_strategy' => new EE_Template_Layout(
-                    [
-                        'layout_template_file' => SPCO_REG_STEPS_PATH
-                                                  . $this->_slug
-                                                  . '/no_payment_required.template.php', // layout_template
-                        'template_args'        => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
-                            [
-                                'revisit'                       => $this->checkout->revisit,
-                                'registrations'                 => [],
-                                'ticket_count'                  => [],
-                                'registrations_for_free_events' => $registrations_for_free_events,
-                                'no_payment_required_msg'       => EEH_HTML::p(
-                                    esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
-                                ),
-                            ]
-                        ),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * _display_payment_options
-     *
-     * @param string $transaction_details
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
-            new EE_Form_Section_Proper(
-                [
-                    'subsections'     => [
-                        'before_payment_options' => apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
-                            new EE_Form_Section_Proper(
-                                ['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(
-                                ['layout_strategy' => new EE_Div_Per_Section_Layout()]
-                            )
-                        ),
-                    ],
-                    'layout_strategy' => new EE_Template_Layout(
-                        [
-                            'layout_template_file' => $this->_template,
-                            'template_args'        => apply_filters(
-                                'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
-                                [
-                                    'reg_count'                 => $this->line_item_display->total_items(),
-                                    'transaction_details'       => $transaction_details,
-                                    'available_payment_methods' => [],
-                                ]
-                            ),
-                        ]
-                    ),
-                ]
-            )
-        );
-    }
-
-
-    /**
-     * _extra_hidden_inputs
-     *
-     * @param bool $no_payment_required
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _extra_hidden_inputs($no_payment_required = true)
-    {
-        return new EE_Form_Section_Proper(
-            [
-                'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => [
-                    'spco_no_payment_required' => new EE_Hidden_Input(
-                        [
-                            'normalization_strategy' => new EE_Boolean_Normalization(),
-                            'html_name'              => 'spco_no_payment_required',
-                            'html_id'                => 'spco-no-payment-required-payment_options',
-                            'default'                => $no_payment_required,
-                        ]
-                    ),
-                    'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
-                        [
-                            'normalization_strategy' => new EE_Int_Normalization(),
-                            'html_name'              => 'spco_transaction_id',
-                            'html_id'                => 'spco-transaction-id',
-                            'default'                => $this->checkout->transaction->ID(),
-                        ]
-                    ),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     *    _apply_registration_payments_to_amount_owing
-     *
-     * @param array $registrations
-     * @throws EE_Error|ReflectionException
-     */
-    protected function _apply_registration_payments_to_amount_owing(array $registrations)
-    {
-        $payments = [];
-        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) {
-                    $this->checkout->amount_owing -= $payment->amount();
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    _reset_selected_method_of_payment
-     *
-     * @access    private
-     * @param bool $force_reset
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _reset_selected_method_of_payment($force_reset = false)
-    {
-        /** @var RequestInterface $request */
-        $request              = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $reset_payment_method = $request->getRequestParam('reset_payment_method', $force_reset, 'bool');
-        if ($reset_payment_method) {
-            $this->checkout->selected_method_of_payment = null;
-            $this->checkout->payment_method             = null;
-            $this->checkout->billing_form               = null;
-            $this->_save_selected_method_of_payment();
-        }
-    }
-
-
-    /**
-     * _save_selected_method_of_payment
-     * stores the selected_method_of_payment in the session
-     * so that it's available for all subsequent requests including AJAX
-     *
-     * @access        private
-     * @param string $selected_method_of_payment
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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(
-            ['selected_method_of_payment' => $selected_method_of_payment]
-        );
-    }
-
-
-    /**
-     * _setup_payment_options
-     *
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function _setup_payment_options()
-    {
-        // load payment method classes
-        $this->checkout->available_payment_methods = $this->_get_available_payment_methods();
-        if (empty($this->checkout->available_payment_methods)) {
-            EE_Error::add_error(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
-                    sprintf(
-                        esc_html__(
-                            'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
-                            'event_espresso'
-                        ),
-                        '<br>',
-                        EE_Registry::instance()->CFG->organization->get_pretty('email')
-                    )
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // switch up header depending on number of available payment methods
-        $payment_method_header     = count($this->checkout->available_payment_methods) > 1
-            ? apply_filters(
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
-                esc_html__('Please Select Your Method of Payment', 'event_espresso')
-            )
-            : apply_filters(
-                'FHEE__registration_page_payment_options__method_of_payment_hdr',
-                esc_html__('Method of Payment', 'event_espresso')
-            );
-        $available_payment_methods = [
-            // display the "Payment Method" header
-            'payment_method_header' => new EE_Form_Section_HTML(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__payment_method_header',
-                    EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr'),
-                    $payment_method_header
-                )
-            ),
-        ];
-        // the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
-        $available_payment_method_options = [];
-        $default_payment_method_option    = [];
-        // additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
-        $payment_methods_billing_info = [
-            new EE_Form_Section_HTML(
-                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) {
-                $payment_method_button = EEH_HTML::img(
-                    $payment_method->button_url(),
-                    $payment_method->name(),
-                    '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->_save_selected_method_of_payment();
-                    $default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
-                } else {
-                    $available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
-                }
-                $payment_methods_billing_info[ $payment_method->slug() . '-info' ] =
-                    $this->_payment_method_billing_info(
-                        $payment_method
-                    );
-            }
-        }
-        // prepend available_payment_method_options with default_payment_method_option so that it appears first in list
-        // of PMs
-        $available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
-        // now generate the actual form  inputs
-        $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
-            $available_payment_method_options
-        );
-        $available_payment_methods                              += $payment_methods_billing_info;
-        // build the available payment methods form
-        return new EE_Form_Section_Proper(
-            [
-                'html_id'         => 'spco-available-methods-of-payment-dv',
-                'subsections'     => $available_payment_methods,
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-            ]
-        );
-    }
-
-
-    /**
-     * _get_available_payment_methods
-     *
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _get_available_payment_methods()
-    {
-        if (! empty($this->checkout->available_payment_methods)) {
-            return $this->checkout->available_payment_methods;
-        }
-        $available_payment_methods = [];
-        $EEM_Payment_Method        = EEM_Payment_Method::instance();
-        // get all active payment methods
-        $payment_methods = $EEM_Payment_Method->get_all_for_transaction(
-            $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;
-            }
-        }
-        return $available_payment_methods;
-    }
-
-
-    /**
-     *    _available_payment_method_inputs
-     *
-     * @access    private
-     * @param array $available_payment_method_options
-     * @return    EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    private function _available_payment_method_inputs($available_payment_method_options = [])
-    {
-        // generate inputs
-        return new EE_Form_Section_Proper(
-            [
-                'html_id'         => 'ee-available-payment-method-inputs',
-                'layout_strategy' => new EE_Div_Per_Section_Layout(),
-                'subsections'     => [
-                    '' => new EE_Radio_Button_Input(
-                        $available_payment_method_options,
-                        [
-                            'html_name'          => 'selected_method_of_payment',
-                            'html_class'         => 'spco-payment-method',
-                            'default'            => $this->checkout->selected_method_of_payment,
-                            'label_size'         => 11,
-                            'enforce_label_size' => true,
-                        ]
-                    ),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     *    _payment_method_billing_info
-     *
-     * @access    private
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _payment_method_billing_info(EE_Payment_Method $payment_method)
-    {
-        $currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug();
-        // generate the billing form for payment method
-        $billing_form                 = $currently_selected
-            ? $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(
-            esc_html__('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()) {
-            $payment_method_info = $payment_method->description();
-        } elseif ($billing_form instanceof EE_Billing_Info_Form) {
-            $payment_method_info = sprintf(
-                esc_html__(
-                    'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
-                    'event_espresso'
-                ),
-                $this->submit_button_text()
-            );
-        } else {
-            $payment_method_info = sprintf(
-                esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
-                $this->submit_button_text()
-            );
-        }
-        $info_html .= EEH_HTML::div(
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
-                $payment_method_info
-            ),
-            '',
-            'spco-payment-method-desc ee-attention'
-        );
-        return new EE_Form_Section_Proper(
-            [
-                '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'     => [
-                    'info'         => new EE_Form_Section_HTML($info_html),
-                    'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * get_billing_form_html_for_payment_method
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
-        if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
-            return false;
-        }
-        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',
-                    sprintf(
-                        esc_html__(
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                            'event_espresso'
-                        ),
-                        $this->checkout->payment_method->name()
-                    )
-                )
-            );
-        }
-        // now generate billing form for selected method of payment
-        $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
-            && $this->checkout->transaction_has_primary_registrant()
-        ) {
-            $payment_method_billing_form->populate_from_attendee(
-                $this->checkout->transaction->primary_registration()->attendee()
-            );
-        }
-        // and debug content
-        if (
-            $payment_method_billing_form instanceof EE_Billing_Info_Form
-            && $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
-                );
-        }
-        $billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
-            ? $payment_method_billing_form->get_html()
-            : '';
-        $this->checkout->json_response->set_return_data(['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());
-        return true;
-    }
-
-
-    /**
-     * _get_billing_form_for_payment_method
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Billing_Info_Form|EE_Form_Section_HTML
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
-    {
-        $billing_form = $payment_method->type_obj()->billing_form(
-            $this->checkout->transaction,
-            ['amount_owing' => $this->checkout->amount_owing]
-        );
-        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
-                )
-                && $this->request->requestParamIsSet('payment_method')
-            ) {
-                EE_Error::add_success(
-                    apply_filters(
-                        'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
-                        sprintf(
-                            esc_html__(
-                                'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                                'event_espresso'
-                            ),
-                            $payment_method->name()
-                        )
-                    )
-                );
-            }
-            return apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
-                $billing_form,
-                $payment_method
-            );
-        }
-        // no actual billing form, so return empty HTML form section
-        return new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * _get_selected_method_of_payment
-     *
-     * @param boolean $required whether to throw an error if the "selected_method_of_payment"
-     *                          is not found in the incoming request
-     * @param string  $request_param
-     * @return NULL|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_selected_method_of_payment(
-        $required = false,
-        $request_param = 'selected_method_of_payment'
-    ) {
-        // is selected_method_of_payment set in the request ?
-        $selected_method_of_payment = $this->request->getRequestParam($request_param);
-        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;
-            $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);
-        } else {
-            // or is is set in the session ?
-            $selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
-                'selected_method_of_payment'
-            );
-        }
-        // do ya really really gotta have it?
-        if (empty($selected_method_of_payment) && $required) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $selected_method_of_payment;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /***********************************  SWITCH PAYMENT METHOD  ************************************/
-    /********************************************************************************************************/
-    /**
-     * switch_payment_method
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function switch_payment_method()
-    {
-        if (! $this->_verify_payment_method_is_set()) {
-            return false;
-        }
-        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',
-                    sprintf(
-                        esc_html__(
-                            'You have selected "%s" as your method of payment. Please note the important payment information below.',
-                            'event_espresso'
-                        ),
-                        $this->checkout->payment_method->name()
-                    )
-                )
-            );
-        }
-        // 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()) {
-            $this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
-                $this->checkout->payment_method
-            );
-        }
-        // fill form with attendee info if applicable
-        if (
-            apply_filters(
-                'FHEE__populate_billing_form_fields_from_attendee',
-                (
-                $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
-                && $this->checkout->transaction_has_primary_registrant()
-                ),
-                $this->checkout->billing_form,
-                $this->checkout->transaction
-            )
-        ) {
-            $this->checkout->billing_form->populate_from_attendee(
-                $this->checkout->transaction->primary_registration()->attendee()
-            );
-        }
-        // 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->billing_form =
-                $this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
-                    $this->checkout->billing_form
-                );
-        }
-        // get html and validation rules for form
-        if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->json_response->set_return_data(
-                ['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());
-        } else {
-            $this->checkout->json_response->set_return_data(['payment_method_info' => '']);
-        }
-        // prevents advancement to next step
-        $this->checkout->continue_reg = false;
-        return true;
-    }
-
-
-    /**
-     * _verify_payment_method_is_set
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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)) {
-            // how have they chosen to pay?
-            $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) {
-                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',
-                            esc_html__(
-                                '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__
-                    );
-                    return false;
-                case 'payments_closed':
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
-                            esc_html__(
-                                '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__
-                    );
-                    return false;
-                case 'no_payment_required':
-                    EE_Error::add_attention(
-                        apply_filters(
-                            'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
-                            esc_html__(
-                                '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__
-                    );
-                    return false;
-                default:
-            }
-        }
-        // verify 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();
-        }
-        return $this->checkout->payment_method instanceof EE_Payment_Method;
-    }
-
-
-
-    /********************************************************************************************************/
-    /***************************************  SAVE PAYER DETAILS  ****************************************/
-    /********************************************************************************************************/
-    /**
-     * save_payer_details_via_ajax
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function save_payer_details_via_ajax()
-    {
-        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()) {
-            $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()) {
-            $attendee = $this->_create_attendee_from_request_data();
-            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);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * create_attendee_from_request_data
-     * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
-     *
-     * @return EE_Attendee
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _create_attendee_from_request_data()
-    {
-        // get State ID
-        $STA_ID = $this->request->getRequestParam('state');
-        if (! empty($STA_ID)) {
-            // can we get state object from name ?
-            EE_Registry::instance()->load_model('State');
-            $state  = EEM_State::instance()->get_col([['STA_name' => $STA_ID], 'limit' => 1], 'STA_ID');
-            $STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
-        }
-        // get Country ISO
-        $CNT_ISO = $this->request->getRequestParam('country');
-        if (! empty($CNT_ISO)) {
-            // can we get country object from name ?
-            EE_Registry::instance()->load_model('Country');
-            $country = EEM_Country::instance()->get_col(
-                [['CNT_name' => $CNT_ISO], 'limit' => 1],
-                'CNT_ISO'
-            );
-            $CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
-        }
-        // grab attendee data
-        $attendee_data = [
-            'ATT_fname'    => $this->request->getRequestParam('first_name'),
-            'ATT_lname'    => $this->request->getRequestParam('last_name'),
-            'ATT_email'    => $this->request->getRequestParam('email'),
-            'ATT_address'  => $this->request->getRequestParam('address'),
-            'ATT_address2' => $this->request->getRequestParam('address2'),
-            'ATT_city'     => $this->request->getRequestParam('city'),
-            'STA_ID'       => $STA_ID,
-            'CNT_ISO'      => $CNT_ISO,
-            'ATT_zip'      => $this->request->getRequestParam('zip'),
-            'ATT_phone'    => $this->request->getRequestParam('phone'),
-        ];
-        // validate the email address since it is the most important piece of info
-        if (empty($attendee_data['ATT_email'])) {
-            EE_Error::add_error(
-                esc_html__('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'])
-        ) {
-            $existing_attendee = EEM_Attendee::instance()->find_existing_attendee(
-                [
-                    'ATT_fname' => $attendee_data['ATT_fname'],
-                    'ATT_lname' => $attendee_data['ATT_lname'],
-                    'ATT_email' => $attendee_data['ATT_email'],
-                ]
-            );
-            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']
-            : $attendee_data['ATT_email'];
-        $attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
-            ? $attendee_data['ATT_lname']
-            : $attendee_data['ATT_email'];
-        return EE_Attendee::new_instance($attendee_data);
-    }
-
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  *****************************************/
-    /********************************************************************************************************/
-    /**
-     * process_reg_step
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    public function process_reg_step()
-    {
-        // 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);
-        // choose your own adventure based on 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);
-                // mark this reg step as completed
-                $this->set_completed();
-                return false;
-
-            case 'payments_closed':
-                if (
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
-                        false
-                    )
-                ) {
-                    EE_Error::add_success(
-                        esc_html__('no payment required at this time.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-                // mark this reg step as completed
-                $this->set_completed();
-                return true;
-
-            case 'no_payment_required':
-                if (
-                    apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
-                        false
-                    )
-                ) {
-                    EE_Error::add_success(
-                        esc_html__('no payment required.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-                // mark this reg step as completed
-                $this->set_completed();
-                return true;
-
-            default:
-                $registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
-                    EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
-                );
-                $ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
-                    $registrations,
-                    EE_Registry::instance()->SSN->checkout()->revisit
-                );
-                // calculate difference between the two arrays
-                $registrations = array_diff($registrations, $ejected_registrations);
-                if (empty($registrations)) {
-                    $this->_redirect_because_event_sold_out();
-                    return false;
-                }
-                $payment = $this->_process_payment();
-                if ($payment instanceof EE_Payment) {
-                    $this->checkout->continue_reg = true;
-                    $this->_maybe_set_completed($payment);
-                } else {
-                    $this->checkout->continue_reg = false;
-                }
-                return $payment instanceof EE_Payment;
-        }
-    }
-
-
-    /**
-     * _redirect_because_event_sold_out
-     *
-     * @return void
-     */
-    protected function _redirect_because_event_sold_out()
-    {
-        $this->checkout->continue_reg = false;
-        // set redirect URL
-        $this->checkout->redirect_url = add_query_arg(
-            ['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);
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @return void
-     * @throws EE_Error
-     */
-    protected function _maybe_set_completed(EE_Payment $payment)
-    {
-        // Do we need to redirect them? If so, there's more work to be done.
-        if (! $payment->redirect_url()) {
-            $this->set_completed();
-        }
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to retry a payment
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws EntityNotFoundException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidStatusException
-     */
-    public function update_reg_step()
-    {
-        $success = true;
-        // if payment required
-        if ($this->checkout->transaction->total() > 0) {
-            do_action(
-                'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
-                $this->checkout->transaction
-            );
-            // attempt payment via payment method
-            $success = $this->process_reg_step();
-        }
-        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(
-                ['e_reg_url_link' => $this->checkout->reg_url_link],
-                $this->checkout->thank_you_page_url
-            );
-        }
-        return $success;
-    }
-
-
-    /**
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _process_payment()
-    {
-        // basically confirm that the event hasn't sold out since they hit the page
-        if (! $this->_last_second_ticket_verifications()) {
-            return null;
-        }
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $this->checkout->json_response->set_plz_select_method_of_payment(
-                esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
-            );
-            return null;
-        }
-        // get EE_Payment_Method object
-        if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
-            return null;
-        }
-        // setup 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
-            );
-            // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
-                return null;
-            }
-        }
-        // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
-            return null;
-        }
-        // if session is close to expiring (under 10 minutes by default)
-        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();
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        // $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
-        // 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);
-        // process results
-        $payment = $this->_validate_payment($payment);
-        $payment = $this->_post_payment_processing($payment);
-        // verify 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
-            $this->checkout->transaction->toggle_failed_transaction_status();
-            $payment_status = $payment->status();
-            if (
-                $payment_status === EEM_Payment::status_id_approved
-                || $payment_status === EEM_Payment::status_id_pending
-            ) {
-                return $payment;
-            }
-            return null;
-        }
-        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;
-            return $payment;
-        }
-        // where's my money?
-        return null;
-    }
-
-
-    /**
-     * _last_second_ticket_verifications
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _last_second_ticket_verifications()
-    {
-        // don't bother re-validating if not a return visit
-        if (! $this->checkout->revisit) {
-            return true;
-        }
-        $registrations = $this->checkout->transaction->registrations();
-        if (empty($registrations)) {
-            return false;
-        }
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
-                $event = $registration->event_obj();
-                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(
-                                esc_html__(
-                                    '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()
-                            )
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * redirect_form
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function redirect_form()
-    {
-        $payment_method_billing_info = $this->_payment_method_billing_info(
-            $this->_get_payment_method_for_selected_method_of_payment()
-        );
-        $html                        = $payment_method_billing_info->get_html();
-        $html                        .= $this->checkout->redirect_form;
-        /** @var ResponseInterface $response */
-        $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
-        $response->addOutput($html);
-        return true;
-    }
-
-
-    /**
-     * _billing_form_is_valid
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    private function _billing_form_is_valid()
-    {
-        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()) {
-                $this->checkout->billing_form->receive_form_submission();
-                if ($this->checkout->billing_form->is_valid()) {
-                    return true;
-                }
-                $validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
-                $error_strings     = [];
-                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) {
-                            $label = $form_section->html_label_text();
-                        } elseif ($form_section instanceof EE_Form_Section_Base) {
-                            $label = $form_section->name();
-                        } else {
-                            $label = esc_html__('Validation Error', 'event_espresso');
-                        }
-                        $error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
-                    }
-                }
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
-                            'event_espresso'
-                        ),
-                        '<br/>',
-                        implode('<br/>', $error_strings)
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'The billing form was not submitted or something prevented it\'s submission.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'The submitted billing form is invalid possibly due to a technical reason.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * _setup_primary_registrant_prior_to_payment
-     * ensures that the primary registrant has a valid attendee object created with the critical details populated
-     * (first & last name & email) and that both the transaction object and primary registration object have been saved
-     * plz note that any other registrations will NOT be saved at this point (because they may not have any details
-     * yet)
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _setup_primary_registrant_prior_to_payment()
-    {
-        // check if transaction has a primary registrant and that it has a related Attendee object
-        // if not, then we need to at least gather some primary registrant data before attempting payment
-        if (
-            $this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
-            && ! $this->checkout->transaction_has_primary_registrant()
-            && ! $this->_capture_primary_registration_data_from_billing_form()
-        ) {
-            return false;
-        }
-        // because saving an object clears it's cache, we need to do the chevy shuffle
-        // grab the primary_registration object
-        $primary_registration = $this->checkout->transaction->primary_registration();
-        // at this point we'll consider a TXN to not have been failed
-        $this->checkout->transaction->toggle_failed_transaction_status();
-        // 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());
-        // save what we have so far
-        $primary_registration->save();
-        return true;
-    }
-
-
-    /**
-     * _capture_primary_registration_data_from_billing_form
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The billing form details could not be used for attendee details 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 false;
-        }
-        $primary_registration = $this->checkout->transaction->primary_registration();
-        if (! $primary_registration instanceof EE_Registration) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The primary registrant for this transaction 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 false;
-        }
-        if (
-            ! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
-              instanceof
-              EE_Attendee
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The primary registrant could not be associated with this transaction 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 false;
-        }
-        /** @type EE_Registration_Processor $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);
-        return true;
-    }
-
-
-    /**
-     * _get_payment_method_for_selected_method_of_payment
-     * retrieves a valid payment method
-     *
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_payment_method_for_selected_method_of_payment()
-    {
-        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 ];
-        } else {
-            // load EEM_Payment_Method
-            EE_Registry::instance()->load_model('Payment_Method');
-            $EEM_Payment_Method = EEM_Payment_Method::instance();
-            $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) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The selected method of payment 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;
-        }
-        // and verify it has a valid Payment_Method Type object
-        if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        '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;
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     *    _attempt_payment
-     *
-     * @access    private
-     * @type    EE_Payment_Method $payment_method
-     * @return mixed EE_Payment | boolean
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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) {
-            return false;
-        }
-        try {
-            $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),
-                'CART',
-                $this->checkout->admin_request,
-                true,
-                $this->reg_step_url()
-            );
-        } catch (Exception $e) {
-            $this->_handle_payment_processor_exception($e);
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _handle_payment_processor_exception
-     *
-     * @param Exception $e
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _handle_payment_processor_exception(Exception $e)
-    {
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email'),
-                $e->getMessage(),
-                $e->getFile(),
-                $e->getLine()
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * _get_return_url
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_return_url(EE_Payment_Method $payment_method)
-    {
-        $return_url = '';
-        switch ($payment_method->type_obj()->payment_occurs()) {
-            case EE_PMT_Base::offsite:
-                $return_url = add_query_arg(
-                    [
-                        'action'                     => 'process_gateway_response',
-                        'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-                        'spco_txn'                   => $this->checkout->transaction->ID(),
-                    ],
-                    $this->reg_step_url()
-                );
-                break;
-            case EE_PMT_Base::onsite:
-            case EE_PMT_Base::offline:
-                $return_url = $this->checkout->next_step->reg_step_url();
-                break;
-        }
-        return $return_url;
-    }
-
-
-    /**
-     * _validate_payment
-     *
-     * @param EE_Payment $payment
-     * @return EE_Payment|FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _validate_payment($payment = null)
-    {
-        if ($this->checkout->payment_method->is_off_line()) {
-            return true;
-        }
-        // verify payment object
-        if (! $payment instanceof EE_Payment) {
-            // not a payment
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _post_payment_processing
-     *
-     * @param EE_Payment|bool $payment
-     * @return bool|EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _post_payment_processing($payment = null)
-    {
-        // Off-Line payment?
-        if ($payment === true) {
-            return true;
-        }
-        if ($payment instanceof EE_Payment) {
-            // Should the user be redirected?
-            if ($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');
-                // set JSON response
-                $this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
-                // and lastly, let's bump the payment status to pending
-                $payment->set_status(EEM_Payment::status_id_pending);
-                $payment->save();
-            } elseif (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
-                // User shouldn't be redirected. So let's process it here.
-                // $this->_setup_redirect_for_next_step();
-                $this->checkout->continue_reg = false;
-            }
-            return $payment;
-        }
-        // ummm ya... not Off-Line, not On-Site, not off-Site ????
-        $this->checkout->continue_reg = false;
-        return false;
-    }
-
-
-    /**
-     *    _process_payment_status
-     *
-     * @type    EE_Payment $payment
-     * @param string       $payment_occurs
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
-    {
-        // off-line payment? carry on
-        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()');
-            $msg = $payment->gateway_response();
-            // check results
-            switch ($payment->status()) {
-                // good payment
-                case EEM_Payment::status_id_approved:
-                    EE_Error::add_success(
-                        esc_html__('Your payment was processed successfully.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return true;
-                // slow payment
-                case EEM_Payment::status_id_pending:
-                    if (empty($msg)) {
-                        $msg = esc_html__(
-                            '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__);
-                    return true;
-                // don't wanna payment
-                case EEM_Payment::status_id_cancelled:
-                    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),
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                // not enough payment
-                case EEM_Payment::status_id_declined:
-                    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),
-                            'event_espresso'
-                        );
-                    }
-                    EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-                    return false;
-                // bad payment
-                case EEM_Payment::status_id_failed:
-                    if (! empty($msg)) {
-                        EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                        return false;
-                    }
-                    // default to error below
-                    break;
-            }
-        }
-        // 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) {
-            return true;
-        }
-        EE_Error::add_error(
-            sprintf(
-                esc_html__(
-                    'Your payment could not be processed successfully 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 false;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /**********************************  PROCESS GATEWAY RESPONSE  **********************************/
-    /********************************************************************************************************/
-    /**
-     * process_gateway_response
-     * this is the return point for Off-Site Payment Methods
-     * It will attempt to "handle the IPN" if it appears that this has not already occurred,
-     * otherwise, it will load up the last payment made for the TXN.
-     * If the payment retrieved looks good, it will then either:
-     *    complete the current step and allow advancement to the next reg step
-     *        or present the payment options again
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_gateway_response()
-    {
-        // how have they chosen to pay?
-        $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()) {
-            $this->checkout->continue_reg = false;
-            return false;
-        }
-        if (! $this->checkout->payment_method->is_off_site()) {
-            return false;
-        }
-        $this->_validate_offsite_return();
-        // verify TXN
-        if ($this->checkout->transaction instanceof EE_Transaction) {
-            $gateway = $this->checkout->payment_method->type_obj()->get_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);
-            // if payment was not declined by the payment gateway or cancelled by the registrant
-            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 (! $this->handle_IPN_in_this_request()) {
-                    $this->set_completed();
-                }
-                return true;
-            }
-        }
-        // DEBUG LOG
-        // $this->checkout->log(
-        //     __CLASS__,
-        //     __FUNCTION__,
-        //     __LINE__,
-        //     array('payment' => $payment)
-        // );
-        $this->checkout->continue_reg = false;
-        return false;
-    }
-
-
-    /**
-     * _validate_return
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _validate_offsite_return()
-    {
-        $TXN_ID = $this->request->getRequestParam('spco_txn', 0, 'int');
-        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);
-            $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) {
-                // verify that the current cart has tickets
-                $tickets = $cart->get_tickets();
-                if (empty($tickets)) {
-                    $invalid_TXN = true;
-                }
-            } else {
-                $invalid_TXN = true;
-            }
-            $valid_TXN_SID = $primary_registrant instanceof EE_Registration
-                ? $primary_registrant->session_ID()
-                : null;
-            // validate current Session ID and compare against valid TXN session ID
-            if (
-                $invalid_TXN // if this is already true, then skip other checks
-                || EE_Session::instance()->id() === null
-                || (
-                    // 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
-                    // and whether this reg step has even been started ?
-                    EE_Session::instance()->id() === $valid_TXN_SID
-                    // really? you're half way through this reg step, but you never started it ?
-                    && $this->checkout->transaction->reg_step_completed($this->slug()) === false
-                )
-            ) {
-                $invalid_TXN = true;
-            }
-            if ($invalid_TXN) {
-                // is the valid TXN completed ?
-                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) {
-                        // 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);
-                        return;
-                    }
-                }
-                // you appear to be lost?
-                $this->_redirect_wayward_request($primary_registrant);
-            }
-        }
-    }
-
-
-    /**
-     * _redirect_wayward_request
-     *
-     * @param EE_Registration|null $primary_registrant
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    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) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
-                        'event_espresso'
-                    ),
-                    '<br/>',
-                    EE_Registry::instance()->CFG->organization->get_pretty('email')
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-        // make sure transaction is not locked
-        $this->checkout->transaction->unlock();
-        wp_safe_redirect(
-            add_query_arg(
-                [
-                    'e_reg_url_link' => $primary_registrant->reg_url_link(),
-                ],
-                $this->checkout->thank_you_page_url
-            )
-        );
-        exit();
-    }
-
-
-    /**
-     * _process_off_site_payment
-     *
-     * @param EE_Offsite_Gateway $gateway
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
-    {
-        try {
-            $request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $request_data = $request->requestParams();
-            // 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)
-            );
-            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           = $payment_processor->process_ipn(
-                    $request_data,
-                    $this->checkout->transaction,
-                    $this->checkout->payment_method,
-                    true,
-                    false
-                );
-                // $payment_source = 'process_ipn';
-            } else {
-                $payment = $this->checkout->transaction->last_payment();
-                // $payment_source = 'last_payment';
-            }
-        } 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) {
-                // then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
-                $this->_handle_payment_processor_exception($e);
-            }
-        }
-        return $payment;
-    }
-
-
-    /**
-     * _process_cancelled_payments
-     * just makes sure that the payment status gets updated correctly
-     * so tha tan error isn't generated during payment validation
-     *
-     * @param EE_Payment $payment
-     * @return EE_Payment|null
-     * @throws EE_Error
-     */
-    private function _process_cancelled_payments($payment = null)
-    {
-        if (
-            $payment instanceof EE_Payment
-            && $this->request->requestParamIsSet('ee_cancel_payment')
-            && $payment->status() === EEM_Payment::status_id_failed
-        ) {
-            $payment->set_status(EEM_Payment::status_id_cancelled);
-        }
-        return $payment;
-    }
-
-
-    /**
-     *    get_transaction_details_for_gateways
-     *
-     * @access    public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_transaction_details_for_gateways()
-    {
-        $txn_details = [];
-        // ya gotta make a choice man
-        if (empty($this->checkout->selected_method_of_payment)) {
-            $txn_details = [
-                'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
-            ];
-        }
-        // get EE_Payment_Method object
-        if (
-            empty($txn_details)
-            && ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
-        ) {
-            $txn_details = [
-                'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
-                'error'                      => esc_html__(
-                    'A valid Payment Method could not be determined.',
-                    'event_espresso'
-                ),
-            ];
-        }
-        if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
-            $return_url  = $this->_get_return_url($this->checkout->payment_method);
-            $txn_details = [
-                'TXN_ID'         => $this->checkout->transaction->ID(),
-                'TXN_timestamp'  => $this->checkout->transaction->datetime(),
-                'TXN_total'      => $this->checkout->transaction->total(),
-                'TXN_paid'       => $this->checkout->transaction->paid(),
-                'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
-                'STS_ID'         => $this->checkout->transaction->status_ID(),
-                'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
-                'payment_amount' => $this->checkout->amount_owing,
-                'return_url'     => $return_url,
-                'cancel_url'     => add_query_arg(['ee_cancel_payment' => true], $return_url),
-                'notify_url'     => EE_Config::instance()->core->txn_page_url(
-                    [
-                        'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
-                        'ee_payment_method' => $this->checkout->payment_method->slug(),
-                    ]
-                ),
-            ];
-        }
-        echo wp_json_encode($txn_details);
-        exit();
-    }
-
-
-    /**
-     *    __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)), ['reg_form', 'checkout', 'line_item_display']);
-    }
+	/**
+	 * @var EE_Line_Item_Display $Line_Item_Display
+	 */
+	protected $line_item_display;
+
+	/**
+	 * @var boolean $handle_IPN_in_this_request
+	 */
+	protected $handle_IPN_in_this_request = false;
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		add_filter(
+			'FHEE__SPCO__EE_Line_Item_Filter_Collection',
+			['EE_SPCO_Reg_Step_Payment_Options', 'add_spco_line_item_filters']
+		);
+		add_action(
+			'wp_ajax_switch_spco_billing_form',
+			['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
+		);
+		add_action(
+			'wp_ajax_nopriv_switch_spco_billing_form',
+			['EE_SPCO_Reg_Step_Payment_Options', 'switch_spco_billing_form']
+		);
+		add_action('wp_ajax_save_payer_details', ['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']);
+		add_action(
+			'wp_ajax_nopriv_save_payer_details',
+			['EE_SPCO_Reg_Step_Payment_Options', 'save_payer_details']
+		);
+		add_action(
+			'wp_ajax_get_transaction_details_for_gateways',
+			['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
+		);
+		add_action(
+			'wp_ajax_nopriv_get_transaction_details_for_gateways',
+			['EE_SPCO_Reg_Step_Payment_Options', 'get_transaction_details']
+		);
+		add_filter(
+			'FHEE__EED_Recaptcha___bypass_recaptcha__bypass_request_params_array',
+			['EE_SPCO_Reg_Step_Payment_Options', 'bypass_recaptcha_for_load_payment_method'],
+			10,
+			1
+		);
+	}
+
+
+	/**
+	 *    ajax switch_spco_billing_form
+	 *
+	 */
+	public static function switch_spco_billing_form()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('switch_payment_method');
+	}
+
+
+	/**
+	 *    ajax save_payer_details
+	 *
+	 */
+	public static function save_payer_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('save_payer_details_via_ajax');
+	}
+
+
+	/**
+	 *    ajax get_transaction_details
+	 *
+	 */
+	public static function get_transaction_details()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('get_transaction_details_for_gateways');
+	}
+
+
+	/**
+	 * bypass_recaptcha_for_load_payment_method
+	 *
+	 * @access public
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function bypass_recaptcha_for_load_payment_method()
+	{
+		return [
+			'EESID'  => EE_Registry::instance()->SSN->id(),
+			'step'   => 'payment_options',
+			'action' => 'spco_billing_form',
+		];
+	}
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->request   = EED_Single_Page_Checkout::getRequest();
+		$this->_slug     = 'payment_options';
+		$this->_name     = esc_html__('Payment Options', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
+		$this->checkout  = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__(
+				'Please select a method of payment and provide any necessary billing information before proceeding.',
+				'event_espresso'
+			)
+		);
+	}
+
+
+	/**
+	 * @return null
+	 */
+	public function line_item_display()
+	{
+		return $this->line_item_display;
+	}
+
+
+	/**
+	 * @param null $line_item_display
+	 */
+	public function set_line_item_display($line_item_display)
+	{
+		$this->line_item_display = $line_item_display;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function handle_IPN_in_this_request()
+	{
+		return $this->handle_IPN_in_this_request;
+	}
+
+
+	/**
+	 * @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);
+	}
+
+
+	/**
+	 * translate_js_strings
+	 *
+	 * @return void
+	 */
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
+			'Please select a method of payment in order to continue.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
+			'A valid method of payment could not be determined. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
+			'Forwarding to Secure Payment Provider.',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * enqueue_styles_and_scripts
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	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)) {
+			return;
+		}
+		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) {
+					$billing_form->enqueue_js();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * initialize_reg_step
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function initialize_reg_step()
+	{
+		// TODO: if /when we implement donations, then this will need overriding
+		if (
+			// don't need payment options for:
+			// registrations made via the admin
+			// completed transactions
+			// overpaid transactions
+			// $ 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([$this, $this->checkout->action])
+			&& ! $this->completed()
+		) {
+			// and if so, then we no longer need the Payment Options step
+			if ($this->is_current_step()) {
+				$this->checkout->generate_reg_form = false;
+			}
+			$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');
+		// get all active payment methods
+		$this->checkout->available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
+			$this->checkout->transaction,
+			EEM_Payment_Method::scope_cart
+		);
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	public function generate_reg_form()
+	{
+		// reset in case someone changes their mind
+		$this->_reset_selected_method_of_payment();
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'payments_closed';
+		$registrations_requiring_payment            = [];
+		$registrations_for_free_events              = [];
+		$registrations_requiring_pre_approval       = [];
+		$sold_out_events                            = [];
+		$insufficient_spaces_available              = [];
+		$no_payment_required                        = true;
+		// loop thru registrations to gather info
+		$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
+		);
+		$extra_txn_fees_handler = new ExtraTxnFeesForRegistrantsHandler($registrations);
+		$extra_txn_fees_handler->applyExtraFeesToRegistrants();
+		foreach ($registrations as $REG_ID => $registration) {
+			/** @var $registration EE_Registration */
+			// has this registration lost it's space ?
+			if (isset($ejected_registrations[ $REG_ID ])) {
+				if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
+					$sold_out_events[ $registration->event()->ID() ] = $registration->event();
+				} else {
+					$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 (
+				$this->checkout->revisit
+				&& $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;
+			}
+			// are they allowed to pay now and is there monies owing?
+			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(),
+					$this
+				);
+			} elseif (
+				! $this->checkout->revisit
+					  && $registration->status_ID() !== EEM_Registration::status_id_not_approved
+					  && $registration->ticket()->is_free()
+			) {
+				$registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
+			}
+		}
+		$subsections = [];
+		// now decide which template to load
+		if (! empty($sold_out_events)) {
+			$subsections['sold_out_events'] = $this->_sold_out_events($sold_out_events);
+		}
+		if (! empty($insufficient_spaces_available)) {
+			$subsections['insufficient_space'] = $this->_insufficient_spaces_available(
+				$insufficient_spaces_available
+			);
+		}
+		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_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(
+					apply_filters(
+						'FHEE__SPCO__EE_Line_Item_Filter_Collection',
+						new EE_Line_Item_Filter_Collection()
+					),
+					$this->checkout->cart->get_grand_total()
+				);
+				/** @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'));
+				$subsections['payment_options'] = $this->_display_payment_options(
+					$this->line_item_display->display_line_item(
+						$filtered_line_item_tree,
+						['registrations' => $registrations]
+					)
+				);
+				$this->checkout->amount_owing   = $filtered_line_item_tree->total();
+				$this->_apply_registration_payments_to_amount_owing($registrations);
+			}
+			$no_payment_required = false;
+		} else {
+			$this->_hide_reg_step_submit_button_if_revisit();
+		}
+		$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);
+
+		return new EE_Form_Section_Proper(
+			[
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => new EE_No_Layout(),
+			]
+		);
+	}
+
+
+	/**
+	 * add line item filters required for this reg step
+	 * these filters are applied via this line in EE_SPCO_Reg_Step_Payment_Options::set_hooks():
+	 *        add_filter( 'FHEE__SPCO__EE_Line_Item_Filter_Collection', array( 'EE_SPCO_Reg_Step_Payment_Options',
+	 *        'add_spco_line_item_filters' ) ); so any code that wants to use the same set of filters during the
+	 *        payment options reg step, can apply these filters via the following: apply_filters(
+	 *        'FHEE__SPCO__EE_Line_Item_Filter_Collection', new EE_Line_Item_Filter_Collection() ) or to an existing
+	 *        filter collection by passing that instead of instantiating a new collection
+	 *
+	 * @param EE_Line_Item_Filter_Collection $line_item_filter_collection
+	 * @return EE_Line_Item_Filter_Collection
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	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
+			|| ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout
+			|| ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction
+		) {
+			return $line_item_filter_collection;
+		}
+		$line_item_filter_collection->add(
+			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
+					)
+				)
+			)
+		);
+		$line_item_filter_collection->add(new EE_Non_Zero_Line_Item_Filter());
+		return $line_item_filter_collection;
+	}
+
+
+	/**
+	 * remove_ejected_registrations
+	 * if a registrant has lost their potential space at an event due to lack of payment,
+	 * then this method removes them from the list of registrations being paid for during this request
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @return EE_Registration[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	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) {
+			// has this registration lost it's space ?
+			if (isset($ejected_registrations[ $REG_ID ])) {
+				unset($registrations[ $REG_ID ]);
+			}
+		}
+		return $registrations;
+	}
+
+
+	/**
+	 * find_registrations_that_lost_their_space
+	 * If a registrant chooses an offline payment method like Invoice,
+	 * then no space is reserved for them at the event until they fully pay fo that site
+	 * (unless the event's default reg status is set to APPROVED)
+	 * if a registrant then later returns to pay, but the number of spaces available has been reduced due to sales,
+	 * then this method will determine which registrations have lost the ability to complete the reg process.
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @param bool              $revisit
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	public static function find_registrations_that_lost_their_space(array $registrations, $revisit = false)
+	{
+		// registrations per event
+		$event_reg_count = [];
+		// spaces left per event
+		$event_spaces_remaining = [];
+		// tickets left sorted by ID
+		$tickets_remaining = [];
+		// registrations that have lost their space
+		$ejected_registrations = [];
+		foreach ($registrations as $REG_ID => $registration) {
+			if (
+				$registration->status_ID() === EEM_Registration::status_id_approved
+				|| apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options__find_registrations_that_lost_their_space__allow_reg_payment',
+					false,
+					$registration,
+					$revisit
+				)
+			) {
+				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();
+				}
+			}
+			if (
+				$revisit
+				&& ($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) {
+					/** @type EE_Registration_Processor $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,
+						EEM_Registration::status_id_wait_list
+					);
+				}
+			}
+		}
+		return $ejected_registrations;
+	}
+
+
+	/**
+	 * _hide_reg_step_submit_button
+	 * removes the html for the reg step submit button
+	 * by replacing it with an empty string via filter callback
+	 *
+	 * @return void
+	 */
+	protected function _adjust_registration_status_if_event_old_sold()
+	{
+	}
+
+
+	/**
+	 * _hide_reg_step_submit_button
+	 * removes the html for the reg step submit button
+	 * by replacing it with an empty string via filter callback
+	 *
+	 * @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');
+		}
+	}
+
+
+	/**
+	 * sold_out_events
+	 * displays notices regarding events that have sold out since hte registrant first signed up
+	 *
+	 * @param EE_Event[] $sold_out_events_array
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	private function _sold_out_events($sold_out_events_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) {
+			$sold_out_events .= EEH_HTML::li(
+				EEH_HTML::span(
+					'  ' . $sold_out_event->name(),
+					'',
+					'dashicons dashicons-marker ee-icon-size-16 pink-text'
+				)
+			);
+		}
+		return new EE_Form_Section_Proper(
+			[
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . '/sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							[
+								'sold_out_events'     => $sold_out_events,
+								'sold_out_events_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__sold_out_events_msg',
+									sprintf(
+										esc_html__(
+											'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 />'
+									)
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * _insufficient_spaces_available
+	 * displays notices regarding events that do not have enough remaining spaces
+	 * to satisfy the current number of registrations looking to pay
+	 *
+	 * @param EE_Event[] $insufficient_spaces_events_array
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _insufficient_spaces_available($insufficient_spaces_events_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) {
+				$insufficient_space_events .= EEH_HTML::li(
+					EEH_HTML::span(' ' . $event->name(), '', 'dashicons dashicons-marker ee-icon-size-16 pink-text')
+				);
+			}
+		}
+		return new EE_Form_Section_Proper(
+			[
+				'subsections'     => [
+					'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
+					'extra_hidden_inputs'   => $this->_extra_hidden_inputs(),
+				],
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . '/sold_out_events.template.php',
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__template_args',
+							[
+								'sold_out_events'     => $insufficient_space_events,
+								'sold_out_events_msg' => apply_filters(
+									'FHEE__EE_SPCO_Reg_Step_Payment_Options___insufficient_spaces_available__insufficient_space_msg',
+									esc_html__(
+										'It appears that the event you were about to make a payment for has sold additional tickets since you first registered, and there are no longer enough spaces left to accommodate your selections. You may continue to pay and secure the available space(s) remaining, or simply cancel if you no longer wish to purchase. If you have already made a partial payment towards this event, please contact the event administrator for a refund.',
+										'event_espresso'
+									)
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * registrations_requiring_pre_approval
+	 *
+	 * @param array $registrations_requiring_pre_approval
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws ReflectionException
+	 */
+	private function _registrations_requiring_pre_approval($registrations_requiring_pre_approval = [])
+	{
+		$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(
+					EEH_HTML::span(
+						'',
+						'',
+						'dashicons dashicons-marker ee-icon-size-16 orange-text'
+					)
+					. EEH_HTML::span($registration->event()->name(), '', 'orange-text')
+				);
+			}
+		}
+		return new EE_Form_Section_Proper(
+			[
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . '/events_requiring_pre_approval.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___sold_out_events__template_args',
+							[
+								'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',
+									esc_html__(
+										'The following events do not require payment at this time and will not be billed during this transaction. Billing will only occur after the attendee has been approved by the event organizer. You will be notified when your registration has been processed. If this is a free event, then no billing will occur.',
+										'event_espresso'
+									)
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * _no_payment_required
+	 *
+	 * @param EE_Event[] $registrations_for_free_events
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 */
+	private function _no_payment_required($registrations_for_free_events = [])
+	{
+		// set some defaults
+		$this->checkout->selected_method_of_payment = 'no_payment_required';
+		// generate no_payment_required form
+		return new EE_Form_Section_Proper(
+			[
+				'layout_strategy' => new EE_Template_Layout(
+					[
+						'layout_template_file' => SPCO_REG_STEPS_PATH
+												  . $this->_slug
+												  . '/no_payment_required.template.php', // layout_template
+						'template_args'        => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___no_payment_required__template_args',
+							[
+								'revisit'                       => $this->checkout->revisit,
+								'registrations'                 => [],
+								'ticket_count'                  => [],
+								'registrations_for_free_events' => $registrations_for_free_events,
+								'no_payment_required_msg'       => EEH_HTML::p(
+									esc_html__('This is a free event, so no billing will occur.', 'event_espresso')
+								),
+							]
+						),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * _display_payment_options
+	 *
+	 * @param string $transaction_details
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__payment_options_form',
+			new EE_Form_Section_Proper(
+				[
+					'subsections'     => [
+						'before_payment_options' => apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__before_payment_options',
+							new EE_Form_Section_Proper(
+								['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(
+								['layout_strategy' => new EE_Div_Per_Section_Layout()]
+							)
+						),
+					],
+					'layout_strategy' => new EE_Template_Layout(
+						[
+							'layout_template_file' => $this->_template,
+							'template_args'        => apply_filters(
+								'FHEE__EE_SPCO_Reg_Step_Payment_Options___display_payment_options__template_args',
+								[
+									'reg_count'                 => $this->line_item_display->total_items(),
+									'transaction_details'       => $transaction_details,
+									'available_payment_methods' => [],
+								]
+							),
+						]
+					),
+				]
+			)
+		);
+	}
+
+
+	/**
+	 * _extra_hidden_inputs
+	 *
+	 * @param bool $no_payment_required
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _extra_hidden_inputs($no_payment_required = true)
+	{
+		return new EE_Form_Section_Proper(
+			[
+				'html_id'         => 'ee-' . $this->slug() . '-extra-hidden-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => [
+					'spco_no_payment_required' => new EE_Hidden_Input(
+						[
+							'normalization_strategy' => new EE_Boolean_Normalization(),
+							'html_name'              => 'spco_no_payment_required',
+							'html_id'                => 'spco-no-payment-required-payment_options',
+							'default'                => $no_payment_required,
+						]
+					),
+					'spco_transaction_id'      => new EE_Fixed_Hidden_Input(
+						[
+							'normalization_strategy' => new EE_Int_Normalization(),
+							'html_name'              => 'spco_transaction_id',
+							'html_id'                => 'spco-transaction-id',
+							'default'                => $this->checkout->transaction->ID(),
+						]
+					),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 *    _apply_registration_payments_to_amount_owing
+	 *
+	 * @param array $registrations
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function _apply_registration_payments_to_amount_owing(array $registrations)
+	{
+		$payments = [];
+		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) {
+					$this->checkout->amount_owing -= $payment->amount();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    _reset_selected_method_of_payment
+	 *
+	 * @access    private
+	 * @param bool $force_reset
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _reset_selected_method_of_payment($force_reset = false)
+	{
+		/** @var RequestInterface $request */
+		$request              = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$reset_payment_method = $request->getRequestParam('reset_payment_method', $force_reset, 'bool');
+		if ($reset_payment_method) {
+			$this->checkout->selected_method_of_payment = null;
+			$this->checkout->payment_method             = null;
+			$this->checkout->billing_form               = null;
+			$this->_save_selected_method_of_payment();
+		}
+	}
+
+
+	/**
+	 * _save_selected_method_of_payment
+	 * stores the selected_method_of_payment in the session
+	 * so that it's available for all subsequent requests including AJAX
+	 *
+	 * @access        private
+	 * @param string $selected_method_of_payment
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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(
+			['selected_method_of_payment' => $selected_method_of_payment]
+		);
+	}
+
+
+	/**
+	 * _setup_payment_options
+	 *
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function _setup_payment_options()
+	{
+		// load payment method classes
+		$this->checkout->available_payment_methods = $this->_get_available_payment_methods();
+		if (empty($this->checkout->available_payment_methods)) {
+			EE_Error::add_error(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__error_message_no_payment_methods',
+					sprintf(
+						esc_html__(
+							'Sorry, you cannot complete your purchase because a payment method is not active.%1$s Please contact %2$s for assistance and provide a description of the problem.',
+							'event_espresso'
+						),
+						'<br>',
+						EE_Registry::instance()->CFG->organization->get_pretty('email')
+					)
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// switch up header depending on number of available payment methods
+		$payment_method_header     = count($this->checkout->available_payment_methods) > 1
+			? apply_filters(
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
+				esc_html__('Please Select Your Method of Payment', 'event_espresso')
+			)
+			: apply_filters(
+				'FHEE__registration_page_payment_options__method_of_payment_hdr',
+				esc_html__('Method of Payment', 'event_espresso')
+			);
+		$available_payment_methods = [
+			// display the "Payment Method" header
+			'payment_method_header' => new EE_Form_Section_HTML(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Payment_Options___setup_payment_options__payment_method_header',
+					EEH_HTML::h4($payment_method_header, 'method-of-payment-hdr'),
+					$payment_method_header
+				)
+			),
+		];
+		// the list of actual payment methods ( invoice, paypal, etc ) in a  ( slug => HTML )  format
+		$available_payment_method_options = [];
+		$default_payment_method_option    = [];
+		// additional instructions to be displayed and hidden below payment methods (adding a clearing div to start)
+		$payment_methods_billing_info = [
+			new EE_Form_Section_HTML(
+				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) {
+				$payment_method_button = EEH_HTML::img(
+					$payment_method->button_url(),
+					$payment_method->name(),
+					'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->_save_selected_method_of_payment();
+					$default_payment_method_option[ $payment_method->slug() ] = $payment_method_button;
+				} else {
+					$available_payment_method_options[ $payment_method->slug() ] = $payment_method_button;
+				}
+				$payment_methods_billing_info[ $payment_method->slug() . '-info' ] =
+					$this->_payment_method_billing_info(
+						$payment_method
+					);
+			}
+		}
+		// prepend available_payment_method_options with default_payment_method_option so that it appears first in list
+		// of PMs
+		$available_payment_method_options = $default_payment_method_option + $available_payment_method_options;
+		// now generate the actual form  inputs
+		$available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
+			$available_payment_method_options
+		);
+		$available_payment_methods                              += $payment_methods_billing_info;
+		// build the available payment methods form
+		return new EE_Form_Section_Proper(
+			[
+				'html_id'         => 'spco-available-methods-of-payment-dv',
+				'subsections'     => $available_payment_methods,
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+			]
+		);
+	}
+
+
+	/**
+	 * _get_available_payment_methods
+	 *
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _get_available_payment_methods()
+	{
+		if (! empty($this->checkout->available_payment_methods)) {
+			return $this->checkout->available_payment_methods;
+		}
+		$available_payment_methods = [];
+		$EEM_Payment_Method        = EEM_Payment_Method::instance();
+		// get all active payment methods
+		$payment_methods = $EEM_Payment_Method->get_all_for_transaction(
+			$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;
+			}
+		}
+		return $available_payment_methods;
+	}
+
+
+	/**
+	 *    _available_payment_method_inputs
+	 *
+	 * @access    private
+	 * @param array $available_payment_method_options
+	 * @return    EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	private function _available_payment_method_inputs($available_payment_method_options = [])
+	{
+		// generate inputs
+		return new EE_Form_Section_Proper(
+			[
+				'html_id'         => 'ee-available-payment-method-inputs',
+				'layout_strategy' => new EE_Div_Per_Section_Layout(),
+				'subsections'     => [
+					'' => new EE_Radio_Button_Input(
+						$available_payment_method_options,
+						[
+							'html_name'          => 'selected_method_of_payment',
+							'html_class'         => 'spco-payment-method',
+							'default'            => $this->checkout->selected_method_of_payment,
+							'label_size'         => 11,
+							'enforce_label_size' => true,
+						]
+					),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 *    _payment_method_billing_info
+	 *
+	 * @access    private
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _payment_method_billing_info(EE_Payment_Method $payment_method)
+	{
+		$currently_selected = $this->checkout->selected_method_of_payment === $payment_method->slug();
+		// generate the billing form for payment method
+		$billing_form                 = $currently_selected
+			? $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(
+			esc_html__('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()) {
+			$payment_method_info = $payment_method->description();
+		} elseif ($billing_form instanceof EE_Billing_Info_Form) {
+			$payment_method_info = sprintf(
+				esc_html__(
+					'Please provide the following billing information, then click the "%1$s" button below in order to proceed.',
+					'event_espresso'
+				),
+				$this->submit_button_text()
+			);
+		} else {
+			$payment_method_info = sprintf(
+				esc_html__('Please click the "%1$s" button below in order to proceed.', 'event_espresso'),
+				$this->submit_button_text()
+			);
+		}
+		$info_html .= EEH_HTML::div(
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___payment_method_billing_info__payment_method_info',
+				$payment_method_info
+			),
+			'',
+			'spco-payment-method-desc ee-attention'
+		);
+		return new EE_Form_Section_Proper(
+			[
+				'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'     => [
+					'info'         => new EE_Form_Section_HTML($info_html),
+					'billing_form' => $currently_selected ? $billing_form : new EE_Form_Section_HTML(),
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * get_billing_form_html_for_payment_method
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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->payment_method             = $this->_get_payment_method_for_selected_method_of_payment();
+		if (! $this->checkout->payment_method instanceof EE_Payment_Method) {
+			return false;
+		}
+		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',
+					sprintf(
+						esc_html__(
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
+							'event_espresso'
+						),
+						$this->checkout->payment_method->name()
+					)
+				)
+			);
+		}
+		// now generate billing form for selected method of payment
+		$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
+			&& $this->checkout->transaction_has_primary_registrant()
+		) {
+			$payment_method_billing_form->populate_from_attendee(
+				$this->checkout->transaction->primary_registration()->attendee()
+			);
+		}
+		// and debug content
+		if (
+			$payment_method_billing_form instanceof EE_Billing_Info_Form
+			&& $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
+				);
+		}
+		$billing_info = $payment_method_billing_form instanceof EE_Form_Section_Proper
+			? $payment_method_billing_form->get_html()
+			: '';
+		$this->checkout->json_response->set_return_data(['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());
+		return true;
+	}
+
+
+	/**
+	 * _get_billing_form_for_payment_method
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Billing_Info_Form|EE_Form_Section_HTML
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_billing_form_for_payment_method(EE_Payment_Method $payment_method)
+	{
+		$billing_form = $payment_method->type_obj()->billing_form(
+			$this->checkout->transaction,
+			['amount_owing' => $this->checkout->amount_owing]
+		);
+		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
+				)
+				&& $this->request->requestParamIsSet('payment_method')
+			) {
+				EE_Error::add_success(
+					apply_filters(
+						'FHEE__Single_Page_Checkout__registration_checkout__selected_payment_method',
+						sprintf(
+							esc_html__(
+								'You have selected "%s" as your method of payment. Please note the important payment information below.',
+								'event_espresso'
+							),
+							$payment_method->name()
+						)
+					)
+				);
+			}
+			return apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Payment_Options___get_billing_form_for_payment_method__billing_form',
+				$billing_form,
+				$payment_method
+			);
+		}
+		// no actual billing form, so return empty HTML form section
+		return new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * _get_selected_method_of_payment
+	 *
+	 * @param boolean $required whether to throw an error if the "selected_method_of_payment"
+	 *                          is not found in the incoming request
+	 * @param string  $request_param
+	 * @return NULL|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_selected_method_of_payment(
+		$required = false,
+		$request_param = 'selected_method_of_payment'
+	) {
+		// is selected_method_of_payment set in the request ?
+		$selected_method_of_payment = $this->request->getRequestParam($request_param);
+		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;
+			$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);
+		} else {
+			// or is is set in the session ?
+			$selected_method_of_payment = EE_Registry::instance()->SSN->get_session_data(
+				'selected_method_of_payment'
+			);
+		}
+		// do ya really really gotta have it?
+		if (empty($selected_method_of_payment) && $required) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The selected method of payment could not be determined.%sPlease ensure that you have selected one before proceeding.%sIf you continue to experience difficulties, then refresh your browser and try again, or contact %s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $selected_method_of_payment;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/***********************************  SWITCH PAYMENT METHOD  ************************************/
+	/********************************************************************************************************/
+	/**
+	 * switch_payment_method
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function switch_payment_method()
+	{
+		if (! $this->_verify_payment_method_is_set()) {
+			return false;
+		}
+		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',
+					sprintf(
+						esc_html__(
+							'You have selected "%s" as your method of payment. Please note the important payment information below.',
+							'event_espresso'
+						),
+						$this->checkout->payment_method->name()
+					)
+				)
+			);
+		}
+		// 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()) {
+			$this->checkout->billing_form = $this->_get_billing_form_for_payment_method(
+				$this->checkout->payment_method
+			);
+		}
+		// fill form with attendee info if applicable
+		if (
+			apply_filters(
+				'FHEE__populate_billing_form_fields_from_attendee',
+				(
+				$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
+				&& $this->checkout->transaction_has_primary_registrant()
+				),
+				$this->checkout->billing_form,
+				$this->checkout->transaction
+			)
+		) {
+			$this->checkout->billing_form->populate_from_attendee(
+				$this->checkout->transaction->primary_registration()->attendee()
+			);
+		}
+		// 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->billing_form =
+				$this->checkout->payment_method->type_obj()->apply_billing_form_debug_settings(
+					$this->checkout->billing_form
+				);
+		}
+		// get html and validation rules for form
+		if ($this->checkout->billing_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->json_response->set_return_data(
+				['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());
+		} else {
+			$this->checkout->json_response->set_return_data(['payment_method_info' => '']);
+		}
+		// prevents advancement to next step
+		$this->checkout->continue_reg = false;
+		return true;
+	}
+
+
+	/**
+	 * _verify_payment_method_is_set
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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)) {
+			// how have they chosen to pay?
+			$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) {
+				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',
+							esc_html__(
+								'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__
+					);
+					return false;
+				case 'payments_closed':
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__payments_closed_msg',
+							esc_html__(
+								'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__
+					);
+					return false;
+				case 'no_payment_required':
+					EE_Error::add_attention(
+						apply_filters(
+							'FHEE__EE_SPCO_Reg_Step_Payment_Options___verify_payment_method_is_set__no_payment_required_msg',
+							esc_html__(
+								'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__
+					);
+					return false;
+				default:
+			}
+		}
+		// verify 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();
+		}
+		return $this->checkout->payment_method instanceof EE_Payment_Method;
+	}
+
+
+
+	/********************************************************************************************************/
+	/***************************************  SAVE PAYER DETAILS  ****************************************/
+	/********************************************************************************************************/
+	/**
+	 * save_payer_details_via_ajax
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function save_payer_details_via_ajax()
+	{
+		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()) {
+			$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()) {
+			$attendee = $this->_create_attendee_from_request_data();
+			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);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * create_attendee_from_request_data
+	 * uses info from alternate GET or POST data (such as AJAX) to create a new attendee
+	 *
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _create_attendee_from_request_data()
+	{
+		// get State ID
+		$STA_ID = $this->request->getRequestParam('state');
+		if (! empty($STA_ID)) {
+			// can we get state object from name ?
+			EE_Registry::instance()->load_model('State');
+			$state  = EEM_State::instance()->get_col([['STA_name' => $STA_ID], 'limit' => 1], 'STA_ID');
+			$STA_ID = is_array($state) && ! empty($state) ? reset($state) : $STA_ID;
+		}
+		// get Country ISO
+		$CNT_ISO = $this->request->getRequestParam('country');
+		if (! empty($CNT_ISO)) {
+			// can we get country object from name ?
+			EE_Registry::instance()->load_model('Country');
+			$country = EEM_Country::instance()->get_col(
+				[['CNT_name' => $CNT_ISO], 'limit' => 1],
+				'CNT_ISO'
+			);
+			$CNT_ISO = is_array($country) && ! empty($country) ? reset($country) : $CNT_ISO;
+		}
+		// grab attendee data
+		$attendee_data = [
+			'ATT_fname'    => $this->request->getRequestParam('first_name'),
+			'ATT_lname'    => $this->request->getRequestParam('last_name'),
+			'ATT_email'    => $this->request->getRequestParam('email'),
+			'ATT_address'  => $this->request->getRequestParam('address'),
+			'ATT_address2' => $this->request->getRequestParam('address2'),
+			'ATT_city'     => $this->request->getRequestParam('city'),
+			'STA_ID'       => $STA_ID,
+			'CNT_ISO'      => $CNT_ISO,
+			'ATT_zip'      => $this->request->getRequestParam('zip'),
+			'ATT_phone'    => $this->request->getRequestParam('phone'),
+		];
+		// validate the email address since it is the most important piece of info
+		if (empty($attendee_data['ATT_email'])) {
+			EE_Error::add_error(
+				esc_html__('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'])
+		) {
+			$existing_attendee = EEM_Attendee::instance()->find_existing_attendee(
+				[
+					'ATT_fname' => $attendee_data['ATT_fname'],
+					'ATT_lname' => $attendee_data['ATT_lname'],
+					'ATT_email' => $attendee_data['ATT_email'],
+				]
+			);
+			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']
+			: $attendee_data['ATT_email'];
+		$attendee_data['ATT_lname'] = ! empty($attendee_data['ATT_lname'])
+			? $attendee_data['ATT_lname']
+			: $attendee_data['ATT_email'];
+		return EE_Attendee::new_instance($attendee_data);
+	}
+
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  *****************************************/
+	/********************************************************************************************************/
+	/**
+	 * process_reg_step
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	public function process_reg_step()
+	{
+		// 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);
+		// choose your own adventure based on 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);
+				// mark this reg step as completed
+				$this->set_completed();
+				return false;
+
+			case 'payments_closed':
+				if (
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__payments_closed__display_success',
+						false
+					)
+				) {
+					EE_Error::add_success(
+						esc_html__('no payment required at this time.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+				// mark this reg step as completed
+				$this->set_completed();
+				return true;
+
+			case 'no_payment_required':
+				if (
+					apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Payment_Options__process_reg_step__no_payment_required__display_success',
+						false
+					)
+				) {
+					EE_Error::add_success(
+						esc_html__('no payment required.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+				// mark this reg step as completed
+				$this->set_completed();
+				return true;
+
+			default:
+				$registrations         = EE_Registry::instance()->SSN->checkout()->transaction->registrations(
+					EE_Registry::instance()->SSN->checkout()->reg_cache_where_params
+				);
+				$ejected_registrations = EE_SPCO_Reg_Step_Payment_Options::find_registrations_that_lost_their_space(
+					$registrations,
+					EE_Registry::instance()->SSN->checkout()->revisit
+				);
+				// calculate difference between the two arrays
+				$registrations = array_diff($registrations, $ejected_registrations);
+				if (empty($registrations)) {
+					$this->_redirect_because_event_sold_out();
+					return false;
+				}
+				$payment = $this->_process_payment();
+				if ($payment instanceof EE_Payment) {
+					$this->checkout->continue_reg = true;
+					$this->_maybe_set_completed($payment);
+				} else {
+					$this->checkout->continue_reg = false;
+				}
+				return $payment instanceof EE_Payment;
+		}
+	}
+
+
+	/**
+	 * _redirect_because_event_sold_out
+	 *
+	 * @return void
+	 */
+	protected function _redirect_because_event_sold_out()
+	{
+		$this->checkout->continue_reg = false;
+		// set redirect URL
+		$this->checkout->redirect_url = add_query_arg(
+			['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);
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function _maybe_set_completed(EE_Payment $payment)
+	{
+		// Do we need to redirect them? If so, there's more work to be done.
+		if (! $payment->redirect_url()) {
+			$this->set_completed();
+		}
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to retry a payment
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws EntityNotFoundException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidStatusException
+	 */
+	public function update_reg_step()
+	{
+		$success = true;
+		// if payment required
+		if ($this->checkout->transaction->total() > 0) {
+			do_action(
+				'AHEE__EE_Single_Page_Checkout__process_finalize_registration__before_gateway',
+				$this->checkout->transaction
+			);
+			// attempt payment via payment method
+			$success = $this->process_reg_step();
+		}
+		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(
+				['e_reg_url_link' => $this->checkout->reg_url_link],
+				$this->checkout->thank_you_page_url
+			);
+		}
+		return $success;
+	}
+
+
+	/**
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _process_payment()
+	{
+		// basically confirm that the event hasn't sold out since they hit the page
+		if (! $this->_last_second_ticket_verifications()) {
+			return null;
+		}
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$this->checkout->json_response->set_plz_select_method_of_payment(
+				esc_html__('Please select a method of payment before proceeding.', 'event_espresso')
+			);
+			return null;
+		}
+		// get EE_Payment_Method object
+		if (! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()) {
+			return null;
+		}
+		// setup 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
+			);
+			// bad billing form ?
+			if (! $this->_billing_form_is_valid()) {
+				return null;
+			}
+		}
+		// ensure primary registrant has been fully processed
+		if (! $this->_setup_primary_registrant_prior_to_payment()) {
+			return null;
+		}
+		// if session is close to expiring (under 10 minutes by default)
+		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();
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		// $transaction_processor = EE_Registry::instance()->load_class( 'Transaction_Processor' );
+		// 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);
+		// process results
+		$payment = $this->_validate_payment($payment);
+		$payment = $this->_post_payment_processing($payment);
+		// verify 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
+			$this->checkout->transaction->toggle_failed_transaction_status();
+			$payment_status = $payment->status();
+			if (
+				$payment_status === EEM_Payment::status_id_approved
+				|| $payment_status === EEM_Payment::status_id_pending
+			) {
+				return $payment;
+			}
+			return null;
+		}
+		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;
+			return $payment;
+		}
+		// where's my money?
+		return null;
+	}
+
+
+	/**
+	 * _last_second_ticket_verifications
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _last_second_ticket_verifications()
+	{
+		// don't bother re-validating if not a return visit
+		if (! $this->checkout->revisit) {
+			return true;
+		}
+		$registrations = $this->checkout->transaction->registrations();
+		if (empty($registrations)) {
+			return false;
+		}
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration && ! $registration->is_approved()) {
+				$event = $registration->event_obj();
+				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(
+								esc_html__(
+									'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()
+							)
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * redirect_form
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function redirect_form()
+	{
+		$payment_method_billing_info = $this->_payment_method_billing_info(
+			$this->_get_payment_method_for_selected_method_of_payment()
+		);
+		$html                        = $payment_method_billing_info->get_html();
+		$html                        .= $this->checkout->redirect_form;
+		/** @var ResponseInterface $response */
+		$response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
+		$response->addOutput($html);
+		return true;
+	}
+
+
+	/**
+	 * _billing_form_is_valid
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	private function _billing_form_is_valid()
+	{
+		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()) {
+				$this->checkout->billing_form->receive_form_submission();
+				if ($this->checkout->billing_form->is_valid()) {
+					return true;
+				}
+				$validation_errors = $this->checkout->billing_form->get_validation_errors_accumulated();
+				$error_strings     = [];
+				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) {
+							$label = $form_section->html_label_text();
+						} elseif ($form_section instanceof EE_Form_Section_Base) {
+							$label = $form_section->name();
+						} else {
+							$label = esc_html__('Validation Error', 'event_espresso');
+						}
+						$error_strings[] = sprintf('%1$s: %2$s', $label, $validation_error->getMessage());
+					}
+				}
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'One or more billing form inputs are invalid and require correction before proceeding. %1$s %2$s',
+							'event_espresso'
+						),
+						'<br/>',
+						implode('<br/>', $error_strings)
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'The billing form was not submitted or something prevented it\'s submission.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'The submitted billing form is invalid possibly due to a technical reason.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * _setup_primary_registrant_prior_to_payment
+	 * ensures that the primary registrant has a valid attendee object created with the critical details populated
+	 * (first & last name & email) and that both the transaction object and primary registration object have been saved
+	 * plz note that any other registrations will NOT be saved at this point (because they may not have any details
+	 * yet)
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _setup_primary_registrant_prior_to_payment()
+	{
+		// check if transaction has a primary registrant and that it has a related Attendee object
+		// if not, then we need to at least gather some primary registrant data before attempting payment
+		if (
+			$this->checkout->billing_form instanceof EE_Billing_Attendee_Info_Form
+			&& ! $this->checkout->transaction_has_primary_registrant()
+			&& ! $this->_capture_primary_registration_data_from_billing_form()
+		) {
+			return false;
+		}
+		// because saving an object clears it's cache, we need to do the chevy shuffle
+		// grab the primary_registration object
+		$primary_registration = $this->checkout->transaction->primary_registration();
+		// at this point we'll consider a TXN to not have been failed
+		$this->checkout->transaction->toggle_failed_transaction_status();
+		// 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());
+		// save what we have so far
+		$primary_registration->save();
+		return true;
+	}
+
+
+	/**
+	 * _capture_primary_registration_data_from_billing_form
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The billing form details could not be used for attendee details 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 false;
+		}
+		$primary_registration = $this->checkout->transaction->primary_registration();
+		if (! $primary_registration instanceof EE_Registration) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The primary registrant for this transaction 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 false;
+		}
+		if (
+			! $primary_registration->_add_relation_to($this->checkout->primary_attendee_obj, 'Attendee')
+			  instanceof
+			  EE_Attendee
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The primary registrant could not be associated with this transaction 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 false;
+		}
+		/** @type EE_Registration_Processor $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);
+		return true;
+	}
+
+
+	/**
+	 * _get_payment_method_for_selected_method_of_payment
+	 * retrieves a valid payment method
+	 *
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_payment_method_for_selected_method_of_payment()
+	{
+		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 ];
+		} else {
+			// load EEM_Payment_Method
+			EE_Registry::instance()->load_model('Payment_Method');
+			$EEM_Payment_Method = EEM_Payment_Method::instance();
+			$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) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The selected method of payment 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;
+		}
+		// and verify it has a valid Payment_Method Type object
+		if (! $payment_method->type_obj() instanceof EE_PMT_Base) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'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;
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 *    _attempt_payment
+	 *
+	 * @access    private
+	 * @type    EE_Payment_Method $payment_method
+	 * @return mixed EE_Payment | boolean
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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) {
+			return false;
+		}
+		try {
+			$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),
+				'CART',
+				$this->checkout->admin_request,
+				true,
+				$this->reg_step_url()
+			);
+		} catch (Exception $e) {
+			$this->_handle_payment_processor_exception($e);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _handle_payment_processor_exception
+	 *
+	 * @param Exception $e
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _handle_payment_processor_exception(Exception $e)
+	{
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'The payment could not br processed due to a technical issue.%1$sPlease try again or contact %2$s for assistance.||The following Exception was thrown in %4$s on line %5$s:%1$s%3$s',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email'),
+				$e->getMessage(),
+				$e->getFile(),
+				$e->getLine()
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * _get_return_url
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_return_url(EE_Payment_Method $payment_method)
+	{
+		$return_url = '';
+		switch ($payment_method->type_obj()->payment_occurs()) {
+			case EE_PMT_Base::offsite:
+				$return_url = add_query_arg(
+					[
+						'action'                     => 'process_gateway_response',
+						'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+						'spco_txn'                   => $this->checkout->transaction->ID(),
+					],
+					$this->reg_step_url()
+				);
+				break;
+			case EE_PMT_Base::onsite:
+			case EE_PMT_Base::offline:
+				$return_url = $this->checkout->next_step->reg_step_url();
+				break;
+		}
+		return $return_url;
+	}
+
+
+	/**
+	 * _validate_payment
+	 *
+	 * @param EE_Payment $payment
+	 * @return EE_Payment|FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _validate_payment($payment = null)
+	{
+		if ($this->checkout->payment_method->is_off_line()) {
+			return true;
+		}
+		// verify payment object
+		if (! $payment instanceof EE_Payment) {
+			// not a payment
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'A valid payment was not generated due to a technical issue.%1$sPlease try again or contact %2$s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _post_payment_processing
+	 *
+	 * @param EE_Payment|bool $payment
+	 * @return bool|EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _post_payment_processing($payment = null)
+	{
+		// Off-Line payment?
+		if ($payment === true) {
+			return true;
+		}
+		if ($payment instanceof EE_Payment) {
+			// Should the user be redirected?
+			if ($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');
+				// set JSON response
+				$this->checkout->json_response->set_redirect_form($this->checkout->redirect_form);
+				// and lastly, let's bump the payment status to pending
+				$payment->set_status(EEM_Payment::status_id_pending);
+				$payment->save();
+			} elseif (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+				// User shouldn't be redirected. So let's process it here.
+				// $this->_setup_redirect_for_next_step();
+				$this->checkout->continue_reg = false;
+			}
+			return $payment;
+		}
+		// ummm ya... not Off-Line, not On-Site, not off-Site ????
+		$this->checkout->continue_reg = false;
+		return false;
+	}
+
+
+	/**
+	 *    _process_payment_status
+	 *
+	 * @type    EE_Payment $payment
+	 * @param string       $payment_occurs
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _process_payment_status($payment, $payment_occurs = EE_PMT_Base::offline)
+	{
+		// off-line payment? carry on
+		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()');
+			$msg = $payment->gateway_response();
+			// check results
+			switch ($payment->status()) {
+				// good payment
+				case EEM_Payment::status_id_approved:
+					EE_Error::add_success(
+						esc_html__('Your payment was processed successfully.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return true;
+				// slow payment
+				case EEM_Payment::status_id_pending:
+					if (empty($msg)) {
+						$msg = esc_html__(
+							'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__);
+					return true;
+				// don't wanna payment
+				case EEM_Payment::status_id_cancelled:
+					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),
+							'event_espresso'
+						);
+					}
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+				// not enough payment
+				case EEM_Payment::status_id_declined:
+					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),
+							'event_espresso'
+						);
+					}
+					EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+					return false;
+				// bad payment
+				case EEM_Payment::status_id_failed:
+					if (! empty($msg)) {
+						EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+						return false;
+					}
+					// default to error below
+					break;
+			}
+		}
+		// 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) {
+			return true;
+		}
+		EE_Error::add_error(
+			sprintf(
+				esc_html__(
+					'Your payment could not be processed successfully 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 false;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/**********************************  PROCESS GATEWAY RESPONSE  **********************************/
+	/********************************************************************************************************/
+	/**
+	 * process_gateway_response
+	 * this is the return point for Off-Site Payment Methods
+	 * It will attempt to "handle the IPN" if it appears that this has not already occurred,
+	 * otherwise, it will load up the last payment made for the TXN.
+	 * If the payment retrieved looks good, it will then either:
+	 *    complete the current step and allow advancement to the next reg step
+	 *        or present the payment options again
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_gateway_response()
+	{
+		// how have they chosen to pay?
+		$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()) {
+			$this->checkout->continue_reg = false;
+			return false;
+		}
+		if (! $this->checkout->payment_method->is_off_site()) {
+			return false;
+		}
+		$this->_validate_offsite_return();
+		// verify TXN
+		if ($this->checkout->transaction instanceof EE_Transaction) {
+			$gateway = $this->checkout->payment_method->type_obj()->get_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);
+			// if payment was not declined by the payment gateway or cancelled by the registrant
+			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 (! $this->handle_IPN_in_this_request()) {
+					$this->set_completed();
+				}
+				return true;
+			}
+		}
+		// DEBUG LOG
+		// $this->checkout->log(
+		//     __CLASS__,
+		//     __FUNCTION__,
+		//     __LINE__,
+		//     array('payment' => $payment)
+		// );
+		$this->checkout->continue_reg = false;
+		return false;
+	}
+
+
+	/**
+	 * _validate_return
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _validate_offsite_return()
+	{
+		$TXN_ID = $this->request->getRequestParam('spco_txn', 0, 'int');
+		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);
+			$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) {
+				// verify that the current cart has tickets
+				$tickets = $cart->get_tickets();
+				if (empty($tickets)) {
+					$invalid_TXN = true;
+				}
+			} else {
+				$invalid_TXN = true;
+			}
+			$valid_TXN_SID = $primary_registrant instanceof EE_Registration
+				? $primary_registrant->session_ID()
+				: null;
+			// validate current Session ID and compare against valid TXN session ID
+			if (
+				$invalid_TXN // if this is already true, then skip other checks
+				|| EE_Session::instance()->id() === null
+				|| (
+					// 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
+					// and whether this reg step has even been started ?
+					EE_Session::instance()->id() === $valid_TXN_SID
+					// really? you're half way through this reg step, but you never started it ?
+					&& $this->checkout->transaction->reg_step_completed($this->slug()) === false
+				)
+			) {
+				$invalid_TXN = true;
+			}
+			if ($invalid_TXN) {
+				// is the valid TXN completed ?
+				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) {
+						// 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);
+						return;
+					}
+				}
+				// you appear to be lost?
+				$this->_redirect_wayward_request($primary_registrant);
+			}
+		}
+	}
+
+
+	/**
+	 * _redirect_wayward_request
+	 *
+	 * @param EE_Registration|null $primary_registrant
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	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) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Invalid information was received from the Off-Site Payment Processor and your Transaction details could not be retrieved from the database.%1$sPlease try again or contact %2$s for assistance.',
+						'event_espresso'
+					),
+					'<br/>',
+					EE_Registry::instance()->CFG->organization->get_pretty('email')
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+		// make sure transaction is not locked
+		$this->checkout->transaction->unlock();
+		wp_safe_redirect(
+			add_query_arg(
+				[
+					'e_reg_url_link' => $primary_registrant->reg_url_link(),
+				],
+				$this->checkout->thank_you_page_url
+			)
+		);
+		exit();
+	}
+
+
+	/**
+	 * _process_off_site_payment
+	 *
+	 * @param EE_Offsite_Gateway $gateway
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _process_off_site_payment(EE_Offsite_Gateway $gateway)
+	{
+		try {
+			$request      = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$request_data = $request->requestParams();
+			// 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)
+			);
+			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           = $payment_processor->process_ipn(
+					$request_data,
+					$this->checkout->transaction,
+					$this->checkout->payment_method,
+					true,
+					false
+				);
+				// $payment_source = 'process_ipn';
+			} else {
+				$payment = $this->checkout->transaction->last_payment();
+				// $payment_source = 'last_payment';
+			}
+		} 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) {
+				// then we'll object ! ( not object like a thing... but object like what a lawyer says ! )
+				$this->_handle_payment_processor_exception($e);
+			}
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * _process_cancelled_payments
+	 * just makes sure that the payment status gets updated correctly
+	 * so tha tan error isn't generated during payment validation
+	 *
+	 * @param EE_Payment $payment
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 */
+	private function _process_cancelled_payments($payment = null)
+	{
+		if (
+			$payment instanceof EE_Payment
+			&& $this->request->requestParamIsSet('ee_cancel_payment')
+			&& $payment->status() === EEM_Payment::status_id_failed
+		) {
+			$payment->set_status(EEM_Payment::status_id_cancelled);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 *    get_transaction_details_for_gateways
+	 *
+	 * @access    public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_transaction_details_for_gateways()
+	{
+		$txn_details = [];
+		// ya gotta make a choice man
+		if (empty($this->checkout->selected_method_of_payment)) {
+			$txn_details = [
+				'error' => esc_html__('Please select a method of payment before proceeding.', 'event_espresso'),
+			];
+		}
+		// get EE_Payment_Method object
+		if (
+			empty($txn_details)
+			&& ! $this->checkout->payment_method = $this->_get_payment_method_for_selected_method_of_payment()
+		) {
+			$txn_details = [
+				'selected_method_of_payment' => $this->checkout->selected_method_of_payment,
+				'error'                      => esc_html__(
+					'A valid Payment Method could not be determined.',
+					'event_espresso'
+				),
+			];
+		}
+		if (empty($txn_details) && $this->checkout->transaction instanceof EE_Transaction) {
+			$return_url  = $this->_get_return_url($this->checkout->payment_method);
+			$txn_details = [
+				'TXN_ID'         => $this->checkout->transaction->ID(),
+				'TXN_timestamp'  => $this->checkout->transaction->datetime(),
+				'TXN_total'      => $this->checkout->transaction->total(),
+				'TXN_paid'       => $this->checkout->transaction->paid(),
+				'TXN_reg_steps'  => $this->checkout->transaction->reg_steps(),
+				'STS_ID'         => $this->checkout->transaction->status_ID(),
+				'PMD_ID'         => $this->checkout->transaction->payment_method_ID(),
+				'payment_amount' => $this->checkout->amount_owing,
+				'return_url'     => $return_url,
+				'cancel_url'     => add_query_arg(['ee_cancel_payment' => true], $return_url),
+				'notify_url'     => EE_Config::instance()->core->txn_page_url(
+					[
+						'e_reg_url_link'    => $this->checkout->transaction->primary_registration()->reg_url_link(),
+						'ee_payment_method' => $this->checkout->payment_method->slug(),
+					]
+				),
+			];
+		}
+		echo wp_json_encode($txn_details);
+		exit();
+	}
+
+
+	/**
+	 *    __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)), ['reg_form', 'checkout', 'line_item_display']);
+	}
 }

Spacing +78 added lines, -78 removed lines

@@ -133,7 +133,7 @@ 
         $this->request   = EED_Single_Page_Checkout::getRequest();
         $this->_slug     = 'payment_options';
         $this->_name     = esc_html__('Payment Options', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . '/payment_options_main.template.php';
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.'/payment_options_main.template.php';
         $this->checkout  = $checkout;
         $this->_reset_success_message();
         $this->set_instructions(
@@ -188,7 +188,7 @@ 
      */
     public function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['no_payment_method']      = esc_html__(
+        EE_Registry::$i18n_js_strings['no_payment_method'] = esc_html__(
             'Please select a method of payment in order to continue.',
             'event_espresso'
         );
@@ -196,7 +196,7 @@ 
             'A valid method of payment could not be determined. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['forwarding_to_offsite']  = esc_html__(
+        EE_Registry::$i18n_js_strings['forwarding_to_offsite'] = esc_html__(
             'Forwarding to Secure Payment Provider.',
             'event_espresso'
         );
@@ -217,7 +217,7 @@ 
     {
         $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 (
@@ -314,18 +314,18 @@ 
         foreach ($registrations as $REG_ID => $registration) {
             /** @var $registration EE_Registration */
             // has this registration lost it's space ?
-            if (isset($ejected_registrations[ $REG_ID ])) {
+            if (isset($ejected_registrations[$REG_ID])) {
                 if ($registration->event()->is_sold_out() || $registration->event()->is_sold_out(true)) {
-                    $sold_out_events[ $registration->event()->ID() ] = $registration->event();
+                    $sold_out_events[$registration->event()->ID()] = $registration->event();
                 } else {
-                    $insufficient_spaces_available[ $registration->event()->ID() ] = $registration->event();
+                    $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;
+                $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(),
@@ -342,7 +342,7 @@ 
                 )
             ) {
                 // 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(),
@@ -352,7 +352,7 @@ 
             }
             // are they allowed to pay now and is there monies owing?
             if ($registration->owes_monies_and_can_pay()) {
-                $registrations_requiring_payment[ $REG_ID ] = $registration;
+                $registrations_requiring_payment[$REG_ID] = $registration;
                 do_action(
                     'AHEE__EE_SPCO_Reg_Step_Payment_Options__generate_reg_form__event_requires_payment',
                     $registration->event(),
@@ -363,28 +363,28 @@ 
                       && $registration->status_ID() !== EEM_Registration::status_id_not_approved
                       && $registration->ticket()->is_free()
             ) {
-                $registrations_for_free_events[ $registration->ticket()->ID() ] = $registration;
+                $registrations_for_free_events[$registration->ticket()->ID()] = $registration;
             }
         }
         $subsections = [];
         // now decide which template to load
-        if (! empty($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)) {
+        if ( ! empty($registrations_for_free_events)) {
             $subsections['no_payment_required'] = $this->_no_payment_required($registrations_for_free_events);
         }
-        if (! empty($registrations_requiring_payment)) {
+        if ( ! empty($registrations_requiring_payment)) {
             if ($this->checkout->amount_owing > 0) {
                 // autoload Line_Item_Display classes
                 EEH_Autoloader::register_line_item_filter_autoloaders();
@@ -405,7 +405,7 @@ 
                         ['registrations' => $registrations]
                     )
                 );
-                $this->checkout->amount_owing   = $filtered_line_item_tree->total();
+                $this->checkout->amount_owing = $filtered_line_item_tree->total();
                 $this->_apply_registration_payments_to_amount_owing($registrations);
             }
             $no_payment_required = false;
@@ -449,7 +449,7 @@ 
      */
     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
+        if ( ! EE_Registry::instance()->SSN instanceof EE_Session
             || ! EE_Registry::instance()->SSN->checkout() instanceof EE_Checkout
             || ! EE_Registry::instance()->SSN->checkout()->transaction instanceof EE_Transaction
         ) {
@@ -492,8 +492,8 @@ 
         );
         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]);
             }
         }
         return $registrations;
@@ -543,25 +543,25 @@ 
             }
             $EVT_ID = $registration->event_ID();
             $ticket = $registration->ticket();
-            if (! isset($tickets_remaining[ $ticket->ID() ])) {
-                $tickets_remaining[ $ticket->ID() ] = $ticket->remaining();
+            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;
+            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();
+                $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();
+                $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');
@@ -621,7 +621,7 @@ 
         foreach ($sold_out_events_array as $sold_out_event) {
             $sold_out_events .= EEH_HTML::li(
                 EEH_HTML::span(
-                    '  ' . $sold_out_event->name(),
+                    '  '.$sold_out_event->name(),
                     '',
                     'dashicons dashicons-marker ee-icon-size-16 pink-text'
                 )
@@ -677,7 +677,7 @@ 
         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')
                 );
             }
         }
@@ -726,7 +726,7 @@ 
         $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(
+                $events_requiring_pre_approval[$registration->event()->ID()] = EEH_HTML::li(
                     EEH_HTML::span(
                         '',
                         '',
@@ -866,7 +866,7 @@ 
     {
         return new EE_Form_Section_Proper(
             [
-                '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'     => [
                     'spco_no_payment_required' => new EE_Hidden_Input(
@@ -905,7 +905,7 @@ 
                 $payments += $registration->registration_payments();
             }
         }
-        if (! empty($payments)) {
+        if ( ! empty($payments)) {
             foreach ($payments as $payment) {
                 if ($payment instanceof EE_Registration_Payment) {
                     $this->checkout->amount_owing -= $payment->amount();
@@ -994,7 +994,7 @@ 
             );
         }
         // 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',
                 esc_html__('Please Select Your Method of Payment', 'event_espresso')
@@ -1028,7 +1028,7 @@ 
                 $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
@@ -1036,15 +1036,15 @@ 
                 // 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->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' ] =
+                $payment_methods_billing_info[$payment_method->slug().'-info'] =
                     $this->_payment_method_billing_info(
                         $payment_method
                     );
@@ -1057,7 +1057,7 @@ 
         $available_payment_methods['available_payment_methods'] = $this->_available_payment_method_inputs(
             $available_payment_method_options
         );
-        $available_payment_methods                              += $payment_methods_billing_info;
+        $available_payment_methods += $payment_methods_billing_info;
         // build the available payment methods form
         return new EE_Form_Section_Proper(
             [
@@ -1080,7 +1080,7 @@ 
      */
     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 = [];
@@ -1092,7 +1092,7 @@ 
         );
         foreach ($payment_methods as $payment_method) {
             if ($payment_method instanceof EE_Payment_Method) {
-                $available_payment_methods[ $payment_method->slug() ] = $payment_method;
+                $available_payment_methods[$payment_method->slug()] = $payment_method;
             }
         }
         return $available_payment_methods;
@@ -1187,7 +1187,7 @@ 
         );
         return new EE_Form_Section_Proper(
             [
-                '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;',
@@ -1216,7 +1216,7 @@ 
         // how have they chosen to pay?
         $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 (
@@ -1391,7 +1391,7 @@ 
      */
     public function switch_payment_method()
     {
-        if (! $this->_verify_payment_method_is_set()) {
+        if ( ! $this->_verify_payment_method_is_set()) {
             return false;
         }
         if (
@@ -1527,7 +1527,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();
         }
@@ -1552,7 +1552,7 @@ 
      */
     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
@@ -1562,7 +1562,7 @@ 
             );
         }
         // 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) {
@@ -1593,7 +1593,7 @@ 
     {
         // get State ID
         $STA_ID = $this->request->getRequestParam('state');
-        if (! empty($STA_ID)) {
+        if ( ! empty($STA_ID)) {
             // can we get state object from name ?
             EE_Registry::instance()->load_model('State');
             $state  = EEM_State::instance()->get_col([['STA_name' => $STA_ID], 'limit' => 1], 'STA_ID');
@@ -1601,7 +1601,7 @@ 
         }
         // get Country ISO
         $CNT_ISO = $this->request->getRequestParam('country');
-        if (! empty($CNT_ISO)) {
+        if ( ! empty($CNT_ISO)) {
             // can we get country object from name ?
             EE_Registry::instance()->load_model('Country');
             $country = EEM_Country::instance()->get_col(
@@ -1782,7 +1782,7 @@ 
     protected function _maybe_set_completed(EE_Payment $payment)
     {
         // Do we need to redirect them? If so, there's more work to be done.
-        if (! $payment->redirect_url()) {
+        if ( ! $payment->redirect_url()) {
             $this->set_completed();
         }
     }
@@ -1839,7 +1839,7 @@ 
     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 null;
         }
         // ya gotta make a choice man
@@ -1850,7 +1850,7 @@ 
             return null;
         }
         // 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 null;
         }
         // setup billing form
@@ -1859,12 +1859,12 @@ 
                 $this->checkout->payment_method
             );
             // bad billing form ?
-            if (! $this->_billing_form_is_valid()) {
+            if ( ! $this->_billing_form_is_valid()) {
                 return null;
             }
         }
         // ensure primary registrant has been fully processed
-        if (! $this->_setup_primary_registrant_prior_to_payment()) {
+        if ( ! $this->_setup_primary_registrant_prior_to_payment()) {
             return null;
         }
         // if session is close to expiring (under 10 minutes by default)
@@ -1920,7 +1920,7 @@ 
     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();
@@ -1970,7 +1970,7 @@ 
             $this->_get_payment_method_for_selected_method_of_payment()
         );
         $html                        = $payment_method_billing_info->get_html();
-        $html                        .= $this->checkout->redirect_form;
+        $html .= $this->checkout->redirect_form;
         /** @var ResponseInterface $response */
         $response = LoaderFactory::getLoader()->getShared(ResponseInterface::class);
         $response->addOutput($html);
@@ -1986,7 +1986,7 @@ 
      */
     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) {
@@ -2104,7 +2104,7 @@ 
     {
         // 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(
                     esc_html__(
@@ -2121,7 +2121,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(
                     esc_html__(
@@ -2183,8 +2183,8 @@ 
             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');
@@ -2192,7 +2192,7 @@ 
             $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(
@@ -2210,7 +2210,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(
@@ -2248,7 +2248,7 @@ 
         $payment = null;
         $this->checkout->transaction->save();
         $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        if (! $payment_processor instanceof EE_Payment_Processor) {
+        if ( ! $payment_processor instanceof EE_Payment_Processor) {
             return false;
         }
         try {
@@ -2350,7 +2350,7 @@ 
             return true;
         }
         // verify payment object
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             // not a payment
             EE_Error::add_error(
                 sprintf(
@@ -2400,7 +2400,7 @@ 
                 // and lastly, let's bump the payment status to pending
                 $payment->set_status(EEM_Payment::status_id_pending);
                 $payment->save();
-            } elseif (! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
+            } elseif ( ! $this->_process_payment_status($payment, EE_PMT_Base::onsite)) {
                 // User shouldn't be redirected. So let's process it here.
                 // $this->_setup_redirect_for_next_step();
                 $this->checkout->continue_reg = false;
@@ -2481,7 +2481,7 @@ 
                     return false;
                 // bad payment
                 case EEM_Payment::status_id_failed:
-                    if (! empty($msg)) {
+                    if ( ! empty($msg)) {
                         EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
                         return false;
                     }
@@ -2539,18 +2539,18 @@ 
         // how have they chosen to pay?
         $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();
         // verify TXN
         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;
             }
@@ -2564,7 +2564,7 @@ 
                 $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 (! $this->handle_IPN_in_this_request()) {
+                if ( ! $this->handle_IPN_in_this_request()) {
                     $this->set_completed();
                 }
                 return true;
@@ -2667,13 +2667,13 @@ 
      */
     private function _redirect_wayward_request(EE_Registration $primary_registrant)
     {
-        if (! $primary_registrant instanceof EE_Registration) {
+        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(
                     esc_html__(
@@ -2744,7 +2744,7 @@ 
             $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);
             }