eventespresso / event-espresso-core

modules/ticket_selector/TicketSelectorRowStandard.php

Indentation +382 added lines, -382 removed lines

@@ -19,390 +19,390 @@
  */
 class TicketSelectorRowStandard extends TicketSelectorRow
 {
-    /**
-     * @var TicketDetails
-     */
-    protected $ticket_details;
-
-    /**
-     * @var EE_Ticket_Selector_Config
-     */
-    protected $template_settings;
-
-    /**
-     * @var EE_Tax_Config
-     */
-    protected $tax_settings;
-
-    /**
-     * @var boolean
-     */
-    protected $prices_displayed_including_taxes;
-
-    /**
-     * @var int
-     */
-    protected $row;
-
-    /**
-     * @var int
-     */
-    protected $cols;
-
-    /**
-     * @var boolean
-     */
-    protected $hidden_input_qty = false;
-
-    /**
-     * @var string
-     */
-    protected $ticket_datetime_classes;
-
-    private bool $use_new_checkbox_selector;
-
-
-    /**
-     * TicketDetails constructor.
-     *
-     * @param TicketDetails $ticket_details
-     * @param EE_Tax_Config $tax_settings
-     * @param int           $total_tickets
-     * @param int           $max_attendees
-     * @param int           $row
-     * @param int           $cols
-     * @param boolean       $required_ticket_sold_out
-     * @param string        $event_status
-     * @param string        $ticket_datetime_classes
-     * @param bool          $use_new_checkbox_selector
-     * @throws EE_Error
-     * @throws UnexpectedEntityException
-     */
-    public function __construct(
-        TicketDetails $ticket_details,
-        EE_Tax_Config $tax_settings,
-        $total_tickets,
-        $max_attendees,
-        $row,
-        $cols,
-        $required_ticket_sold_out,
-        $event_status,
-        $ticket_datetime_classes,
-        bool $use_new_checkbox_selector = false
-    ) {
-        $this->ticket_details = $ticket_details;
-        $this->template_settings = $ticket_details->getTemplateSettings();
-        $this->tax_settings = $tax_settings;
-        $this->row = $row;
-        $this->cols = $cols;
-        $this->ticket_datetime_classes = $ticket_datetime_classes;
-        $this->use_new_checkbox_selector = $use_new_checkbox_selector;
-        parent::__construct(
-            $ticket_details->getTicket(),
-            $max_attendees,
-            $ticket_details->getDateFormat(),
-            $event_status,
-            $required_ticket_sold_out,
-            $total_tickets
-        );
-    }
-
-
-    /**
-     * other ticket rows will need to know if a required ticket is sold out,
-     * so that they are not offered for sale
-     *
-     * @return boolean
-     */
-    public function getRequiredTicketSoldOut()
-    {
-        return $this->required_ticket_sold_out;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getCols()
-    {
-        return $this->cols;
-    }
-
-
-    /**
-     * getHtml
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getHtml()
-    {
-        $this->min = 0;
-        $this->max = $this->ticket->max();
-        $remaining = $this->ticket->remaining();
-        $this->setTicketMinAndMax($remaining);
-        // set flag if ticket is required (flag is set to start date so that future tickets are not blocked)
-        $this->required_ticket_sold_out = $this->ticket->required() && ! $remaining
-            ? $this->ticket->start_date()
-            : $this->required_ticket_sold_out;
-        $this->setTicketPriceDetails();
-        $this->setTicketStatusClasses($remaining);
-        $filtered_row_html = $this->getFilteredRowHtml();
-        if ($filtered_row_html !== false) {
-            return $filtered_row_html;
-        }
-        $ticket_selector_row_html = EEH_HTML::tr(
-            '',
-            '',
-            "tckt-slctr-tbl-tr {$this->status_class}{$this->ticket_datetime_classes} "
-            . espresso_get_object_css_class($this->ticket)
-        );
-        $filtered_row_content = $this->getFilteredRowContents();
-        if ($filtered_row_content !== false) {
-            if ($this->max_attendees === 1) {
-                return $ticket_selector_row_html
-                       . $filtered_row_content
-                       . $this->ticketQtyAndIdHiddenInputs()
-                       . EEH_HTML::trx();
-            }
-            return $ticket_selector_row_html
-                   . $filtered_row_content
-                   . EEH_HTML::trx();
-        }
-        $this->hidden_input_qty = $this->max_attendees > 1;
-
-        $ticket_selector_row_html .= $this->ticketNameTableCell();
-        $ticket_selector_row_html .= $this->ticketPriceTableCell();
-        $ticket_selector_row_html .= EEH_HTML::td(
-            '',
-            '',
-            'tckt-slctr-tbl-td-qty cntr',
-            '',
-            'headers="quantity-' . $this->EVT_ID . '"'
-        );
-        $this->setTicketStatusDisplay($remaining);
-        if (empty($this->ticket_status_display)) {
-            $this->hidden_input_qty = false;
-            // display submit button since we have tickets available
-            add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-            if ($this->max_attendees === 1) {
-                // only ONE attendee is allowed to register at a time
-                $ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
-            } else {
-                $ticket_selector_row_html .= $this->max === 1 && $this->use_new_checkbox_selector
-                    ? $this->ticketCheckboxSelector()
-                    : $this->ticketQuantitySelector();
-            }
-        }
-        $ticket_selector_row_html .= $this->ticket_status_display;
-        $ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
-        $ticket_selector_row_html .= $this->ticket_details->display(
-            $this->ticket_price,
-            $remaining,
-            $this->cols
-        );
-        $ticket_selector_row_html .= EEH_HTML::tdx();
-        $ticket_selector_row_html .= EEH_HTML::trx();
-
-
-        $this->row++;
-        return $ticket_selector_row_html;
-    }
-
-
-    /**
-     * getTicketPriceDetails
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function setTicketPriceDetails()
-    {
-        $this->ticket_price = $this->tax_settings->prices_displayed_including_taxes
-            ? $this->ticket->get_ticket_total_with_taxes()
-            : $this->ticket->get_ticket_subtotal();
-        $this->ticket_bundle = false;
-        $ticket_min = $this->ticket->min();
-        // for ticket bundles, set min and max qty the same
-        if ($ticket_min !== 0 && $ticket_min === $this->ticket->max()) {
-            $this->ticket_price *= $ticket_min;
-            $this->ticket_bundle = true;
-        }
-        $this->ticket_price = apply_filters(
-            'FHEE__ticket_selector_chart_template__ticket_price',
-            $this->ticket_price,
-            $this->ticket
-        );
-    }
-
-
-    /**
-     * ticketNameTableCell
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketNameTableCell()
-    {
-        $html = EEH_HTML::td(
-            '',
-            '',
-            'tckt-slctr-tbl-td-name',
-            '',
-            'headers="details-' . $this->EVT_ID . '"'
-        );
-        $html .= EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
-        $html .= $this->ticket_details->getShowHideLinks();
-        if ($this->ticket->required()) {
-            $html .= EEH_HTML::p(
-                apply_filters(
-                    'FHEE__ticket_selector_chart_template__ticket_required_message',
-                    esc_html__('This ticket is required and must be purchased.', 'event_espresso')
-                ),
-                '',
-                'ticket-required-pg'
-            );
-        }
-        $html .= EEH_HTML::tdx();
-        return $html;
-    }
-
-
-    /**
-     * ticketPriceTableCell
-     *
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketPriceTableCell()
-    {
-        $html = '';
-        if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
-            $html .= EEH_HTML::td(
-                '',
-                '',
-                'tckt-slctr-tbl-td-price jst-rght',
-                '',
-                'headers="price-' . $this->EVT_ID . '"'
-            );
-            $html .= EEH_HTML::span(
-                EEH_Template::format_currency($this->ticket_price),
-                '',
-                'tckt-price--nowrap'
-            );
-            $html .= $this->ticket->taxable()
-                ? EEH_HTML::span('*', '', 'taxable-tickets-asterisk grey-text')
-                : '';
-            $html .= ' ';
-            // phpcs:disable WordPress.WP.I18n.NoEmptyStrings
-            $html .= EEH_HTML::span(
-                $this->ticket_bundle
-                    ? apply_filters(
-                        'FHEE__ticket_selector_chart_template__per_ticket_bundle_text',
-                        esc_html__(' / bundle', 'event_espresso')
-                    )
-                    : apply_filters(
-                        'FHEE__ticket_selector_chart_template__per_ticket_text',
-                        esc_html__('', 'event_espresso')
-                    ),
-                '',
-                'smaller-text no-bold'
-            );
-            $html .= ' ';
-            $html .= EEH_HTML::tdx();
-            $this->cols++;
-        }
-        return $html;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function onlyOneAttendeeCanRegister(): string
-    {
-        $TKT   = $this->ticket->ID();
-        $label = esc_html__('Select this ticket', 'event_espresso');
-        $name  = "tkt-slctr-qty-$this->EVT_ID";
-        $class = "ticket-selector-tbl-qty-slct";
-        $id    = "$class-$this->EVT_ID-$this->row";
-        $checked = $this->total_tickets === 1 ? ' checked' : '';
-
-        return "
+	/**
+	 * @var TicketDetails
+	 */
+	protected $ticket_details;
+
+	/**
+	 * @var EE_Ticket_Selector_Config
+	 */
+	protected $template_settings;
+
+	/**
+	 * @var EE_Tax_Config
+	 */
+	protected $tax_settings;
+
+	/**
+	 * @var boolean
+	 */
+	protected $prices_displayed_including_taxes;
+
+	/**
+	 * @var int
+	 */
+	protected $row;
+
+	/**
+	 * @var int
+	 */
+	protected $cols;
+
+	/**
+	 * @var boolean
+	 */
+	protected $hidden_input_qty = false;
+
+	/**
+	 * @var string
+	 */
+	protected $ticket_datetime_classes;
+
+	private bool $use_new_checkbox_selector;
+
+
+	/**
+	 * TicketDetails constructor.
+	 *
+	 * @param TicketDetails $ticket_details
+	 * @param EE_Tax_Config $tax_settings
+	 * @param int           $total_tickets
+	 * @param int           $max_attendees
+	 * @param int           $row
+	 * @param int           $cols
+	 * @param boolean       $required_ticket_sold_out
+	 * @param string        $event_status
+	 * @param string        $ticket_datetime_classes
+	 * @param bool          $use_new_checkbox_selector
+	 * @throws EE_Error
+	 * @throws UnexpectedEntityException
+	 */
+	public function __construct(
+		TicketDetails $ticket_details,
+		EE_Tax_Config $tax_settings,
+		$total_tickets,
+		$max_attendees,
+		$row,
+		$cols,
+		$required_ticket_sold_out,
+		$event_status,
+		$ticket_datetime_classes,
+		bool $use_new_checkbox_selector = false
+	) {
+		$this->ticket_details = $ticket_details;
+		$this->template_settings = $ticket_details->getTemplateSettings();
+		$this->tax_settings = $tax_settings;
+		$this->row = $row;
+		$this->cols = $cols;
+		$this->ticket_datetime_classes = $ticket_datetime_classes;
+		$this->use_new_checkbox_selector = $use_new_checkbox_selector;
+		parent::__construct(
+			$ticket_details->getTicket(),
+			$max_attendees,
+			$ticket_details->getDateFormat(),
+			$event_status,
+			$required_ticket_sold_out,
+			$total_tickets
+		);
+	}
+
+
+	/**
+	 * other ticket rows will need to know if a required ticket is sold out,
+	 * so that they are not offered for sale
+	 *
+	 * @return boolean
+	 */
+	public function getRequiredTicketSoldOut()
+	{
+		return $this->required_ticket_sold_out;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getCols()
+	{
+		return $this->cols;
+	}
+
+
+	/**
+	 * getHtml
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getHtml()
+	{
+		$this->min = 0;
+		$this->max = $this->ticket->max();
+		$remaining = $this->ticket->remaining();
+		$this->setTicketMinAndMax($remaining);
+		// set flag if ticket is required (flag is set to start date so that future tickets are not blocked)
+		$this->required_ticket_sold_out = $this->ticket->required() && ! $remaining
+			? $this->ticket->start_date()
+			: $this->required_ticket_sold_out;
+		$this->setTicketPriceDetails();
+		$this->setTicketStatusClasses($remaining);
+		$filtered_row_html = $this->getFilteredRowHtml();
+		if ($filtered_row_html !== false) {
+			return $filtered_row_html;
+		}
+		$ticket_selector_row_html = EEH_HTML::tr(
+			'',
+			'',
+			"tckt-slctr-tbl-tr {$this->status_class}{$this->ticket_datetime_classes} "
+			. espresso_get_object_css_class($this->ticket)
+		);
+		$filtered_row_content = $this->getFilteredRowContents();
+		if ($filtered_row_content !== false) {
+			if ($this->max_attendees === 1) {
+				return $ticket_selector_row_html
+					   . $filtered_row_content
+					   . $this->ticketQtyAndIdHiddenInputs()
+					   . EEH_HTML::trx();
+			}
+			return $ticket_selector_row_html
+				   . $filtered_row_content
+				   . EEH_HTML::trx();
+		}
+		$this->hidden_input_qty = $this->max_attendees > 1;
+
+		$ticket_selector_row_html .= $this->ticketNameTableCell();
+		$ticket_selector_row_html .= $this->ticketPriceTableCell();
+		$ticket_selector_row_html .= EEH_HTML::td(
+			'',
+			'',
+			'tckt-slctr-tbl-td-qty cntr',
+			'',
+			'headers="quantity-' . $this->EVT_ID . '"'
+		);
+		$this->setTicketStatusDisplay($remaining);
+		if (empty($this->ticket_status_display)) {
+			$this->hidden_input_qty = false;
+			// display submit button since we have tickets available
+			add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+			if ($this->max_attendees === 1) {
+				// only ONE attendee is allowed to register at a time
+				$ticket_selector_row_html .= $this->onlyOneAttendeeCanRegister();
+			} else {
+				$ticket_selector_row_html .= $this->max === 1 && $this->use_new_checkbox_selector
+					? $this->ticketCheckboxSelector()
+					: $this->ticketQuantitySelector();
+			}
+		}
+		$ticket_selector_row_html .= $this->ticket_status_display;
+		$ticket_selector_row_html .= $this->ticketQtyAndIdHiddenInputs();
+		$ticket_selector_row_html .= $this->ticket_details->display(
+			$this->ticket_price,
+			$remaining,
+			$this->cols
+		);
+		$ticket_selector_row_html .= EEH_HTML::tdx();
+		$ticket_selector_row_html .= EEH_HTML::trx();
+
+
+		$this->row++;
+		return $ticket_selector_row_html;
+	}
+
+
+	/**
+	 * getTicketPriceDetails
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function setTicketPriceDetails()
+	{
+		$this->ticket_price = $this->tax_settings->prices_displayed_including_taxes
+			? $this->ticket->get_ticket_total_with_taxes()
+			: $this->ticket->get_ticket_subtotal();
+		$this->ticket_bundle = false;
+		$ticket_min = $this->ticket->min();
+		// for ticket bundles, set min and max qty the same
+		if ($ticket_min !== 0 && $ticket_min === $this->ticket->max()) {
+			$this->ticket_price *= $ticket_min;
+			$this->ticket_bundle = true;
+		}
+		$this->ticket_price = apply_filters(
+			'FHEE__ticket_selector_chart_template__ticket_price',
+			$this->ticket_price,
+			$this->ticket
+		);
+	}
+
+
+	/**
+	 * ticketNameTableCell
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketNameTableCell()
+	{
+		$html = EEH_HTML::td(
+			'',
+			'',
+			'tckt-slctr-tbl-td-name',
+			'',
+			'headers="details-' . $this->EVT_ID . '"'
+		);
+		$html .= EEH_HTML::strong($this->ticket->get_pretty('TKT_name'));
+		$html .= $this->ticket_details->getShowHideLinks();
+		if ($this->ticket->required()) {
+			$html .= EEH_HTML::p(
+				apply_filters(
+					'FHEE__ticket_selector_chart_template__ticket_required_message',
+					esc_html__('This ticket is required and must be purchased.', 'event_espresso')
+				),
+				'',
+				'ticket-required-pg'
+			);
+		}
+		$html .= EEH_HTML::tdx();
+		return $html;
+	}
+
+
+	/**
+	 * ticketPriceTableCell
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketPriceTableCell()
+	{
+		$html = '';
+		if (apply_filters('FHEE__ticket_selector_chart_template__display_ticket_price_details', true)) {
+			$html .= EEH_HTML::td(
+				'',
+				'',
+				'tckt-slctr-tbl-td-price jst-rght',
+				'',
+				'headers="price-' . $this->EVT_ID . '"'
+			);
+			$html .= EEH_HTML::span(
+				EEH_Template::format_currency($this->ticket_price),
+				'',
+				'tckt-price--nowrap'
+			);
+			$html .= $this->ticket->taxable()
+				? EEH_HTML::span('*', '', 'taxable-tickets-asterisk grey-text')
+				: '';
+			$html .= ' ';
+			// phpcs:disable WordPress.WP.I18n.NoEmptyStrings
+			$html .= EEH_HTML::span(
+				$this->ticket_bundle
+					? apply_filters(
+						'FHEE__ticket_selector_chart_template__per_ticket_bundle_text',
+						esc_html__(' / bundle', 'event_espresso')
+					)
+					: apply_filters(
+						'FHEE__ticket_selector_chart_template__per_ticket_text',
+						esc_html__('', 'event_espresso')
+					),
+				'',
+				'smaller-text no-bold'
+			);
+			$html .= ' ';
+			$html .= EEH_HTML::tdx();
+			$this->cols++;
+		}
+		return $html;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function onlyOneAttendeeCanRegister(): string
+	{
+		$TKT   = $this->ticket->ID();
+		$label = esc_html__('Select this ticket', 'event_espresso');
+		$name  = "tkt-slctr-qty-$this->EVT_ID";
+		$class = "ticket-selector-tbl-qty-slct";
+		$id    = "$class-$this->EVT_ID-$this->row";
+		$checked = $this->total_tickets === 1 ? ' checked' : '';
+
+		return "
         <label class='ee-a11y-screen-reader-text' for='$id' >$label</label>
         <input type='radio'$checked name='$name' id='$id' class='$class' value='$TKT-1' />";
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketCheckboxSelector(): string
-    {
-        $TKT = $this->ticket->ID();
-        $label = esc_html__('Select this ticket', 'event_espresso');
-        $name  = "tkt-slctr-qty-$this->EVT_ID[$TKT]";
-        $class = 'ticket-selector-tbl-qty-slct';
-        $id    = "$class-$this->EVT_ID-$this->row";
-        $title = esc_html__('only one of this ticket can be purchased at a time', 'event_espresso');
-
-        return "
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketCheckboxSelector(): string
+	{
+		$TKT = $this->ticket->ID();
+		$label = esc_html__('Select this ticket', 'event_espresso');
+		$name  = "tkt-slctr-qty-$this->EVT_ID[$TKT]";
+		$class = 'ticket-selector-tbl-qty-slct';
+		$id    = "$class-$this->EVT_ID-$this->row";
+		$title = esc_html__('only one of this ticket can be purchased at a time', 'event_espresso');
+
+		return "
         <label class='ee-a11y-screen-reader-text' for='$id' >$label</label>
         <input type='checkbox' name='$name' id='$id' class='$class' value='1' title='$title'/>";
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketQuantitySelector(): string
-    {
-        $TKT = $this->ticket->ID();
-        $label = esc_html__('Quantity', 'event_espresso');
-        $name  = "tkt-slctr-qty-$this->EVT_ID[$TKT]";
-        $class = 'ticket-selector-tbl-qty-slct';
-        $id = "$class-{$this->EVT_ID}-{$this->row}";
-
-        $html = "<label class='ee-a11y-screen-reader-text' for='$id' >$label</label>";
-        $html .= "<select name='$name' id='$id' class='$class'>";
-        // this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
-        if ($this->min !== 0 && ! $this->ticket->required()) {
-            $html .= "<option value='0'>&nbsp;0&nbsp;</option>";
-        }
-        // offer ticket quantities from the min to the max
-        for ($i = $this->min; $i <= $this->max; $i++) {
-            $html .= "<option value='$i'>&nbsp;$i&nbsp;</option>";
-        }
-        $html .= "</select>";
-        return $html;
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function ticketQtyAndIdHiddenInputs(): string
-    {
-        $html = '';
-        $EVT = $this->EVT_ID;
-        $TKT = $this->ticket->ID();
-        // depending on group reg we need to change the format for qty
-        if ($this->hidden_input_qty) {
-            $html .= "<input type='hidden' name='tkt-slctr-qty-{$EVT}[]' value='0' />";
-        }
-        $html .= "<input type='hidden' name='tkt-slctr-ticket-id-{$EVT}[]' value='{$TKT}' />";
-        return $html;
-    }
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketQuantitySelector(): string
+	{
+		$TKT = $this->ticket->ID();
+		$label = esc_html__('Quantity', 'event_espresso');
+		$name  = "tkt-slctr-qty-$this->EVT_ID[$TKT]";
+		$class = 'ticket-selector-tbl-qty-slct';
+		$id = "$class-{$this->EVT_ID}-{$this->row}";
+
+		$html = "<label class='ee-a11y-screen-reader-text' for='$id' >$label</label>";
+		$html .= "<select name='$name' id='$id' class='$class'>";
+		// this ensures that non-required tickets with non-zero MIN QTYs don't HAVE to be purchased
+		if ($this->min !== 0 && ! $this->ticket->required()) {
+			$html .= "<option value='0'>&nbsp;0&nbsp;</option>";
+		}
+		// offer ticket quantities from the min to the max
+		for ($i = $this->min; $i <= $this->max; $i++) {
+			$html .= "<option value='$i'>&nbsp;$i&nbsp;</option>";
+		}
+		$html .= "</select>";
+		return $html;
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function ticketQtyAndIdHiddenInputs(): string
+	{
+		$html = '';
+		$EVT = $this->EVT_ID;
+		$TKT = $this->ticket->ID();
+		// depending on group reg we need to change the format for qty
+		if ($this->hidden_input_qty) {
+			$html .= "<input type='hidden' name='tkt-slctr-qty-{$EVT}[]' value='0' />";
+		}
+		$html .= "<input type='hidden' name='tkt-slctr-ticket-id-{$EVT}[]' value='{$TKT}' />";
+		return $html;
+	}
 }

modules/ticket_sales_monitor/EED_Ticket_Sales_Monitor.module.php

Indentation +1074 added lines, -1074 removed lines

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

Spacing +80 added lines, -80 removed lines

@@ -19,7 +19,7 @@ 
  */
 class EED_Ticket_Sales_Monitor extends EED_Module
 {
-    const debug = false;    // true false
+    const debug = false; // true false
 
     private static $nl = '';
 
@@ -169,7 +169,7 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'()';
         }
         do_action('AHEE__EED_Ticket_Sales_Monitor__release_tickets_for_expired_carts__begin');
         $expired_ticket_IDs = array();
@@ -180,29 +180,29 @@ 
         $timestamp = $session_lifespan->expiration();
         $expired_ticket_line_items = EEM_Line_Item::instance()->getTicketLineItemsForExpiredCarts($timestamp);
         if (self::debug) {
-            echo self::$nl . ' . time(): ' . time();
-            echo self::$nl . ' . time() as date: ' . date('Y-m-d H:i a');
-            echo self::$nl . ' . session expiration: ' . $session_lifespan->expiration();
-            echo self::$nl . ' . session expiration as date: ' . date('Y-m-d H:i a', $session_lifespan->expiration());
-            echo self::$nl . ' . timestamp: ' . $timestamp;
-            echo self::$nl . ' . $expired_ticket_line_items: ' . count($expired_ticket_line_items);
+            echo self::$nl.' . time(): '.time();
+            echo self::$nl.' . time() as date: '.date('Y-m-d H:i a');
+            echo self::$nl.' . session expiration: '.$session_lifespan->expiration();
+            echo self::$nl.' . session expiration as date: '.date('Y-m-d H:i a', $session_lifespan->expiration());
+            echo self::$nl.' . timestamp: '.$timestamp;
+            echo self::$nl.' . $expired_ticket_line_items: '.count($expired_ticket_line_items);
         }
-        if (! empty($expired_ticket_line_items)) {
+        if ( ! empty($expired_ticket_line_items)) {
             foreach ($expired_ticket_line_items as $expired_ticket_line_item) {
-                if (! $expired_ticket_line_item instanceof EE_Line_Item) {
+                if ( ! $expired_ticket_line_item instanceof EE_Line_Item) {
                     continue;
                 }
-                $expired_ticket_IDs[ $expired_ticket_line_item->OBJ_ID() ] = $expired_ticket_line_item->OBJ_ID();
+                $expired_ticket_IDs[$expired_ticket_line_item->OBJ_ID()] = $expired_ticket_line_item->OBJ_ID();
                 if (self::debug) {
-                    echo self::$nl . ' . $expired_ticket_line_item->OBJ_ID(): ' . $expired_ticket_line_item->OBJ_ID();
-                    echo self::$nl . ' . $expired_ticket_line_item->timestamp(): '
+                    echo self::$nl.' . $expired_ticket_line_item->OBJ_ID(): '.$expired_ticket_line_item->OBJ_ID();
+                    echo self::$nl.' . $expired_ticket_line_item->timestamp(): '
                          . date(
                              'Y-m-d h:i a',
                              $expired_ticket_line_item->timestamp(true)
                          );
                 }
             }
-            if (! empty($expired_ticket_IDs)) {
+            if ( ! empty($expired_ticket_IDs)) {
                 EED_Ticket_Sales_Monitor::release_reservations_for_tickets(
                     EEM_Ticket::instance()->get_tickets_with_IDs($expired_ticket_IDs),
                     array(),
@@ -242,8 +242,8 @@ 
         }
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '()';
-            echo self::$nl . self::$nl . '<b> RETURNED QTY: ' . $qty . '</b>';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'()';
+            echo self::$nl.self::$nl.'<b> RETURNED QTY: '.$qty.'</b>';
         }
         return $qty;
     }
@@ -263,36 +263,36 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
-        if (! $ticket instanceof EE_Ticket) {
+        if ( ! $ticket instanceof EE_Ticket) {
             return 0;
         }
         if (self::debug) {
-            echo self::$nl . '<b> . ticket->ID: ' . $ticket->ID() . '</b>';
-            echo self::$nl . ' . original ticket->reserved: ' . $ticket->reserved();
+            echo self::$nl.'<b> . ticket->ID: '.$ticket->ID().'</b>';
+            echo self::$nl.' . original ticket->reserved: '.$ticket->reserved();
         }
         $ticket->refresh_from_db();
         // first let's determine the ticket availability based on sales
         $available = $ticket->qty('saleable');
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->qty: ' . $ticket->qty();
-            echo self::$nl . ' . . . ticket->sold: ' . $ticket->sold();
-            echo self::$nl . ' . . . ticket->reserved: ' . $ticket->reserved();
-            echo self::$nl . ' . . . ticket->qty(saleable): ' . $ticket->qty('saleable');
-            echo self::$nl . ' . . . available: ' . $available;
+            echo self::$nl.' . . . ticket->qty: '.$ticket->qty();
+            echo self::$nl.' . . . ticket->sold: '.$ticket->sold();
+            echo self::$nl.' . . . ticket->reserved: '.$ticket->reserved();
+            echo self::$nl.' . . . ticket->qty(saleable): '.$ticket->qty('saleable');
+            echo self::$nl.' . . . available: '.$available;
         }
         if ($available < 1) {
             $this->_ticket_sold_out($ticket);
             return 0;
         }
         if (self::debug) {
-            echo self::$nl . ' . . . qty: ' . $qty;
+            echo self::$nl.' . . . qty: '.$qty;
         }
         if ($available < $qty) {
             $qty = $available;
             if (self::debug) {
-                echo self::$nl . ' . . . QTY ADJUSTED: ' . $qty;
+                echo self::$nl.' . . . QTY ADJUSTED: '.$qty;
             }
             $this->_ticket_quantity_decremented($ticket);
         }
@@ -316,9 +316,9 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . ' . . . INCREASE RESERVED: ' . $quantity;
+            echo self::$nl.self::$nl.' . . . INCREASE RESERVED: '.$quantity;
         }
-        return $ticket->increaseReserved($quantity, 'TicketSalesMonitor:' . __LINE__);
+        return $ticket->increaseReserved($quantity, 'TicketSalesMonitor:'.__LINE__);
     }
 
 
@@ -333,12 +333,12 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->ID: ' . $ticket->ID();
-            echo self::$nl . ' . . . ticket->reserved before: ' . $ticket->reserved();
+            echo self::$nl.' . . . ticket->ID: '.$ticket->ID();
+            echo self::$nl.' . . . ticket->reserved before: '.$ticket->reserved();
         }
-        $ticket->decreaseReserved($quantity, true, 'TicketSalesMonitor:' . __LINE__);
+        $ticket->decreaseReserved($quantity, true, 'TicketSalesMonitor:'.__LINE__);
         if (self::debug) {
-            echo self::$nl . ' . . . ticket->reserved after: ' . $ticket->reserved();
+            echo self::$nl.' . . . ticket->reserved after: '.$ticket->reserved();
         }
         return (bool) $ticket->save();
     }
@@ -357,8 +357,8 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->sold_out_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -377,8 +377,8 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . ticket->name: ' . $this->_get_ticket_and_event_name($ticket);
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . ticket->name: '.$this->_get_ticket_and_event_name($ticket);
         }
         $this->decremented_tickets[] = $this->_get_ticket_and_event_name($ticket);
     }
