eventespresso / event-espresso-core

acceptance_tests/Page/CoreAdmin.php

Indentation +92 added lines, -92 removed lines

@@ -13,96 +13,96 @@
 class CoreAdmin
 {
 
-    /**
-     * @var string
-     */
-    const URL_PREFIX = 'admin.php?page=';
-
-
-    /**
-     * This is the selector for the next page button on list tables.
-     * @var string
-     */
-    const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page';
-
-
-    /**
-     * The selector for the search input submit button on list table pages
-     * @var string
-     */
-    const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit';
-
-
-    /**
-     * Selector for the screen options dropdown.
-     * @var string
-     */
-    const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link';
-
-
-    /**
-     * Selector for the per page field setting selector (found within screen options dropdown)
-     * @var string
-     */
-    const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page';
-
-
-    /**
-     * Selector for apply screen options settings.
-     * @var string
-     */
-    const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply';
-
-
-    /**
-     * Selector for bulk action select field on list tables.
-     */
-    const SELECTOR_LIST_TABLE_BULK_ACTION_FIELD = '#bulk-action-selector-';
-
-
-    /**
-     * Selector for applying a bulk action.
-     */
-    const SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY = '#doaction';
-
-
-    /**
-     * Get the EE admin url for the given properties.
-     * Note, this is JUST the endpoint for the admin route.  It is expected that the actor/test would be calling this
-     * with `amOnAdminPage` action.
-     *
-     * @param string $page
-     * @param string $action
-     * @param string $additional_params
-     * @return string
-     */
-    public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '')
-    {
-        $url = self::URL_PREFIX . $page;
-        $url .= $action ? '&action=' . $action : '';
-        $url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : '';
-        return $url;
-    }
-
-
-    /**
-     * Returns the selector for the text tab switcher for a wp-editor instance.
-     * @param $field_reference
-     * @return string
-     */
-    public static function wpEditorTextTabSelector($field_reference)
-    {
-        return '#content-' . $field_reference . '-content-html';
-    }
-
-
-    /**
-     * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance.
-     * @param $field_reference
-     * @return string
-     */
-    public static function wpEditorTextAreaSelector($field_reference)
-    {
-        return '#content-' . $field_reference . '-content';
-    }
+	/**
+	 * @var string
+	 */
+	const URL_PREFIX = 'admin.php?page=';
+
+
+	/**
+	 * This is the selector for the next page button on list tables.
+	 * @var string
+	 */
+	const ADMIN_LIST_TABLE_NEXT_PAGE_CLASS = '.next-page';
+
+
+	/**
+	 * The selector for the search input submit button on list table pages
+	 * @var string
+	 */
+	const LIST_TABLE_SEARCH_SUBMIT_SELECTOR = '#search-submit';
+
+
+	/**
+	 * Selector for the screen options dropdown.
+	 * @var string
+	 */
+	const WP_SCREEN_SETTINGS_LINK_SELECTOR = '#show-settings-link';
+
+
+	/**
+	 * Selector for the per page field setting selector (found within screen options dropdown)
+	 * @var string
+	 */
+	const WP_SCREEN_SETTINGS_PER_PAGE_FIELD_SELECTOR = '.screen-per-page';
+
+
+	/**
+	 * Selector for apply screen options settings.
+	 * @var string
+	 */
+	const WP_SCREEN_OPTIONS_APPLY_SETTINGS_BUTTON_SELECTOR = '#screen-options-apply';
+
+
+	/**
+	 * Selector for bulk action select field on list tables.
+	 */
+	const SELECTOR_LIST_TABLE_BULK_ACTION_FIELD = '#bulk-action-selector-';
+
+
+	/**
+	 * Selector for applying a bulk action.
+	 */
+	const SELECTOR_LIST_TABLE_BULK_ACTTION_APPLY = '#doaction';
+
+
+	/**
+	 * Get the EE admin url for the given properties.
+	 * Note, this is JUST the endpoint for the admin route.  It is expected that the actor/test would be calling this
+	 * with `amOnAdminPage` action.
+	 *
+	 * @param string $page
+	 * @param string $action
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function adminUrl($page = 'espresso_events', $action = 'default', $additional_params = '')
+	{
+		$url = self::URL_PREFIX . $page;
+		$url .= $action ? '&action=' . $action : '';
+		$url .= $additional_params ? '&' . ltrim('&', ltrim('?', $additional_params)) : '';
+		return $url;
+	}
+
+
+	/**
+	 * Returns the selector for the text tab switcher for a wp-editor instance.
+	 * @param $field_reference
+	 * @return string
+	 */
+	public static function wpEditorTextTabSelector($field_reference)
+	{
+		return '#content-' . $field_reference . '-content-html';
+	}
+
+
+	/**
+	 * Returns the selector for the textarea exposed when clicing the text tab switcher for a wp-editor instance.
+	 * @param $field_reference
+	 * @return string
+	 */
+	public static function wpEditorTextAreaSelector($field_reference)
+	{
+		return '#content-' . $field_reference . '-content';
+	}
 }

acceptance_tests/Page/RegistrationsAdmin.php

Indentation +30 added lines, -30 removed lines

@@ -11,43 +11,43 @@
  */
 class RegistrationsAdmin extends CoreAdmin
 {
-    /**
-     * @var string
-     */
-    const REGISTRATION_STATUS_NOT_APPROVED = 'RNA';
+	/**
+	 * @var string
+	 */
+	const REGISTRATION_STATUS_NOT_APPROVED = 'RNA';
 
 
-    /**
-     * @var string
-     */
-    const REGISTRATION_STATUS_APPROVED = 'RAP';
+	/**
+	 * @var string
+	 */
+	const REGISTRATION_STATUS_APPROVED = 'RAP';
 
 
-    /**
-     * @var string
-     */
-    const REGISTRATION_STATUS_PENDING_PAYMENT = 'RPP';
+	/**
+	 * @var string
+	 */
+	const REGISTRATION_STATUS_PENDING_PAYMENT = 'RPP';
 
 
 
-    /**
-     * @param string $additional_params
-     * @return string
-     */
-    public static function registrationsDefaultAdminListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_registrations', 'default', $additional_params);
-    }
+	/**
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function registrationsDefaultAdminListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_registrations', 'default', $additional_params);
+	}
 
 
-    /**
-     * Given a registration id, this will return the selector for all the checkbox for that id.
-     * Assumes the view is a Registration list table.
-     * @param int $registration_id
-     * @return string
-     */
-    public static function listTableCheckBoxSelectorForRegistrationId($registration_id)
-    {
-        return "//input[@name='_REG_ID[]' and @value='{$registration_id}']";
-    }
+	/**
+	 * Given a registration id, this will return the selector for all the checkbox for that id.
+	 * Assumes the view is a Registration list table.
+	 * @param int $registration_id
+	 * @return string
+	 */
+	public static function listTableCheckBoxSelectorForRegistrationId($registration_id)
+	{
+		return "//input[@name='_REG_ID[]' and @value='{$registration_id}']";
+	}
 }
\ No newline at end of file

acceptance_tests/Page/EventsAdmin.php

Indentation +263 added lines, -263 removed lines

@@ -14,267 +14,267 @@
 class EventsAdmin extends CoreAdmin
 {
 
-    /**
-     * Selector for the Add new Event button in the admin.
-     * @var string
-     */
-    const ADD_NEW_EVENT_BUTTON_SELECTOR = '#add-new-event';
-
-
-    /**
-     * Selector for the Event Title field in the event editor
-     * @var string
-     */
-    const EVENT_EDITOR_TITLE_FIELD_SELECTOR = "//input[@id='title']";
-
-    /**
-     * Selector for the publish submit button in the event editor.
-     * @var string
-     */
-    const EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR = "#publish";
-
-
-    /**
-     * Selector for the save button in the event editor
-     */
-    const EVENT_EDITOR_SAVE_BUTTON_SELECTOR = "#save-post";
-
-
-    /**
-     * @var string
-     */
-    const EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR = '#EVT_default_registration_status';
-
-    /**
-     * Selector for the view link after publishing an event.
-     * @var string
-     */
-    const EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR = "//span[@id='sample-permalink']/a";
-
-
-    /**
-     * Selector for the ID of the event in the event editor
-     * @var string
-     */
-    const EVENT_EDITOR_EVT_ID_SELECTOR = "//input[@id='post_ID']";
-
-
-    /**
-     * Selector for the search input on the event list table page.
-     * @var string
-     */
-    const EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR = '#toplevel_page_espresso_events-search-input';
-
-
-
-
-    /**
-     * @param string $additional_params
-     * @return string
-     */
-    public static function defaultEventsListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_events', 'default', $additional_params);
-    }
-
-
-    /**
-     * The selector for the DTTname field for the given row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorDatetimeNameFieldSelector($row_number = 1)
-    {
-        return self::eventEditorDatetimeFieldSelectorForField('DTT_name', $row_number);
-    }
-
-
-    /**
-     * The selector for the DTT_EVT_start field for the given row in the event editor.d
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorDatetimeStartDateFieldSelector($row_number = 1)
-    {
-        return self::eventEditorDatetimeFieldSelectorForField('DTT_EVT_start', $row_number);
-    }
-
-
-    /**
-     * Wrapper for getting the selector for a given field and given row of a datetime in the event editor.
-     *
-     * @param string $field_name
-     * @param int    $row_number
-     * @return string
-     */
-    public static function eventEditorDatetimeFieldSelectorForField($field_name, $row_number = 1)
-    {
-        return "//input[@id='event-datetime-$field_name-$row_number']";
-    }
-
-
-    /**
-     * The selector for the TKT_name field for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketNameFieldSelector($row_number = 1)
-    {
-        return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_name', $row_number);
-    }
-
-
-    /**
-     * Selector for the TKT_base_price field for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketPriceFieldSelector($row_number = 1)
-    {
-        return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_base_price', $row_number);
-    }
-
-
-    /**
-     * Selector for the TKT_qty field for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketQuantityFieldSelector($row_number = 1)
-    {
-        return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_qty', $row_number);
-    }
-
-
-    /**
-     * Selector for the advanced details toggle for the ticket for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketAdvancedDetailsSelector($row_number = 1)
-    {
-        return "//tr[@id='display-ticketrow-$row_number']//span[contains(@class, 'gear-icon')]";
-    }
-
-
-    /**
-     * Selector for the subtotal amount for the given display row of the ticket in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketAdvancedDetailsSubtotalSelector($row_number = 1)
-    {
-        return "//span[@id='price-total-amount-$row_number']";
-    }
-
-
-    /**
-     * Selector for the Total element for the given display row of the ticket in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketAdvancedDetailsTotalSelector($row_number = 1)
-    {
-        return "//span[@id='price-total-amount-$row_number']";
-    }
-
-
-    /**
-     * Selector for the taxable selector for the ticket for the given display row in the event editor.
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketTaxableCheckboxSelector($row_number = 1)
-    {
-        return "//input[@id='edit-ticket-TKT_taxable-$row_number']";
-    }
-
-
-    /**
-     * This returns the xpath locater for the Tax amount display container within the advanced settings view for the
-     * given ticket (row) and the given tax id (PRC_ID).
-     *
-     * @param int $tax_id     The PRC_ID for the tax you want the locater for.  Note, this defaults to the default tax
-     *                        setup on a fresh install.
-     * @param int $row_number What row representing the ticket you want the locator for.
-     * @return string
-     */
-    public static function eventEditorTicketTaxAmountDisplayForTaxIdAndTicketRowSelector($tax_id = 2, $row_number = 1)
-    {
-        return "//span[@id='TKT-tax-amount-display-$tax_id-$row_number']";
-    }
-
-
-    /**
-     * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor.
-     * @param     $field_name
-     * @param int $row_number
-     * @return string
-     */
-    public static function eventEditorTicketFieldSelectorForFieldInDisplayRow($field_name, $row_number = 1)
-    {
-        return "//tr[@id='display-ticketrow-$row_number']//input[contains(@class, 'edit-ticket-$field_name')]";
-    }
-
-
-    /**
-     * Returns the selector for the event title edit link in the events list table for the given Event Title.
-     * @param string $event_title
-     * @return string
-     */
-    public static function eventListTableEventTitleEditLinkSelectorForTitle($event_title)
-    {
-        return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']";
-    }
-
-
-    /**
-     * Locator for for the ID column in the event list table for a given event title.
-     * @param string $event_title
-     * @return string
-     */
-    public static function eventListTableEventIdSelectorForTitle($event_title)
-    {
-        return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
-               . "//ancestor::tr/th[contains(@class, 'check-column')]/input";
-    }
-
-
-    /**
-     * Locator for the view link in the row of an event list table for the given event title.
-     * @param string $event_title
-     * @return string
-     */
-    public static function eventListTableEventTitleViewLinkSelectorForTitle($event_title)
-    {
-        return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
-               . "//ancestor::td//span[@class='view']/a";
-    }
-
-
-    /**
-     * Locator for the messenger tab in the Notifications metabox in the event editor.
-     * @param string $messenger_slug  The slug for the messenger (it's reference slug).
-     * @return string
-     */
-    public static function eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)
-    {
-        return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
-               . "//a[@rel='ee-tab-$messenger_slug']";
-    }
-
-
-    /**
-     * Locator for the select input within the notifications metabox.
-     * Note, this assumes the tab content for the related messenger is already visible.
-     * @param string $message_type_label The message type label (visible string in the table) you want the selector for.
-     * @return string
-     */
-    public static function eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label)
-    {
-        return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
-               . "//table[@class='messages-custom-template-switcher']"
-               . "//tr/td[contains(.,'Registration Approved')]"
-               . "//ancestor::tr//select[contains(@class,'message-template-selector')]";
-    }
+	/**
+	 * Selector for the Add new Event button in the admin.
+	 * @var string
+	 */
+	const ADD_NEW_EVENT_BUTTON_SELECTOR = '#add-new-event';
+
+
+	/**
+	 * Selector for the Event Title field in the event editor
+	 * @var string
+	 */
+	const EVENT_EDITOR_TITLE_FIELD_SELECTOR = "//input[@id='title']";
+
+	/**
+	 * Selector for the publish submit button in the event editor.
+	 * @var string
+	 */
+	const EVENT_EDITOR_PUBLISH_BUTTON_SELECTOR = "#publish";
+
+
+	/**
+	 * Selector for the save button in the event editor
+	 */
+	const EVENT_EDITOR_SAVE_BUTTON_SELECTOR = "#save-post";
+
+
+	/**
+	 * @var string
+	 */
+	const EVENT_EDITOR_DEFAULT_REGISTRATION_STATUS_FIELD_SELECTOR = '#EVT_default_registration_status';
+
+	/**
+	 * Selector for the view link after publishing an event.
+	 * @var string
+	 */
+	const EVENT_EDITOR_VIEW_LINK_AFTER_PUBLISH_SELECTOR = "//span[@id='sample-permalink']/a";
+
+
+	/**
+	 * Selector for the ID of the event in the event editor
+	 * @var string
+	 */
+	const EVENT_EDITOR_EVT_ID_SELECTOR = "//input[@id='post_ID']";
+
+
+	/**
+	 * Selector for the search input on the event list table page.
+	 * @var string
+	 */
+	const EVENT_LIST_TABLE_SEARCH_INPUT_SELECTOR = '#toplevel_page_espresso_events-search-input';
+
+
+
+
+	/**
+	 * @param string $additional_params
+	 * @return string
+	 */
+	public static function defaultEventsListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_events', 'default', $additional_params);
+	}
+
+
+	/**
+	 * The selector for the DTTname field for the given row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorDatetimeNameFieldSelector($row_number = 1)
+	{
+		return self::eventEditorDatetimeFieldSelectorForField('DTT_name', $row_number);
+	}
+
+
+	/**
+	 * The selector for the DTT_EVT_start field for the given row in the event editor.d
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorDatetimeStartDateFieldSelector($row_number = 1)
+	{
+		return self::eventEditorDatetimeFieldSelectorForField('DTT_EVT_start', $row_number);
+	}
+
+
+	/**
+	 * Wrapper for getting the selector for a given field and given row of a datetime in the event editor.
+	 *
+	 * @param string $field_name
+	 * @param int    $row_number
+	 * @return string
+	 */
+	public static function eventEditorDatetimeFieldSelectorForField($field_name, $row_number = 1)
+	{
+		return "//input[@id='event-datetime-$field_name-$row_number']";
+	}
+
+
+	/**
+	 * The selector for the TKT_name field for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketNameFieldSelector($row_number = 1)
+	{
+		return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_name', $row_number);
+	}
+
+
+	/**
+	 * Selector for the TKT_base_price field for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketPriceFieldSelector($row_number = 1)
+	{
+		return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_base_price', $row_number);
+	}
+
+
+	/**
+	 * Selector for the TKT_qty field for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketQuantityFieldSelector($row_number = 1)
+	{
+		return self::eventEditorTicketFieldSelectorForFieldInDisplayRow('TKT_qty', $row_number);
+	}
+
+
+	/**
+	 * Selector for the advanced details toggle for the ticket for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketAdvancedDetailsSelector($row_number = 1)
+	{
+		return "//tr[@id='display-ticketrow-$row_number']//span[contains(@class, 'gear-icon')]";
+	}
+
+
+	/**
+	 * Selector for the subtotal amount for the given display row of the ticket in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketAdvancedDetailsSubtotalSelector($row_number = 1)
+	{
+		return "//span[@id='price-total-amount-$row_number']";
+	}
+
+
+	/**
+	 * Selector for the Total element for the given display row of the ticket in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketAdvancedDetailsTotalSelector($row_number = 1)
+	{
+		return "//span[@id='price-total-amount-$row_number']";
+	}
+
+
+	/**
+	 * Selector for the taxable selector for the ticket for the given display row in the event editor.
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketTaxableCheckboxSelector($row_number = 1)
+	{
+		return "//input[@id='edit-ticket-TKT_taxable-$row_number']";
+	}
+
+
+	/**
+	 * This returns the xpath locater for the Tax amount display container within the advanced settings view for the
+	 * given ticket (row) and the given tax id (PRC_ID).
+	 *
+	 * @param int $tax_id     The PRC_ID for the tax you want the locater for.  Note, this defaults to the default tax
+	 *                        setup on a fresh install.
+	 * @param int $row_number What row representing the ticket you want the locator for.
+	 * @return string
+	 */
+	public static function eventEditorTicketTaxAmountDisplayForTaxIdAndTicketRowSelector($tax_id = 2, $row_number = 1)
+	{
+		return "//span[@id='TKT-tax-amount-display-$tax_id-$row_number']";
+	}
+
+
+	/**
+	 * Wrapper for getting the selector for a given field and given display row of a ticket in the event editor.
+	 * @param     $field_name
+	 * @param int $row_number
+	 * @return string
+	 */
+	public static function eventEditorTicketFieldSelectorForFieldInDisplayRow($field_name, $row_number = 1)
+	{
+		return "//tr[@id='display-ticketrow-$row_number']//input[contains(@class, 'edit-ticket-$field_name')]";
+	}
+
+
+	/**
+	 * Returns the selector for the event title edit link in the events list table for the given Event Title.
+	 * @param string $event_title
+	 * @return string
+	 */
+	public static function eventListTableEventTitleEditLinkSelectorForTitle($event_title)
+	{
+		return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']";
+	}
+
+
+	/**
+	 * Locator for for the ID column in the event list table for a given event title.
+	 * @param string $event_title
+	 * @return string
+	 */
+	public static function eventListTableEventIdSelectorForTitle($event_title)
+	{
+		return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
+			   . "//ancestor::tr/th[contains(@class, 'check-column')]/input";
+	}
+
+
+	/**
+	 * Locator for the view link in the row of an event list table for the given event title.
+	 * @param string $event_title
+	 * @return string
+	 */
+	public static function eventListTableEventTitleViewLinkSelectorForTitle($event_title)
+	{
+		return "//td[contains(@class, 'column-name')]/strong/a[text()='$event_title']"
+			   . "//ancestor::td//span[@class='view']/a";
+	}
+
+
+	/**
+	 * Locator for the messenger tab in the Notifications metabox in the event editor.
+	 * @param string $messenger_slug  The slug for the messenger (it's reference slug).
+	 * @return string
+	 */
+	public static function eventEditorNotificationsMetaBoxMessengerTabSelector($messenger_slug)
+	{
+		return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
+			   . "//a[@rel='ee-tab-$messenger_slug']";
+	}
+
+
+	/**
+	 * Locator for the select input within the notifications metabox.
+	 * Note, this assumes the tab content for the related messenger is already visible.
+	 * @param string $message_type_label The message type label (visible string in the table) you want the selector for.
+	 * @return string
+	 */
+	public static function eventEditorNotificationsMetaBoxSelectSelectorForMessageType($message_type_label)
+	{
+		return "//div[@id='espresso_events_Messages_Hooks_Extend_messages_metabox_metabox']"
+			   . "//table[@class='messages-custom-template-switcher']"
+			   . "//tr/td[contains(.,'Registration Approved')]"
+			   . "//ancestor::tr//select[contains(@class,'message-template-selector')]";
+	}
 }

acceptance_tests/Page/Checkout.php

Indentation +47 added lines, -47 removed lines

@@ -13,62 +13,62 @@
 class Checkout
 {
 
-    /**
-     * The class selector for the next step button in the checkout.
-     * @var string
-     */
-    const NEXT_STEP_BUTTON_SELECTOR = '.spco-next-step-btn';
+	/**
+	 * The class selector for the next step button in the checkout.
+	 * @var string
+	 */
+	const NEXT_STEP_BUTTON_SELECTOR = '.spco-next-step-btn';
 
 
-    const PAYMENT_METHOD_STEP_FORM = '#ee-spco-payment_options-reg-step-form';
+	const PAYMENT_METHOD_STEP_FORM = '#ee-spco-payment_options-reg-step-form';
 
 
-    /**
-     * @param int $attendee_number
-     * @return string
-     */
-    public static function firstNameFieldSelectorForAttendeeNumber($attendee_number = 1)
-    {
-        return self::fieldSelectorForAttendeeNumber('fname', $attendee_number);
-    }
+	/**
+	 * @param int $attendee_number
+	 * @return string
+	 */
+	public static function firstNameFieldSelectorForAttendeeNumber($attendee_number = 1)
+	{
+		return self::fieldSelectorForAttendeeNumber('fname', $attendee_number);
+	}
 
 
-    /**
-     * @param int $attendee_number
-     * @return string
-     */
-    public static function lastNameFieldSelectorForAttendeeNumber($attendee_number = 1)
-    {
-        return self::fieldSelectorForAttendeeNumber('lname', $attendee_number);
-    }
+	/**
+	 * @param int $attendee_number
+	 * @return string
+	 */
+	public static function lastNameFieldSelectorForAttendeeNumber($attendee_number = 1)
+	{
+		return self::fieldSelectorForAttendeeNumber('lname', $attendee_number);
+	}
 
 
-    /**
-     * @param int $attendee_number
-     * @return string
-     */
-    public static function emailFieldSelectorForAttendeeNumber($attendee_number = 1)
-    {
-        return self::fieldSelectorForAttendeeNumber('email', $attendee_number);
-    }
+	/**
+	 * @param int $attendee_number
+	 * @return string
+	 */
+	public static function emailFieldSelectorForAttendeeNumber($attendee_number = 1)
+	{
+		return self::fieldSelectorForAttendeeNumber('email', $attendee_number);
+	}
 
-    /**
-     * @param     $field_name
-     * @param int $attendee_number
-     * @return string
-     */
-    public static function fieldSelectorForAttendeeNumber($field_name, $attendee_number = 1)
-    {
-        return "//div[starts-with(@id, 'spco-attendee-panel-dv-$attendee_number')]//input[contains(@class, 'ee-reg-qstn-$field_name')]";
-    }
+	/**
+	 * @param     $field_name
+	 * @param int $attendee_number
+	 * @return string
+	 */
+	public static function fieldSelectorForAttendeeNumber($field_name, $attendee_number = 1)
+	{
+		return "//div[starts-with(@id, 'spco-attendee-panel-dv-$attendee_number')]//input[contains(@class, 'ee-reg-qstn-$field_name')]";
+	}
 
 
-    /**
-     * @param string $payment_method_slug Slug for the payment method.
-     * @return string
-     */
-    public static function fieldSelectorForPaymentOption($payment_method_slug)
-    {
-        return "#ee-available-payment-method-inputs-{$payment_method_slug}";
-    }
+	/**
+	 * @param string $payment_method_slug Slug for the payment method.
+	 * @return string
+	 */
+	public static function fieldSelectorForPaymentOption($payment_method_slug)
+	{
+		return "#ee-available-payment-method-inputs-{$payment_method_slug}";
+	}
 }