@@ -432,7 +432,7 @@ 
             if (self::debug) {
                 $ticket->add_extra_meta(
                     EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                    __LINE__ . ') ' . __METHOD__ . '()'
+                    __LINE__.') '.__METHOD__.'()'
                 );
             }
             if ($quantity > 0) {
@@ -458,7 +458,7 @@ 
         if (self::debug) {
             $ticket->add_extra_meta(
                 EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                __LINE__ . ') ' . __METHOD__ . '()'
+                __LINE__.') '.__METHOD__.'()'
             );
         }
         EED_Ticket_Sales_Monitor::instance()->_release_reserved_ticket($ticket, $quantity);
@@ -492,7 +492,7 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         $refresh_msg = '';
         $none_added_msg = '';
@@ -503,7 +503,7 @@ 
             );
             $none_added_msg = esc_html__('No tickets were added for the event.', 'event_espresso');
         }
-        if (! empty($this->sold_out_tickets)) {
+        if ( ! empty($this->sold_out_tickets)) {
             EE_Error::add_attention(
                 sprintf(
                     apply_filters(
@@ -526,7 +526,7 @@ 
             // and reset the cart
             EED_Ticket_Sales_Monitor::session_cart_reset(EE_Registry::instance()->SSN);
         }
-        if (! empty($this->decremented_tickets)) {
+        if ( ! empty($this->decremented_tickets)) {
             EE_Error::add_attention(
                 sprintf(
                     apply_filters(
@@ -564,9 +564,9 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . transaction->ID: ' . $transaction->ID();
-            echo self::$nl . ' . TXN status_ID: ' . $transaction->status_ID();
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . transaction->ID: '.$transaction->ID();
+            echo self::$nl.' . TXN status_ID: '.$transaction->status_ID();
         }
         // check if 'finalize_registration' step has been completed...
         $finalized = $transaction->reg_step_completed('finalize_registration');
@@ -578,13 +578,13 @@ 
                 __LINE__,
                 array('finalized' => $finalized),
                 false,
-                'EE_Transaction: ' . $transaction->ID()
+                'EE_Transaction: '.$transaction->ID()
             );
         }
         // how many tickets were released
         $count = 0;
         if (self::debug) {
-            echo self::$nl . ' . . . TXN finalized: ' . $finalized;
+            echo self::$nl.' . . . TXN finalized: '.$finalized;
         }
         $release_tickets_with_TXN_status = array(
             EEM_Transaction::failed_status_code,
@@ -593,28 +593,28 @@ 
         );
         $events = array();
         // if the session is getting cleared BEFORE the TXN has been finalized or the transaction is not completed
-        if (! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
+        if ( ! $finalized || in_array($transaction->status_ID(), $release_tickets_with_TXN_status, true)) {
             // cancel any reserved tickets for registrations that were not approved
             $registrations = $transaction->registrations();
             if (self::debug) {
-                echo self::$nl . ' . . . # registrations: ' . count($registrations);
+                echo self::$nl.' . . . # registrations: '.count($registrations);
                 $reg = reset($registrations);
                 $ticket = $reg->ticket();
                 if ($ticket instanceof EE_Ticket) {
                     $ticket->add_extra_meta(
                         EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') Release All Tickets TXN:' . $transaction->ID()
+                        __LINE__.') Release All Tickets TXN:'.$transaction->ID()
                     );
                 }
             }
-            if (! empty($registrations)) {
+            if ( ! empty($registrations)) {
                 foreach ($registrations as $registration) {
                     if (
                         $registration instanceof EE_Registration
                         && $this->_release_reserved_ticket_for_registration($registration, $transaction)
                     ) {
                         $count++;
-                        $events[ $registration->event_ID() ] = $registration->event();
+                        $events[$registration->event_ID()] = $registration->event();
                     }
                 }
             }
@@ -646,10 +646,10 @@ 
         $STS_ID = $transaction->status_ID();
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
-            echo self::$nl . ' . . registration->ID: ' . $registration->ID();
-            echo self::$nl . ' . . registration->status_ID: ' . $registration->status_ID();
-            echo self::$nl . ' . . transaction->status_ID(): ' . $STS_ID;
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
+            echo self::$nl.' . . registration->ID: '.$registration->ID();
+            echo self::$nl.' . . registration->status_ID: '.$registration->status_ID();
+            echo self::$nl.' . . transaction->status_ID(): '.$STS_ID;
         }
         if (
 // release Tickets for Failed Transactions and Abandoned Transactions
@@ -662,12 +662,12 @@ 
             )
         ) {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' . . RELEASE RESERVED TICKET';
+                echo self::$nl.self::$nl.' . . RELEASE RESERVED TICKET';
                 $reserved = $registration->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true);
-                echo self::$nl . ' . . . registration HAS_RESERVED_TICKET_KEY: ';
+                echo self::$nl.' . . . registration HAS_RESERVED_TICKET_KEY: ';
                 var_dump($reserved);
             }
-            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:' . __LINE__);
+            $registration->release_reserved_ticket(true, 'TicketSalesMonitor:'.__LINE__);
             return 1;
         }
         return 0;
@@ -697,7 +697,7 @@ 
         }
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         // first check of the session has a valid Checkout object
         $checkout = $session->checkout();
@@ -709,12 +709,12 @@ 
         $cart = $session->cart();
         if ($cart instanceof EE_Cart) {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' cart instance of EE_Cart: ';
+                echo self::$nl.self::$nl.' cart instance of EE_Cart: ';
             }
             EED_Ticket_Sales_Monitor::instance()->_session_cart_reset($cart, $session);
         } else {
             if (self::debug) {
-                echo self::$nl . self::$nl . ' invalid EE_Cart: ';
+                echo self::$nl.self::$nl.' invalid EE_Cart: ';
                 echo var_export($cart, true);
             }
         }
@@ -737,31 +737,31 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         $ticket_line_items = $cart->get_tickets();
         if (empty($ticket_line_items)) {
             return;
         }
         if (self::debug) {
-            echo '<br /> . ticket_line_item count: ' . count($ticket_line_items);
+            echo '<br /> . ticket_line_item count: '.count($ticket_line_items);
         }
         foreach ($ticket_line_items as $ticket_line_item) {
             if (self::debug) {
-                echo self::$nl . ' . ticket_line_item->ID(): ' . $ticket_line_item->ID();
+                echo self::$nl.' . ticket_line_item->ID(): '.$ticket_line_item->ID();
             }
             if ($ticket_line_item instanceof EE_Line_Item && $ticket_line_item->OBJ_type() === 'Ticket') {
                 if (self::debug) {
-                    echo self::$nl . ' . . ticket_line_item->OBJ_ID(): ' . $ticket_line_item->OBJ_ID();
+                    echo self::$nl.' . . ticket_line_item->OBJ_ID(): '.$ticket_line_item->OBJ_ID();
                 }
                 $ticket = EEM_Ticket::instance()->get_one_by_ID($ticket_line_item->OBJ_ID());
                 if ($ticket instanceof EE_Ticket) {
                     if (self::debug) {
-                        echo self::$nl . ' . . ticket->ID(): ' . $ticket->ID();
-                        echo self::$nl . ' . . ticket_line_item->quantity(): ' . $ticket_line_item->quantity();
+                        echo self::$nl.' . . ticket->ID(): '.$ticket->ID();
+                        echo self::$nl.' . . ticket_line_item->quantity(): '.$ticket_line_item->quantity();
                         $ticket->add_extra_meta(
                             EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                            __LINE__ . ') ' . __METHOD__ . '() SID = ' . $session->id()
+                            __LINE__.') '.__METHOD__.'() SID = '.$session->id()
                         );
                     }
                     $this->_release_reserved_ticket($ticket, $ticket_line_item->quantity());
@@ -769,7 +769,7 @@ 
             }
         }
         if (self::debug) {
-            echo self::$nl . self::$nl . ' RESET COMPLETED ';
+            echo self::$nl.self::$nl.' RESET COMPLETED ';
         }
     }
 
@@ -811,7 +811,7 @@ 
     {
         // self::debug hardcoded to false
         if (self::debug) {
-            echo self::$nl . self::$nl . __LINE__ . ') ' . __METHOD__ . '() ';
+            echo self::$nl.self::$nl.__LINE__.') '.__METHOD__.'() ';
         }
         // we want to release the each registration's reserved tickets if the session was cleared, but not if this is a revisit
         if ($checkout->revisit || ! $checkout->transaction instanceof EE_Transaction) {
@@ -860,7 +860,7 @@ 
                     __LINE__,
                     array($transaction),
                     false,
-                    'EE_Transaction: ' . $transaction->ID()
+                    'EE_Transaction: '.$transaction->ID()
                 );
             }
             return;
@@ -877,7 +877,7 @@ 
                         __LINE__,
                         array($payment),
                         false,
-                        'EE_Transaction: ' . $transaction->ID()
+                        'EE_Transaction: '.$transaction->ID()
                     );
                 }
                 return;
@@ -939,7 +939,7 @@ 
             }
             $total_line_item = $transaction->total_line_item();
             // $transaction_in_progress->line