acceptance_tests/Page/MessagesAdmin.php

Indentation +267 added lines, -267 removed lines

@@ -14,289 +14,289 @@
 class MessagesAdmin extends CoreAdmin
 {
 
-    /**
-     * Context slug for the admin messages context.
-     */
-    const ADMIN_CONTEXT_SLUG = 'admin';
+	/**
+	 * Context slug for the admin messages context.
+	 */
+	const ADMIN_CONTEXT_SLUG = 'admin';
 
-    /**
-     * Context slug for the primary attendee messages context
-     */
-    const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee';
+	/**
+	 * Context slug for the primary attendee messages context
+	 */
+	const PRIMARY_ATTENDEE_CONTEXT_SLUG = 'primary_attendee';
 
 
-    /**
-     * Context slug for the attendee messages context
-     */
-    const ATTENDEE_CONTEXT_SLUG = 'attendee';
+	/**
+	 * Context slug for the attendee messages context
+	 */
+	const ATTENDEE_CONTEXT_SLUG = 'attendee';
 
 
-    /**
-     * Status reference for the EEM_Message::status_sent status.
-     */
-    const MESSAGE_STATUS_SENT = 'MSN';
+	/**
+	 * Status reference for the EEM_Message::status_sent status.
+	 */
+	const MESSAGE_STATUS_SENT = 'MSN';
 
 
-    /**
-     * Message type slug for the Payment Failed message type
-     */
-    const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed';
+	/**
+	 * Message type slug for the Payment Failed message type
+	 */
+	const PAYMENT_FAILED_MESSAGE_TYPE_SLUG = 'payment_failed';
 
 
-    /**
-     * Message type slug for the Registration Pending Payment message type
-     */
-    const MESSAGE_TYPE_PENDING_PAYMENT = 'pending_approval';
+	/**
+	 * Message type slug for the Registration Pending Payment message type
+	 */
+	const MESSAGE_TYPE_PENDING_PAYMENT = 'pending_approval';
 
 
-    /**
-     * Selector for the Global Messages "Send on same request" field in the Messages Settings tab.
-     */
-    const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR =
-        '#global_messages_settings-do-messages-on-same-request';
+	/**
+	 * Selector for the Global Messages "Send on same request" field in the Messages Settings tab.
+	 */
+	const GLOBAL_MESSAGES_SETTINGS_ON_REQUEST_SELECTION_SELECTOR =
+		'#global_messages_settings-do-messages-on-same-request';
 
 
-    /**
-     * Selector for the Global Messages Settings submit button in the Messages Settings tab.
-     */
-    const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit';
+	/**
+	 * Selector for the Global Messages Settings submit button in the Messages Settings tab.
+	 */
+	const GLOBAL_MESSAGES_SETTINGS_SUBMIT_SELECTOR = '#global_messages_settings-update-settings-submit';
 
 
-    /**
-     * This is the container where active message types for a messenger are found/dragged to.
-     */
-    const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types';
+	/**
+	 * This is the container where active message types for a messenger are found/dragged to.
+	 */
+	const MESSAGES_SETTINGS_ACTIVE_MESSAGE_TYPES_CONTAINER_SELECTOR = '#active-message-types';
 
 
-    /**
-     * Locator for the context switcher selector on the Message Template Editor page.
-     */
-    const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select";
+	/**
+	 * Locator for the context switcher selector on the Message Template Editor page.
+	 */
+	const MESSAGES_CONTEXT_SWITCHER_SELECTOR = "//form[@id='ee-msg-context-switcher-frm']/select";
 
-
-    /**
-     * Locator for the context switcher submit button in the Message Template Editor page.
-     */
-    const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt";
-
-
-    /**
-     * Locator for the dialog container used for housing viewed messages in the message activity list table.
-     */
-    const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content';
-
-
-    /**
-     * Returns the selector for the on/off toggle for context on the message template editor.
-     */
-    const MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE =
-        "//div[@class='activate_context_on_off_toggle_container']/div[@class='switch']/label";
-
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function messageActivityListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'default', $additional_params);
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function defaultMessageTemplateListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'global_mtps', $additional_params);
-    }
-
-
-    /**
-     * @param string $additional_params Any additional request parameters for the generated url should be included as
-     *                                  a string.
-     * @return string
-     */
-    public static function customMessageTemplateListTableUrl($additional_params = '')
-    {
-        return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params);
-    }
-
-
-    /**
-     * @return string
-     */
-    public static function messageSettingsUrl()
-    {
-        return self::adminUrl('espresso_messages', 'settings');
-    }
-
-
-
-    public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger(
-        $message_type_slug,
-        $messenger_slug = 'email'
-    ) {
-        return "#$message_type_slug-messagetype-$messenger_slug";
-    }
-
-
-    /**
-     * @param string $message_type_slug
-     * @param string $context
-     * @return string
-     */
-    public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
-    {
-        return $context
-            ? '.' . $message_type_slug . '-' . $context . '-edit-link'
-            : '.' . $message_type_slug . '-edit-link';
-    }
-
-
-    /**
-     * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters.
-     *
-     * @param        $field
-     * @param        $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param string $table_cell_content_for_field
-     * @param int    $number_in_set   It's possible that the given parameters could match multiple items in the view.
-     *                                This allows you to indicate which item from the set to match.  If this is set to 0
-     *                                then all matches for the locator will be returned.
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableCellSelectorFor(
-        $field,
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $table_cell_content_for_field = '',
-        $number_in_set = 1
-    ) {
-        $selector = "//tbody[@id='the-list']";
-        $selector .= "//tr[contains(@class, 'msg-status-$message_status')]"
-                     . "//td[contains(@class, 'message_type') and text()='$message_type_label']";
-        if ($messenger) {
-            $selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']";
-        }
-        $selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']";
-        $selector .= $table_cell_content_for_field
-            ? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']"
-            : "/ancestor::tr/td[contains(@class, 'column-$field')]";
-        return $number_in_set > 0 ? Locator::elementAt($selector, $number_in_set) : $selector;
-    }
-
-
-    /**
-     * Selector for the Create Custom button found in the message template list table.
-     * @param string $message_type_label
-     * @param string $messenger_label
-     * @return string
-     */
-    public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label)
-    {
-        $selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']"
-                    . "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]"
-                    . "//ancestor::tr/td/a[@class='button button-small']";
-        return $selector;
-    }
-
-
-    /**
-     * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to
-     * the FIRST match (which will be the latest message sent if the table is default sorted).
-     *
-     * @param string $message_type_label    The visible message type label for the row you want to match
-     * @param string $message_status        The status of the message for the row you want to match.
-     * @param string $messenger             The visible messenger label for the row you want to match.
-     * @param string $context               The visible context label for the row you want to match.
-     * @param int    $number_in_set         It's possible that the given parameters could match multiple items in the
-     *                                      view. This allows you to indicate which item from the set to match.
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableViewButtonSelectorFor(
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $selector = self::messagesActivityListTableCellSelectorFor(
-            'action',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $selector .= "/a/span[contains(@class, 'ee-message-action-link-view')"
-                     . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]";
-        return $selector;
-    }
-
-
-    /**
-     * Locator for the delete action link for a message item in the message activity list table.
-     * Note: The link is not visible by default, so the column would need hovered over for the link to appear.
-     *
-     * @param        $message_type_label
-     * @param string $message_status
-     * @param string $messenger
-     * @param string $context
-     * @param int    $number_in_set
-     * @return string
-     * @throws \InvalidArgumentException
-     */
-    public static function messagesActivityListTableDeleteActionSelectorFor(
-        $message_type_label,
-        $message_status = self::MESSAGE_STATUS_SENT,
-        $messenger = 'Email',
-        $context = 'Event Admin',
-        $number_in_set = 1
-    ) {
-        $selector = self::messagesActivityListTableCellSelectorFor(
-            'to',
-            $message_type_label,
-            $message_status,
-            $messenger,
-            $context,
-            '',
-            $number_in_set
-        );
-        $selector .= "/div/span[@class='delete']/a";
-        return $selector;
-    }
-
-
-
-    /**
-     * Returns the input selector for a given field in the message template editor.
-     * Assumes one is already viewing the Message Template Editor.
-     * @param string     $field
-     * @return string
-     */
-    public static function messageInputFieldSelectorFor($field)
-    {
-        return "//div[@id='post-body']//input[@id='$field-content']";
-    }
-
-
-    /**
-     * Wrapper for self::messageInputFieldSelectorFor('to') that takes care of getting the input for the To field.
-     */
-    public static function messageTemplateToFieldSelector()
-    {
-        return self::messageInputFieldSelectorFor('to');
-    }
+
+	/**
+	 * Locator for the context switcher submit button in the Message Template Editor page.
+	 */
+	const MESSAGES_CONTEXT_SWITCHER_BUTTON_SELECTOR = "#submit-msg-context-switcher-sbmt";
+
+
+	/**
+	 * Locator for the dialog container used for housing viewed messages in the message activity list table.
+	 */
+	const MESSAGES_LIST_TABLE_VIEW_MESSAGE_DIALOG_CONTAINER_SELECTOR = '.ee-admin-dialog-container-inner-content';
+
+
+	/**
+	 * Returns the selector for the on/off toggle for context on the message template editor.
+	 */
+	const MESSAGES_CONTEXT_ACTIVE_STATE_TOGGLE =
+		"//div[@class='activate_context_on_off_toggle_container']/div[@class='switch']/label";
+
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function messageActivityListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'default', $additional_params);
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function defaultMessageTemplateListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'global_mtps', $additional_params);
+	}
+
+
+	/**
+	 * @param string $additional_params Any additional request parameters for the generated url should be included as
+	 *                                  a string.
+	 * @return string
+	 */
+	public static function customMessageTemplateListTableUrl($additional_params = '')
+	{
+		return self::adminUrl('espresso_messages', 'custom_mtps', $additional_params);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public static function messageSettingsUrl()
+	{
+		return self::adminUrl('espresso_messages', 'settings');
+	}
+
+
+
+	public static function draggableSettingsBoxSelectorForMessageTypeAndMessenger(
+		$message_type_slug,
+		$messenger_slug = 'email'
+	) {
+		return "#$message_type_slug-messagetype-$messenger_slug";
+	}
+
+
+	/**
+	 * @param string $message_type_slug
+	 * @param string $context
+	 * @return string
+	 */
+	public static function editMessageTemplateClassByMessageType($message_type_slug, $context = '')
+	{
+		return $context
+			? '.' . $message_type_slug . '-' . $context . '-edit-link'
+			: '.' . $message_type_slug . '-edit-link';
+	}
+
+
+	/**
+	 * Selector for (a) specific table cell(s) in the Messages Activity list table for the given parameters.
+	 *
+	 * @param        $field
+	 * @param        $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param string $table_cell_content_for_field
+	 * @param int    $number_in_set   It's possible that the given parameters could match multiple items in the view.
+	 *                                This allows you to indicate which item from the set to match.  If this is set to 0
+	 *                                then all matches for the locator will be returned.
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableCellSelectorFor(
+		$field,
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$table_cell_content_for_field = '',
+		$number_in_set = 1
+	) {
+		$selector = "//tbody[@id='the-list']";
+		$selector .= "//tr[contains(@class, 'msg-status-$message_status')]"
+					 . "//td[contains(@class, 'message_type') and text()='$message_type_label']";
+		if ($messenger) {
+			$selector .= "/ancestor::tr/td[contains(@class, 'messenger') and text()='$messenger']";
+		}
+		$selector .= "/ancestor::tr/td[contains(@class, 'column-context') and text()='$context']";
+		$selector .= $table_cell_content_for_field
+			? "/ancestor::tr/td[contains(@class, 'column-$field') and text()='$table_cell_content_for_field']"
+			: "/ancestor::tr/td[contains(@class, 'column-$field')]";
+		return $number_in_set > 0 ? Locator::elementAt($selector, $number_in_set) : $selector;
+	}
+
+
+	/**
+	 * Selector for the Create Custom button found in the message template list table.
+	 * @param string $message_type_label
+	 * @param string $messenger_label
+	 * @return string
+	 */
+	public static function createCustomButtonForMessageTypeAndMessenger($message_type_label, $messenger_label)
+	{
+		$selector = "//tr/td[contains(@class, 'message_type') and text()='$message_type_label']"
+					. "//ancestor::tr/td[contains(@class, 'messenger') and contains(., '$messenger_label')]"
+					. "//ancestor::tr/td/a[@class='button button-small']";
+		return $selector;
+	}
+
+
+	/**
+	 * Note, this could potentially match multiple buttons in the view so the selector is intentionally restricted to
+	 * the FIRST match (which will be the latest message sent if the table is default sorted).
+	 *
+	 * @param string $message_type_label    The visible message type label for the row you want to match
+	 * @param string $message_status        The status of the message for the row you want to match.
+	 * @param string $messenger             The visible messenger label for the row you want to match.
+	 * @param string $context               The visible context label for the row you want to match.
+	 * @param int    $number_in_set         It's possible that the given parameters could match multiple items in the
+	 *                                      view. This allows you to indicate which item from the set to match.
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableViewButtonSelectorFor(
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$selector = self::messagesActivityListTableCellSelectorFor(
+			'action',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$selector .= "/a/span[contains(@class, 'ee-message-action-link-view')"
+					 . " and not(contains(@class, 'ee-message-action-link-view_transaction'))]";
+		return $selector;
+	}
+
+
+	/**
+	 * Locator for the delete action link for a message item in the message activity list table.
+	 * Note: The link is not visible by default, so the column would need hovered over for the link to appear.
+	 *
+	 * @param        $message_type_label
+	 * @param string $message_status
+	 * @param string $messenger
+	 * @param string $context
+	 * @param int    $number_in_set
+	 * @return string
+	 * @throws \InvalidArgumentException
+	 */
+	public static function messagesActivityListTableDeleteActionSelectorFor(
+		$message_type_label,
+		$message_status = self::MESSAGE_STATUS_SENT,
+		$messenger = 'Email',
+		$context = 'Event Admin',
+		$number_in_set = 1
+	) {
+		$selector = self::messagesActivityListTableCellSelectorFor(
+			'to',
+			$message_type_label,
+			$message_status,
+			$messenger,
+			$context,
+			'',
+			$number_in_set
+		);
+		$selector .= "/div/span[@class='delete']/a";
+		return $selector;
+	}
+
+
+
+	/**
+	 * Returns the input selector for a given field in the message template editor.
+	 * Assumes one is already viewing the Message Template Editor.
+	 * @param string     $field
+	 * @return string
+	 */
+	public static function messageInputFieldSelectorFor($field)
+	{
+		return "//div[@id='post-body']//input[@id='$field-content']";
+	}
+
+
+	/**
+	 * Wrapper for self::messageInputFieldSelectorFor('to') that takes care of getting the input for the To field.
+	 */
+	public static function messageTemplateToFieldSelector()
+	{
+		return self::messageInputFieldSelectorFor('to');
+	}
 }
\ No newline at end of file

core/libraries/messages/EE_message_type.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -825,7 +825,7 @@
      * Takes care of setting up the addressee object(s) for the primary attendee.
      *
      * @access protected