-            if (! $total_line_item instanceof EE_Line_Item) {
+            if ( ! $total_line_item instanceof EE_Line_Item) {
                 throw new DomainException(
                     esc_html__(
                         'Transaction does not have a valid Total Line Item associated with it.',
@@ -979,7 +979,7 @@ 
         $ticket_line_items = EEH_Line_Item::get_ticket_line_items($total_line_item);
         foreach ($ticket_line_items as $ticket_line_item) {
             if ($ticket_line_item instanceof EE_Line_Item) {
-                $valid_reserved_tickets[ $ticket_line_item->ID() ] = $ticket_line_item;
+                $valid_reserved_tickets[$ticket_line_item->ID()] = $ticket_line_item;
             }
         }
         return $valid_reserved_tickets;
@@ -1016,7 +1016,7 @@ 
         $total_tickets_released = 0;
         $sold_out_events = array();
         foreach ($tickets_with_reservations as $ticket_with_reservations) {
-            if (! $ticket_with_reservations instanceof EE_Ticket) {
+            if ( ! $ticket_with_reservations instanceof EE_Ticket) {
                 continue;
             }
             // The $valid_reserved_ticket_line_items tells us what the reserved count on their tickets (and datetimes)
@@ -1039,10 +1039,10 @@ 
                 if (self::debug) {
                     $ticket_with_reservations->add_extra_meta(
                         EE_Ticket::META_KEY_TICKET_RESERVATIONS,
-                        __LINE__ . ') ' . $source . '()'
+                        __LINE__.') '.$source.'()'
                     );
                 }
-                $ticket_with_reservations->decreaseReserved($expired_reservations_count, true, 'TicketSalesMonitor:' . __LINE__);
+                $ticket_with_reservations->decreaseReserved($expired_reservations_count, true, 'TicketSalesMonitor:'.__LINE__);
                 $total_tickets_released += $expired_reservations_count;
                 $event = $ticket_with_reservations->get_related_event();
                 // track sold out events
@@ -1079,7 +1079,7 @@ 
     {
         /** @type WPDB $wpdb */
         global $wpdb;
-        if (! absint($timestamp)) {
+        if ( ! absint($timestamp)) {
             /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
             $session_lifespan = LoaderFactory::getLoader()->getShared(
                 'EventEspresso\core\domain\values\session\SessionLifespan'
@@ -1088,7 +1088,7 @@ 
         }
         return $wpdb->query(
             $wpdb->prepare(
-                'DELETE FROM ' . EEM_Line_Item::instance()->table() . '
+                'DELETE FROM '.EEM_Line_Item::instance()->table().'
                 WHERE TXN_ID = 0 AND LIN_timestamp <= %s',
                 // use GMT time because that's what LIN_timestamps are in
                 date('Y-m-d H:i:s', $timestamp)

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1658 added lines, -1658 removed lines

@@ -24,1662 +24,1662 @@
  */
 class EED_Single_Page_Checkout extends EED_Module
 {
-    /**
-     * $_initialized - has the SPCO controller already been initialized ?
-     */
-    private static bool $_initialized = false;
-
-
-    /**
-     * $_checkout_verified - is the EE_Checkout verified as correct for this request ?
-     */
-    private static bool $_checkout_verified = true;
-
-    /**
-     * $_reg_steps_array - holds initial array of reg steps
-     *
-     * @var array $_reg_steps_array
-     */
-    private static array $_reg_steps_array = [];
-
-    /**
-     * $checkout - EE_Checkout object for handling the properties of the current checkout process
-     */
-    public ?EE_Checkout $checkout = null;
-
-    protected ?RequestInterface $request = null;
-
-    public ?EE_Session $session = null;
-
-    private bool $debug = false;    //  true    false
-
-
-    /**
-     * @return EED_Single_Page_Checkout|EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance()
-    {
-        add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true');
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * @return EE_CART
-     */
-    public function cart(): EE_CART
-    {
-        return $this->checkout->cart;
-    }
-
-
-    /**
-     * @return RequestInterface
-     * @since   4.10.14.p
-     */
-    public static function getRequest(): RequestInterface
-    {
-        return LoaderFactory::getLoader()->getShared(RequestInterface::class);
-    }
-
-
-    /**
-     * @return EE_Transaction
-     */
-    public function transaction(): EE_Transaction
-    {
-        return $this->checkout->transaction;
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function set_hooks()
-    {
-        EED_Single_Page_Checkout::set_definitions();
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function set_hooks_admin()
-    {
-        EED_Single_Page_Checkout::set_definitions();
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
-            return;
-        }
-        // going to start an output buffer in case anything gets accidentally output
-        // that might disrupt our JSON response
-        ob_start();
-        EED_Single_Page_Checkout::load_reg_steps();
-        // set ajax hooks
-        add_action('wp_ajax_process_reg_step', ['EED_Single_Page_Checkout', 'process_reg_step']);
-        add_action('wp_ajax_nopriv_process_reg_step', ['EED_Single_Page_Checkout', 'process_reg_step']);
-        add_action('wp_ajax_display_spco_reg_step', ['EED_Single_Page_Checkout', 'display_reg_step']);
-        add_action('wp_ajax_nopriv_display_spco_reg_step', ['EED_Single_Page_Checkout', 'display_reg_step']);
-        add_action('wp_ajax_update_reg_step', ['EED_Single_Page_Checkout', 'update_reg_step']);
-        add_action('wp_ajax_nopriv_update_reg_step', ['EED_Single_Page_Checkout', 'update_reg_step']);
-    }
-
-
-    /**
-     *    process ajax request
-     *
-     * @param string $ajax_action
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function process_ajax_request(string $ajax_action)
-    {
-        $request = EED_Single_Page_Checkout::getRequest();
-        $request->setRequestParam('action', $ajax_action);
-        EED_Single_Page_Checkout::instance()->_initialize();
-    }
-
-
-    /**
-     * ajax display registration step
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function display_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step');
-    }
-
-
-    /**
-     * ajax process registration step
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function process_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('process_reg_step');
-    }
-
-
-    /**
-     * ajax process registration step
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function update_reg_step()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('update_reg_step');
-    }
-
-
-    /**
-     * update_checkout
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public static function update_checkout()
-    {
-        EED_Single_Page_Checkout::process_ajax_request('update_checkout');
-    }
-
-
-    /**
-     *    set_definitions
-     *
-     * @return    void
-     * @throws EE_Error
-     */
-    public static function set_definitions()
-    {
-        if (defined('SPCO_BASE_PATH')) {
-            return;
-        }
-        define(
-            'SPCO_BASE_PATH',
-            rtrim(str_replace(['\\', '/'], '/', plugin_dir_path(__FILE__)), '/') . '/'
-        );
-        define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css/');
-        define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img/');
-        define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js/');
-        define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc/');
-        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps/');
-        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates/');
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] =
-            EED_Single_Page_Checkout::getRegistrationExpirationNotice();
-    }
-
-
-    /**
-     * load_reg_steps
-     * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
-     *
-     * @throws EE_Error
-     */
-    public static function load_reg_steps()
-    {
-        static $reg_steps_loaded = false;
-        if ($reg_steps_loaded) {
-            return;
-        }
-        // filter list of reg_steps
-        $reg_steps_to_load = (array) apply_filters(
-            'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
-            EED_Single_Page_Checkout::get_reg_steps()
-        );
-        // sort by key (order)
-        ksort($reg_steps_to_load);
-        // loop through folders
-        foreach ($reg_steps_to_load as $order => $reg_step) {
-            // we need a
-            if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
-                // copy over to the reg_steps_array
-                EED_Single_Page_Checkout::$_reg_steps_array[ $order ] = $reg_step;
-                // register custom key route for each reg step
-                // ie: step=>"slug" - this is the entire reason we load the reg steps array now
-                EED_Module::registerRoute(
-                    $reg_step['slug'],
-                    'EED_Single_Page_Checkout',
-                    'run',
-                    'step'
-                );
-                // add AJAX or other hooks
-                if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
-                    // setup autoloaders if necessary
-                    if (! class_exists($reg_step['class_name'])) {
-                        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
-                            $reg_step['file_path'],
-                            true
-                        );
-                    }
-                    if (is_callable($reg_step['class_name'], 'set_hooks')) {
-                        call_user_func([$reg_step['class_name'], 'set_hooks']);
-                    }
-                }
-            }
-        }
-        $reg_steps_loaded = true;
-    }
-
-
-    /**
-     *    get_reg_steps
-     *
-     * @return    array
-     */
-    public static function get_reg_steps(): array
-    {
-        $reg_steps = EE_Registry::instance()->CFG->registration->reg_steps;
-        if (empty($reg_steps)) {
-            $reg_steps = [
-                10  => [
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
-                    'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
-                    'slug'       => 'attendee_information',
-                    'has_hooks'  => false,
-                ],
-                30  => [
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
-                    'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
-                    'slug'       => 'payment_options',
-                    'has_hooks'  => true,
-                ],
-                999 => [
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
-                    'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
-                    'slug'       => 'finalize_registration',
-                    'has_hooks'  => false,
-                ],
-            ];
-        }
-        return $reg_steps;
-    }
-
-
-    /**
-     * @return array|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function registration_checkout_for_admin()
-    {
-        $request = EED_Single_Page_Checkout::getRequest();
-        $request->setRequestParam('step', 'attendee_information');
-        $request->setRequestParam('action', 'display_spco_reg_step');
-        $request->setRequestParam('process_form_submission', false);
-        EED_Single_Page_Checkout::instance()->_initialize();
-        EED_Single_Page_Checkout::instance()->_display_spco_reg_form();
-        return EED_Single_Page_Checkout::getResponse()->getOutput();
-    }
-
-
-    /**
-     * @return EE_Transaction|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function process_registration_from_admin(): ?EE_Transaction
-    {
-        $request = EED_Single_Page_Checkout::getRequest();
-        $request->setRequestParam('step', 'attendee_information');
-        $request->setRequestParam('action', 'process_reg_step');
-        $request->setRequestParam('process_form_submission', true);
-        EED_Single_Page_Checkout::instance()->_initialize();
-        if (EED_Single_Page_Checkout::instance()->checkout->current_step->completed()) {
-            $final_reg_step = end(EED_Single_Page_Checkout::instance()->checkout->reg_steps);
-            if ($final_reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
-                EED_Single_Page_Checkout::instance()->checkout->set_reg_step_initiated($final_reg_step);
-                if ($final_reg_step->process_reg_step()) {
-                    $final_reg_step->set_completed();
-                    EED_Single_Page_Checkout::instance()->checkout->update_txn_reg_steps_array();
-                    return EED_Single_Page_Checkout::instance()->checkout->transaction;
-                }
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     *    run
-     *
-     * @param WP_Query|null $WP_Query
-     * @return    void
-     */
-    public function run($WP_Query)
-    {
-        if (
-            $WP_Query instanceof WP_Query
-            && $WP_Query->is_main_query()
-            && apply_filters('FHEE__EED_Single_Page_Checkout__run', true)
-            && $this->_is_reg_checkout()
-        ) {
-            $this->_initialize();
-        }
-    }
-
-
-    /**
-     * determines whether current url matches reg page url
-     *
-     * @return bool
-     */
-    protected function _is_reg_checkout(): bool
-    {
-        // get current permalink for reg page without any extra query args
-        $reg_page_url = get_permalink(EE_Config::instance()->core->reg_page_id);
-        // get request URI for current request, but without the scheme or host
-        $current_request_uri = EEH_URL::filter_input_server_url();
-        $current_request_uri = html_entity_decode($current_request_uri);
-        // get array of query args from the current request URI
-        $query_args = EEH_URL::get_query_string($current_request_uri);
-        // grab page id if it is set
-        $page_id = isset($query_args['page_id']) ? absint($query_args['page_id']) : 0;
-        // and remove the page id from the query args (we will re-add it later)
-        unset($query_args['page_id']);
-        // now strip all query args from current request URI
-        $current_request_uri = remove_query_arg(array_keys($query_args), $current_request_uri);
-        // and re-add the page id if it was set
-        if ($page_id) {
-            $current_request_uri = add_query_arg('page_id', $page_id, $current_request_uri);
-        }
-        // remove slashes and ?
-        $current_request_uri = trim($current_request_uri, '?/');
-        // is current request URI part of the known full reg page URL ?
-        return ! empty($current_request_uri) && strpos($reg_page_url, $current_request_uri) !== false;
-    }
-
-
-    /**
-     * @param WP_Query $wp_query
-     * @return    void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function init(WP_Query $wp_query)
-    {
-        EED_Single_Page_Checkout::instance()->run($wp_query);
-    }
-
-
-    /**
-     * @return void
-     */
-    private function _initialize()
-    {
-        // ensure SPCO doesn't run twice
-        if (EED_Single_Page_Checkout::$_initialized) {
-            return;
-        }
-        try {
-            $this->request = EED_Single_Page_Checkout::getRequest();
-            EED_Single_Page_Checkout::load_reg_steps();
-            $this->_verify_session();
-            // set up the EE_Checkout object
-            $this->checkout = $this->_initialize_checkout();
-            // filter checkout
-            $this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout);
-            // get the $_GET
-            $this->_get_request_vars();
-            if ($this->_block_bots()) {
-                return;
-            }
-            // filter continue_reg
-            $this->checkout->continue_reg = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__init___continue_reg',
-                true,
-                $this->checkout
-            );
-            // load the reg steps array
-            if (! $this->_load_and_instantiate_reg_steps()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // set the current step
-            $this->checkout->set_current_step($this->checkout->step);
-            // and the next step
-            $this->checkout->set_next_step();
-            // verify that everything has been set up correctly
-            if (! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            do_action('AHEE__Single_Page_Checkout___initialize__after_final_verifications', $this->checkout);
-            // lock the transaction
-            $this->checkout->transaction->lock();
-            // make sure all of our cached objects are added to their respective model entity mappers
-            $this->checkout->refresh_all_entities();
-            // set amount owing
-            $this->checkout->amount_owing = $this->checkout->transaction->remaining();
-            // initialize each reg step, which gives them the chance to potentially alter the process
-            $this->_initialize_reg_steps();
-            // DEBUG LOG
-            // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
-            // get reg form
-            if (! $this->_check_form_submission()) {
-                EED_Single_Page_Checkout::$_initialized = true;
-                return;
-            }
-            // checkout the action!!!
-            $this->_process_form_action();
-            // add some style and make it dance
-            $this->add_styles_and_scripts($this);
-            // kk... SPCO has successfully run
-            EED_Single_Page_Checkout::$_initialized = true;
-            // set no cache headers and constants
-            EE_System::do_not_cache();
-            // add anchor
-            add_action('loop_start', [$this, 'set_checkout_anchor'], 1);
-            // remove transaction lock
-            add_action('shutdown', [$this, 'unlock_transaction'], 1);
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-    /**
-     * checks that the session is valid and not expired
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _verify_session()
-    {
-        if (! $this->session instanceof EE_Session) {
-            $this->session = LoaderFactory::getShared(EE_Session::class);
-            if (! $this->session instanceof EE_Session) {
-                throw new EE_Error(esc_html__('The EE_Session class could not be loaded.', 'event_espresso'));
-            }
-        }
-        $clear_session_requested = $this->request->getRequestParam('clear_session', false, 'bool');
-        // is session still valid ?
-        if (
-            $clear_session_requested
-            || (
-                $this->session->expired()
-                && $this->request->getRequestParam('e_reg_url_link') === ''
-            )
-        ) {
-            $this->checkout = new EE_Checkout();
-            $this->session->clear_session(__CLASS__, __FUNCTION__);
-            if (! $clear_session_requested) {
-                EE_Error::add_attention(
-                    EE_Registry::$i18n_js_strings['registration_expiration_notice'],
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-
-    /**
-     * loads and instantiates EE_Checkout
-     *
-     * @return EE_Checkout
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _initialize_checkout(): EE_Checkout
-    {
-        // look in session for existing checkout
-        /** @type EE_Checkout $checkout */
-        $checkout = $this->session->checkout();
-        // verify
-        if (! $checkout instanceof EE_Checkout) {
-            // instantiate EE_Checkout object for handling the properties of the current checkout process
-            $checkout = EE_Registry::instance()->load_file(
-                SPCO_INC_PATH,
-                'EE_Checkout',
-                'class',
-                [],
-                false
-            );
-        } else {
-            if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) {
-                $this->unlock_transaction();
-                wp_safe_redirect($checkout->redirect_url);
-                exit();
-            }
-        }
-        $checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
-        // verify again
-        if (! $checkout instanceof EE_Checkout) {
-            throw new EE_Error(esc_html__('The EE_Checkout class could not be loaded.', 'event_espresso'));
-        }
-        // reset anything that needs a clean slate for each request
-        $checkout->reset_for_current_request();
-        return $checkout;
-    }
-
-
-    /**
-     * @return void
-     */
-    private function _get_request_vars()
-    {
-        // make sure this request is marked as belonging to EE
-        /** @var CurrentPage $current_page */
-        $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-        $current_page->setEspressoPage(true);
-        // which step is being requested ?
-        $this->checkout->step = $this->request->getRequestParam('step', $this->_get_first_step());
-        // which step is being edited ?
-        $this->checkout->edit_step = $this->request->getRequestParam('edit_step');
-        // and what we're doing on the current step
-        $this->checkout->action = $this->request->getRequestParam('action', 'display_spco_reg_step');
-        // timestamp
-        $this->checkout->uts = $this->request->getRequestParam('uts', 0, 'int');
-        // returning to edit ?
-        $this->checkout->reg_url_link = $this->request->getRequestParam('e_reg_url_link');
-        // add reg url link to registration query params
-        if ($this->checkout->reg_url_link && strpos($this->checkout->reg_url_link, '1-') !== 0) {
-            $this->checkout->reg_cache_where_params[0]['REG_url_link'] = $this->checkout->reg_url_link;
-        }
-        // or some other kind of revisit ?
-        $this->checkout->revisit = $this->request->getRequestParam('revisit', false, 'bool');
-        // and whether to generate a reg form for this request
-        $this->checkout->generate_reg_form = $this->request->getRequestParam('generate_reg_form', true, 'bool');
-        // and whether to process a reg form submission for this request
-        $this->checkout->process_form_submission = $this->request->getRequestParam(
-            'process_form_submission',
-            $this->checkout->action === 'process_reg_step',
-            'bool'
-        );
-        $this->checkout->process_form_submission = filter_var(
-            $this->checkout->action !== 'display_spco_reg_step'
-                ? $this->checkout->process_form_submission
-                : false,
-            FILTER_VALIDATE_BOOLEAN
-        );
-        $this->_display_request_vars();
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _display_request_vars()
-    {
-        if (! ($this->debug && defined('WP_DEBUG') && WP_DEBUG)) {
-            return;
-        }
-        EEH_Debug_Tools::printr($this->request->requestParams(), 'requestParams', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__);
-        EEH_Debug_Tools::printr(
-            $this->checkout->generate_reg_form,
-            '$this->checkout->generate_reg_form',
-            __FILE__,
-            __LINE__
-        );
-        EEH_Debug_Tools::printr(
-            $this->checkout->process_form_submission,
-            '$this->checkout->process_form_submission',
-            __FILE__,
-            __LINE__
-        );
-    }
-
-
-    /**
-     * _block_bots
-     * checks that the incoming request has either of the following set:
-     *  a UTS (unix timestamp) which indicates that the request was redirected from the Ticket Selector
-     *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
-     * so if you're not coming from the Ticket Selector nor returning for a valid IP...
-     * then where you coming from man?
-     *
-     * @return boolean
-     */
-    private function _block_bots(): bool
-    {
-        return EED_Invalid_Checkout_Access::getInvalidCheckoutAccess()->checkoutAccessIsInvalid($this->checkout);
-    }
-
-
-    /**
-     *  gets slug for first step in $_reg_steps_array
-     *
-     * @return string
-     */
-    private function _get_first_step(): string
-    {
-        $first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array);
-        return $first_step['slug'] ?? 'attendee_information';
-    }
-
-
-    /**
-     * instantiates each reg step based on the loaded reg_steps array
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _load_and_instantiate_reg_steps(): bool
-    {
-        do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout);
-        // have reg_steps already been instantiated ?
-        if (
-            empty($this->checkout->reg_steps)
-            || apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout)
-        ) {
-            // if not, then loop through raw reg steps array
-            foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
-                if (! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
-                    return false;
-                }
-            }
-            if (isset($this->checkout->reg_steps['registration_confirmation'])) {
-                // skip the registration_confirmation page ?
-                // just remove it from the reg steps array
-                $this->checkout->remove_reg_step('registration_confirmation', false);
-            }
-            // filter the array for good luck
-            $this->checkout->reg_steps = apply_filters(
-                'FHEE__Single_Page_Checkout__load_reg_steps__reg_steps',
-                $this->checkout->reg_steps
-            );
-            // finally re-sort based on the reg step class order properties
-            $this->checkout->sort_reg_steps();
-        } else {
-            foreach ($this->checkout->reg_steps as $reg_step) {
-                // set all current step stati to FALSE
-                $reg_step->set_is_current_step(false);
-            }
-        }
-        if (empty($this->checkout->reg_steps)) {
-            EE_Error::add_error(
-                esc_html__('No Reg Steps were loaded..', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // make reg step details available to JS
-        $this->checkout->set_reg_step_JSON_info();
-        return true;
-    }
-
-
-    /**
-     * @param array $reg_step
-     * @param int   $order
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _load_and_instantiate_reg_step(array $reg_step = [], int $order = 0): bool
-    {
-        // we need a file_path, class_name, and slug to add a reg step
-        if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
-            // if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step)
-            if (
-                $this->checkout->reg_url_link
-                && $this->checkout->step !== $reg_step['slug']
-                && $reg_step['slug'] !== 'finalize_registration'
-                // normally at this point we would NOT load the reg step, but this filter can change that
-                && apply_filters(
-                    'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step',
-                    true,
-                    $reg_step,
-                    $this->checkout
-                )
-            ) {
-                return true;
-            }
-
-            // instantiate step class using file path and class name
-            $reg_step_obj = EE_Registry::instance()->load_file(
-                $reg_step['file_path'],
-                $reg_step['class_name'],
-                'class',
-                [$this->checkout],
-                false
-            );
-            // did we get the goods ?
-            if ($reg_step_obj instanceof EE_SPCO_Reg_Step) {
-                // set reg step order based on config
-                $reg_step_obj->set_order($order);
-                // add instantiated reg step object to the master reg steps array
-                $this->checkout->add_reg_step($reg_step_obj);
-            } else {
-                EE_Error::add_error(
-                    esc_html__('The current step could not be set.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        } else {
-            if (WP_DEBUG) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s',
-                            'event_espresso'
-                        ),
-                        $reg_step['file_path'] ?? '',
-                        $reg_step['class_name'] ?? '',
-                        $reg_step['slug'] ?? '',
-                        '<ul>',
-                        '<li>',
-                        '</li>',
-                        '</ul>'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _verify_transaction_and_get_registrations(): bool
-    {
-        // was there already a valid transaction in the checkout from the session ?
-        if (! $this->checkout->transaction instanceof EE_Transaction) {
-            // get transaction from db or session
-            $this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
-                ? $this->_get_transaction_and_cart_for_previous_visit()
-                : $this->_get_cart_for_current_session_and_setup_new_transaction();
-            if (! $this->checkout->transaction instanceof EE_Transaction) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Your Registration and Transaction information could not be retrieved from the db.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->checkout->transaction = EE_Transaction::new_instance();
-                // add some style and make it dance
-                $this->add_styles_and_scripts($this);
-                EED_Single_Page_Checkout::$_initialized = true;
-                return false;
-            }
-            // and the registrations for the transaction
-            $this->_get_registrations($this->checkout->transaction);
-        }
-        return true;
-    }
-
-
-    /**
-     * @return EE_Transaction|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_transaction_and_cart_for_previous_visit(): ?EE_Transaction
-    {
-        /** @var $TXN_model EEM_Transaction */
-        $TXN_model = EE_Registry::instance()->load_model('Transaction');
-        // because the reg_url_link is present in the request,
-        // this is a return visit to SPCO, so we'll get the transaction data from the db
-        $transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link);
-        // verify transaction
-        if ($transaction instanceof EE_Transaction) {
-            // and get the cart that was used for that transaction
-            $this->checkout->cart = $this->_get_cart_for_transaction($transaction);
-            return $transaction;
-        }
-        EE_Error::add_error(
-            esc_html__(
-                'Your Registration and Transaction information could not be retrieved from the db.',
-                'event_espresso'
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return null;
-    }
-
-
-    /**
-     * @param EE_Transaction|null $transaction
-     * @return EE_Cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_cart_for_transaction(?EE_Transaction $transaction): EE_Cart
-    {
-        return $this->checkout->get_cart_for_transaction($transaction);
-    }
-
-
-    /**
-     * @param EE_Transaction|null $transaction
-     * @return EE_Cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_cart_for_transaction(?EE_Transaction $transaction): EE_Cart
-    {
-        return $this->checkout->get_cart_for_transaction($transaction);
-    }
-
-
-    /**
-     * generates a new EE_Transaction object and adds it to the $_transaction property.
-     *
-     * @return EE_Transaction|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_cart_for_current_session_and_setup_new_transaction(): ?EE_Transaction
-    {
-        //  if there's no transaction, then this is the FIRST visit to SPCO
-        // so load up the cart ( passing nothing for the TXN because it doesn't exist yet )
-        $this->checkout->cart = $this->_get_cart_for_transaction(null);
-        // and then create a new transaction
-        $transaction = $this->_initialize_transaction();
-        // verify transaction
-        if ($transaction instanceof EE_Transaction) {
-            // and save TXN data to the cart
-            $this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID());
-        } else {
-            EE_Error::add_error(
-                esc_html__('A Valid Transaction could not be initialized.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $transaction;
-    }
-
-
-    /**
-     * generates a new EE_Transaction object and adds it to the $_transaction property.
-     *
-     * @return EE_Transaction|null
-     */
-    private function _initialize_transaction(): ?EE_Transaction
-    {
-        try {
-            // ensure cart totals have been calculated
-            $this->checkout->cart->get_grand_total()->recalculate_total_including_taxes();
-            // grab the cart grand total
-            $cart_total = $this->checkout->cart->get_cart_grand_total();
-            // create new TXN
-            $transaction = EE_Transaction::new_instance(
-                [
-                    'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(),
-                    'TXN_total'     => max($cart_total, 0),
-                    'TXN_paid'      => 0,
-                    'STS_ID'        => EEM_Transaction::failed_status_code,
-                ]
-            );
-            // save it so that we have an ID for other objects to use
-            $transaction->save();
-            // set cron job for following up on TXNs after their session has expired
-            EE_Cron_Tasks::schedule_expired_transaction_check(
-                $this->session->expiration() + 1,
-                $transaction->ID()
-            );
-            return $transaction;
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-        }
-        return null;
-    }
-
-
-    /**
-     * _get_registrations
-     *
-     * @param EE_Transaction $transaction
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_registrations(EE_Transaction $transaction)
-    {
-        // first step: grab the registrants  { : o
-        $registrations                      = $transaction->registrations($this->checkout->reg_cache_where_params);
-        $this->checkout->total_ticket_count = count($registrations);
-        // verify registrations have been set
-        if (empty($registrations)) {
-            // if no cached registrations, then check the db
-            $registrations = $transaction->registrations($this->checkout->reg_cache_where_params);
-            // still nothing ? well as long as this isn't a revisit
-            if (empty($registrations) && ! $this->checkout->revisit) {
-                // generate new registrations from scratch
-                $registrations = $this->_initialize_registrations($transaction);
-            }
-        }
-        // sort by their original registration order
-        usort($registrations, ['EED_Single_Page_Checkout', 'sort_registrations_by_REG_count']);
-        // then loop thru the array
-        foreach ($registrations as $registration) {
-            // verify each registration
-            if ($registration instanceof EE_Registration) {
-                // we display all attendee info for the primary registrant
-                if (
-                    $this->checkout->reg_url_link === $registration->reg_url_link()
-                    && $registration->is_primary_registrant()
-                ) {
-                    $this->checkout->primary_revisit = true;
-                    break;
-                }
-                if ($this->checkout->revisit && $this->checkout->reg_url_link !== $registration->reg_url_link()) {
-                    // but hide info if it doesn't belong to you
-                    $transaction->clear_cache('Registration', $registration->ID());
-                    $this->checkout->total_ticket_count--;
-                }
-                $this->checkout->set_reg_status_updated($registration->ID(), false);
-            }
-        }
-    }
-
-
-    /**
-     * adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
-     *
-     * @param EE_Transaction $transaction
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _initialize_registrations(EE_Transaction $transaction): array
-    {
-        $att_nmbr      = 0;
-        $registrations = [];
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor             = EE_Registry::instance()->load_class('Registration_Processor');
-        $this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count();
-        // now let's add the cart items to the $transaction
-        foreach ($this->checkout->cart->get_tickets() as $line_item) {
-            // do the following for each ticket of this type they selected
-            for ($x = 1; $x <= $line_item->quantity(); $x++) {
-                $att_nmbr++;
-                /** @var CreateRegistrationCommand $CreateRegistrationCommand */
-                $CreateRegistrationCommand = EE_Registry::instance()->create(
-                    CreateRegistrationCommand::class,
-                    [
-                        $transaction,
-                        $line_item,
-                        $att_nmbr,
-                        $this->checkout->total_ticket_count,
-                    ]
-                );
-                // override capabilities for frontend registrations
-                if ($this->request->isFrontend()) {
-                    $CreateRegistrationCommand->setCapCheck(
-                        new PublicCapabilities('', 'create_new_registration')
-                    );
-                }
-                $registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
-                if (! $registration instanceof EE_Registration) {
-                    throw new InvalidEntityException($registration, 'EE_Registration');
-                }
-                $registrations[ $registration->ID() ] = $registration;
-            }
-        }
-        $registration_processor->fix_reg_final_price_rounding_issue($transaction);
-        return $registrations;
-    }
-
-
-    /**
-     * @param EE_Registration $reg_A
-     * @param EE_Registration $reg_B
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B): int
-    {
-        // this shouldn't ever happen within the same TXN, but oh well
-        if ($reg_A->count() === $reg_B->count()) {
-            return 0;
-        }
-        return ($reg_A->count() > $reg_B->count()) ? 1 : -1;
-    }
-
-
-    /**
-     * just makes sure that everything is set up correctly before proceeding
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _final_verifications(): bool
-    {
-        // filter checkout
-        $this->checkout = apply_filters(
-            'FHEE__EED_Single_Page_Checkout___final_verifications__checkout',
-            $this->checkout
-        );
-        // verify that current step is still set correctly
-        if (! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
-            EE_Error::add_error(
-                esc_html__(
-                    'We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // if returning to SPCO, then verify that primary registrant is set
-        if (! empty($this->checkout->reg_url_link)) {
-            $valid_registrant = $this->checkout->transaction->primary_registration();
-            if (! $valid_registrant instanceof EE_Registration) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $valid_registrant = null;
-            foreach (
-                $this->checkout->transaction->registrations(
-                    $this->checkout->reg_cache_where_params
-                ) as $registration
-            ) {
-                if (
-                    $registration instanceof EE_Registration
-                    && $registration->reg_url_link() === $this->checkout->reg_url_link
-                ) {
-                    $valid_registrant = $registration;
-                }
-            }
-            if (! $valid_registrant instanceof EE_Registration) {
-                // hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
-                if (EED_Single_Page_Checkout::$_checkout_verified) {
-                    // clear the session, mark the checkout as unverified, and try again
-                    $this->session->clear_session(__CLASS__, __FUNCTION__);
-                    EED_Single_Page_Checkout::$_initialized       = false;
-                    EED_Single_Page_Checkout::$_checkout_verified = false;
-                    $this->_initialize();
-                    EE_Error::reset_notices();
-                    return false;
-                }
-                EE_Error::add_error(
-                    esc_html__(
-                        'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        // now that things have been kinda sufficiently verified,
-        // let's add the checkout to the session so that it's available to other systems
-        $this->session->set_checkout($this->checkout);
-        return true;
-    }
-
-
-    /**
-     * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required
-     * then loops thru all the active reg steps and calls the initialize_reg_step() method
-     *
-     * @param bool $reinitializing
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _initialize_reg_steps(bool $reinitializing = false)
-    {
-        $this->checkout->set_reg_step_initiated($this->checkout->current_step);
-        // loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
-        foreach ($this->checkout->reg_steps as $reg_step) {
-            if (! $reg_step->initialize_reg_step()) {
-                // if not initialized then maybe this step is being removed...
-                if (! $reinitializing && $reg_step->is_current_step()) {
-                    // if it was the current step, then we need to start over here
-                    $this->_initialize_reg_steps(true);
-                    return;
-                }
-                continue;
-            }
-            // add css and JS for current step
-            $this->add_styles_and_scripts($reg_step);
-            if ($reg_step->is_current_step()) {
-                // the text that appears on the reg step form submit button
-                $reg_step->set_submit_button_text();
-            }
-        }
-        // dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
-        do_action(
-            "AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}",
-            $this->checkout->current_step
-        );
-        $this->checkout->json_response->set_return_data(
-            [
-                'action'        => $this->checkout->action,
-                'admin_request' => $this->checkout->admin_request,
-                'current_step'  => $this->checkout->current_step->slug(),
-                'revisit'       => $this->checkout->revisit,
-            ]
-        );
-    }
-
-
-    /**
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _check_form_submission(): bool
-    {
-        // does this request require the reg form to be generated ?
-        if ($this->checkout->generate_reg_form) {
-            // ever heard that song by Blue Rodeo ?
-            try {
-                $this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form();
-                // if not displaying a form, then check for form submission
-                if (
-                    $this->checkout->process_form_submission
-                    && $this->checkout->current_step->reg_form->was_submitted()
-                ) {
-                    // clear out any old data in case this step is being run again
-                    $this->checkout->current_step->set_valid_data([]);
-                    // capture submitted form data
-                    $request_data = $this->request->requestParams();
-                    $this->checkout->current_step->reg_form->receive_form_submission(
-                        (array) apply_filters(
-                            'FHEE__Single_Page_Checkout___check_form_submission__request_params',
-                            $request_data,
-                            $this->checkout
-                        )
-                    );
-                    // validate submitted form data
-                    if (! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
-                        // thou shall not pass !!!
-                        $this->checkout->continue_reg = false;
-                        // any form validation errors?
-                        if ($this->checkout->current_step->reg_form->submission_error_message() !== '') {
-                            EE_Error::add_error(
-                                $this->checkout->current_step->reg_form->submission_error_message(),
-                                __FILE__,
-                                __FUNCTION__,
-                                __LINE__
-                            );
-                        }
-                        // well not really... what will happen is
-                        // we'll just get redirected back to redo the current step
-                        $this->go_to_next_step();
-                        return false;
-                    }
-                }
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _process_form_action()
-    {
-        // what cha wanna do?
-        switch ($this->checkout->action) {
-            // AJAX next step reg form
-            case 'display_spco_reg_step':
-                $this->checkout->redirect = false;
-                if ($this->request->isAjax()) {
-                    $this->checkout->json_response->set_reg_step_html(
-                        $this->checkout->current_step->display_reg_form()
-                    );
-                }
-                break;
-            default:
-                // meh... do one of those other steps first
-                if (
-                    ! empty($this->checkout->action)
-                    && is_callable([$this->checkout->current_step, $this->checkout->action])
-                ) {
-                    // dynamically creates hook point like:
-                    //   AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
-                    do_action(
-                        "AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        $this->checkout->current_step
-                    );
-                    $process_reg_step = apply_filters(
-                        "AHEE__Single_Page_Checkout__process_reg_step__{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        true,
-                        $this->checkout->current_step,
-                        $this
-                    );
-                    // call action on current step
-                    if ($process_reg_step && call_user_func([$this->checkout->current_step, $this->checkout->action])) {
-                        // good registrant, you get to proceed
-                        if (
-                            $this->checkout->current_step->success_message() !== ''
-                            && apply_filters(
-                                'FHEE__Single_Page_Checkout___process_form_action__display_success',
-                                false
-                            )
-                        ) {
-                            EE_Error::add_success(
-                                $this->checkout->current_step->success_message()
-                                . '<br />' . $this->checkout->next_step->_instructions()
-                            );
-                        }
-                        // pack it up, pack it in...
-                        $this->_setup_redirect();
-                    }
-                    // dynamically creates hook point like:
-                    //  AHEE__Single_Page_Checkout__after_payment_options__process_reg_step
-                    do_action(
-                        "AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
-                        $this->checkout->current_step
-                    );
-                } else {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'The requested form action "%s" does not exist for the current "%s" registration step.',
-                                'event_espresso'
-                            ),
-                            $this->checkout->action,
-                            $this->checkout->current_step->name()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            // end default
-        }
-        // store our progress so far
-        $this->checkout->stash_transaction_and_checkout();
-        // advance to the next step! If you pass GO, collect $200
-        $this->go_to_next_step();
-    }
-
-
-    /**
-     * @param EED_Single_Page_Checkout|EE_SPCO_Reg_Step $target an object with the method `translate_js_strings` and
-     *                                                          `enqueue_styles_and_scripts`.
-     * @return void
-     */
-    public function add_styles_and_scripts($target)
-    {
-        // i18n
-        $target->translate_js_strings();
-        if ($this->checkout->admin_request) {
-            add_action('admin_enqueue_scripts', [$target, 'enqueue_styles_and_scripts']);
-        } else {
-            add_action('wp_enqueue_scripts', [$target, 'enqueue_styles_and_scripts']);
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['revisit']                        = $this->checkout->revisit;
-        EE_Registry::$i18n_js_strings['e_reg_url_link']                 = $this->checkout->reg_url_link;
-        EE_Registry::$i18n_js_strings['server_error']                   = esc_html__(
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_json_response']          = esc_html__(
-            'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['validation_error']               = esc_html__(
-            'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_payment_method']         = esc_html__(
-            'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['reg_step_error']                 = esc_html__(
-            'This registration step could not be completed. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_coupon']                 = esc_html__(
-            'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['process_registration']           = sprintf(
-            esc_html__(
-                'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.',
-                'event_espresso'
-            ),
-            '<br/>',
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['language']                       = get_bloginfo('language');
-        EE_Registry::$i18n_js_strings['EESID']                          = $this->session->id();
-        EE_Registry::$i18n_js_strings['currency']                       = EE_Registry::instance()->CFG->currency;
-        EE_Registry::$i18n_js_strings['datepicker_yearRange']           = '-150:+20';
-        EE_Registry::$i18n_js_strings['timer_years']                    = esc_html__('years', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_months']                   = esc_html__('months', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_weeks']                    = esc_html__('weeks', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_days']                     = esc_html__('days', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hours']                    = esc_html__('hours', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minutes']                  = esc_html__('minutes', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_seconds']                  = esc_html__('seconds', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_year']                     = esc_html__('year', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_month']                    = esc_html__('month', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_week']                     = esc_html__('week', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_day']                      = esc_html__('day', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hour']                     = esc_html__('hour', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minute']                   = esc_html__('minute', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_second']                   = esc_html__('second', 'event_espresso');
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] =
-            EED_Single_Page_Checkout::getRegistrationExpirationNotice();
-        EE_Registry::$i18n_js_strings['ajax_submit']                    = apply_filters(
-            'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
-            true
-        );
-        EE_Registry::$i18n_js_strings['session_extension']              = absint(
-            apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
-        );
-        EE_Registry::$i18n_js_strings['session_expiration']    = $this->session->expiration();
-        EE_Registry::$i18n_js_strings['use_session_countdown'] = EE_Registry::instance()->CFG->registration->useSessionCountdown();
-        EE_Registry::$i18n_js_strings['no_copy_paste_email_confirm'] = esc_html__("We're sorry but copy and paste is disabled for email confirmation inputs. Please enter the email address manually.", 'event_espresso');
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function enqueue_styles_and_scripts()
-    {
-        // load css
-        wp_register_style(
-            'single_page_checkout',
-            SPCO_CSS_URL . 'single_page_checkout.css',
-            ['espresso_default'],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('single_page_checkout');
-        // load JS
-        wp_register_script(
-            'single_page_checkout',
-            SPCO_JS_URL . 'single_page_checkout.js',
-            ['espresso_core', 'underscore', 'ee_form_section_validation'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->registration_form->enqueue_js();
-        }
-        if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->current_step->reg_form->enqueue_js();
-        }
-        wp_enqueue_script('single_page_checkout');
-        /**
-         * global action hook for enqueueing styles and scripts with
-         * spco calls.
-         */
-        do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
-        /**
-         * dynamic action hook for enqueueing styles and scripts with spco calls.
-         * The hook will end up being something like:
-         *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
-         */
-        do_action(
-            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
-            $this
-        );
-    }
-
-
-    /**
-     * display the Registration Single Page Checkout Form
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _display_spco_reg_form()
-    {
-        // if registering via the admin, just display the reg form for the current step
-        if ($this->checkout->admin_request) {
-            EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->current_step->display_reg_form());
-            return;
-        }
-
-        // add powered by EE msg
-        add_action('AHEE__SPCO__reg_form_footer', ['EED_Single_Page_Checkout', 'display_registration_footer']);
-        $empty_cart = count(
-                $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)
-            ) < 1;
-        EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
-
-        /** @var FeatureFlags $feature */
-        $feature = LoaderFactory::getShared(FeatureFlags::class);
-
-        $this->checkout->registration_form = $feature->allowed(FeatureFlag::USE_SPCO_FORM_REFACTOR)
-            ? new SinglePageCheckoutForm($this->checkout, $empty_cart)
-            : new LegacySpcoForm($this->checkout, $empty_cart, $this->session->expiration());
-
-        // load template and add to output sent that gets filtered into the_content()
-        EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->registration_form->get_html());
-
-    }
-
-
-    /**
-     * @param $next_step
-     * @return void
-     */
-    public function add_extra_finalize_registration_inputs($next_step)
-    {
-        if ($next_step === 'finalize_registration') {
-            echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>';
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function display_registration_footer()
-    {
-        if (
-            apply_filters(
-                'FHEE__EE_Front__Controller__show_reg_footer',
-                EE_Registry::instance()->CFG->admin->show_reg_footer
-            )
-        ) {
-            add_filter(
-                'FHEE__EEH_Template__powered_by_event_espresso__url',
-                function ($url) {
-                    return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
-                }
-            );
-            echo apply_filters(
-                'FHEE__EE_Front_Controller__display_registration_footer',
-                EEH_Template::powered_by_event_espresso(
-                    '',
-                    'espresso-registration-footer-dv',
-                    ['utm_content' => 'registration_checkout']
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function unlock_transaction()
-    {
-        if ($this->checkout instanceof EE_Checkout && $this->checkout->transaction instanceof EE_Transaction) {
-            $this->checkout->transaction->unlock();
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    private function _setup_redirect()
-    {
-        if ($this->checkout->continue_reg && $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            $this->checkout->redirect = true;
-            if (empty($this->checkout->redirect_url)) {
-                $this->checkout->redirect_url = $this->checkout->next_step->reg_step_url();
-            }
-            $this->checkout->redirect_url = apply_filters(
-                'FHEE__EED_Single_Page_Checkout___setup_redirect__checkout_redirect_url',
-                $this->checkout->redirect_url,
-                $this->checkout
-            );
-        }
-    }
-
-
-    /**
-     * handle ajax message responses and redirects
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function go_to_next_step()
-    {
-        if ($this->request->isAjax()) {
-            // capture contents of output buffer we started earlier in the request, and insert into JSON response
-            $this->checkout->json_response->set_unexpected_errors(ob_get_clean());
-        }
-        $this->unlock_transaction();
-        // just return for these conditions
-        if (
-            $this->checkout->admin_request
-            || $this->checkout->action === 'redirect_form'
-            || $this->checkout->action === 'update_checkout'
-        ) {
-            return;
-        }
-        // AJAX response
-        $this->_handle_json_response();
-        // redirect to next step or the Thank-You page
-        $this->_handle_html_redirects();
-        // hmmm... must be something wrong, so let's just display the form again !
-        $this->_display_spco_reg_form();
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _handle_json_response()
-    {
-        // if this is an ajax request
-        if ($this->request->isAjax()) {
-            $this->checkout->json_response->set_registration_time_limit(
-                $this->checkout->get_registration_time_limit()
-            );
-            $this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
-            /** @var EE_SPCO_JSON_Response $json_response */
-            $json_response = apply_filters(
-                'FHEE__EE_Single_Page_Checkout__JSON_response',
-                $this->checkout->json_response
-            );
-            // just send the ajax
-            $json_response->sendResponse();
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _handle_html_redirects()
-    {
-        // going somewhere ?
-        if ($this->checkout->redirect && ! empty($this->checkout->redirect_url)) {
-            // store notices in a transient
-            EE_Error::get_notices(false, true);
-            wp_safe_redirect($this->checkout->redirect_url);
-            exit();
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    public function set_checkout_anchor()
-    {
-        echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>';
-    }
-
-
-    /**
-     * @return string
-     * @since 4.9.59.p
-     */
-    public static function getRegistrationExpirationNotice(): string
-    {
-        return sprintf(
-            esc_html__(
-                '%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please accept our apologies for any inconvenience this may have caused.%8$s',
-                'event_espresso'
-            ),
-            '<h4 class="important-notice">',
-            '</h4>',
-            '<br />',
-            '<p>',
-            '<a href="' . get_post_type_archive_link(EspressoPostType::EVENTS) . '" title="',
-            '">',
-            '</a>',
-            '</p>'
-        );
-    }
+	/**
+	 * $_initialized - has the SPCO controller already been initialized ?
+	 */
+	private static bool $_initialized = false;
+
+
+	/**
+	 * $_checkout_verified - is the EE_Checkout verified as correct for this request ?
+	 */
+	private static bool $_checkout_verified = true;
+
+	/**
+	 * $_reg_steps_array - holds initial array of reg steps
+	 *
+	 * @var array $_reg_steps_array
+	 */
+	private static array $_reg_steps_array = [];
+
+	/**
+	 * $checkout - EE_Checkout object for handling the properties of the current checkout process
+	 */
+	public ?EE_Checkout $checkout = null;
+
+	protected ?RequestInterface $request = null;
+
+	public ?EE_Session $session = null;
+
+	private bool $debug = false;    //  true    false
+
+
+	/**
+	 * @return EED_Single_Page_Checkout|EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance()
+	{
+		add_filter('EED_Single_Page_Checkout__SPCO_active', '__return_true');
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * @return EE_CART
+	 */
+	public function cart(): EE_CART
+	{
+		return $this->checkout->cart;
+	}
+
+
+	/**
+	 * @return RequestInterface
+	 * @since   4.10.14.p
+	 */
+	public static function getRequest(): RequestInterface
+	{
+		return LoaderFactory::getLoader()->getShared(RequestInterface::class);
+	}
+
+
+	/**
+	 * @return EE_Transaction
+	 */
+	public function transaction(): EE_Transaction
+	{
+		return $this->checkout->transaction;
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function set_hooks()
+	{
+		EED_Single_Page_Checkout::set_definitions();
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function set_hooks_admin()
+	{
+		EED_Single_Page_Checkout::set_definitions();
+		if (! (defined('DOING_AJAX') && DOING_AJAX)) {
+			return;
+		}
+		// going to start an output buffer in case anything gets accidentally output
+		// that might disrupt our JSON response
+		ob_start();
+		EED_Single_Page_Checkout::load_reg_steps();
+		// set ajax hooks
+		add_action('wp_ajax_process_reg_step', ['EED_Single_Page_Checkout', 'process_reg_step']);
+		add_action('wp_ajax_nopriv_process_reg_step', ['EED_Single_Page_Checkout', 'process_reg_step']);
+		add_action('wp_ajax_display_spco_reg_step', ['EED_Single_Page_Checkout', 'display_reg_step']);
+		add_action('wp_ajax_nopriv_display_spco_reg_step', ['EED_Single_Page_Checkout', 'display_reg_step']);
+		add_action('wp_ajax_update_reg_step', ['EED_Single_Page_Checkout', 'update_reg_step']);
+		add_action('wp_ajax_nopriv_update_reg_step', ['EED_Single_Page_Checkout', 'update_reg_step']);
+	}
+
+
+	/**
+	 *    process ajax request
+	 *
+	 * @param string $ajax_action
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function process_ajax_request(string $ajax_action)
+	{
+		$request = EED_Single_Page_Checkout::getRequest();
+		$request->setRequestParam('action', $ajax_action);
+		EED_Single_Page_Checkout::instance()->_initialize();
+	}
+
+
+	/**
+	 * ajax display registration step
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function display_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('display_spco_reg_step');
+	}
+
+
+	/**
+	 * ajax process registration step
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function process_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('process_reg_step');
+	}
+
+
+	/**
+	 * ajax process registration step
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function update_reg_step()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('update_reg_step');
+	}
+
+
+	/**
+	 * update_checkout
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public static function update_checkout()
+	{
+		EED_Single_Page_Checkout::process_ajax_request('update_checkout');
+	}
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public static function set_definitions()
+	{
+		if (defined('SPCO_BASE_PATH')) {
+			return;
+		}
+		define(
+			'SPCO_BASE_PATH',
+			rtrim(str_replace(['\\', '/'], '/', plugin_dir_path(__FILE__)), '/') . '/'
+		);
+		define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css/');
+		define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img/');
+		define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js/');
+		define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc/');
+		define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps/');
+		define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates/');
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] =
+			EED_Single_Page_Checkout::getRegistrationExpirationNotice();
+	}
+
+
+	/**
+	 * load_reg_steps
+	 * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
+	 *
+	 * @throws EE_Error
+	 */
+	public static function load_reg_steps()
+	{
+		static $reg_steps_loaded = false;
+		if ($reg_steps_loaded) {
+			return;
+		}
+		// filter list of reg_steps
+		$reg_steps_to_load = (array) apply_filters(
+			'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
+			EED_Single_Page_Checkout::get_reg_steps()
+		);
+		// sort by key (order)
+		ksort($reg_steps_to_load);
+		// loop through folders
+		foreach ($reg_steps_to_load as $order => $reg_step) {
+			// we need a
+			if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
+				// copy over to the reg_steps_array
+				EED_Single_Page_Checkout::$_reg_steps_array[ $order ] = $reg_step;
+				// register custom key route for each reg step
+				// ie: step=>"slug" - this is the entire reason we load the reg steps array now
+				EED_Module::registerRoute(
+					$reg_step['slug'],
+					'EED_Single_Page_Checkout',
+					'run',
+					'step'
+				);
+				// add AJAX or other hooks
+				if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
+					// setup autoloaders if necessary
+					if (! class_exists($reg_step['class_name'])) {
+						EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
+							$reg_step['file_path'],
+							true
+						);
+					}
+					if (is_callable($reg_step['class_name'], 'set_hooks')) {
+						call_user_func([$reg_step['class_name'], 'set_hooks']);
+					}
+				}
+			}
+		}
+		$reg_steps_loaded = true;
+	}
+
+
+	/**
+	 *    get_reg_steps
+	 *
+	 * @return    array
+	 */
+	public static function get_reg_steps(): array
+	{
+		$reg_steps = EE_Registry::instance()->CFG->registration->reg_steps;
+		if (empty($reg_steps)) {
+			$reg_steps = [
+				10  => [
+					'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
+					'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
+					'slug'       => 'attendee_information',
+					'has_hooks'  => false,
+				],
+				30  => [
+					'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
+					'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
+					'slug'       => 'payment_options',
+					'has_hooks'  => true,
+				],
+				999 => [
+					'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
+					'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
+					'slug'       => 'finalize_registration',
+					'has_hooks'  => false,
+				],
+			];
+		}
+		return $reg_steps;
+	}
+
+
+	/**
+	 * @return array|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function registration_checkout_for_admin()
+	{
+		$request = EED_Single_Page_Checkout::getRequest();
+		$request->setRequestParam('step', 'attendee_information');
+		$request->setRequestParam('action', 'display_spco_reg_step');
+		$request->setRequestParam('process_form_submission', false);
+		EED_Single_Page_Checkout::instance()->_initialize();
+		EED_Single_Page_Checkout::instance()->_display_spco_reg_form();
+		return EED_Single_Page_Checkout::getResponse()->getOutput();
+	}
+
+
+	/**
+	 * @return EE_Transaction|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function process_registration_from_admin(): ?EE_Transaction
+	{
+		$request = EED_Single_Page_Checkout::getRequest();
+		$request->setRequestParam('step', 'attendee_information');
+		$request->setRequestParam('action', 'process_reg_step');
+		$request->setRequestParam('process_form_submission', true);
+		EED_Single_Page_Checkout::instance()->_initialize();
+		if (EED_Single_Page_Checkout::instance()->checkout->current_step->completed()) {
+			$final_reg_step = end(EED_Single_Page_Checkout::instance()->checkout->reg_steps);
+			if ($final_reg_step instanceof EE_SPCO_Reg_Step_Finalize_Registration) {
+				EED_Single_Page_Checkout::instance()->checkout->set_reg_step_initiated($final_reg_step);
+				if ($final_reg_step->process_reg_step()) {
+					$final_reg_step->set_completed();
+					EED_Single_Page_Checkout::instance()->checkout->update_txn_reg_steps_array();
+					return EED_Single_Page_Checkout::instance()->checkout->transaction;
+				}
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 *    run
+	 *
+	 * @param WP_Query|null $WP_Query
+	 * @return    void
+	 */
+	public function run($WP_Query)
+	{
+		if (
+			$WP_Query instanceof WP_Query
+			&& $WP_Query->is_main_query()
+			&& apply_filters('FHEE__EED_Single_Page_Checkout__run', true)
+			&& $this->_is_reg_checkout()
+		) {
+			$this->_initialize();
+		}
+	}
+
+
+	/**
+	 * determines whether current url matches reg page url
+	 *
+	 * @return bool
+	 */
+	protected function _is_reg_checkout(): bool
+	{
+		// get current permalink for reg page without any extra query args
+		$reg_page_url = get_permalink(EE_Config::instance()->core->reg_page_id);
+		// get request URI for current request, but without the scheme or host
+		$current_request_uri = EEH_URL::filter_input_server_url();
+		$current_request_uri = html_entity_decode($current_request_uri);
+		// get array of query args from the current request URI
+		$query_args = EEH_URL::get_query_string($current_request_uri);
+		// grab page id if it is set
+		$page_id = isset($query_args['page_id']) ? absint($query_args['page_id']) : 0;
+		// and remove the page id from the query args (we will re-add it later)
+		unset($query_args['page_id']);
+		// now strip all query args from current request URI
+		$current_request_uri = remove_query_arg(array_keys($query_args), $current_request_uri);
+		// and re-add the page id if it was set
+		if ($page_id) {
+			$current_request_uri = add_query_arg('page_id', $page_id, $current_request_uri);
+		}
+		// remove slashes and ?
+		$current_request_uri = trim($current_request_uri, '?/');
+		// is current request URI part of the known full reg page URL ?
+		return ! empty($current_request_uri) && strpos($reg_page_url, $current_request_uri) !== false;
+	}
+
+
+	/**
+	 * @param WP_Query $wp_query
+	 * @return    void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function init(WP_Query $wp_query)
+	{
+		EED_Single_Page_Checkout::instance()->run($wp_query);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function _initialize()
+	{
+		// ensure SPCO doesn't run twice
+		if (EED_Single_Page_Checkout::$_initialized) {
+			return;
+		}
+		try {
+			$this->request = EED_Single_Page_Checkout::getRequest();
+			EED_Single_Page_Checkout::load_reg_steps();
+			$this->_verify_session();
+			// set up the EE_Checkout object
+			$this->checkout = $this->_initialize_checkout();
+			// filter checkout
+			$this->checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize__checkout', $this->checkout);
+			// get the $_GET
+			$this->_get_request_vars();
+			if ($this->_block_bots()) {
+				return;
+			}
+			// filter continue_reg
+			$this->checkout->continue_reg = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__init___continue_reg',
+				true,
+				$this->checkout
+			);
+			// load the reg steps array
+			if (! $this->_load_and_instantiate_reg_steps()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// set the current step
+			$this->checkout->set_current_step($this->checkout->step);
+			// and the next step
+			$this->checkout->set_next_step();
+			// verify that everything has been set up correctly
+			if (! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			do_action('AHEE__Single_Page_Checkout___initialize__after_final_verifications', $this->checkout);
+			// lock the transaction
+			$this->checkout->transaction->lock();
+			// make sure all of our cached objects are added to their respective model entity mappers
+			$this->checkout->refresh_all_entities();
+			// set amount owing
+			$this->checkout->amount_owing = $this->checkout->transaction->remaining();
+			// initialize each reg step, which gives them the chance to potentially alter the process
+			$this->_initialize_reg_steps();
+			// DEBUG LOG
+			// $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
+			// get reg form
+			if (! $this->_check_form_submission()) {
+				EED_Single_Page_Checkout::$_initialized = true;
+				return;
+			}
+			// checkout the action!!!
+			$this->_process_form_action();
+			// add some style and make it dance
+			$this->add_styles_and_scripts($this);
+			// kk... SPCO has successfully run
+			EED_Single_Page_Checkout::$_initialized = true;
+			// set no cache headers and constants
+			EE_System::do_not_cache();
+			// add anchor
+			add_action('loop_start', [$this, 'set_checkout_anchor'], 1);
+			// remove transaction lock
+			add_action('shutdown', [$this, 'unlock_transaction'], 1);
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+	/**
+	 * checks that the session is valid and not expired
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _verify_session()
+	{
+		if (! $this->session instanceof EE_Session) {
+			$this->session = LoaderFactory::getShared(EE_Session::class);
+			if (! $this->session instanceof EE_Session) {
+				throw new EE_Error(esc_html__('The EE_Session class could not be loaded.', 'event_espresso'));
+			}
+		}
+		$clear_session_requested = $this->request->getRequestParam('clear_session', false, 'bool');
+		// is session still valid ?
+		if (
+			$clear_session_requested
+			|| (
+				$this->session->expired()
+				&& $this->request->getRequestParam('e_reg_url_link') === ''
+			)
+		) {
+			$this->checkout = new EE_Checkout();
+			$this->session->clear_session(__CLASS__, __FUNCTION__);
+			if (! $clear_session_requested) {
+				EE_Error::add_attention(
+					EE_Registry::$i18n_js_strings['registration_expiration_notice'],
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * loads and instantiates EE_Checkout
+	 *
+	 * @return EE_Checkout
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _initialize_checkout(): EE_Checkout
+	{
+		// look in session for existing checkout
+		/** @type EE_Checkout $checkout */
+		$checkout = $this->session->checkout();
+		// verify
+		if (! $checkout instanceof EE_Checkout) {
+			// instantiate EE_Checkout object for handling the properties of the current checkout process
+			$checkout = EE_Registry::instance()->load_file(
+				SPCO_INC_PATH,
+				'EE_Checkout',
+				'class',
+				[],
+				false
+			);
+		} else {
+			if ($checkout->current_step->is_final_step() && $checkout->exit_spco() === true) {
+				$this->unlock_transaction();
+				wp_safe_redirect($checkout->redirect_url);
+				exit();
+			}
+		}
+		$checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
+		// verify again
+		if (! $checkout instanceof EE_Checkout) {
+			throw new EE_Error(esc_html__('The EE_Checkout class could not be loaded.', 'event_espresso'));
+		}
+		// reset anything that needs a clean slate for each request
+		$checkout->reset_for_current_request();
+		return $checkout;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function _get_request_vars()
+	{
+		// make sure this request is marked as belonging to EE
+		/** @var CurrentPage $current_page */
+		$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+		$current_page->setEspressoPage(true);
+		// which step is being requested ?
+		$this->checkout->step = $this->request->getRequestParam('step', $this->_get_first_step());
+		// which step is being edited ?
+		$this->checkout->edit_step = $this->request->getRequestParam('edit_step');
+		// and what we're doing on the current step
+		$this->checkout->action = $this->request->getRequestParam('action', 'display_spco_reg_step');
+		// timestamp
+		$this->checkout->uts = $this->request->getRequestParam('uts', 0, 'int');
+		// returning to edit ?
+		$this->checkout->reg_url_link = $this->request->getRequestParam('e_reg_url_link');
+		// add reg url link to registration query params
+		if ($this->checkout->reg_url_link && strpos($this->checkout->reg_url_link, '1-') !== 0) {
+			$this->checkout->reg_cache_where_params[0]['REG_url_link'] = $this->checkout->reg_url_link;
+		}
+		// or some other kind of revisit ?
+		$this->checkout->revisit = $this->request->getRequestParam('revisit', false, 'bool');
+		// and whether to generate a reg form for this request
+		$this->checkout->generate_reg_form = $this->request->getRequestParam('generate_reg_form', true, 'bool');
+		// and whether to process a reg form submission for this request
+		$this->checkout->process_form_submission = $this->request->getRequestParam(
+			'process_form_submission',
+			$this->checkout->action === 'process_reg_step',
+			'bool'
+		);
+		$this->checkout->process_form_submission = filter_var(
+			$this->checkout->action !== 'display_spco_reg_step'
+				? $this->checkout->process_form_submission
+				: false,
+			FILTER_VALIDATE_BOOLEAN
+		);
+		$this->_display_request_vars();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _display_request_vars()
+	{
+		if (! ($this->debug && defined('WP_DEBUG') && WP_DEBUG)) {
+			return;
+		}
+		EEH_Debug_Tools::printr($this->request->requestParams(), 'requestParams', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->step, '$this->checkout->step', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->edit_step, '$this->checkout->edit_step', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->action, '$this->checkout->action', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->reg_url_link, '$this->checkout->reg_url_link', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr($this->checkout->revisit, '$this->checkout->revisit', __FILE__, __LINE__);
+		EEH_Debug_Tools::printr(
+			$this->checkout->generate_reg_form,
+			'$this->checkout->generate_reg_form',
+			__FILE__,
+			__LINE__
+		);
+		EEH_Debug_Tools::printr(
+			$this->checkout->process_form_submission,
+			'$this->checkout->process_form_submission',
+			__FILE__,
+			__LINE__
+		);
+	}
+
+
+	/**
+	 * _block_bots
+	 * checks that the incoming request has either of the following set:
+	 *  a UTS (unix timestamp) which indicates that the request was redirected from the Ticket Selector
+	 *  a REG URL Link, which indicates that the request is a return visit to SPCO for a valid TXN
+	 * so if you're not coming from the Ticket Selector nor returning for a valid IP...
+	 * then where you coming from man?
+	 *
+	 * @return boolean
+	 */
+	private function _block_bots(): bool
+	{
+		return EED_Invalid_Checkout_Access::getInvalidCheckoutAccess()->checkoutAccessIsInvalid($this->checkout);
+	}
+
+
+	/**
+	 *  gets slug for first step in $_reg_steps_array
+	 *
+	 * @return string
+	 */
+	private function _get_first_step(): string
+	{
+		$first_step = reset(EED_Single_Page_Checkout::$_reg_steps_array);
+		return $first_step['slug'] ?? 'attendee_information';
+	}
+
+
+	/**
+	 * instantiates each reg step based on the loaded reg_steps array
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _load_and_instantiate_reg_steps(): bool
+	{
+		do_action('AHEE__Single_Page_Checkout___load_and_instantiate_reg_steps__start', $this->checkout);
+		// have reg_steps already been instantiated ?
+		if (
+			empty($this->checkout->reg_steps)
+			|| apply_filters('FHEE__Single_Page_Checkout__load_reg_steps__reload_reg_steps', false, $this->checkout)
+		) {
+			// if not, then loop through raw reg steps array
+			foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
+				if (! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
+					return false;
+				}
+			}
+			if (isset($this->checkout->reg_steps['registration_confirmation'])) {
+				// skip the registration_confirmation page ?
+				// just remove it from the reg steps array
+				$this->checkout->remove_reg_step('registration_confirmation', false);
+			}
+			// filter the array for good luck
+			$this->checkout->reg_steps = apply_filters(
+				'FHEE__Single_Page_Checkout__load_reg_steps__reg_steps',
+				$this->checkout->reg_steps
+			);
+			// finally re-sort based on the reg step class order properties
+			$this->checkout->sort_reg_steps();
+		} else {
+			foreach ($this->checkout->reg_steps as $reg_step) {
+				// set all current step stati to FALSE
+				$reg_step->set_is_current_step(false);
+			}
+		}
+		if (empty($this->checkout->reg_steps)) {
+			EE_Error::add_error(
+				esc_html__('No Reg Steps were loaded..', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// make reg step details available to JS
+		$this->checkout->set_reg_step_JSON_info();
+		return true;
+	}
+
+
+	/**
+	 * @param array $reg_step
+	 * @param int   $order
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _load_and_instantiate_reg_step(array $reg_step = [], int $order = 0): bool
+	{
+		// we need a file_path, class_name, and slug to add a reg step
+		if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
+			// if editing a specific step, but this is NOT that step... (and it's not the 'finalize_registration' step)
+			if (
+				$this->checkout->reg_url_link
+				&& $this->checkout->step !== $reg_step['slug']
+				&& $reg_step['slug'] !== 'finalize_registration'
+				// normally at this point we would NOT load the reg step, but this filter can change that
+				&& apply_filters(
+					'FHEE__Single_Page_Checkout___load_and_instantiate_reg_step__bypass_reg_step',
+					true,
+					$reg_step,
+					$this->checkout
+				)
+			) {
+				return true;
+			}
+
+			// instantiate step class using file path and class name
+			$reg_step_obj = EE_Registry::instance()->load_file(
+				$reg_step['file_path'],
+				$reg_step['class_name'],
+				'class',
+				[$this->checkout],
+				false
+			);
+			// did we get the goods ?
+			if ($reg_step_obj instanceof EE_SPCO_Reg_Step) {
+				// set reg step order based on config
+				$reg_step_obj->set_order($order);
+				// add instantiated reg step object to the master reg steps array
+				$this->checkout->add_reg_step($reg_step_obj);
+			} else {
+				EE_Error::add_error(
+					esc_html__('The current step could not be set.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		} else {
+			if (WP_DEBUG) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s',
+							'event_espresso'
+						),
+						$reg_step['file_path'] ?? '',
+						$reg_step['class_name'] ?? '',
+						$reg_step['slug'] ?? '',
+						'<ul>',
+						'<li>',
+						'</li>',
+						'</ul>'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _verify_transaction_and_get_registrations(): bool
+	{
+		// was there already a valid transaction in the checkout from the session ?
+		if (! $this->checkout->transaction instanceof EE_Transaction) {
+			// get transaction from db or session
+			$this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
+				? $this->_get_transaction_and_cart_for_previous_visit()
+				: $this->_get_cart_for_current_session_and_setup_new_transaction();
+			if (! $this->checkout->transaction instanceof EE_Transaction) {
+				EE_Error::add_error(
+					esc_html__(
+						'Your Registration and Transaction information could not be retrieved from the db.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->checkout->transaction = EE_Transaction::new_instance();
+				// add some style and make it dance
+				$this->add_styles_and_scripts($this);
+				EED_Single_Page_Checkout::$_initialized = true;
+				return false;
+			}
+			// and the registrations for the transaction
+			$this->_get_registrations($this->checkout->transaction);
+		}
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Transaction|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_transaction_and_cart_for_previous_visit(): ?EE_Transaction
+	{
+		/** @var $TXN_model EEM_Transaction */
+		$TXN_model = EE_Registry::instance()->load_model('Transaction');
+		// because the reg_url_link is present in the request,
+		// this is a return visit to SPCO, so we'll get the transaction data from the db
+		$transaction = $TXN_model->get_transaction_from_reg_url_link($this->checkout->reg_url_link);
+		// verify transaction
+		if ($transaction instanceof EE_Transaction) {
+			// and get the cart that was used for that transaction
+			$this->checkout->cart = $this->_get_cart_for_transaction($transaction);
+			return $transaction;
+		}
+		EE_Error::add_error(
+			esc_html__(
+				'Your Registration and Transaction information could not be retrieved from the db.',
+				'event_espresso'
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return null;
+	}
+
+
+	/**
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_cart_for_transaction(?EE_Transaction $transaction): EE_Cart
+	{
+		return $this->checkout->get_cart_for_transaction($transaction);
+	}
+
+
+	/**
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_cart_for_transaction(?EE_Transaction $transaction): EE_Cart
+	{
+		return $this->checkout->get_cart_for_transaction($transaction);
+	}
+
+
+	/**
+	 * generates a new EE_Transaction object and adds it to the $_transaction property.
+	 *
+	 * @return EE_Transaction|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_cart_for_current_session_and_setup_new_transaction(): ?EE_Transaction
+	{
+		//  if there's no transaction, then this is the FIRST visit to SPCO
+		// so load up the cart ( passing nothing for the TXN because it doesn't exist yet )
+		$this->checkout->cart = $this->_get_cart_for_transaction(null);
+		// and then create a new transaction
+		$transaction = $this->_initialize_transaction();
+		// verify transaction
+		if ($transaction instanceof EE_Transaction) {
+			// and save TXN data to the cart
+			$this->checkout->cart->get_grand_total()->save_this_and_descendants_to_txn($transaction->ID());
+		} else {
+			EE_Error::add_error(
+				esc_html__('A Valid Transaction could not be initialized.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 * generates a new EE_Transaction object and adds it to the $_transaction property.
+	 *
+	 * @return EE_Transaction|null
+	 */
+	private function _initialize_transaction(): ?EE_Transaction
+	{
+		try {
+			// ensure cart totals have been calculated
+			$this->checkout->cart->get_grand_total()->recalculate_total_including_taxes();
+			// grab the cart grand total
+			$cart_total = $this->checkout->cart->get_cart_grand_total();
+			// create new TXN
+			$transaction = EE_Transaction::new_instance(
+				[
+					'TXN_reg_steps' => $this->checkout->initialize_txn_reg_steps_array(),
+					'TXN_total'     => max($cart_total, 0),
+					'TXN_paid'      => 0,
+					'STS_ID'        => EEM_Transaction::failed_status_code,
+				]
+			);
+			// save it so that we have an ID for other objects to use
+			$transaction->save();
+			// set cron job for following up on TXNs after their session has expired
+			EE_Cron_Tasks::schedule_expired_transaction_check(
+				$this->session->expiration() + 1,
+				$transaction->ID()
+			);
+			return $transaction;
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+		}
+		return null;
+	}
+
+
+	/**
+	 * _get_registrations
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_registrations(EE_Transaction $transaction)
+	{
+		// first step: grab the registrants  { : o
+		$registrations                      = $transaction->registrations($this->checkout->reg_cache_where_params);
+		$this->checkout->total_ticket_count = count($registrations);
+		// verify registrations have been set
+		if (empty($registrations)) {
+			// if no cached registrations, then check the db
+			$registrations = $transaction->registrations($this->checkout->reg_cache_where_params);
+			// still nothing ? well as long as this isn't a revisit
+			if (empty($registrations) && ! $this->checkout->revisit) {
+				// generate new registrations from scratch
+				$registrations = $this->_initialize_registrations($transaction);
+			}
+		}
+		// sort by their original registration order
+		usort($registrations, ['EED_Single_Page_Checkout', 'sort_registrations_by_REG_count']);
+		// then loop thru the array
+		foreach ($registrations as $registration) {
+			// verify each registration
+			if ($registration instanceof EE_Registration) {
+				// we display all attendee info for the primary registrant
+				if (
+					$this->checkout->reg_url_link === $registration->reg_url_link()
+					&& $registration->is_primary_registrant()
+				) {
+					$this->checkout->primary_revisit = true;
+					break;
+				}
+				if ($this->checkout->revisit && $this->checkout->reg_url_link !== $registration->reg_url_link()) {
+					// but hide info if it doesn't belong to you
+					$transaction->clear_cache('Registration', $registration->ID());
+					$this->checkout->total_ticket_count--;
+				}
+				$this->checkout->set_reg_status_updated($registration->ID(), false);
+			}
+		}
+	}
+
+
+	/**
+	 * adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _initialize_registrations(EE_Transaction $transaction): array
+	{
+		$att_nmbr      = 0;
+		$registrations = [];
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor             = EE_Registry::instance()->load_class('Registration_Processor');
+		$this->checkout->total_ticket_count = $this->checkout->cart->all_ticket_quantity_count();
+		// now let's add the cart items to the $transaction
+		foreach ($this->checkout->cart->get_tickets() as $line_item) {
+			// do the following for each ticket of this type they selected
+			for ($x = 1; $x <= $line_item->quantity(); $x++) {
+				$att_nmbr++;
+				/** @var CreateRegistrationCommand $CreateRegistrationCommand */
+				$CreateRegistrationCommand = EE_Registry::instance()->create(
+					CreateRegistrationCommand::class,
+					[
+						$transaction,
+						$line_item,
+						$att_nmbr,
+						$this->checkout->total_ticket_count,
+					]
+				);
+				// override capabilities for frontend registrations
+				if ($this->request->isFrontend()) {
+					$CreateRegistrationCommand->setCapCheck(
+						new PublicCapabilities('', 'create_new_registration')
+					);
+				}
+				$registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
+				if (! $registration instanceof EE_Registration) {
+					throw new InvalidEntityException($registration, 'EE_Registration');
+				}
+				$registrations[ $registration->ID() ] = $registration;
+			}
+		}
+		$registration_processor->fix_reg_final_price_rounding_issue($transaction);
+		return $registrations;
+	}
+
+
+	/**
+	 * @param EE_Registration $reg_A
+	 * @param EE_Registration $reg_B
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function sort_registrations_by_REG_count(EE_Registration $reg_A, EE_Registration $reg_B): int
+	{
+		// this shouldn't ever happen within the same TXN, but oh well
+		if ($reg_A->count() === $reg_B->count()) {
+			return 0;
+		}
+		return ($reg_A->count() > $reg_B->count()) ? 1 : -1;
+	}
+
+
+	/**
+	 * just makes sure that everything is set up correctly before proceeding
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _final_verifications(): bool
+	{
+		// filter checkout
+		$this->checkout = apply_filters(
+			'FHEE__EED_Single_Page_Checkout___final_verifications__checkout',
+			$this->checkout
+		);
+		// verify that current step is still set correctly
+		if (! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
+			EE_Error::add_error(
+				esc_html__(
+					'We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// if returning to SPCO, then verify that primary registrant is set
+		if (! empty($this->checkout->reg_url_link)) {
+			$valid_registrant = $this->checkout->transaction->primary_registration();
+			if (! $valid_registrant instanceof EE_Registration) {
+				EE_Error::add_error(
+					esc_html__(
+						'We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$valid_registrant = null;
+			foreach (
+				$this->checkout->transaction->registrations(
+					$this->checkout->reg_cache_where_params
+				) as $registration
+			) {
+				if (
+					$registration instanceof EE_Registration
+					&& $registration->reg_url_link() === $this->checkout->reg_url_link
+				) {
+					$valid_registrant = $registration;
+				}
+			}
+			if (! $valid_registrant instanceof EE_Registration) {
+				// hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
+				if (EED_Single_Page_Checkout::$_checkout_verified) {
+					// clear the session, mark the checkout as unverified, and try again
+					$this->session->clear_session(__CLASS__, __FUNCTION__);
+					EED_Single_Page_Checkout::$_initialized       = false;
+					EED_Single_Page_Checkout::$_checkout_verified = false;
+					$this->_initialize();
+					EE_Error::reset_notices();
+					return false;
+				}
+				EE_Error::add_error(
+					esc_html__(
+						'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		// now that things have been kinda sufficiently verified,
+		// let's add the checkout to the session so that it's available to other systems
+		$this->session->set_checkout($this->checkout);
+		return true;
+	}
+
+
+	/**
+	 * first makes sure that EE_Transaction_Processor::set_reg_step_initiated() is called as required
+	 * then loops thru all the active reg steps and calls the initialize_reg_step() method
+	 *
+	 * @param bool $reinitializing
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _initialize_reg_steps(bool $reinitializing = false)
+	{
+		$this->checkout->set_reg_step_initiated($this->checkout->current_step);
+		// loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
+		foreach ($this->checkout->reg_steps as $reg_step) {
+			if (! $reg_step->initialize_reg_step()) {
+				// if not initialized then maybe this step is being removed...
+				if (! $reinitializing && $reg_step->is_current_step()) {
+					// if it was the current step, then we need to start over here
+					$this->_initialize_reg_steps(true);
+					return;
+				}
+				continue;
+			}
+			// add css and JS for current step
+			$this->add_styles_and_scripts($reg_step);
+			if ($reg_step->is_current_step()) {
+				// the text that appears on the reg step form submit button
+				$reg_step->set_submit_button_text();
+			}
+		}
+		// dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
+		do_action(
+			"AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}",
+			$this->checkout->current_step
+		);
+		$this->checkout->json_response->set_return_data(
+			[
+				'action'        => $this->checkout->action,
+				'admin_request' => $this->checkout->admin_request,
+				'current_step'  => $this->checkout->current_step->slug(),
+				'revisit'       => $this->checkout->revisit,
+			]
+		);
+	}
+
+
+	/**
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _check_form_submission(): bool
+	{
+		// does this request require the reg form to be generated ?
+		if ($this->checkout->generate_reg_form) {
+			// ever heard that song by Blue Rodeo ?
+			try {
+				$this->checkout->current_step->reg_form = $this->checkout->current_step->generate_reg_form();
+				// if not displaying a form, then check for form submission
+				if (
+					$this->checkout->process_form_submission
+					&& $this->checkout->current_step->reg_form->was_submitted()
+				) {
+					// clear out any old data in case this step is being run again
+					$this->checkout->current_step->set_valid_data([]);
+					// capture submitted form data
+					$request_data = $this->request->requestParams();
+					$this->checkout->current_step->reg_form->receive_form_submission(
+						(array) apply_filters(
+							'FHEE__Single_Page_Checkout___check_form_submission__request_params',
+							$request_data,
+							$this->checkout
+						)
+					);
+					// validate submitted form data
+					if (! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
+						// thou shall not pass !!!
+						$this->checkout->continue_reg = false;
+						// any form validation errors?
+						if ($this->checkout->current_step->reg_form->submission_error_message() !== '') {
+							EE_Error::add_error(
+								$this->checkout->current_step->reg_form->submission_error_message(),
+								__FILE__,
+								__FUNCTION__,
+								__LINE__
+							);
+						}
+						// well not really... what will happen is
+						// we'll just get redirected back to redo the current step
+						$this->go_to_next_step();
+						return false;
+					}
+				}
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _process_form_action()
+	{
+		// what cha wanna do?
+		switch ($this->checkout->action) {
+			// AJAX next step reg form
+			case 'display_spco_reg_step':
+				$this->checkout->redirect = false;
+				if ($this->request->isAjax()) {
+					$this->checkout->json_response->set_reg_step_html(
+						$this->checkout->current_step->display_reg_form()
+					);
+				}
+				break;
+			default:
+				// meh... do one of those other steps first
+				if (
+					! empty($this->checkout->action)
+					&& is_callable([$this->checkout->current_step, $this->checkout->action])
+				) {
+					// dynamically creates hook point like:
+					//   AHEE__Single_Page_Checkout__before_attendee_information__process_reg_step
+					do_action(
+						"AHEE__Single_Page_Checkout__before_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						$this->checkout->current_step
+					);
+					$process_reg_step = apply_filters(
+						"AHEE__Single_Page_Checkout__process_reg_step__{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						true,
+						$this->checkout->current_step,
+						$this
+					);
+					// call action on current step
+					if ($process_reg_step && call_user_func([$this->checkout->current_step, $this->checkout->action])) {
+						// good registrant, you get to proceed
+						if (
+							$this->checkout->current_step->success_message() !== ''
+							&& apply_filters(
+								'FHEE__Single_Page_Checkout___process_form_action__display_success',
+								false
+							)
+						) {
+							EE_Error::add_success(
+								$this->checkout->current_step->success_message()
+								. '<br />' . $this->checkout->next_step->_instructions()
+							);
+						}
+						// pack it up, pack it in...
+						$this->_setup_redirect();
+					}
+					// dynamically creates hook point like:
+					//  AHEE__Single_Page_Checkout__after_payment_options__process_reg_step
+					do_action(
+						"AHEE__Single_Page_Checkout__after_{$this->checkout->current_step->slug()}__{$this->checkout->action}",
+						$this->checkout->current_step
+					);
+				} else {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'The requested form action "%s" does not exist for the current "%s" registration step.',
+								'event_espresso'
+							),
+							$this->checkout->action,
+							$this->checkout->current_step->name()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			// end default
+		}
+		// store our progress so far
+		$this->checkout->stash_transaction_and_checkout();
+		// advance to the next step! If you pass GO, collect $200
+		$this->go_to_next_step();
+	}
+
+
+	/**
+	 * @param EED_Single_Page_Checkout|EE_SPCO_Reg_Step $target an object with the method `translate_js_strings` and
+	 *                                                          `enqueue_styles_and_scripts`.
+	 * @return void
+	 */
+	public function add_styles_and_scripts($target)
+	{
+		// i18n
+		$target->translate_js_strings();
+		if ($this->checkout->admin_request) {
+			add_action('admin_enqueue_scripts', [$target, 'enqueue_styles_and_scripts']);
+		} else {
+			add_action('wp_enqueue_scripts', [$target, 'enqueue_styles_and_scripts']);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['revisit']                        = $this->checkout->revisit;
+		EE_Registry::$i18n_js_strings['e_reg_url_link']                 = $this->checkout->reg_url_link;
+		EE_Registry::$i18n_js_strings['server_error']                   = esc_html__(
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_json_response']          = esc_html__(
+			'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['validation_error']               = esc_html__(
+			'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_payment_method']         = esc_html__(
+			'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['reg_step_error']                 = esc_html__(
+			'This registration step could not be completed. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_coupon']                 = esc_html__(
+			'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['process_registration']           = sprintf(
+			esc_html__(
+				'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.',
+				'event_espresso'
+			),
+			'<br/>',
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['language']                       = get_bloginfo('language');
+		EE_Registry::$i18n_js_strings['EESID']                          = $this->session->id();
+		EE_Registry::$i18n_js_strings['currency']                       = EE_Registry::instance()->CFG->currency;
+		EE_Registry::$i18n_js_strings['datepicker_yearRange']           = '-150:+20';
+		EE_Registry::$i18n_js_strings['timer_years']                    = esc_html__('years', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_months']                   = esc_html__('months', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_weeks']                    = esc_html__('weeks', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_days']                     = esc_html__('days', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hours']                    = esc_html__('hours', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minutes']                  = esc_html__('minutes', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_seconds']                  = esc_html__('seconds', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_year']                     = esc_html__('year', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_month']                    = esc_html__('month', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_week']                     = esc_html__('week', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_day']                      = esc_html__('day', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hour']                     = esc_html__('hour', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minute']                   = esc_html__('minute', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_second']                   = esc_html__('second', 'event_espresso');
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] =
+			EED_Single_Page_Checkout::getRegistrationExpirationNotice();
+		EE_Registry::$i18n_js_strings['ajax_submit']                    = apply_filters(
+			'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
+			true
+		);
+		EE_Registry::$i18n_js_strings['session_extension']              = absint(
+			apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
+		);
+		EE_Registry::$i18n_js_strings['session_expiration']    = $this->session->expiration();
+		EE_Registry::$i18n_js_strings['use_session_countdown'] = EE_Registry::instance()->CFG->registration->useSessionCountdown();
+		EE_Registry::$i18n_js_strings['no_copy_paste_email_confirm'] = esc_html__("We're sorry but copy and paste is disabled for email confirmation inputs. Please enter the email address manually.", 'event_espresso');
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function enqueue_styles_and_scripts()
+	{
+		// load css
+		wp_register_style(
+			'single_page_checkout',
+			SPCO_CSS_URL . 'single_page_checkout.css',
+			['espresso_default'],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('single_page_checkout');
+		// load JS
+		wp_register_script(
+			'single_page_checkout',
+			SPCO_JS_URL . 'single_page_checkout.js',
+			['espresso_core', 'underscore', 'ee_form_section_validation'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->registration_form->enqueue_js();
+		}
+		if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->current_step->reg_form->enqueue_js();
+		}
+		wp_enqueue_script('single_page_checkout');
+		/**
+		 * global action hook for enqueueing styles and scripts with
+		 * spco calls.
+		 */
+		do_action('AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts', $this);
+		/**
+		 * dynamic action hook for enqueueing styles and scripts with spco calls.
+		 * The hook will end up being something like:
+		 *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
+		 */
+		do_action(
+			'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
+			$this
+		);
+	}
+
+
+	/**
+	 * display the Registration Single Page Checkout Form
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _display_spco_reg_form()
+	{
+		// if registering via the admin, just display the reg form for the current step
+		if ($this->checkout->admin_request) {
+			EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->current_step->display_reg_form());
+			return;
+		}
+
+		// add powered by EE msg
+		add_action('AHEE__SPCO__reg_form_footer', ['EED_Single_Page_Checkout', 'display_registration_footer']);
+		$empty_cart = count(
+				$this->checkout->transaction->registrations($this->checkout->reg_cache_where_params)
+			) < 1;
+		EE_Registry::$i18n_js_strings['empty_cart'] = $empty_cart;
+
+		/** @var FeatureFlags $feature */
+		$feature = LoaderFactory::getShared(FeatureFlags::class);
+
+		$this->checkout->registration_form = $feature->allowed(FeatureFlag::USE_SPCO_FORM_REFACTOR)
+			? new SinglePageCheckoutForm($this->checkout, $empty_cart)
+			: new LegacySpcoForm($this->checkout, $empty_cart, $this->session->expiration());
+
+		// load template and add to output sent that gets filtered into the_content()
+		EED_Single_Page_Checkout::getResponse()->addOutput($this->checkout->registration_form->get_html());
+
+	}
+
+
+	/**
+	 * @param $next_step
+	 * @return void
+	 */
+	public function add_extra_finalize_registration_inputs($next_step)
+	{
+		if ($next_step === 'finalize_registration') {
+			echo '<div id="spco-extra-finalize_registration-inputs-dv"></div>';
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function display_registration_footer()
+	{
+		if (
+			apply_filters(
+				'FHEE__EE_Front__Controller__show_reg_footer',
+				EE_Registry::instance()->CFG->admin->show_reg_footer
+			)
+		) {
+			add_filter(
+				'FHEE__EEH_Template__powered_by_event_espresso__url',
+				function ($url) {
+					return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
+				}
+			);
+			echo apply_filters(
+				'FHEE__EE_Front_Controller__display_registration_footer',
+				EEH_Template::powered_by_event_espresso(
+					'',
+					'espresso-registration-footer-dv',
+					['utm_content' => 'registration_checkout']
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function unlock_transaction()
+	{
+		if ($this->checkout instanceof EE_Checkout && $this->checkout->transaction instanceof EE_Transaction) {
+			$this->checkout->transaction->unlock();
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function _setup_redirect()
+	{
+		if ($this->checkout->continue_reg && $this->checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			$this->checkout->redirect = true;
+			if (empty($this->checkout->redirect_url)) {
+				$this->checkout->redirect_url = $this->checkout->next_step->reg_step_url();
+			}
+			$this->checkout->redirect_url = apply_filters(
+				'FHEE__EED_Single_Page_Checkout___setup_redirect__checkout_redirect_url',
+				$this->checkout->redirect_url,
+				$this->checkout
+			);
+		}
+	}
+
+
+	/**
+	 * handle ajax message responses and redirects
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function go_to_next_step()
+	{
+		if ($this->request->isAjax()) {
+			// capture contents of output buffer we started earlier in the request, and insert into JSON response
+			$this->checkout->json_response->set_unexpected_errors(ob_get_clean());
+		}
+		$this->unlock_transaction();
+		// just return for these conditions
+		if (
+			$this->checkout->admin_request
+			|| $this->checkout->action === 'redirect_form'
+			|| $this->checkout->action === 'update_checkout'
+		) {
+			return;
+		}
+		// AJAX response
+		$this->_handle_json_response();
+		// redirect to next step or the Thank-You page
+		$this->_handle_html_redirects();
+		// hmmm... must be something wrong, so let's just display the form again !
+		$this->_display_spco_reg_form();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _handle_json_response()
+	{
+		// if this is an ajax request
+		if ($this->request->isAjax()) {
+			$this->checkout->json_response->set_registration_time_limit(
+				$this->checkout->get_registration_time_limit()
+			);
+			$this->checkout->json_response->set_payment_amount($this->checkout->amount_owing);
+			/** @var EE_SPCO_JSON_Response $json_response */
+			$json_response = apply_filters(
+				'FHEE__EE_Single_Page_Checkout__JSON_response',
+				$this->checkout->json_response
+			);
+			// just send the ajax
+			$json_response->sendResponse();
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _handle_html_redirects()
+	{
+		// going somewhere ?
+		if ($this->checkout->redirect && ! empty($this->checkout->redirect_url)) {
+			// store notices in a transient
+			EE_Error::get_notices(false, true);
+			wp_safe_redirect($this->checkout->redirect_url);
+			exit();
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function set_checkout_anchor()
+	{
+		echo '<a id="checkout" style="float: left; margin-left: -999em;"></a>';
+	}
+
+
+	/**
+	 * @return string
+	 * @since 4.9.59.p
+	 */
+	public static function getRegistrationExpirationNotice(): string
+	{
+		return sprintf(
+			esc_html__(
+				'%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please accept our apologies for any inconvenience this may have caused.%8$s',
+				'event_espresso'
+			),
+			'<h4 class="important-notice">',
+			'</h4>',
+			'<br />',
+			'<p>',
+			'<a href="' . get_post_type_archive_link(EspressoPostType::EVENTS) . '" title="',
+			'">',
+			'</a>',
+			'</p>'
+		);
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -51,7 +51,7 @@ 
 
     public ?EE_Session $session = null;
 
-    private bool $debug = false;    //  true    false
+    private bool $debug = false; //  true    false
 
 
     /**
@@ -115,7 +115,7 @@ 
     public static function set_hooks_admin()
     {
         EED_Single_Page_Checkout::set_definitions();
-        if (! (defined('DOING_AJAX') && DOING_AJAX)) {
+        if ( ! (defined('DOING_AJAX') && DOING_AJAX)) {
             return;
         }
         // going to start an output buffer in case anything gets accidentally output
@@ -209,14 +209,14 @@ 
         }
         define(
             'SPCO_BASE_PATH',
-            rtrim(str_replace(['\\', '/'], '/', plugin_dir_path(__FILE__)), '/') . '/'
+            rtrim(str_replace(['\\', '/'], '/', plugin_dir_path(__FILE__)), '/').'/'
         );
-        define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css/');
-        define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img/');
-        define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js/');
-        define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc/');
-        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps/');
-        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates/');
+        define('SPCO_CSS_URL', plugin_dir_url(__FILE__).'css/');
+        define('SPCO_IMG_URL', plugin_dir_url(__FILE__).'img/');
+        define('SPCO_JS_URL', plugin_dir_url(__FILE__).'js/');
+        define('SPCO_INC_PATH', SPCO_BASE_PATH.'inc/');
+        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH.'reg_steps/');
+        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH.'templates/');
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
         EE_Registry::$i18n_js_strings['registration_expiration_notice'] =
             EED_Single_Page_Checkout::getRegistrationExpirationNotice();
@@ -247,7 +247,7 @@ 
             // we need a
             if (isset($reg_step['file_path'], $reg_step['class_name'], $reg_step['slug'])) {
                 // copy over to the reg_steps_array
-                EED_Single_Page_Checkout::$_reg_steps_array[ $order ] = $reg_step;
+                EED_Single_Page_Checkout::$_reg_steps_array[$order] = $reg_step;
                 // register custom key route for each reg step
                 // ie: step=>"slug" - this is the entire reason we load the reg steps array now
                 EED_Module::registerRoute(
@@ -259,7 +259,7 @@ 
                 // add AJAX or other hooks
                 if (isset($reg_step['has_hooks']) && $reg_step['has_hooks']) {
                     // setup autoloaders if necessary
-                    if (! class_exists($reg_step['class_name'])) {
+                    if ( ! class_exists($reg_step['class_name'])) {
                         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(
                             $reg_step['file_path'],
                             true
@@ -286,19 +286,19 @@ 
         if (empty($reg_steps)) {
             $reg_steps = [
                 10  => [
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'attendee_information',
                     'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
                     'slug'       => 'attendee_information',
                     'has_hooks'  => false,
                 ],
                 30  => [
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'payment_options',
                     'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
                     'slug'       => 'payment_options',
                     'has_hooks'  => true,
                 ],
                 999 => [
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'finalize_registration',
                     'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
                     'slug'       => 'finalize_registration',
                     'has_hooks'  => false,
@@ -444,7 +444,7 @@ 
                 $this->checkout
             );
             // load the reg steps array
-            if (! $this->_load_and_instantiate_reg_steps()) {
+            if ( ! $this->_load_and_instantiate_reg_steps()) {
                 EED_Single_Page_Checkout::$_initialized = true;
                 return;
             }
@@ -453,7 +453,7 @@ 
             // and the next step
             $this->checkout->set_next_step();
             // verify that everything has been set up correctly
-            if (! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
+            if ( ! ($this->_verify_transaction_and_get_registrations() && $this->_final_verifications())) {
                 EED_Single_Page_Checkout::$_initialized = true;
                 return;
             }
@@ -469,7 +469,7 @@ 
             // DEBUG LOG
             // $this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
             // get reg form
-            if (! $this->_check_form_submission()) {
+            if ( ! $this->_check_form_submission()) {
                 EED_Single_Page_Checkout::$_initialized = true;
                 return;
             }
@@ -499,9 +499,9 @@ 
      */
     private function _verify_session()
     {
-        if (! $this->session instanceof EE_Session) {
+        if ( ! $this->session instanceof EE_Session) {
             $this->session = LoaderFactory::getShared(EE_Session::class);
-            if (! $this->session instanceof EE_Session) {
+            if ( ! $this->session instanceof EE_Session) {
                 throw new EE_Error(esc_html__('The EE_Session class could not be loaded.', 'event_espresso'));
             }
         }
@@ -516,7 +516,7 @@ 
         ) {
             $this->checkout = new EE_Checkout();
             $this->session->clear_session(__CLASS__, __FUNCTION__);
-            if (! $clear_session_requested) {
+            if ( ! $clear_session_requested) {
                 EE_Error::add_attention(
                     EE_Registry::$i18n_js_strings['registration_expiration_notice'],
                     __FILE__,
@@ -541,7 +541,7 @@ 
         /** @type EE_Checkout $checkout */
         $checkout = $this->session->checkout();
         // verify
-        if (! $checkout instanceof EE_Checkout) {
+        if ( ! $checkout instanceof EE_Checkout) {
             // instantiate EE_Checkout object for handling the properties of the current checkout process
             $checkout = EE_Registry::instance()->load_file(
                 SPCO_INC_PATH,
@@ -559,7 +559,7 @@ 
         }
         $checkout = apply_filters('FHEE__EED_Single_Page_Checkout___initialize_checkout__checkout', $checkout);
         // verify again
-        if (! $checkout instanceof EE_Checkout) {
+        if ( ! $checkout instanceof EE_Checkout) {
             throw new EE_Error(esc_html__('The EE_Checkout class could not be loaded.', 'event_espresso'));
         }
         // reset anything that needs a clean slate for each request
@@ -616,7 +616,7 @@ 
      */
     protected function _display_request_vars()
     {
-        if (! ($this->debug && defined('WP_DEBUG') && WP_DEBUG)) {
+        if ( ! ($this->debug && defined('WP_DEBUG') && WP_DEBUG)) {
             return;
         }
         EEH_Debug_Tools::printr($this->request->requestParams(), 'requestParams', __FILE__, __LINE__);
@@ -688,7 +688,7 @@ 
         ) {
             // if not, then loop through raw reg steps array
             foreach (EED_Single_Page_Checkout::$_reg_steps_array as $order => $reg_step) {
-                if (! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
+                if ( ! $this->_load_and_instantiate_reg_step($reg_step, $order)) {
                     return false;
                 }
             }
@@ -810,12 +810,12 @@ 
     private function _verify_transaction_and_get_registrations(): bool
     {
         // was there already a valid transaction in the checkout from the session ?
-        if (! $this->checkout->transaction instanceof EE_Transaction) {
+        if ( ! $this->checkout->transaction instanceof EE_Transaction) {
             // get transaction from db or session
             $this->checkout->transaction = $this->checkout->reg_url_link && ! is_admin()
                 ? $this->_get_transaction_and_cart_for_previous_visit()
                 : $this->_get_cart_for_current_session_and_setup_new_transaction();
-            if (! $this->checkout->transaction instanceof EE_Transaction) {
+            if ( ! $this->checkout->transaction instanceof EE_Transaction) {
                 EE_Error::add_error(
                     esc_html__(
                         'Your Registration and Transaction information could not be retrieved from the db.',
@@ -1044,10 +1044,10 @@ 
                     );
                 }
                 $registration = EE_Registry::instance()->BUS->execute($CreateRegistrationCommand);
-                if (! $registration instanceof EE_Registration) {
+                if ( ! $registration instanceof EE_Registration) {
                     throw new InvalidEntityException($registration, 'EE_Registration');
                 }
-                $registrations[ $registration->ID() ] = $registration;
+                $registrations[$registration->ID()] = $registration;
             }
         }
         $registration_processor->fix_reg_final_price_rounding_issue($transaction);
@@ -1087,7 +1087,7 @@ 
             $this->checkout
         );
         // verify that current step is still set correctly
-        if (! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
+        if ( ! $this->checkout->current_step instanceof EE_SPCO_Reg_Step) {
             EE_Error::add_error(
                 esc_html__(
                     'We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.',
@@ -1100,9 +1100,9 @@ 
             return false;
         }
         // if returning to SPCO, then verify that primary registrant is set
-        if (! empty($this->checkout->reg_url_link)) {
+        if ( ! empty($this->checkout->reg_url_link)) {
             $valid_registrant = $this->checkout->transaction->primary_registration();
-            if (! $valid_registrant instanceof EE_Registration) {
+            if ( ! $valid_registrant instanceof EE_Registration) {
                 EE_Error::add_error(
                     esc_html__(
                         'We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.',
@@ -1127,7 +1127,7 @@ 
                     $valid_registrant = $registration;
                 }
             }
-            if (! $valid_registrant instanceof EE_Registration) {
+            if ( ! $valid_registrant instanceof EE_Registration) {
                 // hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
                 if (EED_Single_Page_Checkout::$_checkout_verified) {
                     // clear the session, mark the checkout as unverified, and try again
@@ -1170,9 +1170,9 @@ 
         $this->checkout->set_reg_step_initiated($this->checkout->current_step);
         // loop thru all steps to call their individual "initialize" methods and set i18n strings for JS
         foreach ($this->checkout->reg_steps as $reg_step) {
-            if (! $reg_step->initialize_reg_step()) {
+            if ( ! $reg_step->initialize_reg_step()) {
                 // if not initialized then maybe this step is being removed...
-                if (! $reinitializing && $reg_step->is_current_step()) {
+                if ( ! $reinitializing && $reg_step->is_current_step()) {
                     // if it was the current step, then we need to start over here
                     $this->_initialize_reg_steps(true);
                     return;
@@ -1231,7 +1231,7 @@ 
                         )
                     );
                     // validate submitted form data
-                    if (! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
+                    if ( ! $this->checkout->continue_reg || ! $this->checkout->current_step->reg_form->is_valid()) {
                         // thou shall not pass !!!
                         $this->checkout->continue_reg = false;
                         // any form validation errors?
@@ -1305,7 +1305,7 @@ 
                         ) {
                             EE_Error::add_success(
                                 $this->checkout->current_step->success_message()
-                                . '<br />' . $this->checkout->next_step->_instructions()
+                                . '<br />'.$this->checkout->next_step->_instructions()
                             );
                         }
                         // pack it up, pack it in...
@@ -1369,27 +1369,27 @@ 
             'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['invalid_json_response']          = esc_html__(
+        EE_Registry::$i18n_js_strings['invalid_json_response'] = esc_html__(
             'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['validation_error']               = esc_html__(
+        EE_Registry::$i18n_js_strings['validation_error'] = esc_html__(
             'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['invalid_payment_method']         = esc_html__(
+        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
             'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['reg_step_error']                 = esc_html__(
+        EE_Registry::$i18n_js_strings['reg_step_error'] = esc_html__(
             'This registration step could not be completed. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['invalid_coupon']                 = esc_html__(
+        EE_Registry::$i18n_js_strings['invalid_coupon'] = esc_html__(
             'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['process_registration']           = sprintf(
+        EE_Registry::$i18n_js_strings['process_registration'] = sprintf(
             esc_html__(
                 'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.',
                 'event_espresso'
@@ -1421,7 +1421,7 @@ 
             'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
             true
         );
-        EE_Registry::$i18n_js_strings['session_extension']              = absint(
+        EE_Registry::$i18n_js_strings['session_extension'] = absint(
             apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
         );
         EE_Registry::$i18n_js_strings['session_expiration']    = $this->session->expiration();
@@ -1439,7 +1439,7 @@ 
         // load css
         wp_register_style(
             'single_page_checkout',
-            SPCO_CSS_URL . 'single_page_checkout.css',
+            SPCO_CSS_URL.'single_page_checkout.css',
             ['espresso_default'],
             EVENT_ESPRESSO_VERSION
         );
@@ -1447,7 +1447,7 @@ 
         // load JS
         wp_register_script(
             'single_page_checkout',
-            SPCO_JS_URL . 'single_page_checkout.js',
+            SPCO_JS_URL.'single_page_checkout.js',
             ['espresso_core', 'underscore', 'ee_form_section_validation'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -1470,7 +1470,7 @@ 
          *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
          */
         do_action(
-            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
+            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__'.$this->checkout->current_step->slug(),
             $this
         );
     }
@@ -1536,7 +1536,7 @@ 
         ) {
             add_filter(
                 'FHEE__EEH_Template__powered_by_event_espresso__url',
-                function ($url) {
+                function($url) {
                     return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
                 }
             );
@@ -1676,7 +1676,7 @@ 
             '</h4>',
             '<br />',
             '<p>',
-            '<a href="' . get_post_type_archive_link(EspressoPostType::EVENTS) . '" title="',
+            '<a href="'.get_post_type_archive_link(EspressoPostType::EVENTS).'" title="',
             '">',
             '</a>',
             '</p>'

modules/single_page_checkout/templates/registration_page_wrapper.template.php

Indentation +43 added lines, -43 removed lines

@@ -17,37 +17,37 @@ 
 
 <div id="ee-single-page-checkout-dv">
     <?php
-    if (! $empty_cart) {
-        if ($use_session_countdown) { ?>
+	if (! $empty_cart) {
+		if ($use_session_countdown) { ?>
             <p id="spco-registration-time-limit-pg" class="spco-steps-pg ee-attention important-notice">
                 <?php echo sprintf(
-                    apply_filters(
-                        'FHEE__registration_page_wrapper_template___time_limit',
-                        esc_html__('You have %1$s to complete your registration.', 'event_espresso')
-                    ),
-                    '<span id="spco-registration-time-limit-spn" class="spco-registration-time-limit-spn">'
-                    . $registration_time_limit
-                    . '</span>'
-                );
-                ?>
+					apply_filters(
+						'FHEE__registration_page_wrapper_template___time_limit',
+						esc_html__('You have %1$s to complete your registration.', 'event_espresso')
+					),
+					'<span id="spco-registration-time-limit-spn" class="spco-registration-time-limit-spn">'
+					. $registration_time_limit
+					. '</span>'
+				);
+				?>
                 <span id="spco-registration-expiration-spn" class="" style="display:none;"></span>
             </p>
         <?php }
-        if (! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
-            ?>
+		if (! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
+			?>
             <h2 id="spco-steps-big-hdr" class="spco-steps-big-hdr">
                 <?php esc_html_e(' Steps', 'event_espresso'); ?>
             </h2>
 
             <div id="spco-steps-display-dv">
                 <?php
-                $step_nmbr = 1;
-                $total_steps = count($reg_steps) - 1;
-                foreach ($reg_steps as $reg_step) {
-                    if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
-                        $slug = $reg_step->slug();
-                        $step_display_dv_class = $reg_step->is_current_step() ? 'active-step' : 'inactive-step';
-                        ?>
+				$step_nmbr = 1;
+				$total_steps = count($reg_steps) - 1;
+				foreach ($reg_steps as $reg_step) {
+					if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
+						$slug = $reg_step->slug();
+						$step_display_dv_class = $reg_step->is_current_step() ? 'active-step' : 'inactive-step';
+						?>
                         <div id="spco-step-<?php echo esc_attr($slug); ?>-display-dv"
                              class="spco-step-display-dv <?php echo esc_attr($step_display_dv_class); ?> steps-<?php echo esc_attr($total_steps); ?>"
                         >
@@ -60,28 +60,28 @@ 
                         </div>
 
                         <?php
-                        if ($step_nmbr < $total_steps) { ?>
+						if ($step_nmbr < $total_steps) { ?>
                             <div class="spco-step-arrow-dv">&raquo;</div>
                             <?php
-                        }
-                        $step_nmbr++;
-                    }
-                }
-                ?>
+						}
+						$step_nmbr++;
+					}
+				}
+				?>
                 <div class="clear-float"></div>
             </div>
 
             <?php
-        }
+		}
 
-        do_action('AHEE__SPCO__before_registration_steps');
-        $step_nmbr = 1;
-        foreach ($reg_steps as $reg_step) {
-            if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
-                $slug = $reg_step->slug();
-                do_action('AHEE__' . $slug . '__reg_step_start', $reg_step);
-                // todo: deprecate hook AHEE__registration_page_attendee_information__start
-                ?>
+		do_action('AHEE__SPCO__before_registration_steps');
+		$step_nmbr = 1;
+		foreach ($reg_steps as $reg_step) {
+			if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
+				$slug = $reg_step->slug();
+				do_action('AHEE__' . $slug . '__reg_step_start', $reg_step);
+				// todo: deprecate hook AHEE__registration_page_attendee_information__start
+				?>
                 <div id="spco-<?php echo esc_attr($slug); ?>-dv"
                      class="spco-step-dv <?php echo esc_attr($reg_step->div_class()); ?>"
                 >
@@ -89,19 +89,19 @@ 
                     <?php do_action('AHEE__SPCO_after_reg_step_form', $slug, $next_step); ?>
                 </div>
                 <?php $step_nmbr++;
-            }
-        }
-        do_action('AHEE__SPCO__after_registration_steps');
-    } else {
-        ?>
+			}
+		}
+		do_action('AHEE__SPCO__after_registration_steps');
+	} else {
+		?>
         <h3 id="spco-empty-cart-hdr" class="spco-step-title-hdr">
             <?php esc_html_e('Nothing in your Event Queue', 'event_espresso'); ?>
         </h3>
         <p><?php echo wp_kses($empty_msg, AllowedTags::getWithFormTags()); ?></p>
         <?php echo wp_kses($cookies_not_set_msg, AllowedTags::getWithFormTags()); ?>
         <?php
-    }
-    do_action('AHEE__SPCO__reg_form_footer');
-    ?>
+	}
+	do_action('AHEE__SPCO__reg_form_footer');
+	?>
 
 </div>

Spacing +3 added lines, -3 removed lines

@@ -17,7 +17,7 @@ 
 
 <div id="ee-single-page-checkout-dv">
     <?php
-    if (! $empty_cart) {
+    if ( ! $empty_cart) {
         if ($use_session_countdown) { ?>
             <p id="spco-registration-time-limit-pg" class="spco-steps-pg ee-attention important-notice">
                 <?php echo sprintf(
@@ -33,7 +33,7 @@ 
                 <span id="spco-registration-expiration-spn" class="" style="display:none;"></span>
             </p>
         <?php }
-        if (! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
+        if ( ! $revisit && apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)) {
             ?>
             <h2 id="spco-steps-big-hdr" class="spco-steps-big-hdr">
                 <?php esc_html_e(' Steps', 'event_espresso'); ?>
@@ -79,7 +79,7 @@ 
         foreach ($reg_steps as $reg_step) {
             if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() != 'finalize_registration') {
                 $slug = $reg_step->slug();
-                do_action('AHEE__' . $slug . '__reg_step_start', $reg_step);
+                do_action('AHEE__'.$slug.'__reg_step_start', $reg_step);
                 // todo: deprecate hook AHEE__registration_page_attendee_information__start
                 ?>
                 <div id="spco-<?php echo esc_attr($slug); ?>-dv"

modules/single_page_checkout/form/LegacySpcoForm.php

Indentation +67 added lines, -67 removed lines

@@ -17,74 +17,74 @@
  */
 class LegacySpcoForm extends EE_Form_Section_Proper
 {
-    public function __construct(EE_Checkout $checkout, bool $empty_cart, int $session_expiration)
-    {
-        parent::__construct(
-            [
-                'name'            => 'single-page-checkout',
-                'html_id'         => 'ee-single-page-checkout-dv',
-                'layout_strategy' =>
-                    new EE_Template_Layout(
-                        [
-                            'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
-                            'template_args'        => [
-                                'empty_cart'              => $empty_cart,
-                                'revisit'                 => $checkout->revisit,
-                                'reg_steps'               => $checkout->reg_steps,
-                                'next_step'               => $checkout->next_step instanceof EE_SPCO_Reg_Step
-                                    ? $checkout->next_step->slug()
-                                    : '',
-                                'empty_msg'               => apply_filters(
-                                    'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
-                                    sprintf(
-                                        esc_html__(
-                                            'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
-                                            'event_espresso'
-                                        ),
-                                        '<a href="'
-                                        . get_post_type_archive_link(EspressoPostType::EVENTS)
-                                        . '" title="',
-                                        '">',
-                                        '</a>'
-                                    )
-                                ),
-                                'cookies_not_set_msg'     => $this->getCookiesNotSetMessage($empty_cart),
-                                'registration_time_limit' => $checkout->get_registration_time_limit(),
-                                'session_expiration'      => gmdate(
-                                    'M d, Y H:i:s',
-                                    $session_expiration + (get_option('gmt_offset') * HOUR_IN_SECONDS)
-                                ),
-                                'use_session_countdown'   => EE_Registry::instance()->CFG->registration->useSessionCountdown(),
-                            ],
-                        ]
-                    ),
-            ]
-        );
-    }
+	public function __construct(EE_Checkout $checkout, bool $empty_cart, int $session_expiration)
+	{
+		parent::__construct(
+			[
+				'name'            => 'single-page-checkout',
+				'html_id'         => 'ee-single-page-checkout-dv',
+				'layout_strategy' =>
+					new EE_Template_Layout(
+						[
+							'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+							'template_args'        => [
+								'empty_cart'              => $empty_cart,
+								'revisit'                 => $checkout->revisit,
+								'reg_steps'               => $checkout->reg_steps,
+								'next_step'               => $checkout->next_step instanceof EE_SPCO_Reg_Step
+									? $checkout->next_step->slug()
+									: '',
+								'empty_msg'               => apply_filters(
+									'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
+									sprintf(
+										esc_html__(
+											'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
+											'event_espresso'
+										),
+										'<a href="'
+										. get_post_type_archive_link(EspressoPostType::EVENTS)
+										. '" title="',
+										'">',
+										'</a>'
+									)
+								),
+								'cookies_not_set_msg'     => $this->getCookiesNotSetMessage($empty_cart),
+								'registration_time_limit' => $checkout->get_registration_time_limit(),
+								'session_expiration'      => gmdate(
+									'M d, Y H:i:s',
+									$session_expiration + (get_option('gmt_offset') * HOUR_IN_SECONDS)
+								),
+								'use_session_countdown'   => EE_Registry::instance()->CFG->registration->useSessionCountdown(),
+							],
+						]
+					),
+			]
+		);
+	}
 
 
-    private function getCookiesNotSetMessage($empty_cart)
-    {
-        return $empty_cart
-            ? apply_filters(
-                'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
-                sprintf(
-                    esc_html__(
-                        '%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
-                        'event_espresso'
-                    ),
-                    '<div class="ee-attention hidden" id="ee-cookies-not-set-msg">',
-                    '</div>',
-                    '<h6 class="important-notice">',
-                    '</h6>',
-                    '<p>',
-                    '</p>',
-                    '<br />',
-                    '<a href="https://www.whatismybrowser.com/guides/how-to-enable-cookies/" target="_blank" rel="noopener noreferrer">',
-                    '</a>'
-                )
-            )
-            : '';
+	private function getCookiesNotSetMessage($empty_cart)
+	{
+		return $empty_cart
+			? apply_filters(
+				'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
+				sprintf(
+					esc_html__(
+						'%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
+						'event_espresso'
+					),
+					'<div class="ee-attention hidden" id="ee-cookies-not-set-msg">',
+					'</div>',
+					'<h6 class="important-notice">',
+					'</h6>',
+					'<p>',
+					'</p>',
+					'<br />',
+					'<a href="https://www.whatismybrowser.com/guides/how-to-enable-cookies/" target="_blank" rel="noopener noreferrer">',
+					'</a>'
+				)
+			)
+			: '';
 
-    }
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
                 'layout_strategy' =>
                     new EE_Template_Layout(
                         [
-                            'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+                            'layout_template_file' => SPCO_TEMPLATES_PATH.'registration_page_wrapper.template.php',
                             'template_args'        => [
                                 'empty_cart'              => $empty_cart,
                                 'revisit'                 => $checkout->revisit,

modules/single_page_checkout/form/SinglePageCheckoutForm.php

Indentation +135 added lines, -135 removed lines

@@ -13,139 +13,139 @@
 
 class SinglePageCheckoutForm extends EE_Form_Section_Proper
 {
-    private EE_Checkout $checkout;
-
-    private bool $empty_cart;
-
-    private array $subsections = [];
-
-
-    public function __construct(EE_Checkout $checkout, bool $empty_cart)
-    {
-        $this->checkout   = $checkout;
-        $this->empty_cart = $empty_cart;
-        parent::__construct(
-            [
-                'name'            => 'single-page-checkout',
-                'html_id'         => 'ee-single-page-checkout-dv',
-                'layout_strategy' => new EE_No_Layout(),
-                'subsections'     => $this->generateSubsections(),
-            ]
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    private function generateSubsections(): array
-    {
-        $this->subsections['spco-div-open'] = new EE_Form_Section_HTML(
-            EEH_HTML::div('', 'ee-single-page-checkout-dv')
-        );
-
-        if ($this->empty_cart) {
-            $this->subsections['empty-cart-notice'] = new EmptyCartNotice();
-        } else {
-            $this->addTimeLimitNotice();
-            $this->addRegStepsHeader();
-            $this->addRegStepHookPoint('AHEE__SPCO__before_registration_steps');
-            $this->addRegistrationSteps();
-            $this->addRegStepHookPoint('AHEE__SPCO__after_registration_steps');
-        }
-
-        $this->addRegStepHookPoint('AHEE__SPCO__reg_form_footer');
-
-        $this->subsections['spco-div-close'] = new EE_Form_Section_HTML(
-            EEH_HTML::divx('ee-single-page-checkout-dv')
-        );
-
-        return $this->subsections;
-    }
-
-
-    private function addTimeLimitNotice()
-    {
-        if (
-            ! EE_Registry::instance()->CFG->registration->useSessionCountdown() ||
-            ! apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)
-        ) {
-            return;
-        }
-
-        $this->subsections['registration_time_limit'] = new EE_Form_Section_HTML(
-            EEH_HTML::p(
-                sprintf(
-                    apply_filters(
-                        'FHEE__registration_page_wrapper_template___time_limit',
-                        esc_html__('You have %1$s to complete your registration.', 'event_espresso')
-                    ),
-                    EEH_HTML::span(
-                        $this->checkout->get_registration_time_limit(),
-                        'spco-registration-time-limit-spn',
-                        'spco-registration-time-limit-spn'
-                    )
-                ),
-                'spco-registration-time-limit-pg',
-                'spco-steps-pg ee-attention important-notice',
-                'display: none;'
-            )
-        );
-    }
-
-    private function addRegStepsHeader(): void
-    {
-        if (
-            $this->checkout->revisit
-            || ! apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)
-        ) {
-            return;
-        }
-        $this->subsections['registration_steps_display'] = new RegStepsHeader($this->checkout);
-    }
-
-
-    private function addRegStepHookPoint(string $hook_name)
-    {
-        $key = str_replace('AHEE__SPCO__', '', $hook_name);
-        $this->subsections[ $key ] = new EE_Form_Section_HTML($this->captureRegStepHookPoint($hook_name));
-    }
-
-    private function captureRegStepHookPoint()
-    {
-        $args = func_get_args();
-        ob_start();
-        do_action(...$args);
-        return ob_get_clean();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    private function addRegistrationSteps()
-    {
-        $reg_steps = '';
-        foreach ($this->checkout->reg_steps as $reg_step) {
-            if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() !== 'finalize_registration') {
-                $slug = $reg_step->slug();
-                $reg_steps .= $this->captureRegStepHookPoint("AHEE__{$slug}__reg_step_start", $reg_step);
-                $reg_form_html = $reg_step->display_reg_form();
-                $reg_steps .= EEH_HTML::div(
-                    $reg_form_html
-                    . $this->captureRegStepHookPoint(
-                        'AHEE__SPCO_after_reg_step_form',
-                        $slug,
-                        $this->checkout->next_step->slug()
-                    ),
-                    'spco-' . esc_attr($slug) . '-dv',
-                    "spco-step-dv " . esc_attr($reg_step->div_class())
-                );
-                if (empty($reg_form_html)) {
-                    $reg_steps .= EEH_HTML::divx();
-                }
-            }
-        }
-        $this->subsections['registration_steps'] = new EE_Form_Section_HTML($reg_steps);
-    }
+	private EE_Checkout $checkout;
+
+	private bool $empty_cart;
+
+	private array $subsections = [];
+
+
+	public function __construct(EE_Checkout $checkout, bool $empty_cart)
+	{
+		$this->checkout   = $checkout;
+		$this->empty_cart = $empty_cart;
+		parent::__construct(
+			[
+				'name'            => 'single-page-checkout',
+				'html_id'         => 'ee-single-page-checkout-dv',
+				'layout_strategy' => new EE_No_Layout(),
+				'subsections'     => $this->generateSubsections(),
+			]
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	private function generateSubsections(): array
+	{
+		$this->subsections['spco-div-open'] = new EE_Form_Section_HTML(
+			EEH_HTML::div('', 'ee-single-page-checkout-dv')
+		);
+
+		if ($this->empty_cart) {
+			$this->subsections['empty-cart-notice'] = new EmptyCartNotice();
+		} else {
+			$this->addTimeLimitNotice();
+			$this->addRegStepsHeader();
+			$this->addRegStepHookPoint('AHEE__SPCO__before_registration_steps');
+			$this->addRegistrationSteps();
+			$this->addRegStepHookPoint('AHEE__SPCO__after_registration_steps');
+		}
+
+		$this->addRegStepHookPoint('AHEE__SPCO__reg_form_footer');
+
+		$this->subsections['spco-div-close'] = new EE_Form_Section_HTML(
+			EEH_HTML::divx('ee-single-page-checkout-dv')
+		);
+
+		return $this->subsections;
+	}
+
+
+	private function addTimeLimitNotice()
+	{
+		if (
+			! EE_Registry::instance()->CFG->registration->useSessionCountdown() ||
+			! apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)
+		) {
+			return;
+		}
+
+		$this->subsections['registration_time_limit'] = new EE_Form_Section_HTML(
+			EEH_HTML::p(
+				sprintf(
+					apply_filters(
+						'FHEE__registration_page_wrapper_template___time_limit',
+						esc_html__('You have %1$s to complete your registration.', 'event_espresso')
+					),
+					EEH_HTML::span(
+						$this->checkout->get_registration_time_limit(),
+						'spco-registration-time-limit-spn',
+						'spco-registration-time-limit-spn'
+					)
+				),
+				'spco-registration-time-limit-pg',
+				'spco-steps-pg ee-attention important-notice',
+				'display: none;'
+			)
+		);
+	}
+
+	private function addRegStepsHeader(): void
+	{
+		if (
+			$this->checkout->revisit
+			|| ! apply_filters('FHEE__registration_page_wrapper_template__steps_display', true)
+		) {
+			return;
+		}
+		$this->subsections['registration_steps_display'] = new RegStepsHeader($this->checkout);
+	}
+
+
+	private function addRegStepHookPoint(string $hook_name)
+	{
+		$key = str_replace('AHEE__SPCO__', '', $hook_name);
+		$this->subsections[ $key ] = new EE_Form_Section_HTML($this->captureRegStepHookPoint($hook_name));
+	}
+
+	private function captureRegStepHookPoint()
+	{
+		$args = func_get_args();
+		ob_start();
+		do_action(...$args);
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	private function addRegistrationSteps()
+	{
+		$reg_steps = '';
+		foreach ($this->checkout->reg_steps as $reg_step) {
+			if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() !== 'finalize_registration') {
+				$slug = $reg_step->slug();
+				$reg_steps .= $this->captureRegStepHookPoint("AHEE__{$slug}__reg_step_start", $reg_step);
+				$reg_form_html = $reg_step->display_reg_form();
+				$reg_steps .= EEH_HTML::div(
+					$reg_form_html
+					. $this->captureRegStepHookPoint(
+						'AHEE__SPCO_after_reg_step_form',
+						$slug,
+						$this->checkout->next_step->slug()
+					),
+					'spco-' . esc_attr($slug) . '-dv',
+					"spco-step-dv " . esc_attr($reg_step->div_class())
+				);
+				if (empty($reg_form_html)) {
+					$reg_steps .= EEH_HTML::divx();
+				}
+			}
+		}
+		$this->subsections['registration_steps'] = new EE_Form_Section_HTML($reg_steps);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -108,7 +108,7 @@ 
     private function addRegStepHookPoint(string $hook_name)
     {
         $key = str_replace('AHEE__SPCO__', '', $hook_name);
-        $this->subsections[ $key ] = new EE_Form_Section_HTML($this->captureRegStepHookPoint($hook_name));
+        $this->subsections[$key] = new EE_Form_Section_HTML($this->captureRegStepHookPoint($hook_name));
     }
 
     private function captureRegStepHookPoint()
@@ -138,8 +138,8 @@ 
                         $slug,
                         $this->checkout->next_step->slug()
                     ),
-                    'spco-' . esc_attr($slug) . '-dv',
-                    "spco-step-dv " . esc_attr($reg_step->div_class())
+                    'spco-'.esc_attr($slug).'-dv',
+                    "spco-step-dv ".esc_attr($reg_step->div_class())
                 );
                 if (empty($reg_form_html)) {
                     $reg_steps .= EEH_HTML::divx();

modules/single_page_checkout/form/EmptyCartNotice.php

Indentation +56 added lines, -56 removed lines

@@ -8,66 +8,66 @@
 
 class EmptyCartNotice extends EE_Form_Section_HTML
 {
-    public function __construct()
-    {
-        parent::__construct(
-            $this->nothingInYourCartHeader()
-            . $this->emptyCartMessage()
-            . $this->cookiesNotSetMessage()
-        );
-    }
+	public function __construct()
+	{
+		parent::__construct(
+			$this->nothingInYourCartHeader()
+			. $this->emptyCartMessage()
+			. $this->cookiesNotSetMessage()
+		);
+	}
 
 
-    private function nothingInYourCartHeader(): string
-    {
-        return EEH_HTML::h3(
-            esc_html__('Nothing in your Event Queue', 'event_espresso'),
-            'spco-empty-cart-hdr',
-            'spco-step-title-hdr'
-        );
-    }
+	private function nothingInYourCartHeader(): string
+	{
+		return EEH_HTML::h3(
+			esc_html__('Nothing in your Event Queue', 'event_espresso'),
+			'spco-empty-cart-hdr',
+			'spco-step-title-hdr'
+		);
+	}
 
 
-    private function emptyCartMessage(): string
-    {
-        return EEH_HTML::p(
-            apply_filters(
-                'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
-                sprintf(
-                    esc_html__(
-                        'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
-                        'event_espresso'
-                    ),
-                    '<a href="'
-                    . get_post_type_archive_link(EspressoPostType::EVENTS)
-                    . '" title="',
-                    '">',
-                    '</a>'
-                )
-            )
-        );
-    }
+	private function emptyCartMessage(): string
+	{
+		return EEH_HTML::p(
+			apply_filters(
+				'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
+				sprintf(
+					esc_html__(
+						'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
+						'event_espresso'
+					),
+					'<a href="'
+					. get_post_type_archive_link(EspressoPostType::EVENTS)
+					. '" title="',
+					'">',
+					'</a>'
+				)
+			)
+		);
+	}
 
 
-    private function cookiesNotSetMessage(): string
-    {
-        return apply_filters(
-            'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
-            sprintf(
-                esc_html__(
-                    '%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention hidden" id="ee-cookies-not-set-msg">',
-                '</div>',
-                '<h6 class="important-notice">',
-                '</h6>',
-                '<p>',
-                '</p>',
-                '<br />',
-                '<a href="https://www.whatismybrowser.com/guides/how-to-enable-cookies/" target="_blank" rel="noopener noreferrer">',
-                '</a>'
-            )
-        );
-    }
+	private function cookiesNotSetMessage(): string
+	{
+		return apply_filters(
+			'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
+			sprintf(
+				esc_html__(
+					'%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
+					'event_espresso'
+				),
+				'<div class="ee-attention hidden" id="ee-cookies-not-set-msg">',
+				'</div>',
+				'<h6 class="important-notice">',
+				'</h6>',
+				'<p>',
+				'</p>',
+				'<br />',
+				'<a href="https://www.whatismybrowser.com/guides/how-to-enable-cookies/" target="_blank" rel="noopener noreferrer">',
+				'</a>'
+			)
+		);
+	}
 }

modules/single_page_checkout/form/RegStepsHeader.php

Indentation +52 added lines, -52 removed lines

@@ -9,61 +9,61 @@
 
 class RegStepsHeader extends EE_Form_Section_HTML
 {
-    private EE_Checkout $checkout;
+	private EE_Checkout $checkout;
 
 
-    /**
-     * @param EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->checkout = $checkout;
-        parent::__construct(
-            EEH_HTML::h2(
-                esc_html__('Steps', 'event_espresso'),
-                'spco-steps-big-hdr',
-                'spco-steps-big-hdr'
-            )
-            . EEH_HTML::div($this->regStepsHeader(), 'spco-steps-display-dv')
-        );
-    }
+	/**
+	 * @param EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->checkout = $checkout;
+		parent::__construct(
+			EEH_HTML::h2(
+				esc_html__('Steps', 'event_espresso'),
+				'spco-steps-big-hdr',
+				'spco-steps-big-hdr'
+			)
+			. EEH_HTML::div($this->regStepsHeader(), 'spco-steps-display-dv')
+		);
+	}
 
 
-    private function regStepsHeader(): string
-    {
-        $reg_steps = '';
-        $step_nmbr = 1;
-        $total_steps = count($this->checkout->reg_steps) - 1;
-        foreach ($this->checkout->reg_steps as $reg_step) {
-            if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() !== 'finalize_registration') {
-                $slug = esc_attr($reg_step->slug());
-                $step_display_dv_class = $reg_step->is_current_step() ? 'active-step' : 'inactive-step';
-                $reg_steps .= EEH_HTML::div(
-                    EEH_HTML::h4(
-                        EEH_HTML::span(
-                            esc_html($step_nmbr),
-                            '',
-                            'spco-step-big-nmbr'
-                        )
-                        . EEH_HTML::nbsp()
-                        . EEH_HTML::span(
-                            str_replace('&nbsp;', '<br/>&nbsp;', $reg_step->name()),
-                            '',
-                            'spco-step-name'
-                        ),
-                        "spco-step-$slug-display-hdr",
-                        'spco-steps-display-hdr'
-                    ),
-                    "spco-step-$slug-display-dv",
-                    "spco-step-display-dv $step_display_dv_class steps-$total_steps",
-                );
+	private function regStepsHeader(): string
+	{
+		$reg_steps = '';
+		$step_nmbr = 1;
+		$total_steps = count($this->checkout->reg_steps) - 1;
+		foreach ($this->checkout->reg_steps as $reg_step) {
+			if ($reg_step instanceof EE_SPCO_Reg_Step && $reg_step->slug() !== 'finalize_registration') {
+				$slug = esc_attr($reg_step->slug());
+				$step_display_dv_class = $reg_step->is_current_step() ? 'active-step' : 'inactive-step';
+				$reg_steps .= EEH_HTML::div(
+					EEH_HTML::h4(
+						EEH_HTML::span(
+							esc_html($step_nmbr),
+							'',
+							'spco-step-big-nmbr'
+						)
+						. EEH_HTML::nbsp()
+						. EEH_HTML::span(
+							str_replace('&nbsp;', '<br/>&nbsp;', $reg_step->name()),
+							'',
+							'spco-step-name'
+						),
+						"spco-step-$slug-display-hdr",
+						'spco-steps-display-hdr'
+					),
+					"spco-step-$slug-display-dv",
+					"spco-step-display-dv $step_display_dv_class steps-$total_steps",
+				);
 
-                if ($step_nmbr < $total_steps) {
-                    $reg_steps .= EEH_HTML::div('&raquo;', '', 'spco-step-arrow-dv');
-                }
-                $step_nmbr++;
-            }
-        }
-        return $reg_steps . EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx();
-    }
+				if ($step_nmbr < $total_steps) {
+					$reg_steps .= EEH_HTML::div('&raquo;', '', 'spco-step-arrow-dv');
+				}
+				$step_nmbr++;
+			}
+		}
+		return $reg_steps . EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx();
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -64,6 +64,6 @@
                 $step_nmbr++;
             }
         }
-        return $reg_steps . EEH_HTML::div('', '', 'clear-float') . EEH_HTML::divx();
+        return $reg_steps.EEH_HTML::div('', '', 'clear-float').EEH_HTML::divx();
     }
 }

modules/single_page_checkout/inc/EE_SPCO_JSON_Response.php

Indentation +250 added lines, -250 removed lines

@@ -15,292 +15,292 @@
  */
 class EE_SPCO_JSON_Response
 {
-    protected string $_errors = '';
-
-    protected string $_unexpected_errors = '';
-
-    protected string $_attention = '';
-
-    protected string $_success = '';
-
-    protected string $_plz_select_method_of_payment = '';
-
-    protected string $_redirect_url = '';
-
-    protected string $_registration_time_limit = '';
-
-    protected string $_redirect_form = '';
-
-    protected string $_reg_step_html = '';
-
-    protected string $_method_of_payment = '';
-
-    protected ?float $_payment_amount = 0.00;
-
-    protected array $_return_data = [];
-
-    protected array $request_data = [];
-
-    protected array $_validation_rules = [];
-
-
-    public function __construct()
-    {
-    }
-
-
-    /**
-     * allows you to simply echo or print an EE_SPCO_JSON_Response object to produce a  JSON encoded string
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        return json_encode($this->buildResponse());
-    }
-
-
-    /**
-     * @return array
-     */
-    public function buildResponse(): array
-    {
-        $JSON_response = [];
-        // grab notices
-        $notices = EE_Error::get_notices(false);
-        $this->set_attention($notices['attention'] ?? '');
-        $this->set_errors($notices['errors'] ?? '');
-        $this->set_success($notices['success'] ?? '');
-        // add notices to JSON response, but only if they exist
-        if ($this->attention()) {
-            $JSON_response['attention'] = $this->attention();
-        }
-        if ($this->errors()) {
-            $JSON_response['errors'] = $this->errors();
-        }
-        if ($this->unexpected_errors()) {
-            $JSON_response['unexpected_errors'] = $this->unexpected_errors();
-        }
-        if ($this->success()) {
-            $JSON_response['success'] = $this->success();
-        }
-        // but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
-        if (! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
-            $JSON_response['success'] = null;
-        }
-        // set redirect_url, IF it exists
-        if ($this->redirect_url()) {
-            $JSON_response['redirect_url'] = $this->redirect_url();
-        }
-        // set registration_time_limit, IF it exists
-        if ($this->registration_time_limit()) {
-            $JSON_response['registration_time_limit'] = $this->registration_time_limit();
-        }
-        // set payment_amount, IF it exists
-        if ($this->payment_amount() !== null) {
-            $JSON_response['payment_amount'] = $this->payment_amount();
-        }
-        // grab generic return data
-        $return_data = $this->return_data();
-        // add billing form validation rules
-        if ($this->validation_rules()) {
-            $return_data['validation_rules'] = $this->validation_rules();
-        }
-        // set reg_step_html, IF it exists
-        if ($this->reg_step_html()) {
-            $return_data['reg_step_html'] = $this->reg_step_html();
-        }
-        // set method of payment, IF it exists
-        if ($this->method_of_payment()) {
-            $return_data['method_of_payment'] = $this->method_of_payment();
-        }
-        // set "plz_select_method_of_payment" message, IF it exists
-        if ($this->plz_select_method_of_payment()) {
-            $return_data['plz_select_method_of_payment'] = $this->plz_select_method_of_payment();
-        }
-        // set redirect_form, IF it exists
-        if ($this->redirect_form()) {
-            $return_data['redirect_form'] = $this->redirect_form();
-        }
-        // and finally, add return_data array to main JSON response array, IF it contains anything
-        // why did we add some of the above properties to the return data array?
-        // because it is easier and cleaner in the Javascript to deal with this way
-        if (! empty($return_data)) {
-            $JSON_response['return_data'] = $return_data;
-        }
-        // filter & return final array
-        return apply_filters('FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response);
-    }
-
-    public function sendResponse()
-    {
-        wp_send_json($this->buildResponse());
-    }
-
-
-    public function set_attention(string $attention)
-    {
-        $this->_attention = $attention;
-    }
-
-
-    public function attention(): string
-    {
-        return $this->_attention;
-    }
-
-
-    public function set_errors(string $errors)
-    {
-        $this->_errors = $errors;
-    }
-
-
-    public function errors(): string
-    {
-        return $this->_errors;
-    }
-
-
-    public function unexpected_errors(): string
-    {
-        return $this->_unexpected_errors;
-    }
-
-
-    public function set_unexpected_errors(string $unexpected_errors)
-    {
-        $this->_unexpected_errors = $unexpected_errors;
-    }
-
-
-    public function set_success(string $success)
-    {
-        $this->_success = $success;
-    }
-
-
-    public function success(): string
-    {
-        return $this->_success;
-    }
+	protected string $_errors = '';
+
+	protected string $_unexpected_errors = '';
+
+	protected string $_attention = '';
+
+	protected string $_success = '';
+
+	protected string $_plz_select_method_of_payment = '';
+
+	protected string $_redirect_url = '';
+
+	protected string $_registration_time_limit = '';
+
+	protected string $_redirect_form = '';
+
+	protected string $_reg_step_html = '';
+
+	protected string $_method_of_payment = '';
+
+	protected ?float $_payment_amount = 0.00;
+
+	protected array $_return_data = [];
+
+	protected array $request_data = [];
+
+	protected array $_validation_rules = [];
+
+
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 * allows you to simply echo or print an EE_SPCO_JSON_Response object to produce a  JSON encoded string
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return json_encode($this->buildResponse());
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function buildResponse(): array
+	{
+		$JSON_response = [];
+		// grab notices
+		$notices = EE_Error::get_notices(false);
+		$this->set_attention($notices['attention'] ?? '');
+		$this->set_errors($notices['errors'] ?? '');
+		$this->set_success($notices['success'] ?? '');
+		// add notices to JSON response, but only if they exist
+		if ($this->attention()) {
+			$JSON_response['attention'] = $this->attention();
+		}
+		if ($this->errors()) {
+			$JSON_response['errors'] = $this->errors();
+		}
+		if ($this->unexpected_errors()) {
+			$JSON_response['unexpected_errors'] = $this->unexpected_errors();
+		}
+		if ($this->success()) {
+			$JSON_response['success'] = $this->success();
+		}
+		// but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
+		if (! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
+			$JSON_response['success'] = null;
+		}
+		// set redirect_url, IF it exists
+		if ($this->redirect_url()) {
+			$JSON_response['redirect_url'] = $this->redirect_url();
+		}
+		// set registration_time_limit, IF it exists
+		if ($this->registration_time_limit()) {
+			$JSON_response['registration_time_limit'] = $this->registration_time_limit();
+		}
+		// set payment_amount, IF it exists
+		if ($this->payment_amount() !== null) {
+			$JSON_response['payment_amount'] = $this->payment_amount();
+		}
+		// grab generic return data
+		$return_data = $this->return_data();
+		// add billing form validation rules
+		if ($this->validation_rules()) {
+			$return_data['validation_rules'] = $this->validation_rules();
+		}
+		// set reg_step_html, IF it exists
+		if ($this->reg_step_html()) {
+			$return_data['reg_step_html'] = $this->reg_step_html();
+		}
+		// set method of payment, IF it exists
+		if ($this->method_of_payment()) {
+			$return_data['method_of_payment'] = $this->method_of_payment();
+		}
+		// set "plz_select_method_of_payment" message, IF it exists
+		if ($this->plz_select_method_of_payment()) {
+			$return_data['plz_select_method_of_payment'] = $this->plz_select_method_of_payment();
+		}
+		// set redirect_form, IF it exists
+		if ($this->redirect_form()) {
+			$return_data['redirect_form'] = $this->redirect_form();
+		}
+		// and finally, add return_data array to main JSON response array, IF it contains anything
+		// why did we add some of the above properties to the return data array?
+		// because it is easier and cleaner in the Javascript to deal with this way
+		if (! empty($return_data)) {
+			$JSON_response['return_data'] = $return_data;
+		}
+		// filter & return final array
+		return apply_filters('FHEE__EE_SPCO_JSON_Response___toString__JSON_response', $JSON_response);
+	}
+
+	public function sendResponse()
+	{
+		wp_send_json($this->buildResponse());
+	}
+
+
+	public function set_attention(string $attention)
+	{
+		$this->_attention = $attention;
+	}
+
+
+	public function attention(): string
+	{
+		return $this->_attention;
+	}
+
+
+	public function set_errors(string $errors)
+	{
+		$this->_errors = $errors;
+	}
+
+
+	public function errors(): string
+	{
+		return $this->_errors;
+	}
+
+
+	public function unexpected_errors(): string
+	{
+		return $this->_unexpected_errors;
+	}
+
+
+	public function set_unexpected_errors(string $unexpected_errors)
+	{
+		$this->_unexpected_errors = $unexpected_errors;
+	}
+
+
+	public function set_success(string $success)
+	{
+		$this->_success = $success;
+	}
+
+
+	public function success(): string
+	{
+		return $this->_success;
+	}
 
 
-    public function set_method_of_payment(string $method_of_payment)
-    {
-        $this->_method_of_payment = $method_of_payment;
-    }
+	public function set_method_of_payment(string $method_of_payment)
+	{
+		$this->_method_of_payment = $method_of_payment;
+	}
 
 
-    public function method_of_payment(): string
-    {
-        return $this->_method_of_payment;
-    }
+	public function method_of_payment(): string
+	{
+		return $this->_method_of_payment;
+	}
 
 
-    public function payment_amount(): float
-    {
-        return $this->_payment_amount;
-    }
+	public function payment_amount(): float
+	{
+		return $this->_payment_amount;
+	}
 
 
-    /**
-     * @param float|int $payment_amount
-     */
-    public function set_payment_amount($payment_amount)
-    {
-        $this->_payment_amount = (float) $payment_amount;
-    }
+	/**
+	 * @param float|int $payment_amount
+	 */
+	public function set_payment_amount($payment_amount)
+	{
+		$this->_payment_amount = (float) $payment_amount;
+	}
 
 
-    public function set_reg_step_html(string $next_step_html)
-    {
-        $this->_reg_step_html = $next_step_html;
-    }
+	public function set_reg_step_html(string $next_step_html)
+	{
+		$this->_reg_step_html = $next_step_html;
+	}
 
 
-    public function reg_step_html(): string
-    {
-        return $this->_reg_step_html;
-    }
+	public function reg_step_html(): string
+	{
+		return $this->_reg_step_html;
+	}
 
 
-    public function set_redirect_form(string $redirect_form)
-    {
-        $this->_redirect_form = $redirect_form;
-    }
+	public function set_redirect_form(string $redirect_form)
+	{
+		$this->_redirect_form = $redirect_form;
+	}
 
 
-    public function redirect_form()
-    {
-        return ! empty($this->_redirect_form) ? $this->_redirect_form : false;
-    }
+	public function redirect_form()
+	{
+		return ! empty($this->_redirect_form) ? $this->_redirect_form : false;
+	}
 
 
-    public function set_plz_select_method_of_payment(string $plz_select_method_of_payment)
-    {
-        $this->_plz_select_method_of_payment = $plz_select_method_of_payment;
-    }
+	public function set_plz_select_method_of_payment(string $plz_select_method_of_payment)
+	{
+		$this->_plz_select_method_of_payment = $plz_select_method_of_payment;
+	}
 
 
-    public function plz_select_method_of_payment(): string
-    {
-        return $this->_plz_select_method_of_payment;
-    }
+	public function plz_select_method_of_payment(): string
+	{
+		return $this->_plz_select_method_of_payment;
+	}
 
 
-    public function set_redirect_url(string $redirect_url)
-    {
-        $this->_redirect_url = $redirect_url;
-    }
+	public function set_redirect_url(string $redirect_url)
+	{
+		$this->_redirect_url = $redirect_url;
+	}
 
 
-    public function redirect_url(): string
-    {
-        return $this->_redirect_url;
-    }
+	public function redirect_url(): string
+	{
+		return $this->_redirect_url;
+	}
 
 
-    public function registration_time_limit(): string
-    {
-        return $this->_registration_time_limit;
-    }
+	public function registration_time_limit(): string
+	{
+		return $this->_registration_time_limit;
+	}
 
 
-    public function set_registration_time_limit(string $registration_time_limit)
-    {
-        $this->_registration_time_limit = $registration_time_limit;
-    }
+	public function set_registration_time_limit(string $registration_time_limit)
+	{
+		$this->_registration_time_limit = $registration_time_limit;
+	}
 
 
-    public function set_return_data(array $return_data)
-    {
-        $this->_return_data = array_merge($this->_return_data, $return_data);
-    }
+	public function set_return_data(array $return_data)
+	{
+		$this->_return_data = array_merge($this->_return_data, $return_data);
+	}
 
 
-    public function return_data(): array
-    {
-        return $this->_return_data;
-    }
+	public function return_data(): array
+	{
+		return $this->_return_data;
+	}
 
 
-    public function add_validation_rules(array $validation_rules = [])
-    {
-        if (is_array($validation_rules) && ! empty($validation_rules)) {
-            $this->_validation_rules = array_merge($this->_validation_rules, $validation_rules);
-        }
-    }
+	public function add_validation_rules(array $validation_rules = [])
+	{
+		if (is_array($validation_rules) && ! empty($validation_rules)) {
+			$this->_validation_rules = array_merge($this->_validation_rules, $validation_rules);
+		}
+	}
 
 
-    public function validation_rules(): array
-    {
-        return ! empty($this->_validation_rules) ? $this->_validation_rules : [];
-    }
+	public function validation_rules(): array
+	{
+		return ! empty($this->_validation_rules) ? $this->_validation_rules : [];
+	}
 
 
-    public function echoAndExit()
-    {
-        exit($this->__toString());
-    }
+	public function echoAndExit()
+	{
+		exit($this->__toString());
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -85,7 +85,7 @@ 
             $JSON_response['success'] = $this->success();
         }
         // but if NO notices are set... at least set the "success" as a key so that the JS knows everything worked
-        if (! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
+        if ( ! isset($JSON_response['attention']) && ! isset($JSON_response['errors']) && ! isset($JSON_response['success'])) {
             $JSON_response['success'] = null;
         }
         // set redirect_url, IF it exists
@@ -125,7 +125,7 @@ 
         // and finally, add return_data array to main JSON response array, IF it contains anything
         // why did we add some of the above properties to the return data array?
         // because it is easier and cleaner in the Javascript to deal with this way
-        if (! empty($return_data)) {
+        if ( ! empty($return_data)) {
             $JSON_response['return_data'] = $return_data;
         }
         // filter & return final array