-     * @return array of EE_Addressee objects
+     * @return EE_Messages_Addressee[] of EE_Addressee objects
      */
     protected function _primary_attendee_addressees()
     {

Indentation +895 added lines, -895 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -18,906 +18,906 @@ 
 {
 
 
-    /**
-     * message type child classes will set what contexts are associated with the message type via this array.
-     * format:
-     * array(
-     * 'context' => array(
-     *        'label' => __('Context Label', 'event_espresso'),
-     *        'description' => __('Context description (for help popups)', 'event_espresso')
-     *    ));
-     *
-     * @var array
-     */
-    protected $_contexts = array();
-
-
-    /**
-     * This property is used to define what the display label will be for contexts (eg. "Recipients", "Themes" etc.)
-     * Format:
-     * array( 'label' => 'something', 'plural' => 'somethings', 'description' => 'something' );
-     *
-     * @var array
-     */
-    protected $_context_label;
-
-
-    /** MESSAGE ASSEMBLING PROPERTIES **/
-    /**
-     * This parameter simply holds all the message objects for retrieval by the controller and sending to the messenger.
-     *
-     * @var array of message objects.
-     */
-    public $messages = array();
-
-    /**
-     * The following holds the templates that will be used to assemble the message object for the messenger.
-     *
-     * @var array
-     */
-    protected $_templates;
-
-
-    /**
-     * If a specific template is being parsed, this will hold the message template group GRP_ID for that template.
-     *
-     * @var int.
-     */
-    protected $_GRP_ID;
-
-
-    /** OTHER INFO PROPERTIES **/
-    /**
-     * This will hold the count of the message objects in the messages array. This could be used for determining if
-     * batching/queueing is needed.
-     *
-     * @var int
-     */
-    public $count = 0;
-
-
-    /**
-     * This is set via the `do_messenger_hooks` method and contains the messenger being used to send the message of
-     * this message type at time of sending.
-     *
-     * @var EE_messenger
-     */
-    protected $_active_messenger;
-
-
-    /**
-     * This will hold the shortcode_replace instance for handling replacement of shortcodes in the various templates
-     *
-     * @var object
-     */
-    protected $_shortcode_replace;
-
-
-    /**
-     * The purpose for this property is to simply allow message types to indicate if the message generated is intended
-     * for only single context.  Child message types should redefine this variable (if necessary) in the
-     * _set_data_Handler() method.
-     *
-     * @var boolean
-     */
-    protected $_single_message = false;
-
-
-    /**
-     * This will hold an array of specific reg_ids that are receiving messages.
-     *
-     * @since 4.7.x
-     * @var array
-     */
-    protected $_regs_for_sending = array();
-
-
-    /**
-     * This holds the data passed to this class from the controller and also the final processed data.
-     *
-     * @var object
-     */
-    protected $_data;
-
-
-    /**
-     * this is just a flag indicating whether we're in preview mode or not.
-     *
-     * @var bool
-     */
-    protected $_preview = false;
-
-
-    /**
-     * This just holds defaults for addressee data that children merge with their data array setup
-     *
-     * @var array
-     */
-    protected $_default_addressee_data;
-
-
-    /**
-     * Child classes declare through this property what handler they want to use for the incoming data and this string
-     * is used to instantiate the EE_Messages_incoming_data child class for that handler.
-     *
-     * @var string
-     */
-    protected $_data_handler;
-
-
-    /**
-     * This holds any specific fields for holding any settings related to a message type (if any needed)
-     *
-     * @var array
-     */
-    protected $_admin_settings_fields = array();
-
-    /**
-     * this property will hold any existing setting that may have been set in the admin.
-     *
-     * @var array
-     */
-    protected $_existing_admin_settings = array();
-
-
-    /**
-     * This is used to designate the generating and alternative sending messengers for a message type.  It is set via
-     * set_with_messengers() on construct. Note, generating messenger also acts as a sending messenger for this message
-     * type.  However ONLY the generating messengers are used for creating templates for this message type. Should be
-     * in this format:
-     * {
-     *
-     * @type string $generating_messenger the name of the generating messenger.  Generating
-     *                                          messengers are used for generating templates,
-     *                                          doing validation and defining valid shortcodes.
-     *      {
-     * @type string $sending_messenger    values are the name(s) for the sending
-     *                                              messengers.  sending messengers are
-     *                                              just valid delivery vehicles that will utilize
-     *                                              the templates (and generated EE_message
-     *                                              objects from the generating messengers).
-     *      }
-     * }
-     * @since                             4.5.0
-     * @var array
-     */
-    protected $_with_messengers = array();
-
-
-    /**
-     * This holds the addressees in an array indexed by context for later retrieval when assembling the message objects.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_addressees = array();
-
-
-    /**
-     * This allows each message type to set what alternate messenger&message type combination can be used for fallback
-     * default templates if there are no specific ones defined for this messenger and message type.  Should be in the
-     * format:
-     * array(
-     *      'messenger' => 'message_type',
-     *      'another_messenger' => another_message_type
-     * );
-     * This is set in the message type constructor.
-     *
-     * @var array
-     */
-    protected $_master_templates = array();
-
-
-    /**
-     * This holds whatever the set template pack is for a message template group when generating messages.
-     *
-     * @since 4.5.0
-     * @var EE_Messages_Template_Pack
-     */
-    protected $_template_pack;
-
-
-    /**
-     * This holds whatever the set variation is for a message template group when generating messages.
-     *
-     * @since 4.5.0
-     * @var string
-     */
-    protected $_variation;
-
-
-    /**
-     * EE_message_type constructor.
-     */
-    public function __construct()
-    {
-        $this->_messages_item_type = 'message_type';
-        $this->_set_contexts();
-        $this->_set_with_messengers();
-        parent::__construct();
-    }
-
-
-    /**
-     * This sets the data handler for the message type.  It must be used to define the _data_handler property.  It is
-     * called when messages are setup.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_data_handler();
-
-
-    /**
-     * This method should return a EE_Base_Class object (or array of EE_Base_Class objects) for the given context and
-     * ID (which should be the primary key id for the base class).  Client code doesn't have to know what a message
-     * type's data handler is.
-     *
-     * @since 4.5.0
-     * @param string          $context      This should be a string matching a valid context for the message type.
-     * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
-     *                                      guessing a url).
-     * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
-     *                                      EE_Base_Class_Object
-     * @return mixed ( EE_Base_Class||EE_Base_Class[] )
-     */
-    abstract protected function _get_data_for_context($context, EE_Registration $registration, $id);
-
-
-    /**
-     * _set_contexts
-     * This sets up the contexts associated with the message_type
-     *
-     * @abstract
-     * @access  protected
-     * @return  void
-     */
-    abstract protected function _set_contexts();
-
-
-    /**
-     * This is used to get the "id" value fo the msg_trigger_url generated by get_url_trigger().
-     * In most cases, child classes don't need anything, (hence the default of 0), however if there is a specific
-     * EE_Base_Class that is required in generating a message for a message type recipient then the message
-     * type should override this method and use the given params to generate the correct ID.
-     *
-     * @param string          $context      The message type context.
-     * @param EE_Registration $registration Registration object
-     * @deprecated 4.9.0
-     * @return int
-     */
-    protected function _get_id_for_msg_url($context, EE_Registration $registration)
-    {
-        return 0;
-    }
-
-
-    /**
-     * This sets up any action/filter hooks this message type puts in place for a specific messenger.  Note that by
-     * default this does nothing.  Child classes will need to override if they want to add specific hooks for a
-     * messenger.
-     *
-     * @since 1.0.0
-     * @return void
-     */
-    protected function _do_messenger_hooks()
-    {
-        return;
-    }
-
-
-    /**
-     * This is a public wrapper for the protected _do_messenger_hooks() method.
-     * For backward compat reasons, this was done rather than making the protected method public.
-     *
-     * @param   EE_messenger $messenger This is used to set the $_active_messenger property, so message types are able
-     *                                  to know what messenger is being used to send the message at the time of
-     *                                  sending.
-     * @since 4.9.0
-     */
-    public function do_messenger_hooks($messenger = null)
-    {
-        $this->_active_messenger = $messenger;
-        $this->_do_messenger_hooks();
-    }
-
-
-    /**
-     * This method returns whether this message type should always generate a new copy
-     * when requested, or if links can be to the already generated copy.
-     * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table.
-     * Child classes should override this if different from the default of false.
-     *
-     * @return bool     false means can link to generated EE_Message.  true must regenerate.
-     */
-    public function always_generate()
-    {
-        return false;
-    }
-
-
-    /**
-     * Returns the priority for the message type.
-     * Priorities are defined as constants on EEM_Message.  Currently there are three priorities:
-     * - EEM_Message::priority_high
-     * - EEM_Message::priority_medium
-     * - EEM_Message::priority_low
-     * Priority is used to determine the weight the message type is given when queuing for generation and/or sending.
-     *
-     * @see    EEM_Message for more phpdocs on priority.
-     *         The default priority for all message_types is EEM_Message::priority_low.  Message Types wanting to give
-     *         a higher priority must override this method. Also note, messengers are able to override priorities
-     *         queuing instructions if their "send_now" flag is set to true. An example of this is the HTML messenger
-     *         which displays things in the browser.
-     * @since  4.9.0
-     * @return int
-     */
-    public function get_priority()
-    {
-        return EEM_Message::priority_low;
-    }
-
-
-    /**
-     * This runs the _set_data_handler() method for message types and then returns what got set.
-     *
-     * @param mixed $data This sets the data property for the message type with the incoming data used for generating.
-     * @return string (the reference for the data handler) (will be an empty string if could not be determined).
-     */
-    public function get_data_handler($data)
-    {
-        $this->_data = $data;
-        $this->_set_data_handler();
-        return apply_filters('FHEE__EE_message_type__get_data_handler', $this->_data_handler, $this);
-    }
-
-
-    /**
-     * This is called externally to reset the value of the $_data property for the message type.
-     * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
-     * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called
-     * (and for back compat reasons). This particular method is used in
-     * EE_Messages_Generator::_reset_current_properties to ensure that the internal _data on the message type is
-     * cleaned before subsequent EE_Message generation in the same request.
-     *
-     * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
-     *            ensure that there is no manipulation of the _data property during run time so there's a clear
-     *            expectation of what it is.  Likely we need to ensure that _data is not persisted IN the message type
-     *            at all.
-     * @internal  Plugin authors, do not implement this method, it is subject to change.
-     * @since     4.9
-     */
-    public function reset_data()
-    {
-        $this->_data = null;
-    }
-
-
-    /**
-     * This does some validation of incoming params gets the url trigger from the defined method in the specific child
-     * class and then filters the results.
-     *
-     * @param string          $context           The message type context
-     * @param string          $sending_messenger The sending messenger
-     * @param EE_Registration $registration      Registration object
-     * @throws EE_Error
-     * @deprecated  4.9.0  Likely 4.9.10 or 4.10.0 will remove this method completely
-     * @return string          generated url
-     */
-    public function get_url_trigger($context, $sending_messenger, EE_Registration $registration)
-    {
-        //validate context
-        //valid context?
-        if (! isset($this->_contexts[$context])) {
-            throw new EE_Error(
-                sprintf(
-                    __('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $context,
-                    get_class($this)
-                )
-            );
-        }
-        //valid sending_messenger?
-        $not_valid_msgr = false;
-        foreach ($this->_with_messengers as $generating => $sendings) {
-            if (empty($sendings) || array_search($sending_messenger, $sendings) === false) {
-                $not_valid_msgr = true;
-            }
-        }
-        if ($not_valid_msgr) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The given sending messenger string (%s) does not match a valid sending messenger with the %s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
-                        'event_espresso'
-                    ),
-                    $sending_messenger,
-                    get_class($this)
-                )
-            );
-        }
-        return EEH_MSG_Template::generate_url_trigger(
-            $sending_messenger,
-            $this->_active_messenger->name,
-            $context,
-            $this->name,
-            $registration,
-            $this->_GRP_ID,
-            $this->_get_id_for_msg_url($context, $registration)
-        );
-    }
-
-
-    /**
-     * Wrapper for _get_data_for_context() that handles some validation before calling the main class and also allows
-     * for filtering. This is (currently) called by the EED_Messages module.
-     *
-     * @since 4.5.0
-     * @throws EE_Error
-     * @param string          $context      This should be a string matching a valid context for the message type.
-     * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
-     *                                      guessing a url).
-     * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
-     *                                      EE_Base_Class_Object
-     * @return mixed (EE_Base_Class||EE_Base_Class[])
-     */
-    public function get_data_for_context($context, EE_Registration $registration, $id = 0)
-    {
-        //valid context?
-        if (! isset($this->_contexts[$context])) {
-            throw new EE_Error(
-                sprintf(
-                    __('The context %s is not a valid context for %s.', 'event_espresso'),
-                    $context,
-                    get_class($this)
-                )
-            );
-        }
-        //get data and apply global and class specific filters on it.
-        $data = apply_filters(
-            'FHEE__EE_message_type__get_data_for_context__data',
-            $this->_get_data_for_context($context, $registration, $id),
-            $this
-        );
-        $data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
-        //if empty then something went wrong!
-        if (empty($data)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'There is no data retrieved, it is possible that the id given (%d) does not match any value in the database for the corresponding EE_Base_Class used by the data handler for the %s message type.',
-                        'event_espresso'
-                    ),
-                    $id,
-                    $this->name
-                )
-            );
-        }
-        return $data;
-    }
-
-
-    /**
-     * This returns the contents of the _data property.
-     * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
-     * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called.
-     *
-     * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
-     *            ensure that there is no manipulation of the _data property during run time so there's a clear
-     *            expectation of what it is.
-     * @internal  Plugin authors, do not implement this method, it is subject to change.
-     * @return mixed
-     */
-    public function get_data()
-    {
-        return $this->_data;
-    }
-
-
-    /**
-     * used to set the $_with_messengers property. (this is a default, child classes SHOULD override)
-     *
-     * @see   property definition for description of setup.
-     * @since 4.5.0
-     * @abstract
-     * @return void
-     */
-    protected function _set_with_messengers()
-    {
-        $this->_with_messengers = array(
-            'email' => array('html'),
-        );
-    }
-
-
-    /**
-     * Return the value of the _with_messengers property
-     *
-     * @since 4.5.0
-     * @return array
-     */
-    public function with_messengers()
-    {
-        return apply_filters(
-            'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
-            $this->_with_messengers
-        );
-    }
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class
-     * callback function if that page is registered via the `_admin_registered_page` property set by the child class.
-     * *
-     *
-     * @param string $page       the slug of the EE admin page
-     * @param array  $messengers an array of active messenger objects
-     * @param string $action     the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array  $extra      This is just an extra argument that can be used to pass additional data for setting up
-     *                           page content.
-     * @access public
-     * @return string
-     */
-    public function get_message_type_admin_page_content(
-        $page,
-        $action = null,
-        $extra = array(),
-        $messengers = array()
-    ) {
-        //we can also further refine the context by action (if present).
-        return $this->_get_admin_page_content($page, $action, $extra, $messengers);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_contexts()
-    {
-        return $this->_contexts;
-    }
-
-
-    /**
-     * This just returns the context label for a given context (as set in $_context_label property)
-     *
-     * @access public
-     * @return array
-     */
-    public function get_context_label()
-    {
-        return $this->_context_label;
-    }
-
-
-    /**
-     * This just returns the (filtered) _master_templates property.
-     *
-     * @see property definition for documentation.
-     * @return array
-     */
-    public function get_master_templates()
-    {
-        //first class specific filter then filter that by the global filter.
-        $master_templates = apply_filters(
-            'FHEE__' . get_class($this) . '__get_master_templates',
-            $this->_master_templates
-        );
-        return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
-    }
-
-
-    /**
-     * Accepts an incoming data handler which contains data for processing, and returns an array of
-     * EE_Messages_Addressee objects.
-     *
-     * @param EE_Messages_incoming_data $data
-     * @param string                    $context Limit addressees to specific context.
-     * @return array   An array indexed by context where each context is an array of EE_Messages_Addressee objects for
-     *                                           that context
-     */
-    public function get_addressees(EE_Messages_incoming_data $data, $context = '')
-    {
-        //override _data
-        $this->_data       = $data;
-        $addressees        = array();
-        $original_contexts = $this->_contexts;
-        //if incoming context then limit to that context
-        if (! empty($context)) {
-            $cntxt = ! empty($this->_contexts[$context]) ? $this->_contexts[$context] : '';
-            if (! empty($cntxt)) {
-                $this->_contexts           = array();
-                $this->_contexts[$context] = $cntxt;
-            }
-        }
-        $this->_set_default_addressee_data();
-        if ($this->_process_data()) {
-            $addressees = $this->_addressees;
-        }
-
-        //reset contexts and addressees
-        $this->_contexts   = $original_contexts;
-        $this->_addressees = array();
-        return $addressees;
-    }
-
-
-    /**
-     * processes the data object so we get
-     *
-     * @throws EE_Error
-     * @return bool  true means data was processed successfully, false means not.
-     */
-    protected function _process_data()
-    {
-        //at a minimum, we NEED EE_Attendee objects.
-        if (empty($this->_data->attendees)) {
-            return false;  //there's no data to process!
-        }
-        // process addressees for each context.  Child classes will have to have methods for
-        // each context defined to handle the processing of the data object within them
-        foreach ($this->_contexts as $context => $details) {
-            $xpctd_method = '_' . $context . '_addressees';
-            if (! method_exists($this, $xpctd_method)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present',
-                            'event_espresso'
-                        ),
-                        $this->label['singular'],
-                        $xpctd_method
-                    )
-                );
-            }
-            $this->_addressees[$context] = call_user_func(array($this, $xpctd_method));
-        }
-        return true; //data was processed successfully.
-    }
-
-
-    /**
-     * sets the default_addressee_data property,
-     *
-     * @access private
-     * @return void
-     */
-    private function _set_default_addressee_data()
-    {
-        $this->_default_addressee_data = array(
-            'billing'                  => $this->_data->billing,
-            'taxes'                    => $this->_data->taxes,
-            'tax_line_items'           => $this->_data->tax_line_items,
-            'additional_line_items'    => $this->_data->additional_line_items,
-            'grand_total_line_item'    => $this->_data->grand_total_line_item,
-            'txn'                      => $this->_data->txn,
-            'payments'                 => $this->_data->payments,
-            'payment'                  => isset($this->_data->payment) && $this->_data->payment instanceof EE_Payment
-                ? $this->_data->payment
-                : null,
-            'reg_objs'                 => $this->_data->reg_objs,
-            'registrations'            => $this->_data->registrations,
-            'datetimes'                => $this->_data->datetimes,
-            'tickets'                  => $this->_data->tickets,
-            'line_items_with_children' => $this->_data->line_items_with_children,
-            'questions'                => $this->_data->questions,
-            'answers'                  => $this->_data->answers,
-            'txn_status'               => $this->_data->txn_status,
-            'total_ticket_count'       => $this->_data->total_ticket_count,
-        );
-        if (is_array($this->_data->primary_attendee_data)) {
-            $this->_default_addressee_data                    = array_merge(
-                $this->_default_addressee_data,
-                $this->_data->primary_attendee_data
-            );
-            $this->_default_addressee_data['primary_att_obj'] = $this->_data->primary_attendee_data['att_obj'];
-            $this->_default_addressee_data['primary_reg_obj'] = $this->_data->primary_attendee_data['reg_obj'];
-        }
-    }
-
-
-
-    /********************
+	/**
+	 * message type child classes will set what contexts are associated with the message type via this array.
+	 * format:
+	 * array(
+	 * 'context' => array(
+	 *        'label' => __('Context Label', 'event_espresso'),
+	 *        'description' => __('Context description (for help popups)', 'event_espresso')
+	 *    ));
+	 *
+	 * @var array
+	 */
+	protected $_contexts = array();
+
+
+	/**
+	 * This property is used to define what the display label will be for contexts (eg. "Recipients", "Themes" etc.)
+	 * Format:
+	 * array( 'label' => 'something', 'plural' => 'somethings', 'description' => 'something' );
+	 *
+	 * @var array
+	 */
+	protected $_context_label;
+
+
+	/** MESSAGE ASSEMBLING PROPERTIES **/
+	/**
+	 * This parameter simply holds all the message objects for retrieval by the controller and sending to the messenger.
+	 *
+	 * @var array of message objects.
+	 */
+	public $messages = array();
+
+	/**
+	 * The following holds the templates that will be used to assemble the message object for the messenger.
+	 *
+	 * @var array
+	 */
+	protected $_templates;
+
+
+	/**
+	 * If a specific template is being parsed, this will hold the message template group GRP_ID for that template.
+	 *
+	 * @var int.
+	 */
+	protected $_GRP_ID;
+
+
+	/** OTHER INFO PROPERTIES **/
+	/**
+	 * This will hold the count of the message objects in the messages array. This could be used for determining if
+	 * batching/queueing is needed.
+	 *
+	 * @var int
+	 */
+	public $count = 0;
+
+
+	/**
+	 * This is set via the `do_messenger_hooks` method and contains the messenger being used to send the message of
+	 * this message type at time of sending.
+	 *
+	 * @var EE_messenger
+	 */
+	protected $_active_messenger;
+
+
+	/**
+	 * This will hold the shortcode_replace instance for handling replacement of shortcodes in the various templates
+	 *
+	 * @var object
+	 */
+	protected $_shortcode_replace;
+
+
+	/**
+	 * The purpose for this property is to simply allow message types to indicate if the message generated is intended
+	 * for only single context.  Child message types should redefine this variable (if necessary) in the
+	 * _set_data_Handler() method.
+	 *
+	 * @var boolean
+	 */
+	protected $_single_message = false;
+
+
+	/**
+	 * This will hold an array of specific reg_ids that are receiving messages.
+	 *
+	 * @since 4.7.x
+	 * @var array
+	 */
+	protected $_regs_for_sending = array();
+
+
+	/**
+	 * This holds the data passed to this class from the controller and also the final processed data.
+	 *
+	 * @var object
+	 */
+	protected $_data;
+
+
+	/**
+	 * this is just a flag indicating whether we're in preview mode or not.
+	 *
+	 * @var bool
+	 */
+	protected $_preview = false;
+
+
+	/**
+	 * This just holds defaults for addressee data that children merge with their data array setup
+	 *
+	 * @var array
+	 */
+	protected $_default_addressee_data;
+
+
+	/**
+	 * Child classes declare through this property what handler they want to use for the incoming data and this string
+	 * is used to instantiate the EE_Messages_incoming_data child class for that handler.
+	 *
+	 * @var string
+	 */
+	protected $_data_handler;
+
+
+	/**
+	 * This holds any specific fields for holding any settings related to a message type (if any needed)
+	 *
+	 * @var array
+	 */
+	protected $_admin_settings_fields = array();
+
+	/**
+	 * this property will hold any existing setting that may have been set in the admin.
+	 *
+	 * @var array
+	 */
+	protected $_existing_admin_settings = array();
+
+
+	/**
+	 * This is used to designate the generating and alternative sending messengers for a message type.  It is set via
+	 * set_with_messengers() on construct. Note, generating messenger also acts as a sending messenger for this message
+	 * type.  However ONLY the generating messengers are used for creating templates for this message type. Should be
+	 * in this format:
+	 * {
+	 *
+	 * @type string $generating_messenger the name of the generating messenger.  Generating
+	 *                                          messengers are used for generating templates,
+	 *                                          doing validation and defining valid shortcodes.
+	 *      {
+	 * @type string $sending_messenger    values are the name(s) for the sending
+	 *                                              messengers.  sending messengers are
+	 *                                              just valid delivery vehicles that will utilize
+	 *                                              the templates (and generated EE_message
+	 *                                              objects from the generating messengers).
+	 *      }
+	 * }
+	 * @since                             4.5.0
+	 * @var array
+	 */
+	protected $_with_messengers = array();
+
+
+	/**
+	 * This holds the addressees in an array indexed by context for later retrieval when assembling the message objects.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_addressees = array();
+
+
+	/**
+	 * This allows each message type to set what alternate messenger&message type combination can be used for fallback
+	 * default templates if there are no specific ones defined for this messenger and message type.  Should be in the
+	 * format:
+	 * array(
+	 *      'messenger' => 'message_type',
+	 *      'another_messenger' => another_message_type
+	 * );
+	 * This is set in the message type constructor.
+	 *
+	 * @var array
+	 */
+	protected $_master_templates = array();
+
+
+	/**
+	 * This holds whatever the set template pack is for a message template group when generating messages.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Messages_Template_Pack
+	 */
+	protected $_template_pack;
+
+
+	/**
+	 * This holds whatever the set variation is for a message template group when generating messages.
+	 *
+	 * @since 4.5.0
+	 * @var string
+	 */
+	protected $_variation;
+
+
+	/**
+	 * EE_message_type constructor.
+	 */
+	public function __construct()
+	{
+		$this->_messages_item_type = 'message_type';
+		$this->_set_contexts();
+		$this->_set_with_messengers();
+		parent::__construct();
+	}
+
+
+	/**
+	 * This sets the data handler for the message type.  It must be used to define the _data_handler property.  It is
+	 * called when messages are setup.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_data_handler();
+
+
+	/**
+	 * This method should return a EE_Base_Class object (or array of EE_Base_Class objects) for the given context and
+	 * ID (which should be the primary key id for the base class).  Client code doesn't have to know what a message
+	 * type's data handler is.
+	 *
+	 * @since 4.5.0
+	 * @param string          $context      This should be a string matching a valid context for the message type.
+	 * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
+	 *                                      guessing a url).
+	 * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
+	 *                                      EE_Base_Class_Object
+	 * @return mixed ( EE_Base_Class||EE_Base_Class[] )
+	 */
+	abstract protected function _get_data_for_context($context, EE_Registration $registration, $id);
+
+
+	/**
+	 * _set_contexts
+	 * This sets up the contexts associated with the message_type
+	 *
+	 * @abstract
+	 * @access  protected
+	 * @return  void
+	 */
+	abstract protected function _set_contexts();
+
+
+	/**
+	 * This is used to get the "id" value fo the msg_trigger_url generated by get_url_trigger().
+	 * In most cases, child classes don't need anything, (hence the default of 0), however if there is a specific
+	 * EE_Base_Class that is required in generating a message for a message type recipient then the message
+	 * type should override this method and use the given params to generate the correct ID.
+	 *
+	 * @param string          $context      The message type context.
+	 * @param EE_Registration $registration Registration object
+	 * @deprecated 4.9.0
+	 * @return int
+	 */
+	protected function _get_id_for_msg_url($context, EE_Registration $registration)
+	{
+		return 0;
+	}
+
+
+	/**
+	 * This sets up any action/filter hooks this message type puts in place for a specific messenger.  Note that by
+	 * default this does nothing.  Child classes will need to override if they want to add specific hooks for a
+	 * messenger.
+	 *
+	 * @since 1.0.0
+	 * @return void
+	 */
+	protected function _do_messenger_hooks()
+	{
+		return;
+	}
+
+
+	/**
+	 * This is a public wrapper for the protected _do_messenger_hooks() method.
+	 * For backward compat reasons, this was done rather than making the protected method public.
+	 *
+	 * @param   EE_messenger $messenger This is used to set the $_active_messenger property, so message types are able
+	 *                                  to know what messenger is being used to send the message at the time of
+	 *                                  sending.
+	 * @since 4.9.0
+	 */
+	public function do_messenger_hooks($messenger = null)
+	{
+		$this->_active_messenger = $messenger;
+		$this->_do_messenger_hooks();
+	}
+
+
+	/**
+	 * This method returns whether this message type should always generate a new copy
+	 * when requested, or if links can be to the already generated copy.
+	 * Note: this does NOT affect viewing/resending already generated messages in the EE_Message list table.
+	 * Child classes should override this if different from the default of false.
+	 *
+	 * @return bool     false means can link to generated EE_Message.  true must regenerate.
+	 */
+	public function always_generate()
+	{
+		return false;
+	}
+
+
+	/**
+	 * Returns the priority for the message type.
+	 * Priorities are defined as constants on EEM_Message.  Currently there are three priorities:
+	 * - EEM_Message::priority_high
+	 * - EEM_Message::priority_medium
+	 * - EEM_Message::priority_low
+	 * Priority is used to determine the weight the message type is given when queuing for generation and/or sending.
+	 *
+	 * @see    EEM_Message for more phpdocs on priority.
+	 *         The default priority for all message_types is EEM_Message::priority_low.  Message Types wanting to give
+	 *         a higher priority must override this method. Also note, messengers are able to override priorities
+	 *         queuing instructions if their "send_now" flag is set to true. An example of this is the HTML messenger
+	 *         which displays things in the browser.
+	 * @since  4.9.0
+	 * @return int
+	 */
+	public function get_priority()
+	{
+		return EEM_Message::priority_low;
+	}
+
+
+	/**
+	 * This runs the _set_data_handler() method for message types and then returns what got set.
+	 *
+	 * @param mixed $data This sets the data property for the message type with the incoming data used for generating.
+	 * @return string (the reference for the data handler) (will be an empty string if could not be determined).
+	 */
+	public function get_data_handler($data)
+	{
+		$this->_data = $data;
+		$this->_set_data_handler();
+		return apply_filters('FHEE__EE_message_type__get_data_handler', $this->_data_handler, $this);
+	}
+
+
+	/**
+	 * This is called externally to reset the value of the $_data property for the message type.
+	 * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
+	 * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called
+	 * (and for back compat reasons). This particular method is used in
+	 * EE_Messages_Generator::_reset_current_properties to ensure that the internal _data on the message type is
+	 * cleaned before subsequent EE_Message generation in the same request.
+	 *
+	 * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
+	 *            ensure that there is no manipulation of the _data property during run time so there's a clear
+	 *            expectation of what it is.  Likely we need to ensure that _data is not persisted IN the message type
+	 *            at all.
+	 * @internal  Plugin authors, do not implement this method, it is subject to change.
+	 * @since     4.9
+	 */
+	public function reset_data()
+	{
+		$this->_data = null;
+	}
+
+
+	/**
+	 * This does some validation of incoming params gets the url trigger from the defined method in the specific child
+	 * class and then filters the results.
+	 *
+	 * @param string          $context           The message type context
+	 * @param string          $sending_messenger The sending messenger
+	 * @param EE_Registration $registration      Registration object
+	 * @throws EE_Error
+	 * @deprecated  4.9.0  Likely 4.9.10 or 4.10.0 will remove this method completely
+	 * @return string          generated url
+	 */
+	public function get_url_trigger($context, $sending_messenger, EE_Registration $registration)
+	{
+		//validate context
+		//valid context?
+		if (! isset($this->_contexts[$context])) {
+			throw new EE_Error(
+				sprintf(
+					__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$context,
+					get_class($this)
+				)
+			);
+		}
+		//valid sending_messenger?
+		$not_valid_msgr = false;
+		foreach ($this->_with_messengers as $generating => $sendings) {
+			if (empty($sendings) || array_search($sending_messenger, $sendings) === false) {
+				$not_valid_msgr = true;
+			}
+		}
+		if ($not_valid_msgr) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The given sending messenger string (%s) does not match a valid sending messenger with the %s.  If this is incorrect, make sure that the message type has defined this messenger as a sending messenger in its $_with_messengers array.',
+						'event_espresso'
+					),
+					$sending_messenger,
+					get_class($this)
+				)
+			);
+		}
+		return EEH_MSG_Template::generate_url_trigger(
+			$sending_messenger,
+			$this->_active_messenger->name,
+			$context,
+			$this->name,
+			$registration,
+			$this->_GRP_ID,
+			$this->_get_id_for_msg_url($context, $registration)
+		);
+	}
+
+
+	/**
+	 * Wrapper for _get_data_for_context() that handles some validation before calling the main class and also allows
+	 * for filtering. This is (currently) called by the EED_Messages module.
+	 *
+	 * @since 4.5.0
+	 * @throws EE_Error
+	 * @param string          $context      This should be a string matching a valid context for the message type.
+	 * @param EE_Registration $registration Need a registration to ensure that the data is valid (prevents people
+	 *                                      guessing a url).
+	 * @param int             $id           Optional. Integer corresponding to the value for the primary key of a
+	 *                                      EE_Base_Class_Object
+	 * @return mixed (EE_Base_Class||EE_Base_Class[])
+	 */
+	public function get_data_for_context($context, EE_Registration $registration, $id = 0)
+	{
+		//valid context?
+		if (! isset($this->_contexts[$context])) {
+			throw new EE_Error(
+				sprintf(
+					__('The context %s is not a valid context for %s.', 'event_espresso'),
+					$context,
+					get_class($this)
+				)
+			);
+		}
+		//get data and apply global and class specific filters on it.
+		$data = apply_filters(
+			'FHEE__EE_message_type__get_data_for_context__data',
+			$this->_get_data_for_context($context, $registration, $id),
+			$this
+		);
+		$data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
+		//if empty then something went wrong!
+		if (empty($data)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'There is no data retrieved, it is possible that the id given (%d) does not match any value in the database for the corresponding EE_Base_Class used by the data handler for the %s message type.',
+						'event_espresso'
+					),
+					$id,
+					$this->name
+				)
+			);
+		}
+		return $data;
+	}
+
+
+	/**
+	 * This returns the contents of the _data property.
+	 * Please note the value of the _data is highly volatile.  It was added as an interim measure ensuring
+	 * EE_Message_To_Generate objects have any changes to the _data property when `_set_data_handler` method is called.
+	 *
+	 * @todo      This needs refactored along with the whole _set_data_handler() method in EE_message_types. Need to
+	 *            ensure that there is no manipulation of the _data property during run time so there's a clear
+	 *            expectation of what it is.
+	 * @internal  Plugin authors, do not implement this method, it is subject to change.
+	 * @return mixed
+	 */
+	public function get_data()
+	{
+		return $this->_data;
+	}
+
+
+	/**
+	 * used to set the $_with_messengers property. (this is a default, child classes SHOULD override)
+	 *
+	 * @see   property definition for description of setup.
+	 * @since 4.5.0
+	 * @abstract
+	 * @return void
+	 */
+	protected function _set_with_messengers()
+	{
+		$this->_with_messengers = array(
+			'email' => array('html'),
+		);
+	}
+
+
+	/**
+	 * Return the value of the _with_messengers property
+	 *
+	 * @since 4.5.0
+	 * @return array
+	 */
+	public function with_messengers()
+	{
+		return apply_filters(
+			'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
+			$this->_with_messengers
+		);
+	}
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page) and will return the response from the child class
+	 * callback function if that page is registered via the `_admin_registered_page` property set by the child class.
+	 * *
+	 *
+	 * @param string $page       the slug of the EE admin page
+	 * @param array  $messengers an array of active messenger objects
+	 * @param string $action     the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array  $extra      This is just an extra argument that can be used to pass additional data for setting up
+	 *                           page content.
+	 * @access public
+	 * @return string
+	 */
+	public function get_message_type_admin_page_content(
+		$page,
+		$action = null,
+		$extra = array(),
+		$messengers = array()
+	) {
+		//we can also further refine the context by action (if present).
+		return $this->_get_admin_page_content($page, $action, $extra, $messengers);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_contexts()
+	{
+		return $this->_contexts;
+	}
+
+
+	/**
+	 * This just returns the context label for a given context (as set in $_context_label property)
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public function get_context_label()
+	{
+		return $this->_context_label;
+	}
+
+
+	/**
+	 * This just returns the (filtered) _master_templates property.
+	 *
+	 * @see property definition for documentation.
+	 * @return array
+	 */
+	public function get_master_templates()
+	{
+		//first class specific filter then filter that by the global filter.
+		$master_templates = apply_filters(
+			'FHEE__' . get_class($this) . '__get_master_templates',
+			$this->_master_templates
+		);
+		return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
+	}
+
+
+	/**
+	 * Accepts an incoming data handler which contains data for processing, and returns an array of
+	 * EE_Messages_Addressee objects.
+	 *
+	 * @param EE_Messages_incoming_data $data
+	 * @param string                    $context Limit addressees to specific context.
+	 * @return array   An array indexed by context where each context is an array of EE_Messages_Addressee objects for
+	 *                                           that context
+	 */
+	public function get_addressees(EE_Messages_incoming_data $data, $context = '')
+	{
+		//override _data
+		$this->_data       = $data;
+		$addressees        = array();
+		$original_contexts = $this->_contexts;
+		//if incoming context then limit to that context
+		if (! empty($context)) {
+			$cntxt = ! empty($this->_contexts[$context]) ? $this->_contexts[$context] : '';
+			if (! empty($cntxt)) {
+				$this->_contexts           = array();
+				$this->_contexts[$context] = $cntxt;
+			}
+		}
+		$this->_set_default_addressee_data();
+		if ($this->_process_data()) {
+			$addressees = $this->_addressees;
+		}
+
+		//reset contexts and addressees
+		$this->_contexts   = $original_contexts;
+		$this->_addressees = array();
+		return $addressees;
+	}
+
+
+	/**
+	 * processes the data object so we get
+	 *
+	 * @throws EE_Error
+	 * @return bool  true means data was processed successfully, false means not.
+	 */
+	protected function _process_data()
+	{
+		//at a minimum, we NEED EE_Attendee objects.
+		if (empty($this->_data->attendees)) {
+			return false;  //there's no data to process!
+		}
+		// process addressees for each context.  Child classes will have to have methods for
+		// each context defined to handle the processing of the data object within them
+		foreach ($this->_contexts as $context => $details) {
+			$xpctd_method = '_' . $context . '_addressees';
+			if (! method_exists($this, $xpctd_method)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The data for %1$s message type cannot be prepared because there is no set method for doing so.  The expected method name is "%2$s" please doublecheck the %1$s message type class and make sure that method is present',
+							'event_espresso'
+						),
+						$this->label['singular'],
+						$xpctd_method
+					)
+				);
+			}
+			$this->_addressees[$context] = call_user_func(array($this, $xpctd_method));
+		}
+		return true; //data was processed successfully.
+	}
+
+
+	/**
+	 * sets the default_addressee_data property,
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function _set_default_addressee_data()
+	{
+		$this->_default_addressee_data = array(
+			'billing'                  => $this->_data->billing,
+			'taxes'                    => $this->_data->taxes,
+			'tax_line_items'           => $this->_data->tax_line_items,
+			'additional_line_items'    => $this->_data->additional_line_items,
+			'grand_total_line_item'    => $this->_data->grand_total_line_item,
+			'txn'                      => $this->_data->txn,
+			'payments'                 => $this->_data->payments,
+			'payment'                  => isset($this->_data->payment) && $this->_data->payment instanceof EE_Payment
+				? $this->_data->payment
+				: null,
+			'reg_objs'                 => $this->_data->reg_objs,
+			'registrations'            => $this->_data->registrations,
+			'datetimes'                => $this->_data->datetimes,
+			'tickets'                  => $this->_data->tickets,
+			'line_items_with_children' => $this->_data->line_items_with_children,
+			'questions'                => $this->_data->questions,
+			'answers'                  => $this->_data->answers,
+			'txn_status'               => $this->_data->txn_status,
+			'total_ticket_count'       => $this->_data->total_ticket_count,
+		);
+		if (is_array($this->_data->primary_attendee_data)) {
+			$this->_default_addressee_data                    = array_merge(
+				$this->_default_addressee_data,
+				$this->_data->primary_attendee_data
+			);
+			$this->_default_addressee_data['primary_att_obj'] = $this->_data->primary_attendee_data['att_obj'];
+			$this->_default_addressee_data['primary_reg_obj'] = $this->_data->primary_attendee_data['reg_obj'];
+		}
+	}
+
+
+
+	/********************
      * setup default shared addressee object/contexts
      * These can be utilized simply by defining the context in the child message type.
      * They can also be overridden if a specific message type needs to do something different for that context.
      ****************/
-    /**
-     * see abstract declaration in parent class for details, children message types can
-     * override these valid shortcodes if desired (we include all for all contexts by default).
-     */
-    protected function _set_valid_shortcodes()
-    {
-        $all_shortcodes = array(
-            'attendee_list',
-            'attendee',
-            'datetime_list',
-            'datetime',
-            'event_list',
-            'event_meta',
-            'event',
-            'organization',
-            'recipient_details',
-            'recipient_list',
-            'ticket_list',
-            'ticket',
-            'transaction',
-            'venue',
-            'primary_registration_details',
-            'primary_registration_list',
-            'event_author',
-            'email',
-            'messenger',
-        );
-        $contexts       = $this->get_contexts();
-        foreach ($contexts as $context => $details) {
-            $this->_valid_shortcodes[$context] = $all_shortcodes;
-            //make sure non admin context does not include the event_author shortcodes
-            if ($context != 'admin') {
-                if (($key = array_search('event_author', $this->_valid_shortcodes[$context])) !== false) {
-                    unset($this->_valid_shortcodes[$context][$key]);
-                }
-            }
-        }
-        // make sure admin context does not include the recipient_details shortcodes
-        // IF we have admin context hooked in message types might not have that context.
-        if (! empty($this->_valid_shortcodes['admin'])) {
-            if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][$key]);
-            }
-            //make sure admin context does not include the recipient_details shortcodes
-            if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
-                unset($this->_valid_shortcodes['admin'][$key]);
-            }
-        }
-    }
-
-
-    /**
-     * Used by Validators to modify the valid shortcodes.
-     *
-     * @param  array $new_config array of valid shortcodes (by context)
-     * @return void               sets valid_shortcodes property
-     */
-    public function reset_valid_shortcodes_config($new_config)
-    {
-        foreach ($new_config as $context => $shortcodes) {
-            $this->_valid_shortcodes[$context] = $shortcodes;
-        }
-    }
-
-
-    /**
-     * returns an array of addressee objects for event_admins
-     *
-     * @access protected
-     * @return array array of EE_Messages_Addressee objects
-     */
-    protected function _admin_addressees()
-    {
-        $admin_events = array();
-        $addressees   = array();
-        // first we need to get the event admin user id for all the events
-        // and setup an addressee object for each unique admin user.
-        foreach ($this->_data->events as $line_ref => $event) {
-            $admin_id = $this->_get_event_admin_id($event['ID']);
-            //make sure we are just including the events that belong to this admin!
-            $admin_events[$admin_id][$line_ref] = $event;
-        }
-        //k now we can loop through the event_admins and setup the addressee data.
-        foreach ($admin_events as $admin_id => $event_details) {
-            $aee          = array(
-                'user_id'        => $admin_id,
-                'events'         => $event_details,
-                'attendees'      => $this->_data->attendees,
-                'recipient_id'   => $admin_id,
-                'recipient_type' => 'WP_User',
-            );
-            $aee          = array_merge($this->_default_addressee_data, $aee);
-            $addressees[] = new EE_Messages_Addressee($aee);
-        }
-        return $addressees;
-    }
-
-
-    /**
-     * Takes care of setting up the addressee object(s) for the primary attendee.
-     *
-     * @access protected
-     * @return array of EE_Addressee objects
-     */
-    protected function _primary_attendee_addressees()
-    {
-        $aee                   = $this->_default_addressee_data;
-        $aee['events']         = $this->_data->events;
-        $aee['attendees']      = $this->_data->attendees;
-        $aee['recipient_id']   = $aee['primary_att_obj'] instanceof EE_Attendee ? $aee['primary_att_obj']->ID() : 0;
-        $aee['recipient_type'] = 'Attendee';
-        //great now we can instantiate the $addressee object and return (as an array);
-        $add[] = new EE_Messages_Addressee($aee);
-        return $add;
-    }
-
-
-    /**
-     * Takes care of setting up the addressee object(s) for the registered attendees
-     *
-     * @access protected
-     * @return array of EE_Addressee objects
-     */
-    protected function _attendee_addressees()
-    {
-        $add = array();
-        //we just have to loop through the attendees.  We'll also set the attached events for each attendee.
-        //use to verify unique attendee emails... we don't want to sent multiple copies to the same attendee do we?
-        $already_processed = array();
-        foreach ($this->_data->attendees as $att_id => $details) {
-            //set the attendee array to blank on each loop;
-            $aee = array();
-            if (isset($this->_data->reg_obj)
-                && ($this->_data->reg_obj->attendee_ID() != $att_id)
-                && $this->_single_message
-            ) {
-                continue;
-            }
-            // is $this->_regs_for_sending present?
-            // If so, let's make sure we ONLY generate addressee for registrations in that array.
-            if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
-                $regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
-                if (empty($regs_allowed)) {
-                    continue;
-                }
-            }
-            if (
-                in_array($details['attendee_email'], $already_processed)
-                && apply_filters(
-                    'FHEE__EE_message_type___attendee_addressees__prevent_duplicate_email_sends',
-                    true,
-                    $this->_data,
-                    $this
-                )
-            ) {
-                continue;
-            }
-            $already_processed[] = $details['attendee_email'];
-            foreach ($details as $item => $value) {
-                $aee[$item] = $value;
-                if ($item == 'line_ref') {
-                    foreach ($value as $event_id) {
-                        $aee['events'][$event_id] = $this->_data->events[$event_id];
-                    }
-                }
-                if ($item == 'attendee_email') {
-                    $aee['attendee_email'] = $value;
-                }
-                /*if ( $item == 'registration_id' ) {
+	/**
+	 * see abstract declaration in parent class for details, children message types can
+	 * override these valid shortcodes if desired (we include all for all contexts by default).
+	 */
+	protected function _set_valid_shortcodes()
+	{
+		$all_shortcodes = array(
+			'attendee_list',
+			'attendee',
+			'datetime_list',
+			'datetime',
+			'event_list',
+			'event_meta',
+			'event',
+			'organization',
+			'recipient_details',
+			'recipient_list',
+			'ticket_list',
+			'ticket',
+			'transaction',
+			'venue',
+			'primary_registration_details',
+			'primary_registration_list',
+			'event_author',
+			'email',
+			'messenger',
+		);
+		$contexts       = $this->get_contexts();
+		foreach ($contexts as $context => $details) {
+			$this->_valid_shortcodes[$context] = $all_shortcodes;
+			//make sure non admin context does not include the event_author shortcodes
+			if ($context != 'admin') {
+				if (($key = array_search('event_author', $this->_valid_shortcodes[$context])) !== false) {
+					unset($this->_valid_shortcodes[$context][$key]);
+				}
+			}
+		}
+		// make sure admin context does not include the recipient_details shortcodes
+		// IF we have admin context hooked in message types might not have that context.
+		if (! empty($this->_valid_shortcodes['admin'])) {
+			if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
+				unset($this->_valid_shortcodes['admin'][$key]);
+			}
+			//make sure admin context does not include the recipient_details shortcodes
+			if (($key = array_search('recipient_list', $this->_valid_shortcodes['admin'])) !== false) {
+				unset($this->_valid_shortcodes['admin'][$key]);
+			}
+		}
+	}
+
+
+	/**
+	 * Used by Validators to modify the valid shortcodes.
+	 *
+	 * @param  array $new_config array of valid shortcodes (by context)
+	 * @return void               sets valid_shortcodes property
+	 */
+	public function reset_valid_shortcodes_config($new_config)
+	{
+		foreach ($new_config as $context => $shortcodes) {
+			$this->_valid_shortcodes[$context] = $shortcodes;
+		}
+	}
+
+
+	/**
+	 * returns an array of addressee objects for event_admins
+	 *
+	 * @access protected
+	 * @return array array of EE_Messages_Addressee objects
+	 */
+	protected function _admin_addressees()
+	{
+		$admin_events = array();
+		$addressees   = array();
+		// first we need to get the event admin user id for all the events
+		// and setup an addressee object for each unique admin user.
+		foreach ($this->_data->events as $line_ref => $event) {
+			$admin_id = $this->_get_event_admin_id($event['ID']);
+			//make sure we are just including the events that belong to this admin!
+			$admin_events[$admin_id][$line_ref] = $event;
+		}
+		//k now we can loop through the event_admins and setup the addressee data.
+		foreach ($admin_events as $admin_id => $event_details) {
+			$aee          = array(
+				'user_id'        => $admin_id,
+				'events'         => $event_details,
+				'attendees'      => $this->_data->attendees,
+				'recipient_id'   => $admin_id,
+				'recipient_type' => 'WP_User',
+			);
+			$aee          = array_merge($this->_default_addressee_data, $aee);
+			$addressees[] = new EE_Messages_Addressee($aee);
+		}
+		return $addressees;
+	}
+
+
+	/**
+	 * Takes care of setting up the addressee object(s) for the primary attendee.
+	 *
+	 * @access protected
+	 * @return array of EE_Addressee objects
+	 */
+	protected function _primary_attendee_addressees()
+	{
+		$aee                   = $this->_default_addressee_data;
+		$aee['events']         = $this->_data->events;
+		$aee['attendees']      = $this->_data->attendees;
+		$aee['recipient_id']   = $aee['primary_att_obj'] instanceof EE_Attendee ? $aee['primary_att_obj']->ID() : 0;
+		$aee['recipient_type'] = 'Attendee';
+		//great now we can instantiate the $addressee object and return (as an array);
+		$add[] = new EE_Messages_Addressee($aee);
+		return $add;
+	}
+
+
+	/**
+	 * Takes care of setting up the addressee object(s) for the registered attendees
+	 *
+	 * @access protected
+	 * @return array of EE_Addressee objects
+	 */
+	protected function _attendee_addressees()
+	{
+		$add = array();
+		//we just have to loop through the attendees.  We'll also set the attached events for each attendee.
+		//use to verify unique attendee emails... we don't want to sent multiple copies to the same attendee do we?
+		$already_processed = array();
+		foreach ($this->_data->attendees as $att_id => $details) {
+			//set the attendee array to blank on each loop;
+			$aee = array();
+			if (isset($this->_data->reg_obj)
+				&& ($this->_data->reg_obj->attendee_ID() != $att_id)
+				&& $this->_single_message
+			) {
+				continue;
+			}
+			// is $this->_regs_for_sending present?
+			// If so, let's make sure we ONLY generate addressee for registrations in that array.
+			if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
+				$regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
+				if (empty($regs_allowed)) {
+					continue;
+				}
+			}
+			if (
+				in_array($details['attendee_email'], $already_processed)
+				&& apply_filters(
+					'FHEE__EE_message_type___attendee_addressees__prevent_duplicate_email_sends',
+					true,
+					$this->_data,
+					$this
+				)
+			) {
+				continue;
+			}
+			$already_processed[] = $details['attendee_email'];
+			foreach ($details as $item => $value) {
+				$aee[$item] = $value;
+				if ($item == 'line_ref') {
+					foreach ($value as $event_id) {
+						$aee['events'][$event_id] = $this->_data->events[$event_id];
+					}
+				}
+				if ($item == 'attendee_email') {
+					$aee['attendee_email'] = $value;
+				}
+				/*if ( $item == 'registration_id' ) {
                     $aee['attendee_registration_id'] = $value;
                 }/**/
-            }
-            // note the FIRST reg object in this array is the one
-            // we'll use for this attendee as the primary registration for this attendee.
-            $aee['reg_obj']        = reset($this->_data->attendees[$att_id]['reg_objs']);
-            $aee['attendees']      = $this->_data->attendees;
-            $aee['recipient_id']   = $att_id;
-            $aee['recipient_type'] = 'Attendee';
-            //merge in the primary attendee data
-            $aee   = array_merge($this->_default_addressee_data, $aee);
-            $add[] = new EE_Messages_Addressee($aee);
-        }
-        return $add;
-    }
-
-
-    /**
-     * @param $event_id
-     * @return int
-     */
-    protected function _get_event_admin_id($event_id)
-    {
-        $event = EEM_Event::instance()->get_one_by_ID($event_id);
-        return $event instanceof EE_Event ? $event->wp_user() : 0;
-    }
+			}
+			// note the FIRST reg object in this array is the one
+			// we'll use for this attendee as the primary registration for this attendee.
+			$aee['reg_obj']        = reset($this->_data->attendees[$att_id]['reg_objs']);
+			$aee['attendees']      = $this->_data->attendees;
+			$aee['recipient_id']   = $att_id;
+			$aee['recipient_type'] = 'Attendee';
+			//merge in the primary attendee data
+			$aee   = array_merge($this->_default_addressee_data, $aee);
+			$add[] = new EE_Messages_Addressee($aee);
+		}
+		return $add;
+	}
+
+
+	/**
+	 * @param $event_id
+	 * @return int
+	 */
+	protected function _get_event_admin_id($event_id)
+	{
+		$event = EEM_Event::instance()->get_one_by_ID($event_id);
+		return $event instanceof EE_Event ? $event->wp_user() : 0;
+	}
 
 
 }

Spacing +16 added lines, -16 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('NO direct script access allowed');
 }
 
@@ -409,7 +409,7 @@ 
     {
         //validate context
         //valid context?
-        if (! isset($this->_contexts[$context])) {
+        if ( ! isset($this->_contexts[$context])) {
             throw new EE_Error(
                 sprintf(
                     __('The context %s is not a valid context for %s.', 'event_espresso'),
@@ -465,7 +465,7 @@ 
     public function get_data_for_context($context, EE_Registration $registration, $id = 0)
     {
         //valid context?
-        if (! isset($this->_contexts[$context])) {
+        if ( ! isset($this->_contexts[$context])) {
             throw new EE_Error(
                 sprintf(
                     __('The context %s is not a valid context for %s.', 'event_espresso'),
@@ -480,7 +480,7 @@ 
             $this->_get_data_for_context($context, $registration, $id),
             $this
         );
-        $data = apply_filters('FHEE__' . get_class($this) . '__get_data_for_context__data', $data, $this);
+        $data = apply_filters('FHEE__'.get_class($this).'__get_data_for_context__data', $data, $this);
         //if empty then something went wrong!
         if (empty($data)) {
             throw new EE_Error(
@@ -540,7 +540,7 @@ 
     public function with_messengers()
     {
         return apply_filters(
-            'FHEE__EE_message_type__get_with_messengers__with_messengers__' . get_class($this),
+            'FHEE__EE_message_type__get_with_messengers__with_messengers__'.get_class($this),
             $this->_with_messengers
         );
     }
@@ -601,7 +601,7 @@ 
     {
         //first class specific filter then filter that by the global filter.
         $master_templates = apply_filters(
-            'FHEE__' . get_class($this) . '__get_master_templates',
+            'FHEE__'.get_class($this).'__get_master_templates',
             $this->_master_templates
         );
         return apply_filters('FHEE__EE_message_type__get_master_templates', $master_templates, $this);
@@ -624,9 +624,9 @@ 
         $addressees        = array();
         $original_contexts = $this->_contexts;
         //if incoming context then limit to that context
-        if (! empty($context)) {
+        if ( ! empty($context)) {
             $cntxt = ! empty($this->_contexts[$context]) ? $this->_contexts[$context] : '';
-            if (! empty($cntxt)) {
+            if ( ! empty($cntxt)) {
                 $this->_contexts           = array();
                 $this->_contexts[$context] = $cntxt;
             }
@@ -653,13 +653,13 @@ 
     {
         //at a minimum, we NEED EE_Attendee objects.
         if (empty($this->_data->attendees)) {
-            return false;  //there's no data to process!
+            return false; //there's no data to process!
         }
         // process addressees for each context.  Child classes will have to have methods for
         // each context defined to handle the processing of the data object within them
         foreach ($this->_contexts as $context => $details) {
-            $xpctd_method = '_' . $context . '_addressees';
-            if (! method_exists($this, $xpctd_method)) {
+            $xpctd_method = '_'.$context.'_addressees';
+            if ( ! method_exists($this, $xpctd_method)) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -707,7 +707,7 @@ 
             'total_ticket_count'       => $this->_data->total_ticket_count,
         );
         if (is_array($this->_data->primary_attendee_data)) {
-            $this->_default_addressee_data                    = array_merge(
+            $this->_default_addressee_data = array_merge(
                 $this->_default_addressee_data,
                 $this->_data->primary_attendee_data
             );
@@ -750,7 +750,7 @@ 
             'email',
             'messenger',
         );
-        $contexts       = $this->get_contexts();
+        $contexts = $this->get_contexts();
         foreach ($contexts as $context => $details) {
             $this->_valid_shortcodes[$context] = $all_shortcodes;
             //make sure non admin context does not include the event_author shortcodes
@@ -762,7 +762,7 @@ 
         }
         // make sure admin context does not include the recipient_details shortcodes
         // IF we have admin context hooked in message types might not have that context.
-        if (! empty($this->_valid_shortcodes['admin'])) {
+        if ( ! empty($this->_valid_shortcodes['admin'])) {
             if (($key = array_search('recipient_details', $this->_valid_shortcodes['admin'])) !== false) {
                 unset($this->_valid_shortcodes['admin'][$key]);
             }
@@ -807,7 +807,7 @@ 
         }
         //k now we can loop through the event_admins and setup the addressee data.
         foreach ($admin_events as $admin_id => $event_details) {
-            $aee          = array(
+            $aee = array(
                 'user_id'        => $admin_id,
                 'events'         => $event_details,
                 'attendees'      => $this->_data->attendees,
@@ -863,7 +863,7 @@ 
             }
             // is $this->_regs_for_sending present?
             // If so, let's make sure we ONLY generate addressee for registrations in that array.
-            if (! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
+            if ( ! empty($this->_regs_for_sending) && is_array($this->_regs_for_sending)) {
                 $regs_allowed = array_intersect_key(array_flip($this->_regs_for_sending), $details['reg_objs']);
                 if (empty($regs_allowed)) {
                     continue;

espresso.php

Indentation +219 added lines, -219 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('ABSPATH')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 /*
   Plugin Name:		Event Espresso
@@ -40,243 +40,243 @@ 
  * @since            4.0
  */
 if (function_exists('espresso_version')) {
-    /**
-     *    espresso_duplicate_plugin_error
-     *    displays if more than one version of EE is activated at the same time
-     */
-    function espresso_duplicate_plugin_error()
-    {
-        ?>
+	/**
+	 *    espresso_duplicate_plugin_error
+	 *    displays if more than one version of EE is activated at the same time
+	 */
+	function espresso_duplicate_plugin_error()
+	{
+		?>
         <div class="error">
             <p>
                 <?php echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                ); ?>
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+				); ?>
             </p>
         </div>
         <?php
-        espresso_deactivate_plugin(plugin_basename(__FILE__));
-    }
+		espresso_deactivate_plugin(plugin_basename(__FILE__));
+	}
 
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
-    if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.3.9');
+	if ( ! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                            esc_html__(
-                                    'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                                    'event_espresso'
-                            ),
-                            EE_MIN_PHP_VER_REQUIRED,
-                            PHP_VERSION,
-                            '<br/>',
-                            '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+							esc_html__(
+									'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+									'event_espresso'
+							),
+							EE_MIN_PHP_VER_REQUIRED,
+							PHP_VERSION,
+							'<br/>',
+							'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.47.rc.027');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.47.rc.027');
+		}
 
-        // define versions
-        define('EVENT_ESPRESSO_VERSION', espresso_version());
-        define('EE_MIN_WP_VER_REQUIRED', '4.1');
-        define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
-        define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        //used to be DIRECTORY_SEPARATOR, but that caused issues on windows
-        if ( ! defined('DS')) {
-            define('DS', '/');
-        }
-        if ( ! defined('PS')) {
-            define('PS', PATH_SEPARATOR);
-        }
-        if ( ! defined('SP')) {
-            define('SP', ' ');
-        }
-        if ( ! defined('EENL')) {
-            define('EENL', "\n");
-        }
-        define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
-        // define the plugin directory and URL
-        define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
-        define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
-        // main root folder paths
-        define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
-        define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
-        define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
-        define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
-        define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
-        define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
-        define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
-        define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
-        // core system paths
-        define('EE_ADMIN', EE_CORE . 'admin' . DS);
-        define('EE_CPTS', EE_CORE . 'CPTs' . DS);
-        define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
-        define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
-        define('EE_BUSINESS', EE_CORE . 'business' . DS);
-        define('EE_MODELS', EE_CORE . 'db_models' . DS);
-        define('EE_HELPERS', EE_CORE . 'helpers' . DS);
-        define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
-        define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
-        define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
-        define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
-        define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
-        // gateways
-        define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
-        define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
-        // asset URL paths
-        define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
-        define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
-        define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
-        define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
-        define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
-        define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
-        // define upload paths
-        $uploads = wp_upload_dir();
-        // define the uploads directory and URL
-        define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
-        define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
-        // define the templates directory and URL
-        define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
-        define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
-        // define the gateway directory and URL
-        define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
-        define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
-        // languages folder/path
-        define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
-        define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
-        //check for dompdf fonts in uploads
-        if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
-            define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
-        }
-        //ajax constants
-        define(
-                'EE_FRONT_AJAX',
-                isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
-        );
-        define(
-                'EE_ADMIN_AJAX',
-                isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
-        );
-        //just a handy constant occasionally needed for finding values representing infinity in the DB
-        //you're better to use this than its straight value (currently -1) in case you ever
-        //want to change its default value! or find when -1 means infinity
-        define('EE_INF_IN_DB', -1);
-        define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
-        define('EE_DEBUG', false);
-        // for older WP versions
-        if ( ! defined('MONTH_IN_SECONDS')) {
-            define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
-        }
-        /**
-         *    espresso_plugin_activation
-         *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		// define versions
+		define('EVENT_ESPRESSO_VERSION', espresso_version());
+		define('EE_MIN_WP_VER_REQUIRED', '4.1');
+		define('EE_MIN_WP_VER_RECOMMENDED', '4.4.2');
+		define('EE_MIN_PHP_VER_RECOMMENDED', '5.4.44');
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		//used to be DIRECTORY_SEPARATOR, but that caused issues on windows
+		if ( ! defined('DS')) {
+			define('DS', '/');
+		}
+		if ( ! defined('PS')) {
+			define('PS', PATH_SEPARATOR);
+		}
+		if ( ! defined('SP')) {
+			define('SP', ' ');
+		}
+		if ( ! defined('EENL')) {
+			define('EENL', "\n");
+		}
+		define('EE_SUPPORT_EMAIL', 'support@eventespresso.com');
+		// define the plugin directory and URL
+		define('EE_PLUGIN_BASENAME', plugin_basename(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_PATH', plugin_dir_path(EVENT_ESPRESSO_MAIN_FILE));
+		define('EE_PLUGIN_DIR_URL', plugin_dir_url(EVENT_ESPRESSO_MAIN_FILE));
+		// main root folder paths
+		define('EE_ADMIN_PAGES', EE_PLUGIN_DIR_PATH . 'admin_pages' . DS);
+		define('EE_CORE', EE_PLUGIN_DIR_PATH . 'core' . DS);
+		define('EE_MODULES', EE_PLUGIN_DIR_PATH . 'modules' . DS);
+		define('EE_PUBLIC', EE_PLUGIN_DIR_PATH . 'public' . DS);
+		define('EE_SHORTCODES', EE_PLUGIN_DIR_PATH . 'shortcodes' . DS);
+		define('EE_WIDGETS', EE_PLUGIN_DIR_PATH . 'widgets' . DS);
+		define('EE_PAYMENT_METHODS', EE_PLUGIN_DIR_PATH . 'payment_methods' . DS);
+		define('EE_CAFF_PATH', EE_PLUGIN_DIR_PATH . 'caffeinated' . DS);
+		// core system paths
+		define('EE_ADMIN', EE_CORE . 'admin' . DS);
+		define('EE_CPTS', EE_CORE . 'CPTs' . DS);
+		define('EE_CLASSES', EE_CORE . 'db_classes' . DS);
+		define('EE_INTERFACES', EE_CORE . 'interfaces' . DS);
+		define('EE_BUSINESS', EE_CORE . 'business' . DS);
+		define('EE_MODELS', EE_CORE . 'db_models' . DS);
+		define('EE_HELPERS', EE_CORE . 'helpers' . DS);
+		define('EE_LIBRARIES', EE_CORE . 'libraries' . DS);
+		define('EE_TEMPLATES', EE_CORE . 'templates' . DS);
+		define('EE_THIRD_PARTY', EE_CORE . 'third_party_libs' . DS);
+		define('EE_GLOBAL_ASSETS', EE_TEMPLATES . 'global_assets' . DS);
+		define('EE_FORM_SECTIONS', EE_LIBRARIES . 'form_sections' . DS);
+		// gateways
+		define('EE_GATEWAYS', EE_MODULES . 'gateways' . DS);
+		define('EE_GATEWAYS_URL', EE_PLUGIN_DIR_URL . 'modules' . DS . 'gateways' . DS);
+		// asset URL paths
+		define('EE_TEMPLATES_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'templates' . DS);
+		define('EE_GLOBAL_ASSETS_URL', EE_TEMPLATES_URL . 'global_assets' . DS);
+		define('EE_IMAGES_URL', EE_GLOBAL_ASSETS_URL . 'images' . DS);
+		define('EE_THIRD_PARTY_URL', EE_PLUGIN_DIR_URL . 'core' . DS . 'third_party_libs' . DS);
+		define('EE_HELPERS_ASSETS', EE_PLUGIN_DIR_URL . 'core/helpers/assets/');
+		define('EE_LIBRARIES_URL', EE_PLUGIN_DIR_URL . 'core/libraries/');
+		// define upload paths
+		$uploads = wp_upload_dir();
+		// define the uploads directory and URL
+		define('EVENT_ESPRESSO_UPLOAD_DIR', $uploads['basedir'] . DS . 'espresso' . DS);
+		define('EVENT_ESPRESSO_UPLOAD_URL', $uploads['baseurl'] . DS . 'espresso' . DS);
+		// define the templates directory and URL
+		define('EVENT_ESPRESSO_TEMPLATE_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'templates' . DS);
+		define('EVENT_ESPRESSO_TEMPLATE_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'templates' . DS);
+		// define the gateway directory and URL
+		define('EVENT_ESPRESSO_GATEWAY_DIR', $uploads['basedir'] . DS . 'espresso' . DS . 'gateways' . DS);
+		define('EVENT_ESPRESSO_GATEWAY_URL', $uploads['baseurl'] . DS . 'espresso' . DS . 'gateways' . DS);
+		// languages folder/path
+		define('EE_LANGUAGES_SAFE_LOC', '..' . DS . 'uploads' . DS . 'espresso' . DS . 'languages' . DS);
+		define('EE_LANGUAGES_SAFE_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'languages' . DS);
+		//check for dompdf fonts in uploads
+		if (file_exists(EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS)) {
+			define('DOMPDF_FONT_DIR', EVENT_ESPRESSO_UPLOAD_DIR . 'fonts' . DS);
+		}
+		//ajax constants
+		define(
+				'EE_FRONT_AJAX',
+				isset($_REQUEST['ee_front_ajax']) || isset($_REQUEST['data']['ee_front_ajax']) ? true : false
+		);
+		define(
+				'EE_ADMIN_AJAX',
+				isset($_REQUEST['ee_admin_ajax']) || isset($_REQUEST['data']['ee_admin_ajax']) ? true : false
+		);
+		//just a handy constant occasionally needed for finding values representing infinity in the DB
+		//you're better to use this than its straight value (currently -1) in case you ever
+		//want to change its default value! or find when -1 means infinity
+		define('EE_INF_IN_DB', -1);
+		define('EE_INF', INF > (float)PHP_INT_MAX ? INF : PHP_INT_MAX);
+		define('EE_DEBUG', false);
+		// for older WP versions
+		if ( ! defined('MONTH_IN_SECONDS')) {
+			define('MONTH_IN_SECONDS', DAY_IN_SECONDS * 30);
+		}
+		/**
+		 *    espresso_plugin_activation
+		 *    adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
-        /**
-         *    espresso_load_error_handling
-         *    this function loads EE's class for handling exceptions and errors
-         */
-        function espresso_load_error_handling()
-        {
-            // load debugging tools
-            if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
-                require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
-                EEH_Debug_Tools::instance();
-            }
-            // load error handling
-            if (is_readable(EE_CORE . 'EE_Error.core.php')) {
-                require_once(EE_CORE . 'EE_Error.core.php');
-            } else {
-                wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
-            }
-        }
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		/**
+		 *    espresso_load_error_handling
+		 *    this function loads EE's class for handling exceptions and errors
+		 */
+		function espresso_load_error_handling()
+		{
+			// load debugging tools
+			if (WP_DEBUG === true && is_readable(EE_HELPERS . 'EEH_Debug_Tools.helper.php')) {
+				require_once(EE_HELPERS . 'EEH_Debug_Tools.helper.php');
+				EEH_Debug_Tools::instance();
+			}
+			// load error handling
+			if (is_readable(EE_CORE . 'EE_Error.core.php')) {
+				require_once(EE_CORE . 'EE_Error.core.php');
+			} else {
+				wp_die(esc_html__('The EE_Error core class could not be loaded.', 'event_espresso'));
+			}
+		}
 
-        /**
-         *    espresso_load_required
-         *    given a class name and path, this function will load that file or throw an exception
-         *
-         * @param    string $classname
-         * @param    string $full_path_to_file
-         * @throws    EE_Error
-         */
-        function espresso_load_required($classname, $full_path_to_file)
-        {
-            static $error_handling_loaded = false;
-            if ( ! $error_handling_loaded) {
-                espresso_load_error_handling();
-                $error_handling_loaded = true;
-            }
-            if (is_readable($full_path_to_file)) {
-                require_once($full_path_to_file);
-            } else {
-                throw new EE_Error (
-                        sprintf(
-                                esc_html__(
-                                        'The %s class file could not be located or is not readable due to file permissions.',
-                                        'event_espresso'
-                                ),
-                                $classname
-                        )
-                );
-            }
-        }
+		/**
+		 *    espresso_load_required
+		 *    given a class name and path, this function will load that file or throw an exception
+		 *
+		 * @param    string $classname
+		 * @param    string $full_path_to_file
+		 * @throws    EE_Error
+		 */
+		function espresso_load_required($classname, $full_path_to_file)
+		{
+			static $error_handling_loaded = false;
+			if ( ! $error_handling_loaded) {
+				espresso_load_error_handling();
+				$error_handling_loaded = true;
+			}
+			if (is_readable($full_path_to_file)) {
+				require_once($full_path_to_file);
+			} else {
+				throw new EE_Error (
+						sprintf(
+								esc_html__(
+										'The %s class file could not be located or is not readable due to file permissions.',
+										'event_espresso'
+								),
+								$classname
+						)
+				);
+			}
+		}
 
-        espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
-        espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
-        espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
-        new EE_Bootstrap();
-    }
+		espresso_load_required('EEH_Base', EE_CORE . 'helpers' . DS . 'EEH_Base.helper.php');
+		espresso_load_required('EEH_File', EE_CORE . 'helpers' . DS . 'EEH_File.helper.php');
+		espresso_load_required('EE_Bootstrap', EE_CORE . 'EE_Bootstrap.core.php');
+		new EE_Bootstrap();
+	}
 }
 if ( ! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if ( ! function_exists('deactivate_plugins')) {
-            require_once(ABSPATH . 'wp-admin/includes/plugin.php');
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if ( ! function_exists('deactivate_plugins')) {
+			require_once(ABSPATH . 'wp-admin/includes/plugin.php');
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }
\ No newline at end of file

modules/single_page_checkout/reg_steps/attendee_information/EE_SPCO_Reg_Step_Attendee_Information.class.php

Indentation +1343 added lines, -1343 removed lines

@@ -17,1351 +17,1351 @@
 class EE_SPCO_Reg_Step_Attendee_Information extends EE_SPCO_Reg_Step
 {
 
-    /**
-     * @type bool $_print_copy_info
-     */
-    private $_print_copy_info = false;
-
-    /**
-     * @type array $_attendee_data
-     */
-    private $_attendee_data = array();
-
-    /**
-     * @type array $_required_questions
-     */
-    private $_required_questions = array();
-
-    /**
-     * @type array $_registration_answers
-     */
-    private $_registration_answers = array();
-
-
-    /**
-     *    class constructor
-     *
-     * @access    public
-     * @param    EE_Checkout $checkout
-     */
-    public function __construct(EE_Checkout $checkout)
-    {
-        $this->_slug     = 'attendee_information';
-        $this->_name     = esc_html__('Attendee Information', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
-        $this->checkout  = $checkout;
-        $this->_reset_success_message();
-        $this->set_instructions(
-            esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
-        );
-    }
-
-
-    public function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
-            ' is a required question.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
-            ' is a required question. Please enter a value for at least one of the options.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
-            'Please answer all required questions correctly before proceeding.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
-            esc_html__(
-                'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
-                'event_espresso'
-            ),
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
-            'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
-            'You must enter a valid email address.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
-            'You must enter a valid email address and answer all other required questions before you can proceed.',
-            'event_espresso'
-        );
-    }
-
-
-    public function enqueue_styles_and_scripts()
-    {
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function initialize_reg_step()
-    {
-        return true;
-    }
-
-
-    /**
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function generate_reg_form()
-    {
-        $this->_print_copy_info = false;
-        $primary_registrant     = null;
-        // autoload Line_Item_Display classes
-        EEH_Autoloader::register_line_item_display_autoloaders();
-        $Line_Item_Display = new EE_Line_Item_Display();
-        // calculate taxes
-        $Line_Item_Display->display_line_item(
-            $this->checkout->cart->get_grand_total(),
-            array('set_tax_rate' => true)
-        );
-        /** @var $subsections EE_Form_Section_Proper[] */
-        $subsections   = array(
-            'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
-        );
-        $template_args = array(
-            'revisit'       => $this->checkout->revisit,
-            'registrations' => array(),
-            'ticket_count'  => array(),
-        );
-        // grab the saved registrations from the transaction
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        if ($registrations) {
-            foreach ($registrations as $registration) {
-                // can this registration be processed during this visit ?
-                if ($registration instanceof EE_Registration
-                    && $this->checkout->visit_allows_processing_of_this_registration($registration)
-                ) {
-                    $subsections[$registration->reg_url_link()] = $this->_registrations_reg_form($registration);
-                    if (! $this->checkout->admin_request) {
-                        $template_args['registrations'][$registration->reg_url_link()]    = $registration;
-                        $template_args['ticket_count'][$registration->ticket()->ID()]     = isset(
-                            $template_args['ticket_count'][$registration->ticket()->ID()]
-                        )
-                            ? $template_args['ticket_count'][$registration->ticket()->ID()] + 1
-                            : 1;
-                        $ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-                            $this->checkout->cart->get_grand_total(),
-                            'Ticket',
-                            array($registration->ticket()->ID())
-                        );
-                        $ticket_line_item = is_array($ticket_line_item)
-                            ? reset($ticket_line_item)
-                            : $ticket_line_item;
-                        $template_args['ticket_line_item'][$registration->ticket()->ID()] =
-                            $Line_Item_Display->display_line_item($ticket_line_item);
-                    }
-                    if ($registration->is_primary_registrant()) {
-                        $primary_registrant = $registration->reg_url_link();
-                    }
-                }
-            }
-            // print_copy_info ?
-            if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
-                // TODO: add admin option for toggling copy attendee info,
-                // then use that value to change $this->_print_copy_info
-                $copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
-                    ? $this->_copy_attendee_info_form()
-                    : $this->_auto_copy_attendee_info();
-                // generate hidden input
-                if (isset($subsections[$primary_registrant])
-                    && $subsections[$primary_registrant] instanceof EE_Form_Section_Proper
-                ) {
-                    $subsections[$primary_registrant]->add_subsections(
-                        $copy_options,
-                        'primary_registrant',
-                        false
-                    );
-                }
-            }
-        }
-
-        return new EE_Form_Section_Proper(
-            array(
-                'name'            => $this->reg_form_name(),
-                'html_id'         => $this->reg_form_name(),
-                'subsections'     => $subsections,
-                'layout_strategy' => $this->checkout->admin_request ?
-                    new EE_Div_Per_Section_Layout() :
-                    new EE_Template_Layout(
-                        array(
-                            'layout_template_file' => $this->_template, // layout_template
-                            'template_args'        => $template_args,
-                        )
-                    ),
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Form_Section_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _registrations_reg_form(EE_Registration $registration)
-    {
-        static $attendee_nmbr = 1;
-        $form_args = array();
-        // verify that registration has valid event
-        if ($registration->event() instanceof EE_Event) {
-            $question_groups = $registration->event()->question_groups(
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
-                    array(
-                        array(
-                            'Event.EVT_ID'                     => $registration->event()->ID(),
-                            'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
-                        ),
-                        'order_by' => array('QSG_order' => 'ASC'),
-                    ),
-                    $registration,
-                    $this
-                )
-            );
-            if ($question_groups) {
-                // array of params to pass to parent constructor
-                $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
-                    'html_class'      => 'ee-reg-form-attendee-dv',
-                    'html_style'      => $this->checkout->admin_request
-                        ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
-                        : '',
-                    'subsections'     => array(),
-                    'layout_strategy' => new EE_Fieldset_Section_Layout(
-                        array(
-                            'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
-                            'legend_text'  => sprintf(__('Attendee %d', 'event_espresso'), $attendee_nmbr),
-                        )
-                    ),
-                );
-                foreach ($question_groups as $question_group) {
-                    if ($question_group instanceof EE_Question_Group) {
-                        $form_args['subsections'][$question_group->identifier()] = $this->_question_group_reg_form(
-                            $registration,
-                            $question_group
-                        );
-                    }
-                }
-                // add hidden input
-                $form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
-                    $registration
-                );
-                // if we have question groups for additional attendees, then display the copy options
-                $this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
-                if ($registration->is_primary_registrant()) {
-                    // generate hidden input
-                    $form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
-                        $registration
-                    );
-                }
-            }
-        }
-        $attendee_nmbr++;
-        return ! empty($form_args) ? new EE_Form_Section_Proper($form_args) : new EE_Form_Section_HTML();
-    }
-
-
-    /**
-     * _additional_attendee_reg_info_input
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @param bool            $additional_attendee_reg_info
-     * @return    EE_Form_Input_Base
-     * @throws \EE_Error
-     */
-    private function _additional_attendee_reg_info_input(
-        EE_Registration $registration,
-        $additional_attendee_reg_info = true
-    ) {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            array(
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
-                'default' => $additional_attendee_reg_info,
-            )
-        );
-    }
-
-
-    /**
-     * @param EE_Registration   $registration
-     * @param EE_Question_Group $question_group
-     * @return EE_Form_Section_Proper
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
-    {
-        // array of params to pass to parent constructor
-        $form_args = array(
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
-            'html_class'      => $this->checkout->admin_request
-                ? 'form-table ee-reg-form-qstn-grp-dv'
-                : 'ee-reg-form-qstn-grp-dv',
-            'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-lbl',
-            'subsections'     => array(
-                'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
-            ),
-            'layout_strategy' => $this->checkout->admin_request
-                ? new EE_Admin_Two_Column_Layout()
-                : new EE_Div_Per_Section_Layout(),
-        );
-        // where params
-        $query_params = array('QST_deleted' => 0);
-        // don't load admin only questions on the frontend
-        if (! $this->checkout->admin_request) {
-            $query_params['QST_admin_only'] = array('!=', true);
-        }
-        $questions = $question_group->get_many_related(
-            'Question',
-            apply_filters(
-                'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
-                array(
-                    $query_params,
-                    'order_by' => array(
-                        'Question_Group_Question.QGQ_order' => 'ASC',
-                    ),
-                ),
-                $question_group,
-                $registration,
-                $this
-            )
-        );
-        // filter for additional content before questions
-        $form_args['subsections']['reg_form_questions_before'] = new EE_Form_Section_HTML(
-            apply_filters(
-                'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-                '',
-                $registration,
-                $question_group,
-                $this
-            )
-        );
-        // loop thru questions
-        foreach ($questions as $question) {
-            if ($question instanceof EE_Question) {
-                $identifier                            = $question->is_system_question()
-                    ? $question->system_ID()
-                    : $question->ID();
-                $form_args['subsections'][$identifier] = $this->reg_form_question($registration, $question);
-            }
-        }
-        $form_args['subsections'] = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
-            $form_args['subsections'],
-            $registration,
-            $question_group,
-            $this
-        );
-        // filter for additional content after questions
-        $form_args['subsections']['reg_form_questions_after'] = new EE_Form_Section_HTML(
-            apply_filters(
-                'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-                '',
-                $registration,
-                $question_group,
-                $this
-            )
-        );
+	/**
+	 * @type bool $_print_copy_info
+	 */
+	private $_print_copy_info = false;
+
+	/**
+	 * @type array $_attendee_data
+	 */
+	private $_attendee_data = array();
+
+	/**
+	 * @type array $_required_questions
+	 */
+	private $_required_questions = array();
+
+	/**
+	 * @type array $_registration_answers
+	 */
+	private $_registration_answers = array();
+
+
+	/**
+	 *    class constructor
+	 *
+	 * @access    public
+	 * @param    EE_Checkout $checkout
+	 */
+	public function __construct(EE_Checkout $checkout)
+	{
+		$this->_slug     = 'attendee_information';
+		$this->_name     = esc_html__('Attendee Information', 'event_espresso');
+		$this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+		$this->checkout  = $checkout;
+		$this->_reset_success_message();
+		$this->set_instructions(
+			esc_html__('Please answer the following registration questions before proceeding.', 'event_espresso')
+		);
+	}
+
+
+	public function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+			' is a required question.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
+			' is a required question. Please enter a value for at least one of the options.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['answer_required_questions'] = esc_html__(
+			'Please answer all required questions correctly before proceeding.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+			esc_html__(
+				'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
+				'event_espresso'
+			),
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+			'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
+			'You must enter a valid email address.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['valid_email_and_questions'] = esc_html__(
+			'You must enter a valid email address and answer all other required questions before you can proceed.',
+			'event_espresso'
+		);
+	}
+
+
+	public function enqueue_styles_and_scripts()
+	{
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function initialize_reg_step()
+	{
+		return true;
+	}
+
+
+	/**
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function generate_reg_form()
+	{
+		$this->_print_copy_info = false;
+		$primary_registrant     = null;
+		// autoload Line_Item_Display classes
+		EEH_Autoloader::register_line_item_display_autoloaders();
+		$Line_Item_Display = new EE_Line_Item_Display();
+		// calculate taxes
+		$Line_Item_Display->display_line_item(
+			$this->checkout->cart->get_grand_total(),
+			array('set_tax_rate' => true)
+		);
+		/** @var $subsections EE_Form_Section_Proper[] */
+		$subsections   = array(
+			'default_hidden_inputs' => $this->reg_step_hidden_inputs(),
+		);
+		$template_args = array(
+			'revisit'       => $this->checkout->revisit,
+			'registrations' => array(),
+			'ticket_count'  => array(),
+		);
+		// grab the saved registrations from the transaction
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		if ($registrations) {
+			foreach ($registrations as $registration) {
+				// can this registration be processed during this visit ?
+				if ($registration instanceof EE_Registration
+					&& $this->checkout->visit_allows_processing_of_this_registration($registration)
+				) {
+					$subsections[$registration->reg_url_link()] = $this->_registrations_reg_form($registration);
+					if (! $this->checkout->admin_request) {
+						$template_args['registrations'][$registration->reg_url_link()]    = $registration;
+						$template_args['ticket_count'][$registration->ticket()->ID()]     = isset(
+							$template_args['ticket_count'][$registration->ticket()->ID()]
+						)
+							? $template_args['ticket_count'][$registration->ticket()->ID()] + 1
+							: 1;
+						$ticket_line_item = EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+							$this->checkout->cart->get_grand_total(),
+							'Ticket',
+							array($registration->ticket()->ID())
+						);
+						$ticket_line_item = is_array($ticket_line_item)
+							? reset($ticket_line_item)
+							: $ticket_line_item;
+						$template_args['ticket_line_item'][$registration->ticket()->ID()] =
+							$Line_Item_Display->display_line_item($ticket_line_item);
+					}
+					if ($registration->is_primary_registrant()) {
+						$primary_registrant = $registration->reg_url_link();
+					}
+				}
+			}
+			// print_copy_info ?
+			if ($primary_registrant && ! $this->checkout->admin_request && count($registrations) > 1) {
+				// TODO: add admin option for toggling copy attendee info,
+				// then use that value to change $this->_print_copy_info
+				$copy_options['spco_copy_attendee_chk'] = $this->_print_copy_info
+					? $this->_copy_attendee_info_form()
+					: $this->_auto_copy_attendee_info();
+				// generate hidden input
+				if (isset($subsections[$primary_registrant])
+					&& $subsections[$primary_registrant] instanceof EE_Form_Section_Proper
+				) {
+					$subsections[$primary_registrant]->add_subsections(
+						$copy_options,
+						'primary_registrant',
+						false
+					);
+				}
+			}
+		}
+
+		return new EE_Form_Section_Proper(
+			array(
+				'name'            => $this->reg_form_name(),
+				'html_id'         => $this->reg_form_name(),
+				'subsections'     => $subsections,
+				'layout_strategy' => $this->checkout->admin_request ?
+					new EE_Div_Per_Section_Layout() :
+					new EE_Template_Layout(
+						array(
+							'layout_template_file' => $this->_template, // layout_template
+							'template_args'        => $template_args,
+						)
+					),
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Form_Section_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _registrations_reg_form(EE_Registration $registration)
+	{
+		static $attendee_nmbr = 1;
+		$form_args = array();
+		// verify that registration has valid event
+		if ($registration->event() instanceof EE_Event) {
+			$question_groups = $registration->event()->question_groups(
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information___registrations_reg_form__question_groups_query_parameters',
+					array(
+						array(
+							'Event.EVT_ID'                     => $registration->event()->ID(),
+							'Event_Question_Group.EQG_primary' => $registration->count() === 1 ? true : false,
+						),
+						'order_by' => array('QSG_order' => 'ASC'),
+					),
+					$registration,
+					$this
+				)
+			);
+			if ($question_groups) {
+				// array of params to pass to parent constructor
+				$form_args = array(
+					'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+					'html_class'      => 'ee-reg-form-attendee-dv',
+					'html_style'      => $this->checkout->admin_request
+						? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
+						: '',
+					'subsections'     => array(),
+					'layout_strategy' => new EE_Fieldset_Section_Layout(
+						array(
+							'legend_class' => 'spco-attendee-lgnd smaller-text lt-grey-text',
+							'legend_text'  => sprintf(__('Attendee %d', 'event_espresso'), $attendee_nmbr),
+						)
+					),
+				);
+				foreach ($question_groups as $question_group) {
+					if ($question_group instanceof EE_Question_Group) {
+						$form_args['subsections'][$question_group->identifier()] = $this->_question_group_reg_form(
+							$registration,
+							$question_group
+						);
+					}
+				}
+				// add hidden input
+				$form_args['subsections']['additional_attendee_reg_info'] = $this->_additional_attendee_reg_info_input(
+					$registration
+				);
+				// if we have question groups for additional attendees, then display the copy options
+				$this->_print_copy_info = $attendee_nmbr > 1 ? true : $this->_print_copy_info;
+				if ($registration->is_primary_registrant()) {
+					// generate hidden input
+					$form_args['subsections']['primary_registrant'] = $this->_additional_primary_registrant_inputs(
+						$registration
+					);
+				}
+			}
+		}
+		$attendee_nmbr++;
+		return ! empty($form_args) ? new EE_Form_Section_Proper($form_args) : new EE_Form_Section_HTML();
+	}
+
+
+	/**
+	 * _additional_attendee_reg_info_input
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param bool            $additional_attendee_reg_info
+	 * @return    EE_Form_Input_Base
+	 * @throws \EE_Error
+	 */
+	private function _additional_attendee_reg_info_input(
+		EE_Registration $registration,
+		$additional_attendee_reg_info = true
+	) {
+		// generate hidden input
+		return new EE_Hidden_Input(
+			array(
+				'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+				'default' => $additional_attendee_reg_info,
+			)
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration   $registration
+	 * @param EE_Question_Group $question_group
+	 * @return EE_Form_Section_Proper
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _question_group_reg_form(EE_Registration $registration, EE_Question_Group $question_group)
+	{
+		// array of params to pass to parent constructor
+		$form_args = array(
+			'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
+			'html_class'      => $this->checkout->admin_request
+				? 'form-table ee-reg-form-qstn-grp-dv'
+				: 'ee-reg-form-qstn-grp-dv',
+			'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-lbl',
+			'subsections'     => array(
+				'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
+			),
+			'layout_strategy' => $this->checkout->admin_request
+				? new EE_Admin_Two_Column_Layout()
+				: new EE_Div_Per_Section_Layout(),
+		);
+		// where params
+		$query_params = array('QST_deleted' => 0);
+		// don't load admin only questions on the frontend
+		if (! $this->checkout->admin_request) {
+			$query_params['QST_admin_only'] = array('!=', true);
+		}
+		$questions = $question_group->get_many_related(
+			'Question',
+			apply_filters(
+				'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__related_questions_query_params',
+				array(
+					$query_params,
+					'order_by' => array(
+						'Question_Group_Question.QGQ_order' => 'ASC',
+					),
+				),
+				$question_group,
+				$registration,
+				$this
+			)
+		);
+		// filter for additional content before questions
+		$form_args['subsections']['reg_form_questions_before'] = new EE_Form_Section_HTML(
+			apply_filters(
+				'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+				'',
+				$registration,
+				$question_group,
+				$this
+			)
+		);
+		// loop thru questions
+		foreach ($questions as $question) {
+			if ($question instanceof EE_Question) {
+				$identifier                            = $question->is_system_question()
+					? $question->system_ID()
+					: $question->ID();
+				$form_args['subsections'][$identifier] = $this->reg_form_question($registration, $question);
+			}
+		}
+		$form_args['subsections'] = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__question_group_reg_form__subsections_array',
+			$form_args['subsections'],
+			$registration,
+			$question_group,
+			$this
+		);
+		// filter for additional content after questions
+		$form_args['subsections']['reg_form_questions_after'] = new EE_Form_Section_HTML(
+			apply_filters(
+				'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+				'',
+				$registration,
+				$question_group,
+				$this
+			)
+		);
 //		d( $form_args );
-        $question_group_reg_form = new EE_Form_Section_Proper($form_args);
-        return apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
-            $question_group_reg_form,
-            $registration,
-            $question_group,
-            $this
-        );
-    }
-
-
-    /**
-     * @access public
-     * @param EE_Question_Group $question_group
-     * @return    EE_Form_Section_HTML
-     */
-    private function _question_group_header(EE_Question_Group $question_group)
-    {
-        $html = '';
-        // group_name
-        if ($question_group->show_group_name() && $question_group->name() !== '') {
-            if ($this->checkout->admin_request) {
-                $html .= EEH_HTML::br();
-                $html .= EEH_HTML::h3(
-                    $question_group->name(),
-                    '',
-                    'ee-reg-form-qstn-grp-title title',
-                    'font-size: 1.3em; padding-left:0;'
-                );
-            } else {
-                $html .= EEH_HTML::h4(
-                    $question_group->name(),
-                    '',
-                    'ee-reg-form-qstn-grp-title section-title'
-                );
-            }
-        }
-        // group_desc
-        if ($question_group->show_group_desc() && $question_group->desc() !== '') {
-            $html .= EEH_HTML::p(
-                $question_group->desc(),
-                '',
-                $this->checkout->admin_request
-                    ? 'ee-reg-form-qstn-grp-desc-pg'
-                    : 'ee-reg-form-qstn-grp-desc-pg small-text lt-grey-text'
-            );
-        }
-        return new EE_Form_Section_HTML($html);
-    }
-
-
-    /**
-     * @access public
-     * @return    EE_Form_Section_Proper
-     * @throws \EE_Error
-     */
-    private function _copy_attendee_info_form()
-    {
-        // array of params to pass to parent constructor
-        return new EE_Form_Section_Proper(
-            array(
-                'subsections'     => $this->_copy_attendee_info_inputs(),
-                'layout_strategy' => new EE_Template_Layout(
-                    array(
-                        'layout_template_file'     => SPCO_REG_STEPS_PATH
-                                                      . $this->_slug
-                                                      . DS
-                                                      . 'copy_attendee_info.template.php',
-                        'begin_template_file'      => null,
-                        'input_template_file'      => null,
-                        'subsection_template_file' => null,
-                        'end_template_file'        => null,
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * _auto_copy_attendee_info
-     *
-     * @access public
-     * @return EE_Form_Section_HTML
-     */
-    private function _auto_copy_attendee_info()
-    {
-        return new EE_Form_Section_HTML(
-            EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
-                apply_filters(
-                    'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
-                    array()
-                ),
-                true,
-                true
-            )
-        );
-    }
-
-
-    /**
-     * _copy_attendee_info_inputs
-     *
-     * @access public
-     * @return array
-     * @throws \EE_Error
-     */
-    private function _copy_attendee_info_inputs()
-    {
-        $copy_attendee_info_inputs = array();
-        $prev_ticket               = null;
-        // grab the saved registrations from the transaction
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        foreach ($registrations as $registration) {
-            // for all  attendees other than the primary attendee
-            if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
-                // if this is a new ticket OR if this is the very first additional attendee after the primary attendee
-                if ($registration->ticket()->ID() !== $prev_ticket) {
-                    $item_name = $registration->ticket()->name();
-                    $item_name .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
-                        : '';
-                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']'] =
-                        new EE_Form_Section_HTML(
-                            '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
-                        );
-                    $prev_ticket = $registration->ticket()->ID();
-                }
-
-                $copy_attendee_info_inputs['spco_copy_attendee_chk[' . $registration->ID() . ']'] =
-                    new EE_Checkbox_Multi_Input(
-                        array(
-                            $registration->ID() => sprintf(
-                                esc_html__('Attendee #%s', 'event_espresso'),
-                                $registration->count()
-                            ),
-                        ),
-                        array(
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
-                            'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
-                            'display_html_label_text' => false,
-                        )
-                    );
-            }
-        }
-        return $copy_attendee_info_inputs;
-    }
-
-
-    /**
-     * _additional_primary_registrant_inputs
-     *
-     * @access public
-     * @param EE_Registration $registration
-     * @return    EE_Form_Input_Base
-     * @throws \EE_Error
-     */
-    private function _additional_primary_registrant_inputs(EE_Registration $registration)
-    {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            array(
-                'html_id' => 'primary_registrant',
-                'default' => $registration->reg_url_link(),
-            )
-        );
-    }
-
-
-    /**
-     * @access public
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function reg_form_question(EE_Registration $registration, EE_Question $question)
-    {
-
-        // if this question was for an attendee detail, then check for that answer
-        $answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
-            $registration,
-            $question->system_ID()
-        );
-        $answer       = $answer_value === null
-            ? EEM_Answer::instance()->get_one(
-                array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
-            )
-            : null;
-        // if NOT returning to edit an existing registration
-        // OR if this question is for an attendee property
-        // OR we still don't have an EE_Answer object
-        if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
-            // create an EE_Answer object for storing everything in
-            $answer = EE_Answer::new_instance(array(
-                'QST_ID' => $question->ID(),
-                'REG_ID' => $registration->ID(),
-            ));
-        }
-        // verify instance
-        if ($answer instanceof EE_Answer) {
-            if (! empty($answer_value)) {
-                $answer->set('ANS_value', $answer_value);
-            }
-            $answer->cache('Question', $question);
-            //remember system ID had a bug where sometimes it could be null
-            $answer_cache_id = $question->is_system_question()
-                ? $question->system_ID() . '-' . $registration->reg_url_link()
-                : $question->ID() . '-' . $registration->reg_url_link();
-            $registration->cache('Answer', $answer, $answer_cache_id);
-        }
-        return $this->_generate_question_input($registration, $question, $answer);
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param EE_Question     $question
-     * @param                 mixed EE_Answer|NULL      $answer
-     * @return EE_Form_Input_Base
-     * @throws \EE_Error
-     */
-    private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer)
-    {
-        $identifier                             = $question->is_system_question()
-            ? $question->system_ID()
-            : $question->ID();
-        $this->_required_questions[$identifier] = $question->required() ? true : false;
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            array($this, 'use_cached_countries_for_form_input'),
-            10,
-            4
-        );
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            array($this, 'use_cached_states_for_form_input'),
-            10,
-            4
-        );
-        $input_constructor_args                  = array(
-            'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-            'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-            'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_label_class' => 'ee-reg-qstn',
-        );
-        $input_constructor_args['html_label_id'] .= '-lbl';
-        if ($answer instanceof EE_Answer && $answer->ID()) {
-            $input_constructor_args['html_name']     .= '[' . $answer->ID() . ']';
-            $input_constructor_args['html_id']       .= '-' . $answer->ID();
-            $input_constructor_args['html_label_id'] .= '-' . $answer->ID();
-        }
-        $form_input = $question->generate_form_input(
-            $registration,
-            $answer,
-            $input_constructor_args
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            array($this, 'use_cached_countries_for_form_input')
-        );
-        remove_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            array($this, 'use_cached_states_for_form_input')
-        );
-        return $form_input;
-    }
-
-
-    /**
-     * Gets the list of countries for the form input
-     *
-     * @param array|null       $countries_list
-     * @param \EE_Question     $question
-     * @param \EE_Registration $registration
-     * @param \EE_Answer       $answer
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function use_cached_countries_for_form_input(
-        $countries_list,
-        \EE_Question $question = null,
-        \EE_Registration $registration = null,
-        \EE_Answer $answer = null
-    ) {
-        $country_options = array('' => '');
-        // get possibly cached list of countries
-        $countries = $this->checkout->action === 'process_reg_step'
-            ? EEM_Country::instance()->get_all_countries()
-            : EEM_Country::instance()->get_all_active_countries();
-        if (! empty($countries)) {
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $country_options[$country->ID()] = $country->name();
-                }
-            }
-        }
-        if ($question instanceof EE_Question
-            && $registration instanceof EE_Registration) {
-            $answer = EEM_Answer::instance()->get_one(
-                array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
-            );
-        } else {
-            $answer = EE_Answer::new_instance();
-        }
-        $country_options = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
-            $country_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-        return $country_options;
-    }
-
-
-    /**
-     * Gets the list of states for the form input
-     *
-     * @param array|null       $states_list
-     * @param \EE_Question     $question
-     * @param \EE_Registration $registration
-     * @param \EE_Answer       $answer
-     * @return array 2d keys are state IDs, values are their names
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function use_cached_states_for_form_input(
-        $states_list,
-        \EE_Question $question = null,
-        \EE_Registration $registration = null,
-        \EE_Answer $answer = null
-    ) {
-        $state_options = array('' => array('' => ''));
-        $states        = $this->checkout->action === 'process_reg_step'
-            ? EEM_State::instance()->get_all_states()
-            : EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[$state->country()->name()][$state->ID()] = $state->name();
-                }
-            }
-        }
-        $state_options = apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
-            $state_options,
-            $this,
-            $registration,
-            $question,
-            $answer
-        );
-        return $state_options;
-    }
-
-
-
-
-
-
-    /********************************************************************************************************/
-    /****************************************  PROCESS REG STEP  ****************************************/
-    /********************************************************************************************************/
-    /**
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function process_reg_step()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        // grab validated data from form
-        $valid_data = $this->checkout->current_step->valid_data();
-        // EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
-        // if we don't have any $valid_data then something went TERRIBLY WRONG !!!
-        if (empty($valid_data)) {
-            EE_Error::add_error(
-                esc_html__('No valid question responses were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    'A valid transaction could not be initiated for processing your registrations.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // get cached registrations
-        $registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
-        // verify we got the goods
-        if (empty($registrations)) {
-            //combine the old translated string with a new one, in order to not break translations
-
-            // @codingStandardsIgnoreStart
-            $error_message = esc_html__( 'Your form data could not be applied to any valid registrations.', 'event_espresso' )
-                             . sprintf(
-                                 esc_html__('%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.', 'event_espresso'),
-                                 '<a href="'
-                                 . apply_filters(
-                                     'FHEE__EE_SPCO_Reg_Step_Attendee_Information__process_reg_step__no_regs_link_to_event_list',
-                                     get_post_type_archive_link('espresso_events')
-                                 )
-                                 . '" >',
-                                 '</a>',
-                                 '<br />'
-                             );
-            // @codingStandardsIgnoreEnd
-            EE_Error::add_error(
-                $error_message,
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // extract attendee info from form data and save to model objects
-        $registrations_processed = $this->_process_registrations($registrations, $valid_data);
-        // if first pass thru SPCO,
-        // then let's check processed registrations against the total number of tickets in the cart
-        if ($registrations_processed === false) {
-            // but return immediately if the previous step exited early due to errors
-            return false;
-        } elseif (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
-            // generate a correctly translated string for all possible singular/plural combinations
-            if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            } else {
-                $error_msg = sprintf(
-                    esc_html__(
-                        'There was a total of %1$d tickets in the Event Queue, but %2$ds registrations were processed',
-                        'event_espresso'
-                    ),
-                    $this->checkout->total_ticket_count,
-                    $registrations_processed
-                );
-            }
-            EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // mark this reg step as completed
-        $this->set_completed();
-        $this->_set_success_message(
-            esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
-        );
-        //do action in case a plugin wants to do something with the data submitted in step 1.
-        //passes EE_Single_Page_Checkout, and it's posted data
-        do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
-        return true;
-    }
-
-
-    /**
-     *    _process_registrations
-     *
-     * @param EE_Registration[] $registrations
-     * @param array             $valid_data
-     * @return bool|int
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _process_registrations($registrations = array(), $valid_data = array())
-    {
-        // load resources and set some defaults
-        EE_Registry::instance()->load_model('Attendee');
-        // holder for primary registrant attendee object
-        $this->checkout->primary_attendee_obj = null;
-        // array for tracking reg form data for the primary registrant
-        $primary_registrant = array(
-            'line_item_id' => null,
-        );
-        $copy_primary       = false;
-        // reg form sections that do not contain inputs
-        $non_input_form_sections = array(
-            'primary_registrant',
-            'additional_attendee_reg_info',
-            'spco_copy_attendee_chk',
-        );
-        // attendee counter
-        $att_nmbr = 0;
-        // grab the saved registrations from the transaction
-        foreach ($registrations as $registration) {
-            // verify EE_Registration object
-            if (! $registration instanceof EE_Registration) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid Registration object was discovered when attempting to process your registration information.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            /** @var string $reg_url_link */
-            $reg_url_link = $registration->reg_url_link();
-            // reg_url_link exists ?
-            if (! empty($reg_url_link)) {
-                // should this registration be processed during this visit ?
-                if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
-                    // if NOT revisiting, then let's save the registration now,
-                    // so that we have a REG_ID to use when generating other objects
-                    if (! $this->checkout->revisit) {
-                        $registration->save();
-                    }
-                    /**
-                     * This allows plugins to trigger a fail on processing of a
-                     * registration for any conditions they may have for it to pass.
-                     *
-                     * @var bool   if true is returned by the plugin then the
-                     *            registration processing is halted.
-                     */
-                    if (apply_filters(
-                        'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
-                        false,
-                        $att_nmbr,
-                        $registration,
-                        $registrations,
-                        $valid_data,
-                        $this
-                    )) {
-                        return false;
-                    }
-
-                    // Houston, we have a registration!
-                    $att_nmbr++;
-                    $this->_attendee_data[$reg_url_link] = array();
-                    // grab any existing related answer objects
-                    $this->_registration_answers = $registration->answers();
-                    // unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
-                    if (isset($valid_data[$reg_url_link])) {
-                        // do we need to copy basic info from primary attendee ?
-                        $copy_primary = isset($valid_data[$reg_url_link]['additional_attendee_reg_info'])
-                                        && absint($valid_data[$reg_url_link]['additional_attendee_reg_info']) === 0
-                            ? true
-                            : false;
-                        // filter form input data for this registration
-                        $valid_data[$reg_url_link] = (array)apply_filters(
-                            'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
-                            $valid_data[$reg_url_link]
-                        );
-                        if (isset($valid_data['primary_attendee'])) {
-                            $primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
-                                ? $valid_data['primary_attendee']
-                                : false;
-                            unset($valid_data['primary_attendee']);
-                        }
-                        // now loop through our array of valid post data && process attendee reg forms
-                        foreach ($valid_data[$reg_url_link] as $form_section => $form_inputs) {
-                            if (! in_array($form_section, $non_input_form_sections)) {
-                                foreach ($form_inputs as $form_input => $input_value) {
-                                    // \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
-                                    // check for critical inputs
-                                    if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
-                                        $form_input,
-                                        $input_value
-                                    )
-                                    ) {
-                                        return false;
-                                    }
-                                    // store a bit of data about the primary attendee
-                                    if ($att_nmbr === 1
-                                        && ! empty($input_value)
-                                        && $reg_url_link === $primary_registrant['line_item_id']
-                                    ) {
-                                        $primary_registrant[$form_input] = $input_value;
-                                    } elseif ($copy_primary
-                                        && $input_value === null
-                                        && isset($primary_registrant[$form_input])
-                                    ) {
-                                        $input_value = $primary_registrant[$form_input];
-                                    }
-                                    // now attempt to save the input data
-                                    if (! $this->_save_registration_form_input(
-                                        $registration,
-                                        $form_input,
-                                        $input_value
-                                    )
-                                    ) {
-                                        EE_Error::add_error(
-                                            sprintf(
-                                                esc_html__(
-                                                    'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
-                                                    'event_espresso'
-                                                ),
-                                                $form_input,
-                                                $input_value
-                                            ),
-                                            __FILE__,
-                                            __FUNCTION__,
-                                            __LINE__
-                                        );
-                                        return false;
-                                    }
-                                }
-                            }
-                        }  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
-                    }
-                    //EEH_Debug_Tools::printr( $this->_attendee_data, '$this->_attendee_data', __FILE__, __LINE__ );
-                    // this registration does not require additional attendee information ?
-                    if ($copy_primary
-                        && $att_nmbr > 1
-                        && $this->checkout->primary_attendee_obj instanceof EE_Attendee
-                    ) {
-                        // just copy the primary registrant
-                        $attendee = $this->checkout->primary_attendee_obj;
-                    } else {
-                        // ensure critical details are set for additional attendees
-                        $this->_attendee_data[$reg_url_link] = $att_nmbr > 1
-                            ? $this->_copy_critical_attendee_details_from_primary_registrant(
-                                $this->_attendee_data[$reg_url_link]
-                            )
-                            : $this->_attendee_data[$reg_url_link];
-                        // execute create attendee command (which may return an existing attendee)
-                        $attendee = EE_Registry::instance()->BUS->execute(
-                            new CreateAttendeeCommand(
-                                $this->_attendee_data[$reg_url_link],
-                                $registration
-                            )
-                        );
-                        // who's #1 ?
-                        if ($att_nmbr === 1) {
-                            $this->checkout->primary_attendee_obj = $attendee;
-                        }
-                    }
-                    // EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
-                    // add relation to registration, set attendee ID, and cache attendee
-                    $this->_associate_attendee_with_registration($registration, $attendee);
-                    // \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-                    if (! $registration->attendee() instanceof EE_Attendee) {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'Registration %s has an invalid or missing Attendee object.',
-                                    'event_espresso'
-                                ),
-                                $reg_url_link
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                    /** @type EE_Registration_Processor $registration_processor */
-                    $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-                    // at this point, we should have enough details about the registrant to consider the registration
-                    // NOT incomplete
-                    $registration_processor->toggle_incomplete_registration_status_to_default(
-                        $registration,
-                        false,
-                        new Context(
-                            'spco_reg_step_attendee_information_process_registrations',
-                            esc_html__(
-                                'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
-                                'event_espresso'
-                            )
-                        )
-                    );
-                    // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
-                    // abandoned
-                    $this->checkout->transaction->toggle_failed_transaction_status();
-                    // if we've gotten this far, then let's save what we have
-                    $registration->save();
-                    // add relation between TXN and registration
-                    $this->_associate_registration_with_transaction($registration);
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'An invalid or missing line item ID was encountered while attempting to process the registration form.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                // remove malformed data
-                unset($valid_data[$reg_url_link]);
-                return false;
-            }
-
-        } // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
-        return $att_nmbr;
-    }
-
-
-    /**
-     *    _save_registration_form_input
-     *
-     * @param EE_Registration $registration
-     * @param string          $form_input
-     * @param string          $input_value
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    private function _save_registration_form_input(
-        EE_Registration $registration,
-        $form_input = '',
-        $input_value = ''
-    ) {
-        // \EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__, 2 );
-        // \EEH_Debug_Tools::printr( $form_input, '$form_input', __FILE__, __LINE__ );
-        // \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
-        // allow for plugins to hook in and do their own processing of the form input.
-        // For plugins to bypass normal processing here, they just need to return a boolean value.
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
-            false,
-            $registration,
-            $form_input,
-            $input_value,
-            $this
-        )) {
-            return true;
-        }
-        /*
+		$question_group_reg_form = new EE_Form_Section_Proper($form_args);
+		return apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___question_group_reg_form__question_group_reg_form',
+			$question_group_reg_form,
+			$registration,
+			$question_group,
+			$this
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @param EE_Question_Group $question_group
+	 * @return    EE_Form_Section_HTML
+	 */
+	private function _question_group_header(EE_Question_Group $question_group)
+	{
+		$html = '';
+		// group_name
+		if ($question_group->show_group_name() && $question_group->name() !== '') {
+			if ($this->checkout->admin_request) {
+				$html .= EEH_HTML::br();
+				$html .= EEH_HTML::h3(
+					$question_group->name(),
+					'',
+					'ee-reg-form-qstn-grp-title title',
+					'font-size: 1.3em; padding-left:0;'
+				);
+			} else {
+				$html .= EEH_HTML::h4(
+					$question_group->name(),
+					'',
+					'ee-reg-form-qstn-grp-title section-title'
+				);
+			}
+		}
+		// group_desc
+		if ($question_group->show_group_desc() && $question_group->desc() !== '') {
+			$html .= EEH_HTML::p(
+				$question_group->desc(),
+				'',
+				$this->checkout->admin_request
+					? 'ee-reg-form-qstn-grp-desc-pg'
+					: 'ee-reg-form-qstn-grp-desc-pg small-text lt-grey-text'
+			);
+		}
+		return new EE_Form_Section_HTML($html);
+	}
+
+
+	/**
+	 * @access public
+	 * @return    EE_Form_Section_Proper
+	 * @throws \EE_Error
+	 */
+	private function _copy_attendee_info_form()
+	{
+		// array of params to pass to parent constructor
+		return new EE_Form_Section_Proper(
+			array(
+				'subsections'     => $this->_copy_attendee_info_inputs(),
+				'layout_strategy' => new EE_Template_Layout(
+					array(
+						'layout_template_file'     => SPCO_REG_STEPS_PATH
+													  . $this->_slug
+													  . DS
+													  . 'copy_attendee_info.template.php',
+						'begin_template_file'      => null,
+						'input_template_file'      => null,
+						'subsection_template_file' => null,
+						'end_template_file'        => null,
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * _auto_copy_attendee_info
+	 *
+	 * @access public
+	 * @return EE_Form_Section_HTML
+	 */
+	private function _auto_copy_attendee_info()
+	{
+		return new EE_Form_Section_HTML(
+			EEH_Template::locate_template(
+				SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+				apply_filters(
+					'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
+					array()
+				),
+				true,
+				true
+			)
+		);
+	}
+
+
+	/**
+	 * _copy_attendee_info_inputs
+	 *
+	 * @access public
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	private function _copy_attendee_info_inputs()
+	{
+		$copy_attendee_info_inputs = array();
+		$prev_ticket               = null;
+		// grab the saved registrations from the transaction
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		foreach ($registrations as $registration) {
+			// for all  attendees other than the primary attendee
+			if ($registration instanceof EE_Registration && ! $registration->is_primary_registrant()) {
+				// if this is a new ticket OR if this is the very first additional attendee after the primary attendee
+				if ($registration->ticket()->ID() !== $prev_ticket) {
+					$item_name = $registration->ticket()->name();
+					$item_name .= $registration->ticket()->description() !== ''
+						? ' - ' . $registration->ticket()->description()
+						: '';
+					$copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']'] =
+						new EE_Form_Section_HTML(
+							'<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+						);
+					$prev_ticket = $registration->ticket()->ID();
+				}
+
+				$copy_attendee_info_inputs['spco_copy_attendee_chk[' . $registration->ID() . ']'] =
+					new EE_Checkbox_Multi_Input(
+						array(
+							$registration->ID() => sprintf(
+								esc_html__('Attendee #%s', 'event_espresso'),
+								$registration->count()
+							),
+						),
+						array(
+							'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+							'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
+							'display_html_label_text' => false,
+						)
+					);
+			}
+		}
+		return $copy_attendee_info_inputs;
+	}
+
+
+	/**
+	 * _additional_primary_registrant_inputs
+	 *
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @return    EE_Form_Input_Base
+	 * @throws \EE_Error
+	 */
+	private function _additional_primary_registrant_inputs(EE_Registration $registration)
+	{
+		// generate hidden input
+		return new EE_Hidden_Input(
+			array(
+				'html_id' => 'primary_registrant',
+				'default' => $registration->reg_url_link(),
+			)
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function reg_form_question(EE_Registration $registration, EE_Question $question)
+	{
+
+		// if this question was for an attendee detail, then check for that answer
+		$answer_value = EEM_Answer::instance()->get_attendee_property_answer_value(
+			$registration,
+			$question->system_ID()
+		);
+		$answer       = $answer_value === null
+			? EEM_Answer::instance()->get_one(
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
+			)
+			: null;
+		// if NOT returning to edit an existing registration
+		// OR if this question is for an attendee property
+		// OR we still don't have an EE_Answer object
+		if ($answer_value || ! $answer instanceof EE_Answer || ! $registration->reg_url_link()) {
+			// create an EE_Answer object for storing everything in
+			$answer = EE_Answer::new_instance(array(
+				'QST_ID' => $question->ID(),
+				'REG_ID' => $registration->ID(),
+			));
+		}
+		// verify instance
+		if ($answer instanceof EE_Answer) {
+			if (! empty($answer_value)) {
+				$answer->set('ANS_value', $answer_value);
+			}
+			$answer->cache('Question', $question);
+			//remember system ID had a bug where sometimes it could be null
+			$answer_cache_id = $question->is_system_question()
+				? $question->system_ID() . '-' . $registration->reg_url_link()
+				: $question->ID() . '-' . $registration->reg_url_link();
+			$registration->cache('Answer', $answer, $answer_cache_id);
+		}
+		return $this->_generate_question_input($registration, $question, $answer);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param EE_Question     $question
+	 * @param                 mixed EE_Answer|NULL      $answer
+	 * @return EE_Form_Input_Base
+	 * @throws \EE_Error
+	 */
+	private function _generate_question_input(EE_Registration $registration, EE_Question $question, $answer)
+	{
+		$identifier                             = $question->is_system_question()
+			? $question->system_ID()
+			: $question->ID();
+		$this->_required_questions[$identifier] = $question->required() ? true : false;
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			array($this, 'use_cached_countries_for_form_input'),
+			10,
+			4
+		);
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			array($this, 'use_cached_states_for_form_input'),
+			10,
+			4
+		);
+		$input_constructor_args                  = array(
+			'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
+			'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
+			'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+			'html_label_class' => 'ee-reg-qstn',
+		);
+		$input_constructor_args['html_label_id'] .= '-lbl';
+		if ($answer instanceof EE_Answer && $answer->ID()) {
+			$input_constructor_args['html_name']     .= '[' . $answer->ID() . ']';
+			$input_constructor_args['html_id']       .= '-' . $answer->ID();
+			$input_constructor_args['html_label_id'] .= '-' . $answer->ID();
+		}
+		$form_input = $question->generate_form_input(
+			$registration,
+			$answer,
+			$input_constructor_args
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			array($this, 'use_cached_countries_for_form_input')
+		);
+		remove_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			array($this, 'use_cached_states_for_form_input')
+		);
+		return $form_input;
+	}
+
+
+	/**
+	 * Gets the list of countries for the form input
+	 *
+	 * @param array|null       $countries_list
+	 * @param \EE_Question     $question
+	 * @param \EE_Registration $registration
+	 * @param \EE_Answer       $answer
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function use_cached_countries_for_form_input(
+		$countries_list,
+		\EE_Question $question = null,
+		\EE_Registration $registration = null,
+		\EE_Answer $answer = null
+	) {
+		$country_options = array('' => '');
+		// get possibly cached list of countries
+		$countries = $this->checkout->action === 'process_reg_step'
+			? EEM_Country::instance()->get_all_countries()
+			: EEM_Country::instance()->get_all_active_countries();
+		if (! empty($countries)) {
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$country_options[$country->ID()] = $country->name();
+				}
+			}
+		}
+		if ($question instanceof EE_Question
+			&& $registration instanceof EE_Registration) {
+			$answer = EEM_Answer::instance()->get_one(
+				array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
+			);
+		} else {
+			$answer = EE_Answer::new_instance();
+		}
+		$country_options = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__country_options',
+			$country_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+		return $country_options;
+	}
+
+
+	/**
+	 * Gets the list of states for the form input
+	 *
+	 * @param array|null       $states_list
+	 * @param \EE_Question     $question
+	 * @param \EE_Registration $registration
+	 * @param \EE_Answer       $answer
+	 * @return array 2d keys are state IDs, values are their names
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function use_cached_states_for_form_input(
+		$states_list,
+		\EE_Question $question = null,
+		\EE_Registration $registration = null,
+		\EE_Answer $answer = null
+	) {
+		$state_options = array('' => array('' => ''));
+		$states        = $this->checkout->action === 'process_reg_step'
+			? EEM_State::instance()->get_all_states()
+			: EEM_State::instance()->get_all_active_states();
+		if (! empty($states)) {
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[$state->country()->name()][$state->ID()] = $state->name();
+				}
+			}
+		}
+		$state_options = apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___generate_question_input__state_options',
+			$state_options,
+			$this,
+			$registration,
+			$question,
+			$answer
+		);
+		return $state_options;
+	}
+
+
+
+
+
+
+	/********************************************************************************************************/
+	/****************************************  PROCESS REG STEP  ****************************************/
+	/********************************************************************************************************/
+	/**
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function process_reg_step()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		// grab validated data from form
+		$valid_data = $this->checkout->current_step->valid_data();
+		// EEH_Debug_Tools::printr( $_REQUEST, '$_REQUEST', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $valid_data, '$valid_data', __FILE__, __LINE__ );
+		// if we don't have any $valid_data then something went TERRIBLY WRONG !!!
+		if (empty($valid_data)) {
+			EE_Error::add_error(
+				esc_html__('No valid question responses were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					'A valid transaction could not be initiated for processing your registrations.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// get cached registrations
+		$registrations = $this->checkout->transaction->registrations($this->checkout->reg_cache_where_params);
+		// verify we got the goods
+		if (empty($registrations)) {
+			//combine the old translated string with a new one, in order to not break translations
+
+			// @codingStandardsIgnoreStart
+			$error_message = esc_html__( 'Your form data could not be applied to any valid registrations.', 'event_espresso' )
+							 . sprintf(
+								 esc_html__('%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.', 'event_espresso'),
+								 '<a href="'
+								 . apply_filters(
+									 'FHEE__EE_SPCO_Reg_Step_Attendee_Information__process_reg_step__no_regs_link_to_event_list',
+									 get_post_type_archive_link('espresso_events')
+								 )
+								 . '" >',
+								 '</a>',
+								 '<br />'
+							 );
+			// @codingStandardsIgnoreEnd
+			EE_Error::add_error(
+				$error_message,
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// extract attendee info from form data and save to model objects
+		$registrations_processed = $this->_process_registrations($registrations, $valid_data);
+		// if first pass thru SPCO,
+		// then let's check processed registrations against the total number of tickets in the cart
+		if ($registrations_processed === false) {
+			// but return immediately if the previous step exited early due to errors
+			return false;
+		} elseif (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+			// generate a correctly translated string for all possible singular/plural combinations
+			if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was %1$d ticket in the Event Queue, but %2$ds registrations were processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} elseif ($this->checkout->total_ticket_count !== 1 && $registrations_processed === 1) {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was a total of %1$d tickets in the Event Queue, but only %2$ds registration was processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			} else {
+				$error_msg = sprintf(
+					esc_html__(
+						'There was a total of %1$d tickets in the Event Queue, but %2$ds registrations were processed',
+						'event_espresso'
+					),
+					$this->checkout->total_ticket_count,
+					$registrations_processed
+				);
+			}
+			EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// mark this reg step as completed
+		$this->set_completed();
+		$this->_set_success_message(
+			esc_html__('The Attendee Information Step has been successfully completed.', 'event_espresso')
+		);
+		//do action in case a plugin wants to do something with the data submitted in step 1.
+		//passes EE_Single_Page_Checkout, and it's posted data
+		do_action('AHEE__EE_Single_Page_Checkout__process_attendee_information__end', $this, $valid_data);
+		return true;
+	}
+
+
+	/**
+	 *    _process_registrations
+	 *
+	 * @param EE_Registration[] $registrations
+	 * @param array             $valid_data
+	 * @return bool|int
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _process_registrations($registrations = array(), $valid_data = array())
+	{
+		// load resources and set some defaults
+		EE_Registry::instance()->load_model('Attendee');
+		// holder for primary registrant attendee object
+		$this->checkout->primary_attendee_obj = null;
+		// array for tracking reg form data for the primary registrant
+		$primary_registrant = array(
+			'line_item_id' => null,
+		);
+		$copy_primary       = false;
+		// reg form sections that do not contain inputs
+		$non_input_form_sections = array(
+			'primary_registrant',
+			'additional_attendee_reg_info',
+			'spco_copy_attendee_chk',
+		);
+		// attendee counter
+		$att_nmbr = 0;
+		// grab the saved registrations from the transaction
+		foreach ($registrations as $registration) {
+			// verify EE_Registration object
+			if (! $registration instanceof EE_Registration) {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid Registration object was discovered when attempting to process your registration information.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			/** @var string $reg_url_link */
+			$reg_url_link = $registration->reg_url_link();
+			// reg_url_link exists ?
+			if (! empty($reg_url_link)) {
+				// should this registration be processed during this visit ?
+				if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
+					// if NOT revisiting, then let's save the registration now,
+					// so that we have a REG_ID to use when generating other objects
+					if (! $this->checkout->revisit) {
+						$registration->save();
+					}
+					/**
+					 * This allows plugins to trigger a fail on processing of a
+					 * registration for any conditions they may have for it to pass.
+					 *
+					 * @var bool   if true is returned by the plugin then the
+					 *            registration processing is halted.
+					 */
+					if (apply_filters(
+						'FHEE__EE_SPCO_Reg_Step_Attendee_Information___process_registrations__pre_registration_process',
+						false,
+						$att_nmbr,
+						$registration,
+						$registrations,
+						$valid_data,
+						$this
+					)) {
+						return false;
+					}
+
+					// Houston, we have a registration!
+					$att_nmbr++;
+					$this->_attendee_data[$reg_url_link] = array();
+					// grab any existing related answer objects
+					$this->_registration_answers = $registration->answers();
+					// unset( $valid_data[ $reg_url_link ]['additional_attendee_reg_info'] );
+					if (isset($valid_data[$reg_url_link])) {
+						// do we need to copy basic info from primary attendee ?
+						$copy_primary = isset($valid_data[$reg_url_link]['additional_attendee_reg_info'])
+										&& absint($valid_data[$reg_url_link]['additional_attendee_reg_info']) === 0
+							? true
+							: false;
+						// filter form input data for this registration
+						$valid_data[$reg_url_link] = (array)apply_filters(
+							'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
+							$valid_data[$reg_url_link]
+						);
+						if (isset($valid_data['primary_attendee'])) {
+							$primary_registrant['line_item_id'] = ! empty($valid_data['primary_attendee'])
+								? $valid_data['primary_attendee']
+								: false;
+							unset($valid_data['primary_attendee']);
+						}
+						// now loop through our array of valid post data && process attendee reg forms
+						foreach ($valid_data[$reg_url_link] as $form_section => $form_inputs) {
+							if (! in_array($form_section, $non_input_form_sections)) {
+								foreach ($form_inputs as $form_input => $input_value) {
+									// \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
+									// check for critical inputs
+									if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
+										$form_input,
+										$input_value
+									)
+									) {
+										return false;
+									}
+									// store a bit of data about the primary attendee
+									if ($att_nmbr === 1
+										&& ! empty($input_value)
+										&& $reg_url_link === $primary_registrant['line_item_id']
+									) {
+										$primary_registrant[$form_input] = $input_value;
+									} elseif ($copy_primary
+										&& $input_value === null
+										&& isset($primary_registrant[$form_input])
+									) {
+										$input_value = $primary_registrant[$form_input];
+									}
+									// now attempt to save the input data
+									if (! $this->_save_registration_form_input(
+										$registration,
+										$form_input,
+										$input_value
+									)
+									) {
+										EE_Error::add_error(
+											sprintf(
+												esc_html__(
+													'Unable to save registration form data for the form input: "%1$s" with the submitted value: "%2$s"',
+													'event_espresso'
+												),
+												$form_input,
+												$input_value
+											),
+											__FILE__,
+											__FUNCTION__,
+											__LINE__
+										);
+										return false;
+									}
+								}
+							}
+						}  // end of foreach ( $valid_data[ $reg_url_link ] as $form_section => $form_inputs )
+					}
+					//EEH_Debug_Tools::printr( $this->_attendee_data, '$this->_attendee_data', __FILE__, __LINE__ );
+					// this registration does not require additional attendee information ?
+					if ($copy_primary
+						&& $att_nmbr > 1
+						&& $this->checkout->primary_attendee_obj instanceof EE_Attendee
+					) {
+						// just copy the primary registrant
+						$attendee = $this->checkout->primary_attendee_obj;
+					} else {
+						// ensure critical details are set for additional attendees
+						$this->_attendee_data[$reg_url_link] = $att_nmbr > 1
+							? $this->_copy_critical_attendee_details_from_primary_registrant(
+								$this->_attendee_data[$reg_url_link]
+							)
+							: $this->_attendee_data[$reg_url_link];
+						// execute create attendee command (which may return an existing attendee)
+						$attendee = EE_Registry::instance()->BUS->execute(
+							new CreateAttendeeCommand(
+								$this->_attendee_data[$reg_url_link],
+								$registration
+							)
+						);
+						// who's #1 ?
+						if ($att_nmbr === 1) {
+							$this->checkout->primary_attendee_obj = $attendee;
+						}
+					}
+					// EEH_Debug_Tools::printr( $attendee, '$attendee', __FILE__, __LINE__ );
+					// add relation to registration, set attendee ID, and cache attendee
+					$this->_associate_attendee_with_registration($registration, $attendee);
+					// \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
+					if (! $registration->attendee() instanceof EE_Attendee) {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'Registration %s has an invalid or missing Attendee object.',
+									'event_espresso'
+								),
+								$reg_url_link
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+					/** @type EE_Registration_Processor $registration_processor */
+					$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+					// at this point, we should have enough details about the registrant to consider the registration
+					// NOT incomplete
+					$registration_processor->toggle_incomplete_registration_status_to_default(
+						$registration,
+						false,
+						new Context(
+							'spco_reg_step_attendee_information_process_registrations',
+							esc_html__(
+								'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
+								'event_espresso'
+							)
+						)
+					);
+					// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
+					// abandoned
+					$this->checkout->transaction->toggle_failed_transaction_status();
+					// if we've gotten this far, then let's save what we have
+					$registration->save();
+					// add relation between TXN and registration
+					$this->_associate_registration_with_transaction($registration);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'An invalid or missing line item ID was encountered while attempting to process the registration form.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				// remove malformed data
+				unset($valid_data[$reg_url_link]);
+				return false;
+			}
+
+		} // end of foreach ( $this->checkout->transaction->registrations()  as $registration )
+		return $att_nmbr;
+	}
+
+
+	/**
+	 *    _save_registration_form_input
+	 *
+	 * @param EE_Registration $registration
+	 * @param string          $form_input
+	 * @param string          $input_value
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	private function _save_registration_form_input(
+		EE_Registration $registration,
+		$form_input = '',
+		$input_value = ''
+	) {
+		// \EEH_Debug_Tools::printr( __FUNCTION__, __CLASS__, __FILE__, __LINE__, 2 );
+		// \EEH_Debug_Tools::printr( $form_input, '$form_input', __FILE__, __LINE__ );
+		// \EEH_Debug_Tools::printr( $input_value, '$input_value', __FILE__, __LINE__ );
+		// allow for plugins to hook in and do their own processing of the form input.
+		// For plugins to bypass normal processing here, they just need to return a boolean value.
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information___save_registration_form_input',
+			false,
+			$registration,
+			$form_input,
+			$input_value,
+			$this
+		)) {
+			return true;
+		}
+		/*
          * $answer_cache_id is the key used to find the EE_Answer we want
          * @see https://events.codebasehq.com/projects/event-espresso/tickets/10477
          */
-        $answer_cache_id = $this->checkout->reg_url_link
-            ? $form_input . '-' . $registration->reg_url_link()
-            : $form_input;
-        $answer_is_obj   = isset($this->_registration_answers[$answer_cache_id])
-                           && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
-            ? true
-            : false;
-        //rename form_inputs if they are EE_Attendee properties
-        switch ((string) $form_input) {
-            case 'state':
-            case 'STA_ID':
-                $attendee_property = true;
-                $form_input        = 'STA_ID';
-                break;
-
-            case 'country':
-            case 'CNT_ISO':
-                $attendee_property = true;
-                $form_input        = 'CNT_ISO';
-                break;
-
-            default:
-                $ATT_input = 'ATT_' . $form_input;
-                //EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
-                $attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
-                $form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
-        }
-        // EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
-        // EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
-        // if this form input has a corresponding attendee property
-        if ($attendee_property) {
-            $this->_attendee_data[$registration->reg_url_link()][$form_input] = $input_value;
-            if ($answer_is_obj) {
-                // and delete the corresponding answer since we won't be storing this data in that object
-                $registration->_remove_relation_to($this->_registration_answers[$answer_cache_id], 'Answer');
-                $this->_registration_answers[$answer_cache_id]->delete_permanently();
-            }
-            return true;
-        } elseif ($answer_is_obj) {
-            // save this data to the answer object
-            $this->_registration_answers[$answer_cache_id]->set_value($input_value);
-            $result = $this->_registration_answers[$answer_cache_id]->save();
-            return $result !== false ? true : false;
-        } else {
-            foreach ($this->_registration_answers as $answer) {
-                if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
-                    $answer->set_value($input_value);
-                    $result = $answer->save();
-                    return $result !== false ? true : false;
-                }
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     *    _verify_critical_attendee_details_are_set
-     *
-     * @param string $form_input
-     * @param string $input_value
-     * @return boolean
-     */
-    private function _verify_critical_attendee_details_are_set_and_validate_email(
-        $form_input = '',
-        $input_value = ''
-    ) {
-        if (empty($input_value)) {
-            // if the form input isn't marked as being required, then just return
-            if (! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
-                return true;
-            }
-            switch ($form_input) {
-                case 'fname':
-                    EE_Error::add_error(
-                        esc_html__('First Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-                case 'lname':
-                    EE_Error::add_error(
-                        esc_html__('Last Name is a required value.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-                case 'email':
-                    EE_Error::add_error(
-                        esc_html__('Please enter a valid email address.', 'event_espresso'),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                    break;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     *    _associate_attendee_with_registration
-     *
-     * @param EE_Registration $registration
-     * @param EE_Attendee     $attendee
-     * @return void
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee)
-    {
-        // add relation to attendee
-        $registration->_add_relation_to($attendee, 'Attendee');
-        $registration->set_attendee_id($attendee->ID());
-        $registration->update_cache_after_object_save('Attendee', $attendee);
-    }
-
-
-    /**
-     *    _associate_registration_with_transaction
-     *
-     * @param EE_Registration $registration
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _associate_registration_with_transaction(EE_Registration $registration)
-    {
-        // add relation to registration
-        $this->checkout->transaction->_add_relation_to($registration, 'Registration');
-        $this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
-    }
-
-
-    /**
-     *    _copy_critical_attendee_details_from_primary_registrant
-     *    ensures that all attendees at least have data for first name, last name, and email address
-     *
-     * @param array $attendee_data
-     * @return array
-     * @throws \EE_Error
-     */
-    private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array())
-    {
-        // bare minimum critical details include first name, last name, email address
-        $critical_attendee_details = array('ATT_fname', 'ATT_lname', 'ATT_email');
-        // add address info to critical details?
-        if (apply_filters(
-            'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
-            false
-        )) {
-            $address_details           = array(
-                'ATT_address',
-                'ATT_address2',
-                'ATT_city',
-                'STA_ID',
-                'CNT_ISO',
-                'ATT_zip',
-                'ATT_phone',
-            );
-            $critical_attendee_details = array_merge($critical_attendee_details, $address_details);
-        }
-        foreach ($critical_attendee_details as $critical_attendee_detail) {
-            if (! isset($attendee_data[$critical_attendee_detail])
-                || empty($attendee_data[$critical_attendee_detail])
-            ) {
-                $attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(
-                    $critical_attendee_detail
-                );
-            }
-        }
-        return $attendee_data;
-    }
-
-
-    /**
-     *    update_reg_step
-     *    this is the final step after a user  revisits the site to edit their attendee information
-     *    this gets called AFTER the process_reg_step() method above
-     *
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function update_reg_step()
-    {
-        // save everything
-        if ($this->process_reg_step()) {
-            $this->checkout->redirect     = true;
-            $this->checkout->redirect_url = add_query_arg(
-                array(
-                    'e_reg_url_link' => $this->checkout->reg_url_link,
-                    'revisit'        => true,
-                ),
-                $this->checkout->thank_you_page_url
-            );
-            $this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
-            return true;
-        }
-        return false;
-    }
+		$answer_cache_id = $this->checkout->reg_url_link
+			? $form_input . '-' . $registration->reg_url_link()
+			: $form_input;
+		$answer_is_obj   = isset($this->_registration_answers[$answer_cache_id])
+						   && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
+			? true
+			: false;
+		//rename form_inputs if they are EE_Attendee properties
+		switch ((string) $form_input) {
+			case 'state':
+			case 'STA_ID':
+				$attendee_property = true;
+				$form_input        = 'STA_ID';
+				break;
+
+			case 'country':
+			case 'CNT_ISO':
+				$attendee_property = true;
+				$form_input        = 'CNT_ISO';
+				break;
+
+			default:
+				$ATT_input = 'ATT_' . $form_input;
+				//EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
+				$attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
+				$form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
+		}
+		// EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
+		// EEH_Debug_Tools::printr( $answer_is_obj, '$answer_is_obj', __FILE__, __LINE__ );
+		// if this form input has a corresponding attendee property
+		if ($attendee_property) {
+			$this->_attendee_data[$registration->reg_url_link()][$form_input] = $input_value;
+			if ($answer_is_obj) {
+				// and delete the corresponding answer since we won't be storing this data in that object
+				$registration->_remove_relation_to($this->_registration_answers[$answer_cache_id], 'Answer');
+				$this->_registration_answers[$answer_cache_id]->delete_permanently();
+			}
+			return true;
+		} elseif ($answer_is_obj) {
+			// save this data to the answer object
+			$this->_registration_answers[$answer_cache_id]->set_value($input_value);
+			$result = $this->_registration_answers[$answer_cache_id]->save();
+			return $result !== false ? true : false;
+		} else {
+			foreach ($this->_registration_answers as $answer) {
+				if ($answer instanceof EE_Answer && $answer->question_ID() === $answer_cache_id) {
+					$answer->set_value($input_value);
+					$result = $answer->save();
+					return $result !== false ? true : false;
+				}
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 *    _verify_critical_attendee_details_are_set
+	 *
+	 * @param string $form_input
+	 * @param string $input_value
+	 * @return boolean
+	 */
+	private function _verify_critical_attendee_details_are_set_and_validate_email(
+		$form_input = '',
+		$input_value = ''
+	) {
+		if (empty($input_value)) {
+			// if the form input isn't marked as being required, then just return
+			if (! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
+				return true;
+			}
+			switch ($form_input) {
+				case 'fname':
+					EE_Error::add_error(
+						esc_html__('First Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+				case 'lname':
+					EE_Error::add_error(
+						esc_html__('Last Name is a required value.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+				case 'email':
+					EE_Error::add_error(
+						esc_html__('Please enter a valid email address.', 'event_espresso'),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+					break;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 *    _associate_attendee_with_registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Attendee     $attendee
+	 * @return void
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	private function _associate_attendee_with_registration(EE_Registration $registration, EE_Attendee $attendee)
+	{
+		// add relation to attendee
+		$registration->_add_relation_to($attendee, 'Attendee');
+		$registration->set_attendee_id($attendee->ID());
+		$registration->update_cache_after_object_save('Attendee', $attendee);
+	}
+
+
+	/**
+	 *    _associate_registration_with_transaction
+	 *
+	 * @param EE_Registration $registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _associate_registration_with_transaction(EE_Registration $registration)
+	{
+		// add relation to registration
+		$this->checkout->transaction->_add_relation_to($registration, 'Registration');
+		$this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
+	}
+
+
+	/**
+	 *    _copy_critical_attendee_details_from_primary_registrant
+	 *    ensures that all attendees at least have data for first name, last name, and email address
+	 *
+	 * @param array $attendee_data
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	private function _copy_critical_attendee_details_from_primary_registrant($attendee_data = array())
+	{
+		// bare minimum critical details include first name, last name, email address
+		$critical_attendee_details = array('ATT_fname', 'ATT_lname', 'ATT_email');
+		// add address info to critical details?
+		if (apply_filters(
+			'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
+			false
+		)) {
+			$address_details           = array(
+				'ATT_address',
+				'ATT_address2',
+				'ATT_city',
+				'STA_ID',
+				'CNT_ISO',
+				'ATT_zip',
+				'ATT_phone',
+			);
+			$critical_attendee_details = array_merge($critical_attendee_details, $address_details);
+		}
+		foreach ($critical_attendee_details as $critical_attendee_detail) {
+			if (! isset($attendee_data[$critical_attendee_detail])
+				|| empty($attendee_data[$critical_attendee_detail])
+			) {
+				$attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(
+					$critical_attendee_detail
+				);
+			}
+		}
+		return $attendee_data;
+	}
+
+
+	/**
+	 *    update_reg_step
+	 *    this is the final step after a user  revisits the site to edit their attendee information
+	 *    this gets called AFTER the process_reg_step() method above
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function update_reg_step()
+	{
+		// save everything
+		if ($this->process_reg_step()) {
+			$this->checkout->redirect     = true;
+			$this->checkout->redirect_url = add_query_arg(
+				array(
+					'e_reg_url_link' => $this->checkout->reg_url_link,
+					'revisit'        => true,
+				),
+				$this->checkout->thank_you_page_url
+			);
+			$this->checkout->json_response->set_redirect_url($this->checkout->redirect_url);
+			return true;
+		}
+		return false;
+	}
 }

Spacing +50 added lines, -51 removed lines

@@ -48,7 +48,7 @@ 
     {
         $this->_slug     = 'attendee_information';
         $this->_name     = esc_html__('Attendee Information', 'event_espresso');
-        $this->_template = SPCO_REG_STEPS_PATH . $this->_slug . DS . 'attendee_info_main.template.php';
+        $this->_template = SPCO_REG_STEPS_PATH.$this->_slug.DS.'attendee_info_main.template.php';
         $this->checkout  = $checkout;
         $this->_reset_success_message();
         $this->set_instructions(
@@ -59,11 +59,11 @@ 
 
     public function translate_js_strings()
     {
-        EE_Registry::$i18n_js_strings['required_field']            = esc_html__(
+        EE_Registry::$i18n_js_strings['required_field'] = esc_html__(
             ' is a required question.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['required_multi_field']      = esc_html__(
+        EE_Registry::$i18n_js_strings['required_multi_field'] = esc_html__(
             ' is a required question. Please enter a value for at least one of the options.',
             'event_espresso'
         );
@@ -71,18 +71,18 @@ 
             'Please answer all required questions correctly before proceeding.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['attendee_info_copied']      = sprintf(
+        EE_Registry::$i18n_js_strings['attendee_info_copied'] = sprintf(
             esc_html__(
                 'The attendee information was successfully copied.%sPlease ensure the rest of the registration form is completed before proceeding.',
                 'event_espresso'
             ),
             '<br/>'
         );
-        EE_Registry::$i18n_js_strings['attendee_info_copy_error']  = esc_html__(
+        EE_Registry::$i18n_js_strings['attendee_info_copy_error'] = esc_html__(
             'An unknown error occurred on the server while attempting to copy the attendee information. Please refresh the page and try again.',
             'event_espresso'
         );
-        EE_Registry::$i18n_js_strings['enter_valid_email']         = esc_html__(
+        EE_Registry::$i18n_js_strings['enter_valid_email'] = esc_html__(
             'You must enter a valid email address.',
             'event_espresso'
         );
@@ -145,7 +145,7 @@ 
                     && $this->checkout->visit_allows_processing_of_this_registration($registration)
                 ) {
                     $subsections[$registration->reg_url_link()] = $this->_registrations_reg_form($registration);
-                    if (! $this->checkout->admin_request) {
+                    if ( ! $this->checkout->admin_request) {
                         $template_args['registrations'][$registration->reg_url_link()]    = $registration;
                         $template_args['ticket_count'][$registration->ticket()->ID()]     = isset(
                             $template_args['ticket_count'][$registration->ticket()->ID()]
@@ -194,8 +194,7 @@ 
                 'html_id'         => $this->reg_form_name(),
                 'subsections'     => $subsections,
                 'layout_strategy' => $this->checkout->admin_request ?
-                    new EE_Div_Per_Section_Layout() :
-                    new EE_Template_Layout(
+                    new EE_Div_Per_Section_Layout() : new EE_Template_Layout(
                         array(
                             'layout_template_file' => $this->_template, // layout_template
                             'template_args'        => $template_args,
@@ -238,7 +237,7 @@ 
             if ($question_groups) {
                 // array of params to pass to parent constructor
                 $form_args = array(
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+                    'html_id'         => 'ee-registration-'.$registration->reg_url_link(),
                     'html_class'      => 'ee-reg-form-attendee-dv',
                     'html_style'      => $this->checkout->admin_request
                         ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
@@ -294,7 +293,7 @@ 
         // generate hidden input
         return new EE_Hidden_Input(
             array(
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+                'html_id' => 'additional-attendee-reg-info-'.$registration->reg_url_link(),
                 'default' => $additional_attendee_reg_info,
             )
         );
@@ -314,11 +313,11 @@ 
     {
         // array of params to pass to parent constructor
         $form_args = array(
-            'html_id'         => 'ee-reg-form-qstn-grp-' . $question_group->identifier(),
+            'html_id'         => 'ee-reg-form-qstn-grp-'.$question_group->identifier(),
             'html_class'      => $this->checkout->admin_request
                 ? 'form-table ee-reg-form-qstn-grp-dv'
                 : 'ee-reg-form-qstn-grp-dv',
-            'html_label_id'   => 'ee-reg-form-qstn-grp-' . $question_group->identifier() . '-lbl',
+            'html_label_id'   => 'ee-reg-form-qstn-grp-'.$question_group->identifier().'-lbl',
             'subsections'     => array(
                 'reg_form_qstn_grp_hdr' => $this->_question_group_header($question_group),
             ),
@@ -329,7 +328,7 @@ 
         // where params
         $query_params = array('QST_deleted' => 0);
         // don't load admin only questions on the frontend
-        if (! $this->checkout->admin_request) {
+        if ( ! $this->checkout->admin_request) {
             $query_params['QST_admin_only'] = array('!=', true);
         }
         $questions = $question_group->get_many_related(
@@ -473,7 +472,7 @@ 
     {
         return new EE_Form_Section_HTML(
             EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $this->_slug . DS . '_auto_copy_attendee_info.template.php',
+                SPCO_REG_STEPS_PATH.$this->_slug.DS.'_auto_copy_attendee_info.template.php',
                 apply_filters(
                     'FHEE__EE_SPCO_Reg_Step_Attendee_Information__auto_copy_attendee_info__template_args',
                     array()
@@ -505,16 +504,16 @@ 
                 if ($registration->ticket()->ID() !== $prev_ticket) {
                     $item_name = $registration->ticket()->name();
                     $item_name .= $registration->ticket()->description() !== ''
-                        ? ' - ' . $registration->ticket()->description()
+                        ? ' - '.$registration->ticket()->description()
                         : '';
-                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-' . $registration->ticket()->ID() . ']'] =
+                    $copy_attendee_info_inputs['spco_copy_attendee_chk[ticket-'.$registration->ticket()->ID().']'] =
                         new EE_Form_Section_HTML(
-                            '<h6 class="spco-copy-attendee-event-hdr">' . $item_name . '</h6>'
+                            '<h6 class="spco-copy-attendee-event-hdr">'.$item_name.'</h6>'
                         );
                     $prev_ticket = $registration->ticket()->ID();
                 }
 
-                $copy_attendee_info_inputs['spco_copy_attendee_chk[' . $registration->ID() . ']'] =
+                $copy_attendee_info_inputs['spco_copy_attendee_chk['.$registration->ID().']'] =
                     new EE_Checkbox_Multi_Input(
                         array(
                             $registration->ID() => sprintf(
@@ -523,7 +522,7 @@ 
                             ),
                         ),
                         array(
-                            'html_id'                 => 'spco-copy-attendee-chk-' . $registration->reg_url_link(),
+                            'html_id'                 => 'spco-copy-attendee-chk-'.$registration->reg_url_link(),
                             'html_class'              => 'spco-copy-attendee-chk ee-do-not-validate',
                             'display_html_label_text' => false,
                         )
@@ -572,7 +571,7 @@ 
             $registration,
             $question->system_ID()
         );
-        $answer       = $answer_value === null
+        $answer = $answer_value === null
             ? EEM_Answer::instance()->get_one(
                 array(array('QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()))
             )
@@ -589,14 +588,14 @@ 
         }
         // verify instance
         if ($answer instanceof EE_Answer) {
-            if (! empty($answer_value)) {
+            if ( ! empty($answer_value)) {
                 $answer->set('ANS_value', $answer_value);
             }
             $answer->cache('Question', $question);
             //remember system ID had a bug where sometimes it could be null
             $answer_cache_id = $question->is_system_question()
-                ? $question->system_ID() . '-' . $registration->reg_url_link()
-                : $question->ID() . '-' . $registration->reg_url_link();
+                ? $question->system_ID().'-'.$registration->reg_url_link()
+                : $question->ID().'-'.$registration->reg_url_link();
             $registration->cache('Answer', $answer, $answer_cache_id);
         }
         return $this->_generate_question_input($registration, $question, $answer);
@@ -628,18 +627,18 @@ 
             10,
             4
         );
-        $input_constructor_args                  = array(
-            'html_name'        => 'ee_reg_qstn[' . $registration->ID() . '][' . $identifier . ']',
-            'html_id'          => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
-            'html_class'       => 'ee-reg-qstn ee-reg-qstn-' . $identifier,
-            'html_label_id'    => 'ee_reg_qstn-' . $registration->ID() . '-' . $identifier,
+        $input_constructor_args = array(
+            'html_name'        => 'ee_reg_qstn['.$registration->ID().']['.$identifier.']',
+            'html_id'          => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
+            'html_class'       => 'ee-reg-qstn ee-reg-qstn-'.$identifier,
+            'html_label_id'    => 'ee_reg_qstn-'.$registration->ID().'-'.$identifier,
             'html_label_class' => 'ee-reg-qstn',
         );
         $input_constructor_args['html_label_id'] .= '-lbl';
         if ($answer instanceof EE_Answer && $answer->ID()) {
-            $input_constructor_args['html_name']     .= '[' . $answer->ID() . ']';
-            $input_constructor_args['html_id']       .= '-' . $answer->ID();
-            $input_constructor_args['html_label_id'] .= '-' . $answer->ID();
+            $input_constructor_args['html_name']     .= '['.$answer->ID().']';
+            $input_constructor_args['html_id']       .= '-'.$answer->ID();
+            $input_constructor_args['html_label_id'] .= '-'.$answer->ID();
         }
         $form_input = $question->generate_form_input(
             $registration,
@@ -682,7 +681,7 @@ 
         $countries = $this->checkout->action === 'process_reg_step'
             ? EEM_Country::instance()->get_all_countries()
             : EEM_Country::instance()->get_all_active_countries();
-        if (! empty($countries)) {
+        if ( ! empty($countries)) {
             foreach ($countries as $country) {
                 if ($country instanceof EE_Country) {
                     $country_options[$country->ID()] = $country->name();
@@ -732,7 +731,7 @@ 
         $states        = $this->checkout->action === 'process_reg_step'
             ? EEM_State::instance()->get_all_states()
             : EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
+        if ( ! empty($states)) {
             foreach ($states as $state) {
                 if ($state instanceof EE_State) {
                     $state_options[$state->country()->name()][$state->ID()] = $state->name();
@@ -784,7 +783,7 @@ 
             );
             return false;
         }
-        if (! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
+        if ( ! $this->checkout->transaction instanceof EE_Transaction || ! $this->checkout->continue_reg) {
             EE_Error::add_error(
                 esc_html__(
                     'A valid transaction could not be initiated for processing your registrations.',
@@ -803,7 +802,7 @@ 
             //combine the old translated string with a new one, in order to not break translations
 
             // @codingStandardsIgnoreStart
-            $error_message = esc_html__( 'Your form data could not be applied to any valid registrations.', 'event_espresso' )
+            $error_message = esc_html__('Your form data could not be applied to any valid registrations.', 'event_espresso')
                              . sprintf(
                                  esc_html__('%3$sThis can sometimes happen if too much time has been taken to complete the registration process.%3$sPlease return to the %1$sEvent List%2$s and reselect your tickets. If the problem continues, please contact the site administrator.', 'event_espresso'),
                                  '<a href="'
@@ -831,7 +830,7 @@ 
         if ($registrations_processed === false) {
             // but return immediately if the previous step exited early due to errors
             return false;
-        } elseif (! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
+        } elseif ( ! $this->checkout->revisit && $registrations_processed !== $this->checkout->total_ticket_count) {
             // generate a correctly translated string for all possible singular/plural combinations
             if ($this->checkout->total_ticket_count === 1 && $registrations_processed !== 1) {
                 $error_msg = sprintf(
@@ -912,7 +911,7 @@ 
         // grab the saved registrations from the transaction
         foreach ($registrations as $registration) {
             // verify EE_Registration object
-            if (! $registration instanceof EE_Registration) {
+            if ( ! $registration instanceof EE_Registration) {
                 EE_Error::add_error(
                     esc_html__(
                         'An invalid Registration object was discovered when attempting to process your registration information.',
@@ -927,12 +926,12 @@ 
             /** @var string $reg_url_link */
             $reg_url_link = $registration->reg_url_link();
             // reg_url_link exists ?
-            if (! empty($reg_url_link)) {
+            if ( ! empty($reg_url_link)) {
                 // should this registration be processed during this visit ?
                 if ($this->checkout->visit_allows_processing_of_this_registration($registration)) {
                     // if NOT revisiting, then let's save the registration now,
                     // so that we have a REG_ID to use when generating other objects
-                    if (! $this->checkout->revisit) {
+                    if ( ! $this->checkout->revisit) {
                         $registration->save();
                     }
                     /**
@@ -967,7 +966,7 @@ 
                             ? true
                             : false;
                         // filter form input data for this registration
-                        $valid_data[$reg_url_link] = (array)apply_filters(
+                        $valid_data[$reg_url_link] = (array) apply_filters(
                             'FHEE__EE_Single_Page_Checkout__process_attendee_information__valid_data_line_item',
                             $valid_data[$reg_url_link]
                         );
@@ -979,11 +978,11 @@ 
                         }
                         // now loop through our array of valid post data && process attendee reg forms
                         foreach ($valid_data[$reg_url_link] as $form_section => $form_inputs) {
-                            if (! in_array($form_section, $non_input_form_sections)) {
+                            if ( ! in_array($form_section, $non_input_form_sections)) {
                                 foreach ($form_inputs as $form_input => $input_value) {
                                     // \EEH_Debug_Tools::printr( $input_value, $form_input, __FILE__, __LINE__ );
                                     // check for critical inputs
-                                    if (! $this->_verify_critical_attendee_details_are_set_and_validate_email(
+                                    if ( ! $this->_verify_critical_attendee_details_are_set_and_validate_email(
                                         $form_input,
                                         $input_value
                                     )
@@ -1003,7 +1002,7 @@ 
                                         $input_value = $primary_registrant[$form_input];
                                     }
                                     // now attempt to save the input data
-                                    if (! $this->_save_registration_form_input(
+                                    if ( ! $this->_save_registration_form_input(
                                         $registration,
                                         $form_input,
                                         $input_value
@@ -1059,7 +1058,7 @@ 
                     // add relation to registration, set attendee ID, and cache attendee
                     $this->_associate_attendee_with_registration($registration, $attendee);
                     // \EEH_Debug_Tools::printr( $registration, '$registration', __FILE__, __LINE__ );
-                    if (! $registration->attendee() instanceof EE_Attendee) {
+                    if ( ! $registration->attendee() instanceof EE_Attendee) {
                         EE_Error::add_error(
                             sprintf(
                                 esc_html__(
@@ -1154,7 +1153,7 @@ 
          * @see https://events.codebasehq.com/projects/event-espresso/tickets/10477
          */
         $answer_cache_id = $this->checkout->reg_url_link
-            ? $form_input . '-' . $registration->reg_url_link()
+            ? $form_input.'-'.$registration->reg_url_link()
             : $form_input;
         $answer_is_obj   = isset($this->_registration_answers[$answer_cache_id])
                            && $this->_registration_answers[$answer_cache_id] instanceof EE_Answer
@@ -1175,10 +1174,10 @@ 
                 break;
 
             default:
-                $ATT_input = 'ATT_' . $form_input;
+                $ATT_input = 'ATT_'.$form_input;
                 //EEH_Debug_Tools::printr( $ATT_input, '$ATT_input', __FILE__, __LINE__ );
                 $attendee_property = EEM_Attendee::instance()->has_field($ATT_input) ? true : false;
-                $form_input        = $attendee_property ? 'ATT_' . $form_input : $form_input;
+                $form_input        = $attendee_property ? 'ATT_'.$form_input : $form_input;
         }
         // EEH_Debug_Tools::printr( $answer_cache_id, '$answer_cache_id', __FILE__, __LINE__ );
         // EEH_Debug_Tools::printr( $attendee_property, '$attendee_property', __FILE__, __LINE__ );
@@ -1223,7 +1222,7 @@ 
     ) {
         if (empty($input_value)) {
             // if the form input isn't marked as being required, then just return
-            if (! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
+            if ( ! isset($this->_required_questions[$form_input]) || ! $this->_required_questions[$form_input]) {
                 return true;
             }
             switch ($form_input) {
@@ -1310,7 +1309,7 @@ 
             'FHEE__EE_SPCO_Reg_Step_Attendee_Information__merge_address_details_with_critical_attendee_details',
             false
         )) {
-            $address_details           = array(
+            $address_details = array(
                 'ATT_address',
                 'ATT_address2',
                 'ATT_city',
@@ -1322,7 +1321,7 @@ 
             $critical_attendee_details = array_merge($critical_attendee_details, $address_details);
         }
         foreach ($critical_attendee_details as $critical_attendee_detail) {
-            if (! isset($attendee_data[$critical_attendee_detail])
+            if ( ! isset($attendee_data[$critical_attendee_detail])
                 || empty($attendee_data[$critical_attendee_detail])
             ) {
                 $attendee_data[$critical_attendee_detail] = $this->checkout->primary_attendee_obj->get(