eventespresso / event-espresso-core

core/exceptions/InvalidEntityException.php

Indentation +27 added lines, -27 removed lines

@@ -3,7 +3,7 @@ 
 namespace EventEspresso\core\exceptions;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -18,32 +18,32 @@ 
 class InvalidEntityException extends \InvalidArgumentException
 {
 
-    /**
-     * InvalidInterfaceException constructor.
-     *
-     * @param string     $actual   classname of what we got
-     * @param string     $expected classname of the entity we wanted
-     * @param string     $message
-     * @param int        $code
-     * @param \Exception $previous
-     */
-    public function __construct($actual, $expected, $message = '', $code = 0, \Exception $previous = null)
-    {
-        if (empty($message)) {
-            $message = sprintf(
-                __(
-                    'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
-                    'event_espresso'
-                ),
-                is_object($actual)
-                    ? get_class($actual)
-                    : gettype($actual),
-                $expected,
-                var_export($actual, true)
-            );
-        }
-        parent::__construct($message, $code, $previous);
-    }
+	/**
+	 * InvalidInterfaceException constructor.
+	 *
+	 * @param string     $actual   classname of what we got
+	 * @param string     $expected classname of the entity we wanted
+	 * @param string     $message
+	 * @param int        $code
+	 * @param \Exception $previous
+	 */
+	public function __construct($actual, $expected, $message = '', $code = 0, \Exception $previous = null)
+	{
+		if (empty($message)) {
+			$message = sprintf(
+				__(
+					'The supplied entity is an instance of "%1$s", but an instance of "%2$s" was expected. Object: %3$s',
+					'event_espresso'
+				),
+				is_object($actual)
+					? get_class($actual)
+					: gettype($actual),
+				$expected,
+				var_export($actual, true)
+			);
+		}
+		parent::__construct($message, $code, $previous);
+	}
 
 }
 // End of file InvalidEntityException.php

Spacing +1 added lines, -1 removed lines

@@ -2,7 +2,7 @@
 
 namespace EventEspresso\core\exceptions;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

core/libraries/form_sections/inputs/EE_Email_Input.input.php

Spacing +8 added lines, -8 removed lines

@@ -6,22 +6,22 @@
  * @subpackage
  * @author				Mike Nelson
  */
-class EE_Email_Input extends EE_Form_Input_Base{
+class EE_Email_Input extends EE_Form_Input_Base {
 
 	/**
 	 * @param array $input_settings
 	 */
-	public function __construct( $input_settings = array() ){
-		$this->_set_display_strategy( new EE_Text_Input_Display_Strategy('email') );
-		$this->_set_normalization_strategy( new EE_Text_Normalization() );
+	public function __construct($input_settings = array()) {
+		$this->_set_display_strategy(new EE_Text_Input_Display_Strategy('email'));
+		$this->_set_normalization_strategy(new EE_Text_Normalization());
 		$this->_add_validation_strategy(
 			new EE_Email_Validation_Strategy(
-				isset( $input_settings[ 'validation_error_message' ] )
-					? $input_settings[ 'validation_error_message' ]
+				isset($input_settings['validation_error_message'])
+					? $input_settings['validation_error_message']
 					: NULL
 			)
 		);
-		parent::__construct( $input_settings );
-		$this->set_html_class( $this->html_class() . ' email' );
+		parent::__construct($input_settings);
+		$this->set_html_class($this->html_class().' email');
 	}
 }

admin_pages/transactions/EE_Admin_Transactions_List_Table.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -102,7 +102,7 @@ 
      *
      * @abstract
      * @access protected
-     * @return array
+     * @return string[]
      */
     protected function _get_table_filters()
     {
@@ -265,7 +265,7 @@ 
      *    column_TXN_paid
      *
      * @param \EE_Transaction $transaction
-     * @return mixed|string
+     * @return string
      * @throws \EE_Error
      */
     public function column_TXN_paid(EE_Transaction $transaction)

Indentation +606 added lines, -606 removed lines

@@ -13,114 +13,114 @@ 
 class EE_Admin_Transactions_List_Table extends EE_Admin_List_Table
 {
 
-    private $_status;
-
-
-    /**
-     * @param \Transactions_Admin_Page $admin_page
-     */
-    public function __construct(\Transactions_Admin_Page $admin_page)
-    {
-        parent::__construct($admin_page);
-        $this->_status = $this->_admin_page->get_transaction_status_array();
-    }
-
-
-    /**
-     *_setup_data
-     */
-    protected function _setup_data()
-    {
-        $this->_data           = $this->_admin_page->get_transactions($this->_per_page);
-        $status                = ! empty($this->_req_data['status']) ? $this->_req_data['status'] : 'all';
-        $this->_all_data_count = $this->_admin_page->get_transactions($this->_per_page, true, $status);
-    }
-
-
-    /**
-     *_set_properties
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => __('transaction', 'event_espresso'),
-            'plural'   => __('transactions', 'event_espresso'),
-            'ajax'     => true,
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $ID_column_name      = __('ID', 'event_espresso');
-        $ID_column_name      .= ' : <span class="show-on-mobile-view-only" style="float:none">';
-        $ID_column_name      .= __('Transaction Date', 'event_espresso');
-        $ID_column_name      .= '</span> ';
-        $this->_columns      = array(
-            'TXN_ID'        => $ID_column_name,
-            'TXN_timestamp' => __('Transaction Date', 'event_espresso'),
-            'TXN_total'     => __('Total', 'event_espresso'),
-            'TXN_paid'      => __('Paid', 'event_espresso'),
-            'ATT_fname'     => __('Primary Registrant', 'event_espresso'),
-            'event_name'    => __('Event', 'event_espresso'),
-            'actions'       => __('Actions', 'event_espresso'),
-        );
-
-        $this->_sortable_columns = array(
-            'TXN_ID'        => array('TXN_ID' => false),
-            'event_name'    => array('event_name' => false),
-            'ATT_fname'     => array('ATT_fname' => false),
-            'TXN_timestamp' => array('TXN_timestamp' => true) //true means its already sorted
-        );
-
-        $this->_primary_column = 'TXN_ID';
-
-        $this->_hidden_columns = array();
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param  EE_Transaction $transaction the current item
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_row_class($transaction)
-    {
-        $class = parent::_get_row_class($transaction);
-        //add status class
-        $class .= ' ee-status-strip txn-status-' . $transaction->status_ID();
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * get's shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        $filters    = array();
-        $start_date = isset($this->_req_data['txn-filter-start-date'])
-            ? wp_strip_all_tags($this->_req_data['txn-filter-start-date'])
-            : date(
-                'm/d/Y',
-                strtotime('-10 year')
-            );
-        $end_date   = isset($this->_req_data['txn-filter-end-date'])
-            ? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
-            : date(
-                'm/d/Y',
-                current_time('timestamp')
-            );
-        ob_start();
-        ?>
+	private $_status;
+
+
+	/**
+	 * @param \Transactions_Admin_Page $admin_page
+	 */
+	public function __construct(\Transactions_Admin_Page $admin_page)
+	{
+		parent::__construct($admin_page);
+		$this->_status = $this->_admin_page->get_transaction_status_array();
+	}
+
+
+	/**
+	 *_setup_data
+	 */
+	protected function _setup_data()
+	{
+		$this->_data           = $this->_admin_page->get_transactions($this->_per_page);
+		$status                = ! empty($this->_req_data['status']) ? $this->_req_data['status'] : 'all';
+		$this->_all_data_count = $this->_admin_page->get_transactions($this->_per_page, true, $status);
+	}
+
+
+	/**
+	 *_set_properties
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => __('transaction', 'event_espresso'),
+			'plural'   => __('transactions', 'event_espresso'),
+			'ajax'     => true,
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$ID_column_name      = __('ID', 'event_espresso');
+		$ID_column_name      .= ' : <span class="show-on-mobile-view-only" style="float:none">';
+		$ID_column_name      .= __('Transaction Date', 'event_espresso');
+		$ID_column_name      .= '</span> ';
+		$this->_columns      = array(
+			'TXN_ID'        => $ID_column_name,
+			'TXN_timestamp' => __('Transaction Date', 'event_espresso'),
+			'TXN_total'     => __('Total', 'event_espresso'),
+			'TXN_paid'      => __('Paid', 'event_espresso'),
+			'ATT_fname'     => __('Primary Registrant', 'event_espresso'),
+			'event_name'    => __('Event', 'event_espresso'),
+			'actions'       => __('Actions', 'event_espresso'),
+		);
+
+		$this->_sortable_columns = array(
+			'TXN_ID'        => array('TXN_ID' => false),
+			'event_name'    => array('event_name' => false),
+			'ATT_fname'     => array('ATT_fname' => false),
+			'TXN_timestamp' => array('TXN_timestamp' => true) //true means its already sorted
+		);
+
+		$this->_primary_column = 'TXN_ID';
+
+		$this->_hidden_columns = array();
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param  EE_Transaction $transaction the current item
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_row_class($transaction)
+	{
+		$class = parent::_get_row_class($transaction);
+		//add status class
+		$class .= ' ee-status-strip txn-status-' . $transaction->status_ID();
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * get's shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		$filters    = array();
+		$start_date = isset($this->_req_data['txn-filter-start-date'])
+			? wp_strip_all_tags($this->_req_data['txn-filter-start-date'])
+			: date(
+				'm/d/Y',
+				strtotime('-10 year')
+			);
+		$end_date   = isset($this->_req_data['txn-filter-end-date'])
+			? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
+			: date(
+				'm/d/Y',
+				current_time('timestamp')
+			);
+		ob_start();
+		?>
         <label for="txn-filter-start-date">Display Transactions from </label>
         <input id="txn-filter-start-date" class="datepicker" type="text" value="<?php echo $start_date; ?>"
                name="txn-filter-start-date" size="15"/>
@@ -128,534 +128,534 @@ 
         <input id="txn-filter-end-date" class="datepicker" type="text" value="<?php echo $end_date; ?>"
                name="txn-filter-end-date" size="15"/>
         <?php
-        $filters[] = ob_get_contents();
-        ob_end_clean();
-        return $filters;
-    }
-
-
-    /**
-     *_add_view_counts
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count']       = $this->_admin_page->get_transactions($this->_per_page, true, 'all');
-        $this->_views['abandoned']['count'] = $this->_admin_page->get_transactions($this->_per_page, true, 'abandoned');
-        $this->_views['failed']['count']    = $this->_admin_page->get_transactions($this->_per_page, true, 'failed');
-    }
-
-
-    /**
-     *    column TXN_ID
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_ID(EE_Transaction $transaction)
-    {
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'view_transaction',
-            'TXN_ID' => $transaction->ID(),
-        ), TXN_ADMIN_URL);
-        $content      = '<a href="' . $view_lnk_url . '"'
-                        . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">'
-                        . $transaction->ID()
-                        . '</a>';
-
-        //txn timestamp
-        $content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>';
-        return $content;
-    }
-
-
-    /**
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    protected function _get_txn_timestamp(EE_Transaction $transaction)
-    {
-        //txn timestamp
-        // is TXN less than 2 hours old ?
-        if (($transaction->failed() || $transaction->is_abandoned())
-            && (
-                (time() - EE_Registry::instance()->SSN->lifespan()) < $transaction->datetime(false, true)
-            )
-        ) {
-            $timestamp = esc_html__('TXN in progress...', 'event_espresso');
-        } else {
-            $timestamp = $transaction->get_i18n_datetime('TXN_timestamp');
-        }
-        return $timestamp;
-    }
-
-
-    /**
-     *    column_cb
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_cb($transaction)
-    {
-        return sprintf(
-            '<input type="checkbox" name="%1$s[]" value="%2$s" />',
-            $this->_wp_list_args['singular'],
-            $transaction->ID()
-        );
-    }
-
-
-    /**
-     *    column_TXN_timestamp
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_timestamp(EE_Transaction $transaction)
-    {
-        $view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'view_transaction',
-            'TXN_ID' => $transaction->ID(),
-        ), TXN_ADMIN_URL);
-        $txn_date     = '<a href="' . $view_lnk_url . '"'
-                        . ' title="'
-                        . esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">'
-                        . $this->_get_txn_timestamp($transaction)
-                        . '</a>';
-        //status
-        $txn_date .= '<br><span class="ee-status-text-small">'
-                     . EEH_Template::pretty_status(
-                         $transaction->status_ID(),
-                         false,
-                         'sentence'
-                     )
-                     . '</span>';
-        return $txn_date;
-    }
-
-
-    /**
-     *    column_TXN_total
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_TXN_total(EE_Transaction $transaction)
-    {
-        if ($transaction->get('TXN_total') > 0) {
-            return '<span class="txn-pad-rght">'
-                   . apply_filters(
-                       'FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total',
-                       $transaction->get_pretty('TXN_total'),
-                       $transaction
-                   )
-                   . '</span>';
-        } else {
-            return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
-        }
-    }
-
-
-    /**
-     *    column_TXN_paid
-     *
-     * @param \EE_Transaction $transaction
-     * @return mixed|string
-     * @throws \EE_Error
-     */
-    public function column_TXN_paid(EE_Transaction $transaction)
-    {
-        $transaction_total = $transaction->get('TXN_total');
-        $transaction_paid  = $transaction->get('TXN_paid');
-
-        if (\EEH_Money::compare_floats($transaction_total, 0, '>')) {
-            // monies owing
-            $span_class = 'txn-overview-part-payment-spn';
-            if (\EEH_Money::compare_floats($transaction_paid, $transaction_total, '>=')) {
-                // paid in full
-                $span_class = 'txn-overview-full-payment-spn';
-            } elseif (\EEH_Money::compare_floats($transaction_paid, 0, '==')) {
-                // no payments made
-                $span_class = 'txn-overview-no-payment-spn';
-            }
-        } else {
-            $span_class       = 'txn-overview-free-event-spn';
-            $transaction_paid = 0;
-        }
-
-        $payment_method      = $transaction->payment_method();
-        $payment_method_name = $payment_method instanceof EE_Payment_Method
-            ? $payment_method->admin_name()
-            : esc_html__('Unknown', 'event_espresso');
-        $transaction_paid_content = $transaction_paid !== 0 ? $transaction->get_pretty('TXN_paid') : $transaction_paid;
-
-        $content = '<span class="' . $span_class . ' txn-pad-rght">'
-                   . $transaction_paid_content
-                   . '</span>';
-        if ($transaction_paid > 0) {
-            $content .= '<br><span class="ee-status-text-small">'
-                        . sprintf(
-                            esc_html__('...via %s', 'event_espresso'),
-                            $payment_method_name
-                        )
-                        . '</span>';
-        }
-        return $content;
-    }
-
-
-    /**
-     *    column_ATT_fname
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_ATT_fname(EE_Transaction $transaction)
-    {
-        $primary_reg = $transaction->primary_registration();
-        $attendee    = $primary_reg->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            $edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action'  => 'view_registration',
-                '_REG_ID' => $primary_reg->ID(),
-            ), REG_ADMIN_URL);
-            $content      = EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registration',
-                'espresso_registrations_view_registration',
-                $primary_reg->ID()
-            )
-                ? '<a href="' . $edit_lnk_url . '"'
-                    . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
-                    . $attendee->full_name()
-                    . '</a>'
-                : $attendee->full_name();
-            $content      .= '<br>' . $attendee->email();
-            return $content;
-        }
-        return $transaction->failed() || $transaction->is_abandoned()
-            ? esc_html__('no contact record.', 'event_espresso')
-            : esc_html__(
-                'No contact record, because the transaction was abandoned or the registration process failed.',
-                'event_espresso'
-            );
-    }
-
-
-    /**
-     *    column_ATT_email
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_ATT_email(EE_Transaction $transaction)
-    {
-        $attendee = $transaction->primary_registration()->get_first_related('Attendee');
-        if (! empty($attendee)) {
-            return '<a href="mailto:' . $attendee->get('ATT_email') . '">'
-                   . $attendee->get('ATT_email')
-                   . '</a>';
-        } else {
-            return $transaction->failed() || $transaction->is_abandoned()
-                ? esc_html__('no contact record.', 'event_espresso')
-                : esc_html__(
-                    'No contact record, because the transaction was abandoned or the registration process failed.',
-                    'event_espresso'
-                );
-        }
-    }
-
-
-    /**
-     *    column_event_name
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_event_name(EE_Transaction $transaction)
-    {
-        $actions = array();
-        $event   = $transaction->primary_registration()->get_first_related('Event');
-        if (! empty($event)) {
-            $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
-                array('action' => 'edit', 'post' => $event->ID()),
-                EVENTS_ADMIN_URL
-            );
-            $event_name     = $event->get('EVT_name');
-
-            //filter this view by transactions for this event
-            $txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action' => 'default',
-                'EVT_ID' => $event->ID(),
-            ));
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_edit_event',
-                'espresso_events_edit',
-                $event->ID()
-            )) {
-                $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"'
-                        . ' title="' . esc_attr__('Filter transactions by this event', 'event_espresso') . '">'
-                        . esc_html__('View Transactions for this event', 'event_espresso')
-                        . '</a>';
-            }
-
-            return sprintf(
-                '%1$s %2$s',
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_edit_event',
-                    'espresso_events_edit',
-                    $event->ID()
-                )
-                    ? '<a href="' . $edit_event_url . '"'
-                        . ' title="'
-                        . sprintf(
-                            esc_attr__('Edit Event: %s', 'event_espresso'),
-                            $event->get('EVT_name')
-                        )
-                        . '">'
-                        . wp_trim_words(
-                            $event_name,
-                            30,
-                            '...'
-                        )
-                        . '</a>'
-                        : wp_trim_words($event_name, 30, '...'),
-                $this->row_actions($actions)
-            );
-        } else {
-            return esc_html__(
-                'The event associated with this transaction via the primary registration cannot be retrieved.',
-                'event_espresso'
-            );
-        }
-    }
-
-
-    /**
-     *    column_actions
-     *
-     * @param \EE_Transaction $transaction
-     * @return string
-     * @throws \EE_Error
-     */
-    public function column_actions(EE_Transaction $transaction)
-    {
-        return $this->_action_string(
-            $this->get_transaction_details_link($transaction)
-            . $this->get_invoice_link($transaction)
-            . $this->get_receipt_link($transaction)
-            . $this->get_primary_registration_details_link($transaction)
-            . $this->get_send_payment_reminder_trigger_link($transaction)
-            . $this->get_payment_overview_link($transaction)
-            . $this->get_related_messages_link($transaction),
-            $transaction,
-            'ul',
-            'txn-overview-actions-ul'
-        );
-    }
-
-
-    /**
-     * Get the transaction details link.
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_transaction_details_link(EE_Transaction $transaction)
-    {
-        $url          = EE_Admin_Page::add_query_args_and_nonce(array(
-            'action' => 'view_transaction',
-            'TXN_ID' => $transaction->ID(),
-        ), TXN_ADMIN_URL);
-        return '
+		$filters[] = ob_get_contents();
+		ob_end_clean();
+		return $filters;
+	}
+
+
+	/**
+	 *_add_view_counts
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count']       = $this->_admin_page->get_transactions($this->_per_page, true, 'all');
+		$this->_views['abandoned']['count'] = $this->_admin_page->get_transactions($this->_per_page, true, 'abandoned');
+		$this->_views['failed']['count']    = $this->_admin_page->get_transactions($this->_per_page, true, 'failed');
+	}
+
+
+	/**
+	 *    column TXN_ID
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_ID(EE_Transaction $transaction)
+	{
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'view_transaction',
+			'TXN_ID' => $transaction->ID(),
+		), TXN_ADMIN_URL);
+		$content      = '<a href="' . $view_lnk_url . '"'
+						. ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">'
+						. $transaction->ID()
+						. '</a>';
+
+		//txn timestamp
+		$content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>';
+		return $content;
+	}
+
+
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	protected function _get_txn_timestamp(EE_Transaction $transaction)
+	{
+		//txn timestamp
+		// is TXN less than 2 hours old ?
+		if (($transaction->failed() || $transaction->is_abandoned())
+			&& (
+				(time() - EE_Registry::instance()->SSN->lifespan()) < $transaction->datetime(false, true)
+			)
+		) {
+			$timestamp = esc_html__('TXN in progress...', 'event_espresso');
+		} else {
+			$timestamp = $transaction->get_i18n_datetime('TXN_timestamp');
+		}
+		return $timestamp;
+	}
+
+
+	/**
+	 *    column_cb
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_cb($transaction)
+	{
+		return sprintf(
+			'<input type="checkbox" name="%1$s[]" value="%2$s" />',
+			$this->_wp_list_args['singular'],
+			$transaction->ID()
+		);
+	}
+
+
+	/**
+	 *    column_TXN_timestamp
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_timestamp(EE_Transaction $transaction)
+	{
+		$view_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'view_transaction',
+			'TXN_ID' => $transaction->ID(),
+		), TXN_ADMIN_URL);
+		$txn_date     = '<a href="' . $view_lnk_url . '"'
+						. ' title="'
+						. esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">'
+						. $this->_get_txn_timestamp($transaction)
+						. '</a>';
+		//status
+		$txn_date .= '<br><span class="ee-status-text-small">'
+					 . EEH_Template::pretty_status(
+						 $transaction->status_ID(),
+						 false,
+						 'sentence'
+					 )
+					 . '</span>';
+		return $txn_date;
+	}
+
+
+	/**
+	 *    column_TXN_total
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_total(EE_Transaction $transaction)
+	{
+		if ($transaction->get('TXN_total') > 0) {
+			return '<span class="txn-pad-rght">'
+				   . apply_filters(
+					   'FHEE__EE_Admin_Transactions_List_Table__column_TXN_total__TXN_total',
+					   $transaction->get_pretty('TXN_total'),
+					   $transaction
+				   )
+				   . '</span>';
+		} else {
+			return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
+		}
+	}
+
+
+	/**
+	 *    column_TXN_paid
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return mixed|string
+	 * @throws \EE_Error
+	 */
+	public function column_TXN_paid(EE_Transaction $transaction)
+	{
+		$transaction_total = $transaction->get('TXN_total');
+		$transaction_paid  = $transaction->get('TXN_paid');
+
+		if (\EEH_Money::compare_floats($transaction_total, 0, '>')) {
+			// monies owing
+			$span_class = 'txn-overview-part-payment-spn';
+			if (\EEH_Money::compare_floats($transaction_paid, $transaction_total, '>=')) {
+				// paid in full
+				$span_class = 'txn-overview-full-payment-spn';
+			} elseif (\EEH_Money::compare_floats($transaction_paid, 0, '==')) {
+				// no payments made
+				$span_class = 'txn-overview-no-payment-spn';
+			}
+		} else {
+			$span_class       = 'txn-overview-free-event-spn';
+			$transaction_paid = 0;
+		}
+
+		$payment_method      = $transaction->payment_method();
+		$payment_method_name = $payment_method instanceof EE_Payment_Method
+			? $payment_method->admin_name()
+			: esc_html__('Unknown', 'event_espresso');
+		$transaction_paid_content = $transaction_paid !== 0 ? $transaction->get_pretty('TXN_paid') : $transaction_paid;
+
+		$content = '<span class="' . $span_class . ' txn-pad-rght">'
+				   . $transaction_paid_content
+				   . '</span>';
+		if ($transaction_paid > 0) {
+			$content .= '<br><span class="ee-status-text-small">'
+						. sprintf(
+							esc_html__('...via %s', 'event_espresso'),
+							$payment_method_name
+						)
+						. '</span>';
+		}
+		return $content;
+	}
+
+
+	/**
+	 *    column_ATT_fname
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_ATT_fname(EE_Transaction $transaction)
+	{
+		$primary_reg = $transaction->primary_registration();
+		$attendee    = $primary_reg->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			$edit_lnk_url = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action'  => 'view_registration',
+				'_REG_ID' => $primary_reg->ID(),
+			), REG_ADMIN_URL);
+			$content      = EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registration',
+				'espresso_registrations_view_registration',
+				$primary_reg->ID()
+			)
+				? '<a href="' . $edit_lnk_url . '"'
+					. ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+					. $attendee->full_name()
+					. '</a>'
+				: $attendee->full_name();
+			$content      .= '<br>' . $attendee->email();
+			return $content;
+		}
+		return $transaction->failed() || $transaction->is_abandoned()
+			? esc_html__('no contact record.', 'event_espresso')
+			: esc_html__(
+				'No contact record, because the transaction was abandoned or the registration process failed.',
+				'event_espresso'
+			);
+	}
+
+
+	/**
+	 *    column_ATT_email
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_ATT_email(EE_Transaction $transaction)
+	{
+		$attendee = $transaction->primary_registration()->get_first_related('Attendee');
+		if (! empty($attendee)) {
+			return '<a href="mailto:' . $attendee->get('ATT_email') . '">'
+				   . $attendee->get('ATT_email')
+				   . '</a>';
+		} else {
+			return $transaction->failed() || $transaction->is_abandoned()
+				? esc_html__('no contact record.', 'event_espresso')
+				: esc_html__(
+					'No contact record, because the transaction was abandoned or the registration process failed.',
+					'event_espresso'
+				);
+		}
+	}
+
+
+	/**
+	 *    column_event_name
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_event_name(EE_Transaction $transaction)
+	{
+		$actions = array();
+		$event   = $transaction->primary_registration()->get_first_related('Event');
+		if (! empty($event)) {
+			$edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
+				array('action' => 'edit', 'post' => $event->ID()),
+				EVENTS_ADMIN_URL
+			);
+			$event_name     = $event->get('EVT_name');
+
+			//filter this view by transactions for this event
+			$txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action' => 'default',
+				'EVT_ID' => $event->ID(),
+			));
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_edit_event',
+				'espresso_events_edit',
+				$event->ID()
+			)) {
+				$actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"'
+						. ' title="' . esc_attr__('Filter transactions by this event', 'event_espresso') . '">'
+						. esc_html__('View Transactions for this event', 'event_espresso')
+						. '</a>';
+			}
+
+			return sprintf(
+				'%1$s %2$s',
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_edit_event',
+					'espresso_events_edit',
+					$event->ID()
+				)
+					? '<a href="' . $edit_event_url . '"'
+						. ' title="'
+						. sprintf(
+							esc_attr__('Edit Event: %s', 'event_espresso'),
+							$event->get('EVT_name')
+						)
+						. '">'
+						. wp_trim_words(
+							$event_name,
+							30,
+							'...'
+						)
+						. '</a>'
+						: wp_trim_words($event_name, 30, '...'),
+				$this->row_actions($actions)
+			);
+		} else {
+			return esc_html__(
+				'The event associated with this transaction via the primary registration cannot be retrieved.',
+				'event_espresso'
+			);
+		}
+	}
+
+
+	/**
+	 *    column_actions
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function column_actions(EE_Transaction $transaction)
+	{
+		return $this->_action_string(
+			$this->get_transaction_details_link($transaction)
+			. $this->get_invoice_link($transaction)
+			. $this->get_receipt_link($transaction)
+			. $this->get_primary_registration_details_link($transaction)
+			. $this->get_send_payment_reminder_trigger_link($transaction)
+			. $this->get_payment_overview_link($transaction)
+			. $this->get_related_messages_link($transaction),
+			$transaction,
+			'ul',
+			'txn-overview-actions-ul'
+		);
+	}
+
+
+	/**
+	 * Get the transaction details link.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_transaction_details_link(EE_Transaction $transaction)
+	{
+		$url          = EE_Admin_Page::add_query_args_and_nonce(array(
+			'action' => 'view_transaction',
+			'TXN_ID' => $transaction->ID(),
+		), TXN_ADMIN_URL);
+		return '
 			<li>
 				<a href="' . $url . '"'
-                    . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
+					. ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
 					<span class="dashicons dashicons-cart"></span>
 				</a>
 			</li>';
-    }
-
-
-    /**
-     * Get the invoice link for the given registration.
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_invoice_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration) {
-            $url = $registration->invoice_url();
-            //only show invoice link if message type is active.
-            if ($registration->attendee() instanceof EE_Attendee
-                && EEH_MSG_Template::is_mt_active('invoice')
-            ) {
-                return '
+	}
+
+
+	/**
+	 * Get the invoice link for the given registration.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_invoice_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration) {
+			$url = $registration->invoice_url();
+			//only show invoice link if message type is active.
+			if ($registration->attendee() instanceof EE_Attendee
+				&& EEH_MSG_Template::is_mt_active('invoice')
+			) {
+				return '
                 <li>
                     <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso') . '"'
-                       . ' target="_blank" href="' . $url . '" class="tiny-text">
+					   . ' target="_blank" href="' . $url . '" class="tiny-text">
                         <span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span>
                     </a>
                 </li>';
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * Get the receipt link for the transaction.
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_receipt_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration) {
-            $url = $registration->receipt_url();
-            //only show receipt link if message type is active.
-            if ($registration->attendee() instanceof EE_Attendee
-                && EEH_MSG_Template::is_mt_active('receipt')) {
-                return '
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get the receipt link for the transaction.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_receipt_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration) {
+			$url = $registration->receipt_url();
+			//only show receipt link if message type is active.
+			if ($registration->attendee() instanceof EE_Attendee
+				&& EEH_MSG_Template::is_mt_active('receipt')) {
+				return '
 			<li>
 				<a title="' . esc_attr__('View Transaction Receipt', 'event_espresso') . '"'
-                                  . ' target="_blank" href="' . $url . '" class="tiny-text">
+								  . ' target="_blank" href="' . $url . '" class="tiny-text">
 					<span class="dashicons dashicons-media-default ee-icon-size-18"></span>
 				</a>
 			</li>';
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * Get the link to view the details for the primary registration.
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_primary_registration_details_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration) {
-            $url      = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action'  => 'view_registration',
-                '_REG_ID' => $registration->ID(),
-            ), REG_ADMIN_URL);
-            return EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registration',
-                'espresso_registrations_view_registration',
-                $registration->ID()
-            )
-                ? '
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get the link to view the details for the primary registration.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_primary_registration_details_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration) {
+			$url      = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action'  => 'view_registration',
+				'_REG_ID' => $registration->ID(),
+			), REG_ADMIN_URL);
+			return EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registration',
+				'espresso_registrations_view_registration',
+				$registration->ID()
+			)
+				? '
 				<li>
 					<a href="' . $url . '"'
-                  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
+				  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
 						<span class="dashicons dashicons-clipboard"></span>
 					</a>
 				</li>'
-                : '';
-        }
-        return '';
-    }
-
-
-    /**
-     * Get send payment reminder trigger link
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_send_payment_reminder_trigger_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration
-            && $registration->attendee() instanceof EE_Attendee
-            && EEH_MSG_Template::is_mt_active('payment_reminder')
-            && ! in_array(
-                $transaction->status_ID(),
-                array(EEM_Transaction::complete_status_code, EEM_Transaction::overpaid_status_code),
-                true
-            )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_send_message',
-                'espresso_transactions_send_payment_reminder'
-            )
-        ) {
-            $url = EE_Admin_Page::add_query_args_and_nonce(array(
-                'action' => 'send_payment_reminder',
-                'TXN_ID' => $transaction->ID(),
-            ), TXN_ADMIN_URL);
-            return  '
+				: '';
+		}
+		return '';
+	}
+
+
+	/**
+	 * Get send payment reminder trigger link
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_send_payment_reminder_trigger_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration
+			&& $registration->attendee() instanceof EE_Attendee
+			&& EEH_MSG_Template::is_mt_active('payment_reminder')
+			&& ! in_array(
+				$transaction->status_ID(),
+				array(EEM_Transaction::complete_status_code, EEM_Transaction::overpaid_status_code),
+				true
+			)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_send_message',
+				'espresso_transactions_send_payment_reminder'
+			)
+		) {
+			$url = EE_Admin_Page::add_query_args_and_nonce(array(
+				'action' => 'send_payment_reminder',
+				'TXN_ID' => $transaction->ID(),
+			), TXN_ADMIN_URL);
+			return  '
             <li>
                 <a href="' . $url . '"'
-                  . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text">
+				  . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text">
                     <span class="dashicons dashicons-email-alt"></span>
                 </a>
             </li>';
-        }
-        return '';
-    }
-
-
-
-    /**
-     * Get link to filtered view in the message activity list table of messages for this transaction.
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_related_messages_link(EE_Transaction $transaction)
-    {
-        $url = EEH_MSG_Template::get_message_action_link(
-            'see_notifications_for',
-            null,
-            array('TXN_ID' => $transaction->ID())
-        );
-        return EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_global_messages',
-            'view_filtered_messages'
-        )
-            ? '<li>' . $url . '</li>'
-            : '';
-    }
-
-
-    /**
-     * Return the link to make a payment on the frontend
-     * @param EE_Transaction $transaction
-     * @return string
-     * @throws EE_Error
-     */
-    protected function get_payment_overview_link(EE_Transaction $transaction)
-    {
-        $registration = $transaction->primary_registration();
-        if ($registration instanceof EE_Registration
-            && $transaction->status_ID() !== EEM_Transaction::complete_status_code
-            && $registration->owes_monies_and_can_pay()
-        ) {
-            return '
+		}
+		return '';
+	}
+
+
+
+	/**
+	 * Get link to filtered view in the message activity list table of messages for this transaction.
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_related_messages_link(EE_Transaction $transaction)
+	{
+		$url = EEH_MSG_Template::get_message_action_link(
+			'see_notifications_for',
+			null,
+			array('TXN_ID' => $transaction->ID())
+		);
+		return EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_global_messages',
+			'view_filtered_messages'
+		)
+			? '<li>' . $url . '</li>'
+			: '';
+	}
+
+
+	/**
+	 * Return the link to make a payment on the frontend
+	 * @param EE_Transaction $transaction
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function get_payment_overview_link(EE_Transaction $transaction)
+	{
+		$registration = $transaction->primary_registration();
+		if ($registration instanceof EE_Registration
+			&& $transaction->status_ID() !== EEM_Transaction::complete_status_code
+			&& $registration->owes_monies_and_can_pay()
+		) {
+			return '
             <li>
                 <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso') . '"'
-                    . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"'
-                    . ' class="tiny-text">
+					. ' target="_blank" href="' . $registration->payment_overview_url(true) . '"'
+					. ' class="tiny-text">
                     <span class="dashicons dashicons-money ee-icon-size-18"></span>
                 </a>
             </li>
             ';
 
-        }
-        return '';
-    }
+		}
+		return '';
+	}
 }

Spacing +36 added lines, -36 removed lines

@@ -48,11 +48,11 @@ 
             'ajax'     => true,
             'screen'   => $this->_admin_page->get_current_screen()->id,
         );
-        $ID_column_name      = __('ID', 'event_espresso');
+        $ID_column_name = __('ID', 'event_espresso');
         $ID_column_name      .= ' : <span class="show-on-mobile-view-only" style="float:none">';
         $ID_column_name      .= __('Transaction Date', 'event_espresso');
         $ID_column_name      .= '</span> ';
-        $this->_columns      = array(
+        $this->_columns = array(
             'TXN_ID'        => $ID_column_name,
             'TXN_timestamp' => __('Transaction Date', 'event_espresso'),
             'TXN_total'     => __('Total', 'event_espresso'),
@@ -87,7 +87,7 @@ 
     {
         $class = parent::_get_row_class($transaction);
         //add status class
-        $class .= ' ee-status-strip txn-status-' . $transaction->status_ID();
+        $class .= ' ee-status-strip txn-status-'.$transaction->status_ID();
         if ($this->_has_checkbox_column) {
             $class .= ' has-checkbox-column';
         }
@@ -113,7 +113,7 @@ 
                 'm/d/Y',
                 strtotime('-10 year')
             );
-        $end_date   = isset($this->_req_data['txn-filter-end-date'])
+        $end_date = isset($this->_req_data['txn-filter-end-date'])
             ? wp_strip_all_tags($this->_req_data['txn-filter-end-date'])
             : date(
                 'm/d/Y',
@@ -158,13 +158,13 @@ 
             'action' => 'view_transaction',
             'TXN_ID' => $transaction->ID(),
         ), TXN_ADMIN_URL);
-        $content      = '<a href="' . $view_lnk_url . '"'
-                        . ' title="' . esc_attr__('Go to Transaction Details', 'event_espresso') . '">'
+        $content = '<a href="'.$view_lnk_url.'"'
+                        . ' title="'.esc_attr__('Go to Transaction Details', 'event_espresso').'">'
                         . $transaction->ID()
                         . '</a>';
 
         //txn timestamp
-        $content .= '  <span class="show-on-mobile-view-only">' . $this->_get_txn_timestamp($transaction) . '</span>';
+        $content .= '  <span class="show-on-mobile-view-only">'.$this->_get_txn_timestamp($transaction).'</span>';
         return $content;
     }
 
@@ -221,9 +221,9 @@ 
             'action' => 'view_transaction',
             'TXN_ID' => $transaction->ID(),
         ), TXN_ADMIN_URL);
-        $txn_date     = '<a href="' . $view_lnk_url . '"'
+        $txn_date = '<a href="'.$view_lnk_url.'"'
                         . ' title="'
-                        . esc_attr__('View Transaction Details for TXN #', 'event_espresso') . $transaction->ID() . '">'
+                        . esc_attr__('View Transaction Details for TXN #', 'event_espresso').$transaction->ID().'">'
                         . $this->_get_txn_timestamp($transaction)
                         . '</a>';
         //status
@@ -256,7 +256,7 @@ 
                    )
                    . '</span>';
         } else {
-            return '<span class="txn-overview-free-event-spn">' . esc_html__('free', 'event_espresso') . '</span>';
+            return '<span class="txn-overview-free-event-spn">'.esc_html__('free', 'event_espresso').'</span>';
         }
     }
 
@@ -294,7 +294,7 @@ 
             : esc_html__('Unknown', 'event_espresso');
         $transaction_paid_content = $transaction_paid !== 0 ? $transaction->get_pretty('TXN_paid') : $transaction_paid;
 
-        $content = '<span class="' . $span_class . ' txn-pad-rght">'
+        $content = '<span class="'.$span_class.' txn-pad-rght">'
                    . $transaction_paid_content
                    . '</span>';
         if ($transaction_paid > 0) {
@@ -325,17 +325,17 @@ 
                 'action'  => 'view_registration',
                 '_REG_ID' => $primary_reg->ID(),
             ), REG_ADMIN_URL);
-            $content      = EE_Registry::instance()->CAP->current_user_can(
+            $content = EE_Registry::instance()->CAP->current_user_can(
                 'ee_read_registration',
                 'espresso_registrations_view_registration',
                 $primary_reg->ID()
             )
-                ? '<a href="' . $edit_lnk_url . '"'
-                    . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '">'
+                ? '<a href="'.$edit_lnk_url.'"'
+                    . ' title="'.esc_attr__('View Registration Details', 'event_espresso').'">'
                     . $attendee->full_name()
                     . '</a>'
                 : $attendee->full_name();
-            $content      .= '<br>' . $attendee->email();
+            $content .= '<br>'.$attendee->email();
             return $content;
         }
         return $transaction->failed() || $transaction->is_abandoned()
@@ -357,8 +357,8 @@ 
     public function column_ATT_email(EE_Transaction $transaction)
     {
         $attendee = $transaction->primary_registration()->get_first_related('Attendee');
-        if (! empty($attendee)) {
-            return '<a href="mailto:' . $attendee->get('ATT_email') . '">'
+        if ( ! empty($attendee)) {
+            return '<a href="mailto:'.$attendee->get('ATT_email').'">'
                    . $attendee->get('ATT_email')
                    . '</a>';
         } else {
@@ -383,12 +383,12 @@ 
     {
         $actions = array();
         $event   = $transaction->primary_registration()->get_first_related('Event');
-        if (! empty($event)) {
+        if ( ! empty($event)) {
             $edit_event_url = EE_Admin_Page::add_query_args_and_nonce(
                 array('action' => 'edit', 'post' => $event->ID()),
                 EVENTS_ADMIN_URL
             );
-            $event_name     = $event->get('EVT_name');
+            $event_name = $event->get('EVT_name');
 
             //filter this view by transactions for this event
             $txn_by_event_lnk = EE_Admin_Page::add_query_args_and_nonce(array(
@@ -400,8 +400,8 @@ 
                 'espresso_events_edit',
                 $event->ID()
             )) {
-                $actions['filter_by_event'] = '<a href="' . $txn_by_event_lnk . '"'
-                        . ' title="' . esc_attr__('Filter transactions by this event', 'event_espresso') . '">'
+                $actions['filter_by_event'] = '<a href="'.$txn_by_event_lnk.'"'
+                        . ' title="'.esc_attr__('Filter transactions by this event', 'event_espresso').'">'
                         . esc_html__('View Transactions for this event', 'event_espresso')
                         . '</a>';
             }
@@ -413,7 +413,7 @@ 
                     'espresso_events_edit',
                     $event->ID()
                 )
-                    ? '<a href="' . $edit_event_url . '"'
+                    ? '<a href="'.$edit_event_url.'"'
                         . ' title="'
                         . sprintf(
                             esc_attr__('Edit Event: %s', 'event_espresso'),
@@ -470,14 +470,14 @@ 
      */
     protected function get_transaction_details_link(EE_Transaction $transaction)
     {
-        $url          = EE_Admin_Page::add_query_args_and_nonce(array(
+        $url = EE_Admin_Page::add_query_args_and_nonce(array(
             'action' => 'view_transaction',
             'TXN_ID' => $transaction->ID(),
         ), TXN_ADMIN_URL);
         return '
 			<li>
-				<a href="' . $url . '"'
-                    . ' title="' . esc_attr__('View Transaction Details', 'event_espresso') . '" class="tiny-text">
+				<a href="' . $url.'"'
+                    . ' title="'.esc_attr__('View Transaction Details', 'event_espresso').'" class="tiny-text">
 					<span class="dashicons dashicons-cart"></span>
 				</a>
 			</li>';
@@ -501,8 +501,8 @@ 
             ) {
                 return '
                 <li>
-                    <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso') . '"'
-                       . ' target="_blank" href="' . $url . '" class="tiny-text">
+                    <a title="' . esc_attr__('View Transaction Invoice', 'event_espresso').'"'
+                       . ' target="_blank" href="'.$url.'" class="tiny-text">
                         <span class="dashicons dashicons-media-spreadsheet ee-icon-size-18"></span>
                     </a>
                 </li>';
@@ -528,8 +528,8 @@ 
                 && EEH_MSG_Template::is_mt_active('receipt')) {
                 return '
 			<li>
-				<a title="' . esc_attr__('View Transaction Receipt', 'event_espresso') . '"'
-                                  . ' target="_blank" href="' . $url . '" class="tiny-text">
+				<a title="' . esc_attr__('View Transaction Receipt', 'event_espresso').'"'
+                                  . ' target="_blank" href="'.$url.'" class="tiny-text">
 					<span class="dashicons dashicons-media-default ee-icon-size-18"></span>
 				</a>
 			</li>';
@@ -560,8 +560,8 @@ 
             )
                 ? '
 				<li>
-					<a href="' . $url . '"'
-                  . ' title="' . esc_attr__('View Registration Details', 'event_espresso') . '" class="tiny-text">
+					<a href="' . $url.'"'
+                  . ' title="'.esc_attr__('View Registration Details', 'event_espresso').'" class="tiny-text">
 						<span class="dashicons dashicons-clipboard"></span>
 					</a>
 				</li>'
@@ -599,8 +599,8 @@ 
             ), TXN_ADMIN_URL);
             return  '
             <li>
-                <a href="' . $url . '"'
-                  . ' title="' . esc_attr__('Send Payment Reminder', 'event_espresso') . '" class="tiny-text">
+                <a href="' . $url.'"'
+                  . ' title="'.esc_attr__('Send Payment Reminder', 'event_espresso').'" class="tiny-text">
                     <span class="dashicons dashicons-email-alt"></span>
                 </a>
             </li>';
@@ -627,7 +627,7 @@ 
             'ee_read_global_messages',
             'view_filtered_messages'
         )
-            ? '<li>' . $url . '</li>'
+            ? '<li>'.$url.'</li>'
             : '';
     }
 
@@ -647,8 +647,8 @@ 
         ) {
             return '
             <li>
-                <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso') . '"'
-                    . ' target="_blank" href="' . $registration->payment_overview_url(true) . '"'
+                <a title="' . esc_attr__('Make Payment from the Frontend.', 'event_espresso').'"'
+                    . ' target="_blank" href="'.$registration->payment_overview_url(true).'"'
                     . ' class="tiny-text">
                     <span class="dashicons dashicons-money ee-icon-size-18"></span>
                 </a>

core/db_classes/EE_Registration.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -1159,7 +1159,7 @@ 
      * Sets deleted
      *
      * @param boolean $deleted
-     * @return bool
+     * @return boolean|null
      * @throws EE_Error
      * @throws RuntimeException
      */
@@ -1217,6 +1217,7 @@ 
      * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
      * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
      *                                          consider registration status as well as datetime access.
+     * @param integer $DTT_OR_ID
      * @return bool
      * @throws EE_Error
      */
@@ -1387,7 +1388,7 @@ 
      * Returns the latest datetime related to this registration (via the ticket attached to the registration).
      * "Latest" is defined by the `DTT_EVT_start` column.
      *
-     * @return EE_Datetime|null
+     * @return null|EE_Base_Class
      * @throws \EE_Error
      */
     public function get_latest_related_datetime()
@@ -1680,7 +1681,7 @@ 
      * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
      * Note: if there are no payments on the registration there will be no payment method returned.
      *
-     * @return EE_Payment_Method|null
+     * @return null|EE_Base_Class
      */
     public function payment_method()
     {

Indentation +1934 added lines, -1934 removed lines

@@ -18,1940 +18,1940 @@
 {
 
 
-    /**
-     * Used to reference when a registration has never been checked in.
-     *
-     * @deprecated use \EE_Checkin::status_checked_never instead
-     * @type int
-     */
-    const checkin_status_never = 2;
-
-    /**
-     * Used to reference when a registration has been checked in.
-     *
-     * @deprecated use \EE_Checkin::status_checked_in instead
-     * @type int
-     */
-    const checkin_status_in = 1;
-
-
-    /**
-     * Used to reference when a registration has been checked out.
-     *
-     * @deprecated use \EE_Checkin::status_checked_out instead
-     * @type int
-     */
-    const checkin_status_out = 0;
-
-
-    /**
-     * extra meta key for tracking reg status os trashed registrations
-     *
-     * @type string
-     */
-    const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
-
-
-    /**
-     * extra meta key for tracking if registration has reserved ticket
-     *
-     * @type string
-     */
-    const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
-
-
-    /**
-     * @param array  $props_n_values          incoming values
-     * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
-     *                                        used.)
-     * @param array  $date_formats            incoming date_formats in an array where the first value is the
-     *                                        date_format and the second value is the time format
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
-        return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Registration
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     *        Set Event ID
-     *
-     * @param        int $EVT_ID Event ID
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_event($EVT_ID = 0)
-    {
-        $this->set('EVT_ID', $EVT_ID);
-    }
-
-
-    /**
-     * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
-     * be routed to internal methods
-     *
-     * @param string $field_name
-     * @param mixed  $field_value
-     * @param bool   $use_default
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        switch ($field_name) {
-            case 'REG_code':
-                if (! empty($field_value) && $this->reg_code() === null) {
-                    $this->set_reg_code($field_value, $use_default);
-                }
-                break;
-            case 'STS_ID':
-                $this->set_status($field_value, $use_default);
-                break;
-            default:
-                parent::set($field_name, $field_value, $use_default);
-        }
-    }
-
-
-    /**
-     * Set Status ID
-     * updates the registration status and ALSO...
-     * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
-     * calls release_registration_space() if the reg status changes FROM approved to any other reg status
-     *
-     * @param string       $new_STS_ID
-     * @param boolean      $use_default
-     * @param Context|null $context
-     * @return bool
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function set_status($new_STS_ID = null, $use_default = false, Context $context = null)
-    {
-        // get current REG_Status
-        $old_STS_ID = $this->status_ID();
-        // if status has changed
-        if ($old_STS_ID !== $new_STS_ID // and that status has actually changed
-            && ! empty($old_STS_ID) // and that old status is actually set
-            && ! empty($new_STS_ID) // as well as the new status
-            && $this->ID() // ensure registration is in the db
-        ) {
-            // TO approved
-            if ($new_STS_ID === EEM_Registration::status_id_approved) {
-                // reserve a space by incrementing ticket and datetime sold values
-                $this->_reserve_registration_space();
-                do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID, $context);
-                // OR FROM  approved
-            } elseif ($old_STS_ID === EEM_Registration::status_id_approved) {
-                // release a space by decrementing ticket and datetime sold values
-                $this->_release_registration_space();
-                do_action(
-                    'AHEE__EE_Registration__set_status__from_approved',
-                    $this,
-                    $old_STS_ID,
-                    $new_STS_ID,
-                    $context
-                );
-            }
-            // update status
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID, $context);
-            if($this->statusChangeUpdatesTransaction($context)) {
-                $this->updateTransactionAfterStatusChange();
-            }
-            do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID, $context);
-            return true;
-        }
-        //even though the old value matches the new value, it's still good to
-        //allow the parent set method to have a say
-        parent::set('STS_ID', $new_STS_ID, $use_default);
-        return true;
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param string       $new_STS_ID
-     * @param string       $old_STS_ID
-     * @param Context|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID, Context $context = null)
-    {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = EEM_Registration::closed_reg_statuses();
-        // true if registration has been cancelled or declined
-        $this->updateIfCanceled(
-            $closed_reg_statuses,
-            $new_STS_ID,
-            $old_STS_ID,
-            $context
-        );
-        $this->updateIfDeclined(
-            $closed_reg_statuses,
-            $new_STS_ID,
-            $old_STS_ID,
-            $context
-        );
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param array        $closed_reg_statuses
-     * @param string       $new_STS_ID
-     * @param string       $old_STS_ID
-     * @param Context|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function updateIfCanceled(array $closed_reg_statuses, $new_STS_ID, $old_STS_ID, Context $context = null)
-    {
-        // true if registration has been cancelled or declined
-        if (in_array($new_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($old_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // cancelled or declined registration
-            $registration_processor->update_registration_after_being_canceled_or_declined(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_canceled_or_declined_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action(
-                'AHEE__EE_Registration__set_status__canceled_or_declined',
-                $this,
-                $old_STS_ID,
-                $new_STS_ID,
-                $context
-            );
-            return;
-        }
-    }
-
-
-    /**
-     * update REGs and TXN when cancelled or declined registrations involved
-     *
-     * @param array        $closed_reg_statuses
-     * @param string       $new_STS_ID
-     * @param string       $old_STS_ID
-     * @param Context|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function updateIfDeclined(array $closed_reg_statuses, $new_STS_ID, $old_STS_ID, Context $context = null)
-    {
-        // true if reinstating cancelled or declined registration
-        if (in_array($old_STS_ID, $closed_reg_statuses, true)
-            && ! in_array($new_STS_ID, $closed_reg_statuses, true)
-        ) {
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            /** @type EE_Transaction_Processor $transaction_processor */
-            $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-            // reinstating cancelled or declined registration
-            $registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
-                $this,
-                $closed_reg_statuses
-            );
-            $transaction_processor->update_transaction_after_reinstating_canceled_registration(
-                $this,
-                $closed_reg_statuses,
-                false
-            );
-            do_action(
-                'AHEE__EE_Registration__set_status__after_reinstated',
-                $this,
-                $old_STS_ID,
-                $new_STS_ID,
-                $context
-            );
-        }
-    }
-
-
-    /**
-     * @param Context|null $context
-     * @return bool
-     */
-    private function statusChangeUpdatesTransaction(Context $context = null)
-    {
-        $contexts_that_do_not_update_transaction = (array) apply_filters(
-            'AHEE__EE_Registration__statusChangeUpdatesTransaction__contexts_that_do_not_update_transaction',
-            array('spco_reg_step_attendee_information_process_registrations'),
-            $context,
-            $this
-        );
-        return ! (
-            $context instanceof Context
-            && in_array($context->slug(), $contexts_that_do_not_update_transaction, true)
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateTransactionAfterStatusChange()
-    {
-        /** @type EE_Transaction_Payments $transaction_payments */
-        $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-        $transaction_payments->recalculate_transaction_total($this->transaction(), false);
-        $this->transaction()->update_status_based_on_total_paid(true);
-    }
-
-
-    /**
-     *        get Status ID
-     */
-    public function status_ID()
-    {
-        return $this->get('STS_ID');
-    }
-
-
-    /**
-     * increments this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    private function _reserve_registration_space()
-    {
-        // reserved ticket and datetime counts will be decremented as sold counts are incremented
-        // so stop tracking that this reg has a ticket reserved
-        $this->release_reserved_ticket();
-        $ticket = $this->ticket();
-        $ticket->increase_sold();
-        $ticket->save();
-        // possibly set event status to sold out
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * Gets the ticket this registration is for
-     *
-     * @param boolean $include_archived whether to include archived tickets or not.
-     * @return EE_Ticket|EE_Base_Class
-     * @throws \EE_Error
-     */
-    public function ticket($include_archived = true)
-    {
-        $query_params = array();
-        if ($include_archived) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $this->get_first_related('Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets the event this registration is for
-     *
-     * @return EE_Event
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function event()
-    {
-        $event = $this->get_first_related('Event');
-        if (! $event instanceof \EE_Event) {
-            throw new EntityNotFoundException('Event ID', $this->event_ID());
-        }
-        return $event;
-    }
-
-
-    /**
-     * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
-     * with the author of the event this registration is for.
-     *
-     * @since 4.5.0
-     * @return int
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function wp_user()
-    {
-        $event = $this->event();
-        if ($event instanceof EE_Event) {
-            return $event->wp_user();
-        }
-        return 0;
-    }
-
-
-    /**
-     * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws \EE_Error
-     */
-    private function _release_registration_space()
-    {
-        $ticket = $this->ticket();
-        $ticket->decrease_sold();
-        $ticket->save();
-    }
-
-
-    /**
-     * tracks this registration's ticket reservation in extra meta
-     * and can increment related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will increment ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
-    public function reserve_ticket($update_ticket = false)
-    {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call update_extra_meta(), which is why that is done first
-            if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->increase_reserved();
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * stops tracking this registration's ticket reservation in extra meta
-     * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
-     *
-     * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
-     * @return void
-     * @throws \EE_Error
-     */
-    public function release_reserved_ticket($update_ticket = false)
-    {
-        if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
-            // PLZ NOTE: although checking $update_ticket first would be more efficient,
-            // we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
-            if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
-                $ticket = $this->ticket();
-                $ticket->decrease_reserved();
-                $ticket->save();
-            }
-        }
-    }
-
-
-    /**
-     * Set Attendee ID
-     *
-     * @param        int $ATT_ID Attendee ID
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_attendee_id($ATT_ID = 0)
-    {
-        $this->set('ATT_ID', $ATT_ID);
-    }
-
-
-    /**
-     *        Set Transaction ID
-     *
-     * @param        int $TXN_ID Transaction ID
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_transaction_id($TXN_ID = 0)
-    {
-        $this->set('TXN_ID', $TXN_ID);
-    }
-
-
-    /**
-     *        Set Session
-     *
-     * @param    string $REG_session PHP Session ID
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_session($REG_session = '')
-    {
-        $this->set('REG_session', $REG_session);
-    }
-
-
-    /**
-     *        Set Registration URL Link
-     *
-     * @param    string $REG_url_link Registration URL Link
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_reg_url_link($REG_url_link = '')
-    {
-        $this->set('REG_url_link', $REG_url_link);
-    }
-
-
-    /**
-     *        Set Attendee Counter
-     *
-     * @param        int $REG_count Primary Attendee
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_count($REG_count = 1)
-    {
-        $this->set('REG_count', $REG_count);
-    }
-
-
-    /**
-     *        Set Group Size
-     *
-     * @param        boolean $REG_group_size Group Registration
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_group_size($REG_group_size = false)
-    {
-        $this->set('REG_group_size', $REG_group_size);
-    }
-
-
-    /**
-     *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_not_approved
-     *
-     * @return        boolean
-     */
-    public function is_not_approved()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false;
-    }
-
-
-    /**
-     *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_pending_payment
-     *
-     * @return        boolean
-     */
-    public function is_pending_payment()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false;
-    }
-
-
-    /**
-     *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
-     *
-     * @return        boolean
-     */
-    public function is_approved()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_approved ? true : false;
-    }
-
-
-    /**
-     *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
-     *
-     * @return        boolean
-     */
-    public function is_cancelled()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false;
-    }
-
-
-    /**
-     *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
-     *
-     * @return        boolean
-     */
-    public function is_declined()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_declined ? true : false;
-    }
-
-
-    /**
-     *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
-     *    EEM_Registration::status_id_incomplete
-     *
-     * @return        boolean
-     */
-    public function is_incomplete()
-    {
-        return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false;
-    }
-
-
-    /**
-     *        Set Registration Date
-     *
-     * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
-     *                                                 Date
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_reg_date($REG_date = false)
-    {
-        $this->set('REG_date', $REG_date);
-    }
-
-
-    /**
-     *    Set final price owing for this registration after all ticket/price modifications
-     *
-     * @access    public
-     * @param    float $REG_final_price
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_final_price($REG_final_price = 0.00)
-    {
-        $this->set('REG_final_price', $REG_final_price);
-    }
-
-
-    /**
-     *    Set amount paid towards this registration's final price
-     *
-     * @access    public
-     * @param    float $REG_paid
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_paid($REG_paid = 0.00)
-    {
-        $this->set('REG_paid', $REG_paid);
-    }
-
-
-    /**
-     *        Attendee Is Going
-     *
-     * @param        boolean $REG_att_is_going Attendee Is Going
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_att_is_going($REG_att_is_going = false)
-    {
-        $this->set('REG_att_is_going', $REG_att_is_going);
-    }
-
-
-    /**
-     * Gets the related attendee
-     *
-     * @return EE_Attendee
-     * @throws EE_Error
-     */
-    public function attendee()
-    {
-        return $this->get_first_related('Attendee');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_ID()
-    {
-        return $this->get('EVT_ID');
-    }
-
-
-    /**
-     *        get Event ID
-     */
-    public function event_name()
-    {
-        $event = $this->event_obj();
-        if ($event) {
-            return $event->name();
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Fetches the event this registration is for
-     *
-     * @return EE_Event
-     * @throws EE_Error
-     */
-    public function event_obj()
-    {
-        return $this->get_first_related('Event');
-    }
-
-
-    /**
-     *        get Attendee ID
-     */
-    public function attendee_ID()
-    {
-        return $this->get('ATT_ID');
-    }
-
-
-    /**
-     *        get PHP Session ID
-     */
-    public function session_ID()
-    {
-        return $this->get('REG_session');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the receipt template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     */
-    public function receipt_url($messenger = 'html')
-    {
-
-        /**
-         * The below will be deprecated one version after this.  We check first if there is a custom receipt template
-         * already in use on old system.  If there is then we just return the standard url for it.
-         *
-         * @since 4.5.0
-         */
-        $template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
-        $has_custom             = EEH_Template::locate_template(
-            $template_relative_path,
-            array(),
-            true,
-            true,
-            true
-        );
-
-        if ($has_custom) {
-            return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
-        }
-        return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
-    }
-
-
-    /**
-     * Gets the string which represents the URL trigger for the invoice template in the message template system.
-     *
-     * @param string $messenger 'pdf' or 'html'.  Default 'html'.
-     * @return string
-     * @throws EE_Error
-     */
-    public function invoice_url($messenger = 'html')
-    {
-        /**
-         * The below will be deprecated one version after this.  We check first if there is a custom invoice template
-         * already in use on old system.  If there is then we just return the standard url for it.
-         *
-         * @since 4.5.0
-         */
-        $template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
-        $has_custom             = EEH_Template::locate_template(
-            $template_relative_path,
-            array(),
-            true,
-            true,
-            true
-        );
-
-        if ($has_custom) {
-            if ($messenger == 'html') {
-                return $this->invoice_url('launch');
-            }
-            $route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
-
-            $query_args = array('ee' => $route, 'id' => $this->reg_url_link());
-            if ($messenger == 'html') {
-                $query_args['html'] = true;
-            }
-            return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
-        }
-        return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
-    }
-
-
-    /**
-     * get Registration URL Link
-     *
-     * @access public
-     * @return string
-     * @throws \EE_Error
-     */
-    public function reg_url_link()
-    {
-        return (string) $this->get('REG_url_link');
-    }
-
-
-    /**
-     * Echoes out invoice_url()
-     *
-     * @param string $type 'download','launch', or 'html' (default is 'launch')
-     * @return void
-     * @throws EE_Error
-     */
-    public function e_invoice_url($type = 'launch')
-    {
-        echo $this->invoice_url($type);
-    }
-
-
-    /**
-     * Echoes out payment_overview_url
-     */
-    public function e_payment_overview_url()
-    {
-        echo $this->payment_overview_url();
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @param bool $clear_session Set to true when you want to clear the session on revisiting the
-     *                            payment overview url.
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_overview_url($clear_session = false)
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'payment_options',
-            'revisit'        => true,
-            'clear_session' => (bool) $clear_session
-        ), EE_Registry::instance()->CFG->core->reg_page_url());
-    }
-
-
-    /**
-     * Gets the URL of the thank you page with this registration REG_url_link added as
-     * a query parameter
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function edit_attendee_information_url()
-    {
-        return add_query_arg(array(
-            'e_reg_url_link' => $this->reg_url_link(),
-            'step'           => 'attendee_information',
-            'revisit'        => true,
-        ), EE_Registry::instance()->CFG->core->reg_page_url());
-    }
-
-
-    /**
-     * Simply generates and returns the appropriate admin_url link to edit this registration
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_edit_url()
-    {
-        return EEH_URL::add_query_args_and_nonce(array(
-            'page'    => 'espresso_registrations',
-            'action'  => 'view_registration',
-            '_REG_ID' => $this->ID(),
-        ), admin_url('admin.php'));
-    }
-
-
-    /**
-     *    is_primary_registrant?
-     */
-    public function is_primary_registrant()
-    {
-        return $this->get('REG_count') == 1 ? true : false;
-    }
-
-
-    /**
-     * This returns the primary registration object for this registration group (which may be this object).
-     *
-     * @return EE_Registration
-     * @throws EE_Error
-     */
-    public function get_primary_registration()
-    {
-        if ($this->is_primary_registrant()) {
-            return $this;
-        }
-
-        //k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
-        /** @var EE_Registration $primary_registrant */
-        $primary_registrant = EEM_Registration::instance()->get_one(array(
-            array(
-                'TXN_ID'    => $this->transaction_ID(),
-                'REG_count' => 1,
-            ),
-        ));
-        return $primary_registrant;
-    }
-
-
-    /**
-     *        get  Attendee Number
-     *
-     * @access        public
-     */
-    public function count()
-    {
-        return $this->get('REG_count');
-    }
-
-
-    /**
-     *        get Group Size
-     */
-    public function group_size()
-    {
-        return $this->get('REG_group_size');
-    }
-
-
-    /**
-     *        get Registration Date
-     */
-    public function date()
-    {
-        return $this->get('REG_date');
-    }
-
-
-    /**
-     * gets a pretty date
-     *
-     * @param string $date_format
-     * @param string $time_format
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_date($date_format = null, $time_format = null)
-    {
-        return $this->get_datetime('REG_date', $date_format, $time_format);
-    }
-
-
-    /**
-     * final_price
-     * the registration's share of the transaction total, so that the
-     * sum of all the transaction's REG_final_prices equal the transaction's total
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function final_price()
-    {
-        return $this->get('REG_final_price');
-    }
-
-
-    /**
-     * pretty_final_price
-     *  final price as formatted string, with correct decimal places and currency symbol
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_final_price()
-    {
-        return $this->get_pretty('REG_final_price');
-    }
-
-
-    /**
-     * get paid (yeah)
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function paid()
-    {
-        return $this->get('REG_paid');
-    }
-
-
-    /**
-     * pretty_paid
-     *
-     * @return float
-     * @throws EE_Error
-     */
-    public function pretty_paid()
-    {
-        return $this->get_pretty('REG_paid');
-    }
-
-
-    /**
-     * owes_monies_and_can_pay
-     * whether or not this registration has monies owing and it's' status allows payment
-     *
-     * @param array $requires_payment
-     * @return bool
-     * @throws EE_Error
-     */
-    public function owes_monies_and_can_pay($requires_payment = array())
-    {
-        // these reg statuses require payment (if event is not free)
-        $requires_payment = ! empty($requires_payment)
-            ? $requires_payment
-            : EEM_Registration::reg_statuses_that_allow_payment();
-        if (in_array($this->status_ID(), $requires_payment) &&
-            $this->final_price() != 0 &&
-            $this->final_price() != $this->paid()
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Prints out the return value of $this->pretty_status()
-     *
-     * @param bool $show_icons
-     * @return void
-     * @throws EE_Error
-     */
-    public function e_pretty_status($show_icons = false)
-    {
-        echo $this->pretty_status($show_icons);
-    }
-
-
-    /**
-     * Returns a nice version of the status for displaying to customers
-     *
-     * @param bool $show_icons
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_status($show_icons = false)
-    {
-        $status = EEM_Status::instance()->localized_status(
-            array($this->status_ID() => esc_html__('unknown', 'event_espresso')),
-            false,
-            'sentence'
-        );
-        $icon   = '';
-        switch ($this->status_ID()) {
-            case EEM_Registration::status_id_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_pending_payment:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_not_approved:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_cancelled:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_incomplete:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_declined:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
-                    : '';
-                break;
-            case EEM_Registration::status_id_wait_list:
-                $icon = $show_icons
-                    ? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>'
-                    : '';
-                break;
-        }
-        return $icon . $status[$this->status_ID()];
-    }
-
-
-    /**
-     *        get Attendee Is Going
-     */
-    public function att_is_going()
-    {
-        return $this->get('REG_att_is_going');
-    }
-
-
-    /**
-     * Gets related answers
-     *
-     * @param array $query_params like EEM_Base::get_all
-     * @return EE_Answer[]
-     * @throws EE_Error
-     */
-    public function answers($query_params = null)
-    {
-        return $this->get_many_related('Answer', $query_params);
-    }
-
-
-    /**
-     * Gets the registration's answer value to the specified question
-     * (either the question's ID or a question object)
-     *
-     * @param EE_Question|int $question
-     * @param bool            $pretty_value
-     * @return array|string if pretty_value= true, the result will always be a string
-     * (because the answer might be an array of answer values, so passing pretty_value=true
-     * will convert it into some kind of string)
-     * @throws EE_Error
-     */
-    public function answer_value_to_question($question, $pretty_value = true)
-    {
-        $question_id = EEM_Question::instance()->ensure_is_ID($question);
-        return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
-    }
-
-
-    /**
-     * question_groups
-     * returns an array of EE_Question_Group objects for this registration
-     *
-     * @return EE_Question_Group[]
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function question_groups()
-    {
-        $question_groups = array();
-        if ($this->event() instanceof EE_Event) {
-            $question_groups = $this->event()->question_groups(
-                array(
-                    array(
-                        'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
-                    ),
-                    'order_by' => array('QSG_order' => 'ASC'),
-                )
-            );
-        }
-        return $question_groups;
-    }
-
-
-    /**
-     * count_question_groups
-     * returns a count of the number of EE_Question_Group objects for this registration
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function count_question_groups()
-    {
-        $qg_count = 0;
-        if ($this->event() instanceof EE_Event) {
-            $qg_count = $this->event()->count_related(
-                'Question_Group',
-                array(
-                    array(
-                        'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
-                    ),
-                )
-            );
-        }
-        return $qg_count;
-    }
-
-
-    /**
-     * Returns the registration date in the 'standard' string format
-     * (function may be improved in the future to allow for different formats and timezones)
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function reg_date()
-    {
-        return $this->get_datetime('REG_date');
-    }
-
-
-    /**
-     * Gets the datetime-ticket for this registration (ie, it can be used to isolate
-     * the ticket this registration purchased, or the datetime they have registered
-     * to attend)
-     *
-     * @return EE_Datetime_Ticket
-     * @throws EE_Error
-     */
-    public function datetime_ticket()
-    {
-        return $this->get_first_related('Datetime_Ticket');
-    }
-
-
-    /**
-     * Sets the registration's datetime_ticket.
-     *
-     * @param EE_Datetime_Ticket $datetime_ticket
-     * @return EE_Datetime_Ticket
-     * @throws EE_Error
-     */
-    public function set_datetime_ticket($datetime_ticket)
-    {
-        return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
-    }
-
-    /**
-     * Gets deleted
-     *
-     * @return bool
-     * @throws EE_Error
-     */
-    public function deleted()
-    {
-        return $this->get('REG_deleted');
-    }
-
-    /**
-     * Sets deleted
-     *
-     * @param boolean $deleted
-     * @return bool
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_deleted($deleted)
-    {
-        if ($deleted) {
-            $this->delete();
-        } else {
-            $this->restore();
-        }
-    }
-
-
-    /**
-     * Get the status object of this object
-     *
-     * @return EE_Status
-     * @throws EE_Error
-     */
-    public function status_obj()
-    {
-        return $this->get_first_related('Status');
-    }
-
-
-    /**
-     * Returns the number of times this registration has checked into any of the datetimes
-     * its available for
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_checkins()
-    {
-        return $this->get_model()->count_related($this, 'Checkin');
-    }
-
-
-    /**
-     * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
-     * registration is for.  Note, this is ONLY checked in (does not include checkedout)
-     *
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_checkins_not_checkedout()
-    {
-        return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
-    }
-
-
-    /**
-     * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
-     * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
-     *                                          consider registration status as well as datetime access.
-     * @return bool
-     * @throws EE_Error
-     */
-    public function can_checkin($DTT_OR_ID, $check_approved = true)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        //first check registration status
-        if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
-            return false;
-        }
-        //is there a datetime ticket that matches this dtt_ID?
-        if (! (EEM_Datetime_Ticket::instance()->exists(array(
-            array(
-                'TKT_ID' => $this->get('TKT_ID'),
-                'DTT_ID' => $DTT_ID,
-            ),
-        )))
-        ) {
-            return false;
-        }
-
-        //final check is against TKT_uses
-        return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
-    }
-
-
-    /**
-     * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
-     * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
-     * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
-     * then return false.  Otherwise return true.
-     *
-     * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
-     * @return bool true means can checkin.  false means cannot checkin.
-     * @throws EE_Error
-     */
-    public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
-    {
-        $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
-
-        if (! $DTT_ID) {
-            return false;
-        }
-
-        $max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF;
-
-        // if max uses is not set or equals infinity then return true cause its not a factor for whether user can
-        // check-in or not.
-        if (! $max_uses || $max_uses === EE_INF) {
-            return true;
-        }
-
-        //does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
-        //go ahead and toggle.
-        if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
-            return true;
-        }
-
-        //made it here so the last check is whether the number of checkins per unique datetime on this registration
-        //disallows further check-ins.
-        $count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(
-            array(
-                'REG_ID' => $this->ID(),
-                'CHK_in' => true,
-            ),
-        ), 'DTT_ID', true);
-        // checkins have already reached their max number of uses
-        // so registrant can NOT checkin
-        if ($count_unique_dtt_checkins >= $max_uses) {
-            EE_Error::add_error(
-                esc_html__(
-                    'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * toggle Check-in status for this registration
-     * Check-ins are toggled in the following order:
-     * never checked in -> checked in
-     * checked in -> checked out
-     * checked out -> checked in
-     *
-     * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
-     *                      If not included or null, then it is assumed latest datetime is being toggled.
-     * @param bool $verify  If true then can_checkin() is used to verify whether the person
-     *                      can be checked in or not.  Otherwise this forces change in checkin status.
-     * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
-     * @throws EE_Error
-     */
-    public function toggle_checkin_status($DTT_ID = null, $verify = false)
-    {
-        if (empty($DTT_ID)) {
-            $datetime = $this->get_latest_related_datetime();
-            $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
-            // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
-                        'event_espresso'
-                    ),
-                    $this->ID(),
-                    $DTT_ID
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $status_paths = array(
-            EE_Checkin::status_checked_never => EE_Checkin::status_checked_in,
-            EE_Checkin::status_checked_in    => EE_Checkin::status_checked_out,
-            EE_Checkin::status_checked_out   => EE_Checkin::status_checked_in,
-        );
-        //start by getting the current status so we know what status we'll be changing to.
-        $cur_status = $this->check_in_status_for_datetime($DTT_ID, null);
-        $status_to  = $status_paths[$cur_status];
-        // database only records true for checked IN or false for checked OUT
-        // no record ( null ) means checked in NEVER, but we obviously don't save that
-        $new_status = $status_to === EE_Checkin::status_checked_in ? true : false;
-        // add relation - note Check-ins are always creating new rows
-        // because we are keeping track of Check-ins over time.
-        // Eventually we'll probably want to show a list table
-        // for the individual Check-ins so that they can be managed.
-        $checkin = EE_Checkin::new_instance(array(
-            'REG_ID' => $this->ID(),
-            'DTT_ID' => $DTT_ID,
-            'CHK_in' => $new_status,
-        ));
-        // if the record could not be saved then return false
-        if ($checkin->save() === 0) {
-            if (WP_DEBUG) {
-                global $wpdb;
-                $error = sprintf(
-                    esc_html__(
-                        'Registration check in update failed because of the following database error: %1$s%2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $wpdb->last_error
-                );
-            } else {
-                $error = esc_html__(
-                    'Registration check in update failed because of an unknown database error',
-                    'event_espresso'
-                );
-            }
-            EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return $status_to;
-    }
-
-
-    /**
-     * Returns the latest datetime related to this registration (via the ticket attached to the registration).
-     * "Latest" is defined by the `DTT_EVT_start` column.
-     *
-     * @return EE_Datetime|null
-     * @throws \EE_Error
-     */
-    public function get_latest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'DESC'),
-            )
-        );
-    }
-
-
-    /**
-     * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
-     * "Earliest" is defined by the `DTT_EVT_start` column.
-     *
-     * @throws \EE_Error
-     */
-    public function get_earliest_related_datetime()
-    {
-        return EEM_Datetime::instance()->get_one(
-            array(
-                array(
-                    'Ticket.Registration.REG_ID' => $this->ID(),
-                ),
-                'order_by' => array('DTT_EVT_start' => 'ASC'),
-            )
-        );
-    }
-
-
-    /**
-     * This method simply returns the check-in status for this registration and the given datetime.
-     * If neither the datetime nor the checkin values are provided as arguments,
-     * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
-     *
-     * @param  int       $DTT_ID  The ID of the datetime we're checking against
-     *                            (if empty we'll get the primary datetime for
-     *                            this registration (via event) and use it's ID);
-     * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
-     * @return int                Integer representing Check-in status.
-     * @throws \EE_Error
-     */
-    public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null)
-    {
-        $checkin_query_params = array(
-            'order_by' => array('CHK_timestamp' => 'DESC'),
-        );
-
-        if ($DTT_ID > 0) {
-            $checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
-        }
-
-        //get checkin object (if exists)
-        $checkin = $checkin instanceof EE_Checkin
-            ? $checkin
-            : $this->get_first_related('Checkin', $checkin_query_params);
-        if ($checkin instanceof EE_Checkin) {
-            if ($checkin->get('CHK_in')) {
-                return EE_Checkin::status_checked_in; //checked in
-            }
-            return EE_Checkin::status_checked_out; //had checked in but is now checked out.
-        }
-        return EE_Checkin::status_checked_never; //never been checked in
-    }
-
-
-    /**
-     * This method returns a localized message for the toggled Check-in message.
-     *
-     * @param  int $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
-     *                     then it is assumed Check-in for primary datetime was toggled.
-     * @param bool $error  This just flags that you want an error message returned. This is put in so that the error
-     *                     message can be customized with the attendee name.
-     * @return string internationalized message
-     * @throws EE_Error
-     */
-    public function get_checkin_msg($DTT_ID, $error = false)
-    {
-        //let's get the attendee first so we can include the name of the attendee
-        $attendee = $this->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            if ($error) {
-                return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
-            }
-            $cur_status = $this->check_in_status_for_datetime($DTT_ID);
-            //what is the status message going to be?
-            switch ($cur_status) {
-                case EE_Checkin::status_checked_never:
-                    return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
-                        $attendee->full_name());
-                    break;
-                case EE_Checkin::status_checked_in:
-                    return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
-                    break;
-                case EE_Checkin::status_checked_out:
-                    return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
-                    break;
-            }
-        }
-        return esc_html__("The check-in status could not be determined.", "event_espresso");
-    }
-
-
-    /**
-     * Returns the related EE_Transaction to this registration
-     *
-     * @return EE_Transaction
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function transaction()
-    {
-        $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
-            throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
-        }
-        return $transaction;
-    }
-
-
-    /**
-     *        get Registration Code
-     */
-    public function reg_code()
-    {
-        return $this->get('REG_code');
-    }
-
-
-    /**
-     *        get Transaction ID
-     */
-    public function transaction_ID()
-    {
-        return $this->get('TXN_ID');
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    public function ticket_ID()
-    {
-        return $this->get('TKT_ID');
-    }
-
-
-    /**
-     *        Set Registration Code
-     *
-     * @access    public
-     * @param    string  $REG_code Registration Code
-     * @param    boolean $use_default
-     * @throws EE_Error
-     */
-    public function set_reg_code($REG_code, $use_default = false)
-    {
-        if (empty($REG_code)) {
-            EE_Error::add_error(
-                esc_html__('REG_code can not be empty.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return;
-        }
-        if (! $this->reg_code()) {
-            parent::set('REG_code', $REG_code, $use_default);
-        } else {
-            EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
-                esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
-                '4.6.0'
-            );
-        }
-    }
-
-
-    /**
-     * Returns all other registrations in the same group as this registrant who have the same ticket option.
-     * Note, if you want to just get all registrations in the same transaction (group), use:
-     *    $registration->transaction()->registrations();
-     *
-     * @since 4.5.0
-     * @return EE_Registration[] or empty array if this isn't a group registration.
-     * @throws EE_Error
-     */
-    public function get_all_other_registrations_in_group()
-    {
-        if ($this->group_size() < 2) {
-            return array();
-        }
-
-        $query[0] = array(
-            'TXN_ID' => $this->transaction_ID(),
-            'REG_ID' => array('!=', $this->ID()),
-            'TKT_ID' => $this->ticket_ID(),
-        );
-        /** @var EE_Registration[] $registrations */
-        $registrations = $this->get_model()->get_all($query);
-        return $registrations;
-    }
-
-    /**
-     * Return the link to the admin details for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_details_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page'    => 'espresso_registrations',
-                'action'  => 'view_registration',
-                '_REG_ID' => $this->ID(),
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-    /**
-     * Returns the link to the editor for the object.  Sometimes this is the same as the details.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_edit_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to a settings page for the object.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_admin_settings_link()
-    {
-        return $this->get_admin_details_link();
-    }
-
-    /**
-     * Returns the link to the "overview" for the object (typically the "list table" view).
-     *
-     * @return string
-     */
-    public function get_admin_overview_link()
-    {
-        EE_Registry::instance()->load_helper('URL');
-        return EEH_URL::add_query_args_and_nonce(
-            array(
-                'page' => 'espresso_registrations',
-            ),
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return \EE_Registration[]
-     * @throws \EE_Error
-     */
-    public function payments($query_params = array())
-    {
-        return $this->get_many_related('Payment', $query_params);
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return \EE_Registration_Payment[]
-     * @throws \EE_Error
-     */
-    public function registration_payments($query_params = array())
-    {
-        return $this->get_many_related('Registration_Payment', $query_params);
-    }
-
-
-    /**
-     * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
-     * Note: if there are no payments on the registration there will be no payment method returned.
-     *
-     * @return EE_Payment_Method|null
-     */
-    public function payment_method()
-    {
-        return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
-    }
-
-
-    /**
-     * @return \EE_Line_Item
-     * @throws EntityNotFoundException
-     * @throws \EE_Error
-     */
-    public function ticket_line_item()
-    {
-        $ticket            = $this->ticket();
-        $transaction       = $this->transaction();
-        $line_item         = null;
-        $ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
-            $transaction->total_line_item(),
-            'Ticket',
-            array($ticket->ID())
-        );
-        foreach ($ticket_line_items as $ticket_line_item) {
-            if (
-                $ticket_line_item instanceof \EE_Line_Item
-                && $ticket_line_item->OBJ_type() === 'Ticket'
-                && $ticket_line_item->OBJ_ID() === $ticket->ID()
-            ) {
-                $line_item = $ticket_line_item;
-                break;
-            }
-        }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
-            throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
-        }
-        return $line_item;
-    }
-
-
-    /**
-     * Soft Deletes this model object.
-     *
-     * @return boolean | int
-     * @throws \RuntimeException
-     * @throws \EE_Error
-     */
-    public function delete()
-    {
-        if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
-            $this->set_status(EEM_Registration::status_id_cancelled);
-        }
-        return parent::delete();
-    }
-
-
-    /**
-     * Restores whatever the previous status was on a registration before it was trashed (if possible)
-     *
-     * @throws \EE_Error
-     * @throws \RuntimeException
-     */
-    public function restore()
-    {
-        $previous_status = $this->get_extra_meta(
-            EE_Registration::PRE_TRASH_REG_STATUS_KEY,
-            true,
-            EEM_Registration::status_id_cancelled
-        );
-        if ($previous_status) {
-            $this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
-            $this->set_status($previous_status);
-        }
-        return parent::restore();
-    }
-
-
-
-    /*************************** DEPRECATED ***************************/
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     */
-    public function price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::price_paid()',
-            esc_html__('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'),
-            '4.7.0');
-        return $this->final_price();
-    }
-
-
-    /**
-     * @deprecated
-     * @since     4.7.0
-     * @access    public
-     * @param    float $REG_final_price
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function set_price_paid($REG_final_price = 0.00)
-    {
-        EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
-            esc_html__('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'),
-            '4.7.0');
-        $this->set_final_price($REG_final_price);
-    }
-
-
-    /**
-     * @deprecated
-     * @since 4.7.0
-     * @return string
-     * @throws EE_Error
-     */
-    public function pretty_price_paid()
-    {
-        EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
-            esc_html__('This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
-                'event_espresso'), '4.7.0');
-        return $this->pretty_final_price();
-    }
-
-
-    /**
-     * Gets the primary datetime related to this registration via the related Event to this registration
-     *
-     * @deprecated 4.9.17
-     * @return EE_Datetime
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     */
-    public function get_related_primary_datetime()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
-                'event_espresso'
-            ),
-            '4.9.17',
-            '5.0.0'
-        );
-        return $this->event()->primary_datetime();
-    }
+	/**
+	 * Used to reference when a registration has never been checked in.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_never instead
+	 * @type int
+	 */
+	const checkin_status_never = 2;
+
+	/**
+	 * Used to reference when a registration has been checked in.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_in instead
+	 * @type int
+	 */
+	const checkin_status_in = 1;
+
+
+	/**
+	 * Used to reference when a registration has been checked out.
+	 *
+	 * @deprecated use \EE_Checkin::status_checked_out instead
+	 * @type int
+	 */
+	const checkin_status_out = 0;
+
+
+	/**
+	 * extra meta key for tracking reg status os trashed registrations
+	 *
+	 * @type string
+	 */
+	const PRE_TRASH_REG_STATUS_KEY = 'pre_trash_registration_status';
+
+
+	/**
+	 * extra meta key for tracking if registration has reserved ticket
+	 *
+	 * @type string
+	 */
+	const HAS_RESERVED_TICKET_KEY = 'has_reserved_ticket';
+
+
+	/**
+	 * @param array  $props_n_values          incoming values
+	 * @param string $timezone                incoming timezone (if not set the timezone set for the website will be
+	 *                                        used.)
+	 * @param array  $date_formats            incoming date_formats in an array where the first value is the
+	 *                                        date_format and the second value is the time format
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object($props_n_values, __CLASS__, $timezone, $date_formats);
+		return $has_object ? $has_object : new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Registration
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 *        Set Event ID
+	 *
+	 * @param        int $EVT_ID Event ID
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_event($EVT_ID = 0)
+	{
+		$this->set('EVT_ID', $EVT_ID);
+	}
+
+
+	/**
+	 * Overrides parent set() method so that all calls to set( 'REG_code', $REG_code ) OR set( 'STS_ID', $STS_ID ) can
+	 * be routed to internal methods
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value
+	 * @param bool   $use_default
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		switch ($field_name) {
+			case 'REG_code':
+				if (! empty($field_value) && $this->reg_code() === null) {
+					$this->set_reg_code($field_value, $use_default);
+				}
+				break;
+			case 'STS_ID':
+				$this->set_status($field_value, $use_default);
+				break;
+			default:
+				parent::set($field_name, $field_value, $use_default);
+		}
+	}
+
+
+	/**
+	 * Set Status ID
+	 * updates the registration status and ALSO...
+	 * calls reserve_registration_space() if the reg status changes TO approved from any other reg status
+	 * calls release_registration_space() if the reg status changes FROM approved to any other reg status
+	 *
+	 * @param string       $new_STS_ID
+	 * @param boolean      $use_default
+	 * @param Context|null $context
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function set_status($new_STS_ID = null, $use_default = false, Context $context = null)
+	{
+		// get current REG_Status
+		$old_STS_ID = $this->status_ID();
+		// if status has changed
+		if ($old_STS_ID !== $new_STS_ID // and that status has actually changed
+			&& ! empty($old_STS_ID) // and that old status is actually set
+			&& ! empty($new_STS_ID) // as well as the new status
+			&& $this->ID() // ensure registration is in the db
+		) {
+			// TO approved
+			if ($new_STS_ID === EEM_Registration::status_id_approved) {
+				// reserve a space by incrementing ticket and datetime sold values
+				$this->_reserve_registration_space();
+				do_action('AHEE__EE_Registration__set_status__to_approved', $this, $old_STS_ID, $new_STS_ID, $context);
+				// OR FROM  approved
+			} elseif ($old_STS_ID === EEM_Registration::status_id_approved) {
+				// release a space by decrementing ticket and datetime sold values
+				$this->_release_registration_space();
+				do_action(
+					'AHEE__EE_Registration__set_status__from_approved',
+					$this,
+					$old_STS_ID,
+					$new_STS_ID,
+					$context
+				);
+			}
+			// update status
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			$this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID, $context);
+			if($this->statusChangeUpdatesTransaction($context)) {
+				$this->updateTransactionAfterStatusChange();
+			}
+			do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID, $context);
+			return true;
+		}
+		//even though the old value matches the new value, it's still good to
+		//allow the parent set method to have a say
+		parent::set('STS_ID', $new_STS_ID, $use_default);
+		return true;
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param string       $new_STS_ID
+	 * @param string       $old_STS_ID
+	 * @param Context|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function _update_if_canceled_or_declined($new_STS_ID, $old_STS_ID, Context $context = null)
+	{
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = EEM_Registration::closed_reg_statuses();
+		// true if registration has been cancelled or declined
+		$this->updateIfCanceled(
+			$closed_reg_statuses,
+			$new_STS_ID,
+			$old_STS_ID,
+			$context
+		);
+		$this->updateIfDeclined(
+			$closed_reg_statuses,
+			$new_STS_ID,
+			$old_STS_ID,
+			$context
+		);
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param array        $closed_reg_statuses
+	 * @param string       $new_STS_ID
+	 * @param string       $old_STS_ID
+	 * @param Context|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function updateIfCanceled(array $closed_reg_statuses, $new_STS_ID, $old_STS_ID, Context $context = null)
+	{
+		// true if registration has been cancelled or declined
+		if (in_array($new_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($old_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// cancelled or declined registration
+			$registration_processor->update_registration_after_being_canceled_or_declined(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_canceled_or_declined_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action(
+				'AHEE__EE_Registration__set_status__canceled_or_declined',
+				$this,
+				$old_STS_ID,
+				$new_STS_ID,
+				$context
+			);
+			return;
+		}
+	}
+
+
+	/**
+	 * update REGs and TXN when cancelled or declined registrations involved
+	 *
+	 * @param array        $closed_reg_statuses
+	 * @param string       $new_STS_ID
+	 * @param string       $old_STS_ID
+	 * @param Context|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function updateIfDeclined(array $closed_reg_statuses, $new_STS_ID, $old_STS_ID, Context $context = null)
+	{
+		// true if reinstating cancelled or declined registration
+		if (in_array($old_STS_ID, $closed_reg_statuses, true)
+			&& ! in_array($new_STS_ID, $closed_reg_statuses, true)
+		) {
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			/** @type EE_Transaction_Processor $transaction_processor */
+			$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+			// reinstating cancelled or declined registration
+			$registration_processor->update_canceled_or_declined_registration_after_being_reinstated(
+				$this,
+				$closed_reg_statuses
+			);
+			$transaction_processor->update_transaction_after_reinstating_canceled_registration(
+				$this,
+				$closed_reg_statuses,
+				false
+			);
+			do_action(
+				'AHEE__EE_Registration__set_status__after_reinstated',
+				$this,
+				$old_STS_ID,
+				$new_STS_ID,
+				$context
+			);
+		}
+	}
+
+
+	/**
+	 * @param Context|null $context
+	 * @return bool
+	 */
+	private function statusChangeUpdatesTransaction(Context $context = null)
+	{
+		$contexts_that_do_not_update_transaction = (array) apply_filters(
+			'AHEE__EE_Registration__statusChangeUpdatesTransaction__contexts_that_do_not_update_transaction',
+			array('spco_reg_step_attendee_information_process_registrations'),
+			$context,
+			$this
+		);
+		return ! (
+			$context instanceof Context
+			&& in_array($context->slug(), $contexts_that_do_not_update_transaction, true)
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateTransactionAfterStatusChange()
+	{
+		/** @type EE_Transaction_Payments $transaction_payments */
+		$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+		$transaction_payments->recalculate_transaction_total($this->transaction(), false);
+		$this->transaction()->update_status_based_on_total_paid(true);
+	}
+
+
+	/**
+	 *        get Status ID
+	 */
+	public function status_ID()
+	{
+		return $this->get('STS_ID');
+	}
+
+
+	/**
+	 * increments this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	private function _reserve_registration_space()
+	{
+		// reserved ticket and datetime counts will be decremented as sold counts are incremented
+		// so stop tracking that this reg has a ticket reserved
+		$this->release_reserved_ticket();
+		$ticket = $this->ticket();
+		$ticket->increase_sold();
+		$ticket->save();
+		// possibly set event status to sold out
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * Gets the ticket this registration is for
+	 *
+	 * @param boolean $include_archived whether to include archived tickets or not.
+	 * @return EE_Ticket|EE_Base_Class
+	 * @throws \EE_Error
+	 */
+	public function ticket($include_archived = true)
+	{
+		$query_params = array();
+		if ($include_archived) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $this->get_first_related('Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets the event this registration is for
+	 *
+	 * @return EE_Event
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function event()
+	{
+		$event = $this->get_first_related('Event');
+		if (! $event instanceof \EE_Event) {
+			throw new EntityNotFoundException('Event ID', $this->event_ID());
+		}
+		return $event;
+	}
+
+
+	/**
+	 * Gets the "author" of the registration.  Note that for the purposes of registrations, the author will correspond
+	 * with the author of the event this registration is for.
+	 *
+	 * @since 4.5.0
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function wp_user()
+	{
+		$event = $this->event();
+		if ($event instanceof EE_Event) {
+			return $event->wp_user();
+		}
+		return 0;
+	}
+
+
+	/**
+	 * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private function _release_registration_space()
+	{
+		$ticket = $this->ticket();
+		$ticket->decrease_sold();
+		$ticket->save();
+	}
+
+
+	/**
+	 * tracks this registration's ticket reservation in extra meta
+	 * and can increment related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will increment ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function reserve_ticket($update_ticket = false)
+	{
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) === false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call update_extra_meta(), which is why that is done first
+			if ($this->update_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->increase_reserved();
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * stops tracking this registration's ticket reservation in extra meta
+	 * decrements (subtracts) related ticket reserved and corresponding datetime reserved values
+	 *
+	 * @param bool $update_ticket if true, will decrement ticket and datetime reserved count
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function release_reserved_ticket($update_ticket = false)
+	{
+		if ($this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true, false) !== false) {
+			// PLZ NOTE: although checking $update_ticket first would be more efficient,
+			// we NEED to ALWAYS call delete_extra_meta(), which is why that is done first
+			if ($this->delete_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY) && $update_ticket) {
+				$ticket = $this->ticket();
+				$ticket->decrease_reserved();
+				$ticket->save();
+			}
+		}
+	}
+
+
+	/**
+	 * Set Attendee ID
+	 *
+	 * @param        int $ATT_ID Attendee ID
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_attendee_id($ATT_ID = 0)
+	{
+		$this->set('ATT_ID', $ATT_ID);
+	}
+
+
+	/**
+	 *        Set Transaction ID
+	 *
+	 * @param        int $TXN_ID Transaction ID
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_transaction_id($TXN_ID = 0)
+	{
+		$this->set('TXN_ID', $TXN_ID);
+	}
+
+
+	/**
+	 *        Set Session
+	 *
+	 * @param    string $REG_session PHP Session ID
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_session($REG_session = '')
+	{
+		$this->set('REG_session', $REG_session);
+	}
+
+
+	/**
+	 *        Set Registration URL Link
+	 *
+	 * @param    string $REG_url_link Registration URL Link
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_reg_url_link($REG_url_link = '')
+	{
+		$this->set('REG_url_link', $REG_url_link);
+	}
+
+
+	/**
+	 *        Set Attendee Counter
+	 *
+	 * @param        int $REG_count Primary Attendee
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_count($REG_count = 1)
+	{
+		$this->set('REG_count', $REG_count);
+	}
+
+
+	/**
+	 *        Set Group Size
+	 *
+	 * @param        boolean $REG_group_size Group Registration
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_group_size($REG_group_size = false)
+	{
+		$this->set('REG_group_size', $REG_group_size);
+	}
+
+
+	/**
+	 *    is_not_approved -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_not_approved
+	 *
+	 * @return        boolean
+	 */
+	public function is_not_approved()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_not_approved ? true : false;
+	}
+
+
+	/**
+	 *    is_pending_payment -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_pending_payment
+	 *
+	 * @return        boolean
+	 */
+	public function is_pending_payment()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_pending_payment ? true : false;
+	}
+
+
+	/**
+	 *    is_approved -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_approved
+	 *
+	 * @return        boolean
+	 */
+	public function is_approved()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_approved ? true : false;
+	}
+
+
+	/**
+	 *    is_cancelled -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_cancelled
+	 *
+	 * @return        boolean
+	 */
+	public function is_cancelled()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_cancelled ? true : false;
+	}
+
+
+	/**
+	 *    is_declined -  convenience method that returns TRUE if REG status ID == EEM_Registration::status_id_declined
+	 *
+	 * @return        boolean
+	 */
+	public function is_declined()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_declined ? true : false;
+	}
+
+
+	/**
+	 *    is_incomplete -  convenience method that returns TRUE if REG status ID ==
+	 *    EEM_Registration::status_id_incomplete
+	 *
+	 * @return        boolean
+	 */
+	public function is_incomplete()
+	{
+		return $this->status_ID() == EEM_Registration::status_id_incomplete ? true : false;
+	}
+
+
+	/**
+	 *        Set Registration Date
+	 *
+	 * @param        mixed ( int or string ) $REG_date Registration Date - Unix timestamp or string representation of
+	 *                                                 Date
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_reg_date($REG_date = false)
+	{
+		$this->set('REG_date', $REG_date);
+	}
+
+
+	/**
+	 *    Set final price owing for this registration after all ticket/price modifications
+	 *
+	 * @access    public
+	 * @param    float $REG_final_price
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_final_price($REG_final_price = 0.00)
+	{
+		$this->set('REG_final_price', $REG_final_price);
+	}
+
+
+	/**
+	 *    Set amount paid towards this registration's final price
+	 *
+	 * @access    public
+	 * @param    float $REG_paid
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_paid($REG_paid = 0.00)
+	{
+		$this->set('REG_paid', $REG_paid);
+	}
+
+
+	/**
+	 *        Attendee Is Going
+	 *
+	 * @param        boolean $REG_att_is_going Attendee Is Going
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_att_is_going($REG_att_is_going = false)
+	{
+		$this->set('REG_att_is_going', $REG_att_is_going);
+	}
+
+
+	/**
+	 * Gets the related attendee
+	 *
+	 * @return EE_Attendee
+	 * @throws EE_Error
+	 */
+	public function attendee()
+	{
+		return $this->get_first_related('Attendee');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_ID()
+	{
+		return $this->get('EVT_ID');
+	}
+
+
+	/**
+	 *        get Event ID
+	 */
+	public function event_name()
+	{
+		$event = $this->event_obj();
+		if ($event) {
+			return $event->name();
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Fetches the event this registration is for
+	 *
+	 * @return EE_Event
+	 * @throws EE_Error
+	 */
+	public function event_obj()
+	{
+		return $this->get_first_related('Event');
+	}
+
+
+	/**
+	 *        get Attendee ID
+	 */
+	public function attendee_ID()
+	{
+		return $this->get('ATT_ID');
+	}
+
+
+	/**
+	 *        get PHP Session ID
+	 */
+	public function session_ID()
+	{
+		return $this->get('REG_session');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the receipt template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 */
+	public function receipt_url($messenger = 'html')
+	{
+
+		/**
+		 * The below will be deprecated one version after this.  We check first if there is a custom receipt template
+		 * already in use on old system.  If there is then we just return the standard url for it.
+		 *
+		 * @since 4.5.0
+		 */
+		$template_relative_path = 'modules/gateways/Invoice/lib/templates/receipt_body.template.php';
+		$has_custom             = EEH_Template::locate_template(
+			$template_relative_path,
+			array(),
+			true,
+			true,
+			true
+		);
+
+		if ($has_custom) {
+			return add_query_arg(array('receipt' => 'true'), $this->invoice_url('launch'));
+		}
+		return apply_filters('FHEE__EE_Registration__receipt_url__receipt_url', '', $this, $messenger, 'receipt');
+	}
+
+
+	/**
+	 * Gets the string which represents the URL trigger for the invoice template in the message template system.
+	 *
+	 * @param string $messenger 'pdf' or 'html'.  Default 'html'.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function invoice_url($messenger = 'html')
+	{
+		/**
+		 * The below will be deprecated one version after this.  We check first if there is a custom invoice template
+		 * already in use on old system.  If there is then we just return the standard url for it.
+		 *
+		 * @since 4.5.0
+		 */
+		$template_relative_path = 'modules/gateways/Invoice/lib/templates/invoice_body.template.php';
+		$has_custom             = EEH_Template::locate_template(
+			$template_relative_path,
+			array(),
+			true,
+			true,
+			true
+		);
+
+		if ($has_custom) {
+			if ($messenger == 'html') {
+				return $this->invoice_url('launch');
+			}
+			$route = $messenger == 'download' || $messenger == 'pdf' ? 'download_invoice' : 'launch_invoice';
+
+			$query_args = array('ee' => $route, 'id' => $this->reg_url_link());
+			if ($messenger == 'html') {
+				$query_args['html'] = true;
+			}
+			return add_query_arg($query_args, get_permalink(EE_Registry::instance()->CFG->core->thank_you_page_id));
+		}
+		return apply_filters('FHEE__EE_Registration__invoice_url__invoice_url', '', $this, $messenger, 'invoice');
+	}
+
+
+	/**
+	 * get Registration URL Link
+	 *
+	 * @access public
+	 * @return string
+	 * @throws \EE_Error
+	 */
+	public function reg_url_link()
+	{
+		return (string) $this->get('REG_url_link');
+	}
+
+
+	/**
+	 * Echoes out invoice_url()
+	 *
+	 * @param string $type 'download','launch', or 'html' (default is 'launch')
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function e_invoice_url($type = 'launch')
+	{
+		echo $this->invoice_url($type);
+	}
+
+
+	/**
+	 * Echoes out payment_overview_url
+	 */
+	public function e_payment_overview_url()
+	{
+		echo $this->payment_overview_url();
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @param bool $clear_session Set to true when you want to clear the session on revisiting the
+	 *                            payment overview url.
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_overview_url($clear_session = false)
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'payment_options',
+			'revisit'        => true,
+			'clear_session' => (bool) $clear_session
+		), EE_Registry::instance()->CFG->core->reg_page_url());
+	}
+
+
+	/**
+	 * Gets the URL of the thank you page with this registration REG_url_link added as
+	 * a query parameter
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function edit_attendee_information_url()
+	{
+		return add_query_arg(array(
+			'e_reg_url_link' => $this->reg_url_link(),
+			'step'           => 'attendee_information',
+			'revisit'        => true,
+		), EE_Registry::instance()->CFG->core->reg_page_url());
+	}
+
+
+	/**
+	 * Simply generates and returns the appropriate admin_url link to edit this registration
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_edit_url()
+	{
+		return EEH_URL::add_query_args_and_nonce(array(
+			'page'    => 'espresso_registrations',
+			'action'  => 'view_registration',
+			'_REG_ID' => $this->ID(),
+		), admin_url('admin.php'));
+	}
+
+
+	/**
+	 *    is_primary_registrant?
+	 */
+	public function is_primary_registrant()
+	{
+		return $this->get('REG_count') == 1 ? true : false;
+	}
+
+
+	/**
+	 * This returns the primary registration object for this registration group (which may be this object).
+	 *
+	 * @return EE_Registration
+	 * @throws EE_Error
+	 */
+	public function get_primary_registration()
+	{
+		if ($this->is_primary_registrant()) {
+			return $this;
+		}
+
+		//k reg_count !== 1 so let's get the EE_Registration object matching this txn_id and reg_count == 1
+		/** @var EE_Registration $primary_registrant */
+		$primary_registrant = EEM_Registration::instance()->get_one(array(
+			array(
+				'TXN_ID'    => $this->transaction_ID(),
+				'REG_count' => 1,
+			),
+		));
+		return $primary_registrant;
+	}
+
+
+	/**
+	 *        get  Attendee Number
+	 *
+	 * @access        public
+	 */
+	public function count()
+	{
+		return $this->get('REG_count');
+	}
+
+
+	/**
+	 *        get Group Size
+	 */
+	public function group_size()
+	{
+		return $this->get('REG_group_size');
+	}
+
+
+	/**
+	 *        get Registration Date
+	 */
+	public function date()
+	{
+		return $this->get('REG_date');
+	}
+
+
+	/**
+	 * gets a pretty date
+	 *
+	 * @param string $date_format
+	 * @param string $time_format
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_date($date_format = null, $time_format = null)
+	{
+		return $this->get_datetime('REG_date', $date_format, $time_format);
+	}
+
+
+	/**
+	 * final_price
+	 * the registration's share of the transaction total, so that the
+	 * sum of all the transaction's REG_final_prices equal the transaction's total
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function final_price()
+	{
+		return $this->get('REG_final_price');
+	}
+
+
+	/**
+	 * pretty_final_price
+	 *  final price as formatted string, with correct decimal places and currency symbol
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_final_price()
+	{
+		return $this->get_pretty('REG_final_price');
+	}
+
+
+	/**
+	 * get paid (yeah)
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function paid()
+	{
+		return $this->get('REG_paid');
+	}
+
+
+	/**
+	 * pretty_paid
+	 *
+	 * @return float
+	 * @throws EE_Error
+	 */
+	public function pretty_paid()
+	{
+		return $this->get_pretty('REG_paid');
+	}
+
+
+	/**
+	 * owes_monies_and_can_pay
+	 * whether or not this registration has monies owing and it's' status allows payment
+	 *
+	 * @param array $requires_payment
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function owes_monies_and_can_pay($requires_payment = array())
+	{
+		// these reg statuses require payment (if event is not free)
+		$requires_payment = ! empty($requires_payment)
+			? $requires_payment
+			: EEM_Registration::reg_statuses_that_allow_payment();
+		if (in_array($this->status_ID(), $requires_payment) &&
+			$this->final_price() != 0 &&
+			$this->final_price() != $this->paid()
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Prints out the return value of $this->pretty_status()
+	 *
+	 * @param bool $show_icons
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function e_pretty_status($show_icons = false)
+	{
+		echo $this->pretty_status($show_icons);
+	}
+
+
+	/**
+	 * Returns a nice version of the status for displaying to customers
+	 *
+	 * @param bool $show_icons
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_status($show_icons = false)
+	{
+		$status = EEM_Status::instance()->localized_status(
+			array($this->status_ID() => esc_html__('unknown', 'event_espresso')),
+			false,
+			'sentence'
+		);
+		$icon   = '';
+		switch ($this->status_ID()) {
+			case EEM_Registration::status_id_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-star-filled ee-icon-size-16 green-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_pending_payment:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-star-half ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_not_approved:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-marker ee-icon-size-16 orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_cancelled:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-grey-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_incomplete:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 lt-orange-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_declined:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-no ee-icon-size-16 red-text"></span>'
+					: '';
+				break;
+			case EEM_Registration::status_id_wait_list:
+				$icon = $show_icons
+					? '<span class="dashicons dashicons-clipboard ee-icon-size-16 purple-text"></span>'
+					: '';
+				break;
+		}
+		return $icon . $status[$this->status_ID()];
+	}
+
+
+	/**
+	 *        get Attendee Is Going
+	 */
+	public function att_is_going()
+	{
+		return $this->get('REG_att_is_going');
+	}
+
+
+	/**
+	 * Gets related answers
+	 *
+	 * @param array $query_params like EEM_Base::get_all
+	 * @return EE_Answer[]
+	 * @throws EE_Error
+	 */
+	public function answers($query_params = null)
+	{
+		return $this->get_many_related('Answer', $query_params);
+	}
+
+
+	/**
+	 * Gets the registration's answer value to the specified question
+	 * (either the question's ID or a question object)
+	 *
+	 * @param EE_Question|int $question
+	 * @param bool            $pretty_value
+	 * @return array|string if pretty_value= true, the result will always be a string
+	 * (because the answer might be an array of answer values, so passing pretty_value=true
+	 * will convert it into some kind of string)
+	 * @throws EE_Error
+	 */
+	public function answer_value_to_question($question, $pretty_value = true)
+	{
+		$question_id = EEM_Question::instance()->ensure_is_ID($question);
+		return EEM_Answer::instance()->get_answer_value_to_question($this, $question_id, $pretty_value);
+	}
+
+
+	/**
+	 * question_groups
+	 * returns an array of EE_Question_Group objects for this registration
+	 *
+	 * @return EE_Question_Group[]
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function question_groups()
+	{
+		$question_groups = array();
+		if ($this->event() instanceof EE_Event) {
+			$question_groups = $this->event()->question_groups(
+				array(
+					array(
+						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
+					),
+					'order_by' => array('QSG_order' => 'ASC'),
+				)
+			);
+		}
+		return $question_groups;
+	}
+
+
+	/**
+	 * count_question_groups
+	 * returns a count of the number of EE_Question_Group objects for this registration
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function count_question_groups()
+	{
+		$qg_count = 0;
+		if ($this->event() instanceof EE_Event) {
+			$qg_count = $this->event()->count_related(
+				'Question_Group',
+				array(
+					array(
+						'Event_Question_Group.EQG_primary' => $this->count() == 1 ? true : false,
+					),
+				)
+			);
+		}
+		return $qg_count;
+	}
+
+
+	/**
+	 * Returns the registration date in the 'standard' string format
+	 * (function may be improved in the future to allow for different formats and timezones)
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function reg_date()
+	{
+		return $this->get_datetime('REG_date');
+	}
+
+
+	/**
+	 * Gets the datetime-ticket for this registration (ie, it can be used to isolate
+	 * the ticket this registration purchased, or the datetime they have registered
+	 * to attend)
+	 *
+	 * @return EE_Datetime_Ticket
+	 * @throws EE_Error
+	 */
+	public function datetime_ticket()
+	{
+		return $this->get_first_related('Datetime_Ticket');
+	}
+
+
+	/**
+	 * Sets the registration's datetime_ticket.
+	 *
+	 * @param EE_Datetime_Ticket $datetime_ticket
+	 * @return EE_Datetime_Ticket
+	 * @throws EE_Error
+	 */
+	public function set_datetime_ticket($datetime_ticket)
+	{
+		return $this->_add_relation_to($datetime_ticket, 'Datetime_Ticket');
+	}
+
+	/**
+	 * Gets deleted
+	 *
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function deleted()
+	{
+		return $this->get('REG_deleted');
+	}
+
+	/**
+	 * Sets deleted
+	 *
+	 * @param boolean $deleted
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_deleted($deleted)
+	{
+		if ($deleted) {
+			$this->delete();
+		} else {
+			$this->restore();
+		}
+	}
+
+
+	/**
+	 * Get the status object of this object
+	 *
+	 * @return EE_Status
+	 * @throws EE_Error
+	 */
+	public function status_obj()
+	{
+		return $this->get_first_related('Status');
+	}
+
+
+	/**
+	 * Returns the number of times this registration has checked into any of the datetimes
+	 * its available for
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_checkins()
+	{
+		return $this->get_model()->count_related($this, 'Checkin');
+	}
+
+
+	/**
+	 * Returns the number of current Check-ins this registration is checked into for any of the datetimes the
+	 * registration is for.  Note, this is ONLY checked in (does not include checkedout)
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_checkins_not_checkedout()
+	{
+		return $this->get_model()->count_related($this, 'Checkin', array(array('CHK_in' => 1)));
+	}
+
+
+	/**
+	 * The purpose of this method is simply to check whether this registration can checkin to the given datetime.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID      The datetime the registration is being checked against
+	 * @param bool              $check_approved This is used to indicate whether the caller wants can_checkin to also
+	 *                                          consider registration status as well as datetime access.
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function can_checkin($DTT_OR_ID, $check_approved = true)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		//first check registration status
+		if (($check_approved && ! $this->is_approved()) || ! $DTT_ID) {
+			return false;
+		}
+		//is there a datetime ticket that matches this dtt_ID?
+		if (! (EEM_Datetime_Ticket::instance()->exists(array(
+			array(
+				'TKT_ID' => $this->get('TKT_ID'),
+				'DTT_ID' => $DTT_ID,
+			),
+		)))
+		) {
+			return false;
+		}
+
+		//final check is against TKT_uses
+		return $this->verify_can_checkin_against_TKT_uses($DTT_ID);
+	}
+
+
+	/**
+	 * This method verifies whether the user can checkin for the given datetime considering the max uses value set on
+	 * the ticket. To do this,  a query is done to get the count of the datetime records already checked into.  If the
+	 * datetime given does not have a check-in record and checking in for that datetime will exceed the allowed uses,
+	 * then return false.  Otherwise return true.
+	 *
+	 * @param int | EE_Datetime $DTT_OR_ID The datetime the registration is being checked against
+	 * @return bool true means can checkin.  false means cannot checkin.
+	 * @throws EE_Error
+	 */
+	public function verify_can_checkin_against_TKT_uses($DTT_OR_ID)
+	{
+		$DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
+
+		if (! $DTT_ID) {
+			return false;
+		}
+
+		$max_uses = $this->ticket() instanceof EE_Ticket ? $this->ticket()->uses() : EE_INF;
+
+		// if max uses is not set or equals infinity then return true cause its not a factor for whether user can
+		// check-in or not.
+		if (! $max_uses || $max_uses === EE_INF) {
+			return true;
+		}
+
+		//does this datetime have a checkin record?  If so, then the dtt count has already been verified so we can just
+		//go ahead and toggle.
+		if (EEM_Checkin::instance()->exists(array(array('REG_ID' => $this->ID(), 'DTT_ID' => $DTT_ID)))) {
+			return true;
+		}
+
+		//made it here so the last check is whether the number of checkins per unique datetime on this registration
+		//disallows further check-ins.
+		$count_unique_dtt_checkins = EEM_Checkin::instance()->count(array(
+			array(
+				'REG_ID' => $this->ID(),
+				'CHK_in' => true,
+			),
+		), 'DTT_ID', true);
+		// checkins have already reached their max number of uses
+		// so registrant can NOT checkin
+		if ($count_unique_dtt_checkins >= $max_uses) {
+			EE_Error::add_error(
+				esc_html__(
+					'Check-in denied because number of datetime uses for the ticket has been reached or exceeded.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * toggle Check-in status for this registration
+	 * Check-ins are toggled in the following order:
+	 * never checked in -> checked in
+	 * checked in -> checked out
+	 * checked out -> checked in
+	 *
+	 * @param  int $DTT_ID  include specific datetime to toggle Check-in for.
+	 *                      If not included or null, then it is assumed latest datetime is being toggled.
+	 * @param bool $verify  If true then can_checkin() is used to verify whether the person
+	 *                      can be checked in or not.  Otherwise this forces change in checkin status.
+	 * @return bool|int     the chk_in status toggled to OR false if nothing got changed.
+	 * @throws EE_Error
+	 */
+	public function toggle_checkin_status($DTT_ID = null, $verify = false)
+	{
+		if (empty($DTT_ID)) {
+			$datetime = $this->get_latest_related_datetime();
+			$DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
+			// verify the registration can checkin for the given DTT_ID
+		} elseif (! $this->can_checkin($DTT_ID, $verify)) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The given registration (ID:%1$d) can not be checked in to the given DTT_ID (%2$d), because the registration does not have access',
+						'event_espresso'
+					),
+					$this->ID(),
+					$DTT_ID
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$status_paths = array(
+			EE_Checkin::status_checked_never => EE_Checkin::status_checked_in,
+			EE_Checkin::status_checked_in    => EE_Checkin::status_checked_out,
+			EE_Checkin::status_checked_out   => EE_Checkin::status_checked_in,
+		);
+		//start by getting the current status so we know what status we'll be changing to.
+		$cur_status = $this->check_in_status_for_datetime($DTT_ID, null);
+		$status_to  = $status_paths[$cur_status];
+		// database only records true for checked IN or false for checked OUT
+		// no record ( null ) means checked in NEVER, but we obviously don't save that
+		$new_status = $status_to === EE_Checkin::status_checked_in ? true : false;
+		// add relation - note Check-ins are always creating new rows
+		// because we are keeping track of Check-ins over time.
+		// Eventually we'll probably want to show a list table
+		// for the individual Check-ins so that they can be managed.
+		$checkin = EE_Checkin::new_instance(array(
+			'REG_ID' => $this->ID(),
+			'DTT_ID' => $DTT_ID,
+			'CHK_in' => $new_status,
+		));
+		// if the record could not be saved then return false
+		if ($checkin->save() === 0) {
+			if (WP_DEBUG) {
+				global $wpdb;
+				$error = sprintf(
+					esc_html__(
+						'Registration check in update failed because of the following database error: %1$s%2$s',
+						'event_espresso'
+					),
+					'<br />',
+					$wpdb->last_error
+				);
+			} else {
+				$error = esc_html__(
+					'Registration check in update failed because of an unknown database error',
+					'event_espresso'
+				);
+			}
+			EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return $status_to;
+	}
+
+
+	/**
+	 * Returns the latest datetime related to this registration (via the ticket attached to the registration).
+	 * "Latest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @return EE_Datetime|null
+	 * @throws \EE_Error
+	 */
+	public function get_latest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				),
+				'order_by' => array('DTT_EVT_start' => 'DESC'),
+			)
+		);
+	}
+
+
+	/**
+	 * Returns the earliest datetime related to this registration (via the ticket attached to the registration).
+	 * "Earliest" is defined by the `DTT_EVT_start` column.
+	 *
+	 * @throws \EE_Error
+	 */
+	public function get_earliest_related_datetime()
+	{
+		return EEM_Datetime::instance()->get_one(
+			array(
+				array(
+					'Ticket.Registration.REG_ID' => $this->ID(),
+				),
+				'order_by' => array('DTT_EVT_start' => 'ASC'),
+			)
+		);
+	}
+
+
+	/**
+	 * This method simply returns the check-in status for this registration and the given datetime.
+	 * If neither the datetime nor the checkin values are provided as arguments,
+	 * then this will return the LATEST check-in status for the registration across all datetimes it belongs to.
+	 *
+	 * @param  int       $DTT_ID  The ID of the datetime we're checking against
+	 *                            (if empty we'll get the primary datetime for
+	 *                            this registration (via event) and use it's ID);
+	 * @param EE_Checkin $checkin If present, we use the given checkin object rather than the dtt_id.
+	 * @return int                Integer representing Check-in status.
+	 * @throws \EE_Error
+	 */
+	public function check_in_status_for_datetime($DTT_ID = 0, $checkin = null)
+	{
+		$checkin_query_params = array(
+			'order_by' => array('CHK_timestamp' => 'DESC'),
+		);
+
+		if ($DTT_ID > 0) {
+			$checkin_query_params[0] = array('DTT_ID' => $DTT_ID);
+		}
+
+		//get checkin object (if exists)
+		$checkin = $checkin instanceof EE_Checkin
+			? $checkin
+			: $this->get_first_related('Checkin', $checkin_query_params);
+		if ($checkin instanceof EE_Checkin) {
+			if ($checkin->get('CHK_in')) {
+				return EE_Checkin::status_checked_in; //checked in
+			}
+			return EE_Checkin::status_checked_out; //had checked in but is now checked out.
+		}
+		return EE_Checkin::status_checked_never; //never been checked in
+	}
+
+
+	/**
+	 * This method returns a localized message for the toggled Check-in message.
+	 *
+	 * @param  int $DTT_ID include specific datetime to get the correct Check-in message.  If not included or null,
+	 *                     then it is assumed Check-in for primary datetime was toggled.
+	 * @param bool $error  This just flags that you want an error message returned. This is put in so that the error
+	 *                     message can be customized with the attendee name.
+	 * @return string internationalized message
+	 * @throws EE_Error
+	 */
+	public function get_checkin_msg($DTT_ID, $error = false)
+	{
+		//let's get the attendee first so we can include the name of the attendee
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			if ($error) {
+				return sprintf(__("%s's check-in status was not changed.", "event_espresso"), $attendee->full_name());
+			}
+			$cur_status = $this->check_in_status_for_datetime($DTT_ID);
+			//what is the status message going to be?
+			switch ($cur_status) {
+				case EE_Checkin::status_checked_never:
+					return sprintf(__("%s has been removed from Check-in records", "event_espresso"),
+						$attendee->full_name());
+					break;
+				case EE_Checkin::status_checked_in:
+					return sprintf(__('%s has been checked in', 'event_espresso'), $attendee->full_name());
+					break;
+				case EE_Checkin::status_checked_out:
+					return sprintf(__('%s has been checked out', 'event_espresso'), $attendee->full_name());
+					break;
+			}
+		}
+		return esc_html__("The check-in status could not be determined.", "event_espresso");
+	}
+
+
+	/**
+	 * Returns the related EE_Transaction to this registration
+	 *
+	 * @return EE_Transaction
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function transaction()
+	{
+		$transaction = $this->get_first_related('Transaction');
+		if (! $transaction instanceof \EE_Transaction) {
+			throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 *        get Registration Code
+	 */
+	public function reg_code()
+	{
+		return $this->get('REG_code');
+	}
+
+
+	/**
+	 *        get Transaction ID
+	 */
+	public function transaction_ID()
+	{
+		return $this->get('TXN_ID');
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function ticket_ID()
+	{
+		return $this->get('TKT_ID');
+	}
+
+
+	/**
+	 *        Set Registration Code
+	 *
+	 * @access    public
+	 * @param    string  $REG_code Registration Code
+	 * @param    boolean $use_default
+	 * @throws EE_Error
+	 */
+	public function set_reg_code($REG_code, $use_default = false)
+	{
+		if (empty($REG_code)) {
+			EE_Error::add_error(
+				esc_html__('REG_code can not be empty.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return;
+		}
+		if (! $this->reg_code()) {
+			parent::set('REG_code', $REG_code, $use_default);
+		} else {
+			EE_Error::doing_it_wrong(
+				__CLASS__ . '::' . __FUNCTION__,
+				esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
+				'4.6.0'
+			);
+		}
+	}
+
+
+	/**
+	 * Returns all other registrations in the same group as this registrant who have the same ticket option.
+	 * Note, if you want to just get all registrations in the same transaction (group), use:
+	 *    $registration->transaction()->registrations();
+	 *
+	 * @since 4.5.0
+	 * @return EE_Registration[] or empty array if this isn't a group registration.
+	 * @throws EE_Error
+	 */
+	public function get_all_other_registrations_in_group()
+	{
+		if ($this->group_size() < 2) {
+			return array();
+		}
+
+		$query[0] = array(
+			'TXN_ID' => $this->transaction_ID(),
+			'REG_ID' => array('!=', $this->ID()),
+			'TKT_ID' => $this->ticket_ID(),
+		);
+		/** @var EE_Registration[] $registrations */
+		$registrations = $this->get_model()->get_all($query);
+		return $registrations;
+	}
+
+	/**
+	 * Return the link to the admin details for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_details_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page'    => 'espresso_registrations',
+				'action'  => 'view_registration',
+				'_REG_ID' => $this->ID(),
+			),
+			admin_url('admin.php')
+		);
+	}
+
+	/**
+	 * Returns the link to the editor for the object.  Sometimes this is the same as the details.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_edit_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to a settings page for the object.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_admin_settings_link()
+	{
+		return $this->get_admin_details_link();
+	}
+
+	/**
+	 * Returns the link to the "overview" for the object (typically the "list table" view).
+	 *
+	 * @return string
+	 */
+	public function get_admin_overview_link()
+	{
+		EE_Registry::instance()->load_helper('URL');
+		return EEH_URL::add_query_args_and_nonce(
+			array(
+				'page' => 'espresso_registrations',
+			),
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return \EE_Registration[]
+	 * @throws \EE_Error
+	 */
+	public function payments($query_params = array())
+	{
+		return $this->get_many_related('Payment', $query_params);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return \EE_Registration_Payment[]
+	 * @throws \EE_Error
+	 */
+	public function registration_payments($query_params = array())
+	{
+		return $this->get_many_related('Registration_Payment', $query_params);
+	}
+
+
+	/**
+	 * This grabs the payment method corresponding to the last payment made for the amount owing on the registration.
+	 * Note: if there are no payments on the registration there will be no payment method returned.
+	 *
+	 * @return EE_Payment_Method|null
+	 */
+	public function payment_method()
+	{
+		return EEM_Payment_Method::instance()->get_last_used_for_registration($this);
+	}
+
+
+	/**
+	 * @return \EE_Line_Item
+	 * @throws EntityNotFoundException
+	 * @throws \EE_Error
+	 */
+	public function ticket_line_item()
+	{
+		$ticket            = $this->ticket();
+		$transaction       = $this->transaction();
+		$line_item         = null;
+		$ticket_line_items = \EEH_Line_Item::get_line_items_by_object_type_and_IDs(
+			$transaction->total_line_item(),
+			'Ticket',
+			array($ticket->ID())
+		);
+		foreach ($ticket_line_items as $ticket_line_item) {
+			if (
+				$ticket_line_item instanceof \EE_Line_Item
+				&& $ticket_line_item->OBJ_type() === 'Ticket'
+				&& $ticket_line_item->OBJ_ID() === $ticket->ID()
+			) {
+				$line_item = $ticket_line_item;
+				break;
+			}
+		}
+		if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+			throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
+		}
+		return $line_item;
+	}
+
+
+	/**
+	 * Soft Deletes this model object.
+	 *
+	 * @return boolean | int
+	 * @throws \RuntimeException
+	 * @throws \EE_Error
+	 */
+	public function delete()
+	{
+		if ($this->update_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY, $this->status_ID()) === true) {
+			$this->set_status(EEM_Registration::status_id_cancelled);
+		}
+		return parent::delete();
+	}
+
+
+	/**
+	 * Restores whatever the previous status was on a registration before it was trashed (if possible)
+	 *
+	 * @throws \EE_Error
+	 * @throws \RuntimeException
+	 */
+	public function restore()
+	{
+		$previous_status = $this->get_extra_meta(
+			EE_Registration::PRE_TRASH_REG_STATUS_KEY,
+			true,
+			EEM_Registration::status_id_cancelled
+		);
+		if ($previous_status) {
+			$this->delete_extra_meta(EE_Registration::PRE_TRASH_REG_STATUS_KEY);
+			$this->set_status($previous_status);
+		}
+		return parent::restore();
+	}
+
+
+
+	/*************************** DEPRECATED ***************************/
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 */
+	public function price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::price_paid()',
+			esc_html__('This method is deprecated, please use EE_Registration::final_price() instead.', 'event_espresso'),
+			'4.7.0');
+		return $this->final_price();
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since     4.7.0
+	 * @access    public
+	 * @param    float $REG_final_price
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function set_price_paid($REG_final_price = 0.00)
+	{
+		EE_Error::doing_it_wrong('EE_Registration::set_price_paid()',
+			esc_html__('This method is deprecated, please use EE_Registration::set_final_price() instead.', 'event_espresso'),
+			'4.7.0');
+		$this->set_final_price($REG_final_price);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @since 4.7.0
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function pretty_price_paid()
+	{
+		EE_Error::doing_it_wrong('EE_Registration::pretty_price_paid()',
+			esc_html__('This method is deprecated, please use EE_Registration::pretty_final_price() instead.',
+				'event_espresso'), '4.7.0');
+		return $this->pretty_final_price();
+	}
+
+
+	/**
+	 * Gets the primary datetime related to this registration via the related Event to this registration
+	 *
+	 * @deprecated 4.9.17
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 */
+	public function get_related_primary_datetime()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Use EE_Registration::get_latest_related_datetime() or EE_Registration::get_earliest_related_datetime()',
+				'event_espresso'
+			),
+			'4.9.17',
+			'5.0.0'
+		);
+		return $this->event()->primary_datetime();
+	}
 
 
 }

Spacing +13 added lines, -13 removed lines

@@ -120,7 +120,7 @@ 
     {
         switch ($field_name) {
             case 'REG_code':
-                if (! empty($field_value) && $this->reg_code() === null) {
+                if ( ! empty($field_value) && $this->reg_code() === null) {
                     $this->set_reg_code($field_value, $use_default);
                 }
                 break;
@@ -181,7 +181,7 @@ 
             // update status
             parent::set('STS_ID', $new_STS_ID, $use_default);
             $this->_update_if_canceled_or_declined($new_STS_ID, $old_STS_ID, $context);
-            if($this->statusChangeUpdatesTransaction($context)) {
+            if ($this->statusChangeUpdatesTransaction($context)) {
                 $this->updateTransactionAfterStatusChange();
             }
             do_action('AHEE__EE_Registration__set_status__after_update', $this, $old_STS_ID, $new_STS_ID, $context);
@@ -408,7 +408,7 @@ 
     public function event()
     {
         $event = $this->get_first_related('Event');
-        if (! $event instanceof \EE_Event) {
+        if ( ! $event instanceof \EE_Event) {
             throw new EntityNotFoundException('Event ID', $this->event_ID());
         }
         return $event;
@@ -1097,7 +1097,7 @@ 
             false,
             'sentence'
         );
-        $icon   = '';
+        $icon = '';
         switch ($this->status_ID()) {
             case EEM_Registration::status_id_approved:
                 $icon = $show_icons
@@ -1135,7 +1135,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[$this->status_ID()];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -1353,7 +1353,7 @@ 
             return false;
         }
         //is there a datetime ticket that matches this dtt_ID?
-        if (! (EEM_Datetime_Ticket::instance()->exists(array(
+        if ( ! (EEM_Datetime_Ticket::instance()->exists(array(
             array(
                 'TKT_ID' => $this->get('TKT_ID'),
                 'DTT_ID' => $DTT_ID,
@@ -1382,7 +1382,7 @@ 
     {
         $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
-        if (! $DTT_ID) {
+        if ( ! $DTT_ID) {
             return false;
         }
 
@@ -1390,7 +1390,7 @@ 
 
         // if max uses is not set or equals infinity then return true cause its not a factor for whether user can
         // check-in or not.
-        if (! $max_uses || $max_uses === EE_INF) {
+        if ( ! $max_uses || $max_uses === EE_INF) {
             return true;
         }
 
@@ -1446,7 +1446,7 @@ 
             $datetime = $this->get_latest_related_datetime();
             $DTT_ID   = $datetime instanceof EE_Datetime ? $datetime->ID() : 0;
             // verify the registration can checkin for the given DTT_ID
-        } elseif (! $this->can_checkin($DTT_ID, $verify)) {
+        } elseif ( ! $this->can_checkin($DTT_ID, $verify)) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -1629,7 +1629,7 @@ 
     public function transaction()
     {
         $transaction = $this->get_first_related('Transaction');
-        if (! $transaction instanceof \EE_Transaction) {
+        if ( ! $transaction instanceof \EE_Transaction) {
             throw new EntityNotFoundException('Transaction ID', $this->transaction_ID());
         }
         return $transaction;
@@ -1683,11 +1683,11 @@ 
             );
             return;
         }
-        if (! $this->reg_code()) {
+        if ( ! $this->reg_code()) {
             parent::set('REG_code', $REG_code, $use_default);
         } else {
             EE_Error::doing_it_wrong(
-                __CLASS__ . '::' . __FUNCTION__,
+                __CLASS__.'::'.__FUNCTION__,
                 esc_html__('Can not change a registration REG_code once it has been set.', 'event_espresso'),
                 '4.6.0'
             );
@@ -1837,7 +1837,7 @@ 
                 break;
             }
         }
-        if (! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
+        if ( ! ($line_item instanceof \EE_Line_Item && $line_item->OBJ_type() === 'Ticket')) {
             throw new EntityNotFoundException('Line Item Ticket ID', $ticket->ID());
         }
         return $line_item;

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1856 added lines, -1856 removed lines

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

Spacing +27 added lines, -27 removed lines

@@ -218,19 +218,19 @@ 
      */
     public static function set_definitions()
     {
-        if(defined('SPCO_BASE_PATH')) {
+        if (defined('SPCO_BASE_PATH')) {
             return;
         }
         define(
             'SPCO_BASE_PATH',
-            rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS) . DS
+            rtrim(str_replace(array('\\', '/'), DS, plugin_dir_path(__FILE__)), DS).DS
         );
-        define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css' . DS);
-        define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img' . DS);
-        define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js' . DS);
-        define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc' . DS);
-        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps' . DS);
-        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates' . DS);
+        define('SPCO_CSS_URL', plugin_dir_url(__FILE__).'css'.DS);
+        define('SPCO_IMG_URL', plugin_dir_url(__FILE__).'img'.DS);
+        define('SPCO_JS_URL', plugin_dir_url(__FILE__).'js'.DS);
+        define('SPCO_INC_PATH', SPCO_BASE_PATH.'inc'.DS);
+        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH.'reg_steps'.DS);
+        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH.'templates'.DS);
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
         EE_Registry::$i18n_js_strings['registration_expiration_notice'] = sprintf(
             __('%1$sWe\'re sorry, but you\'re registration time has expired.%2$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please except our apologies for any inconvenience this may have caused.%8$s',
@@ -239,7 +239,7 @@ 
             '</h4>',
             '<br />',
             '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+            '<a href="'.get_post_type_archive_link('espresso_events').'" title="',
             '">',
             '</a>',
             '</p>'
@@ -262,7 +262,7 @@ 
             return;
         }
         // filter list of reg_steps
-        $reg_steps_to_load = (array)apply_filters(
+        $reg_steps_to_load = (array) apply_filters(
             'AHEE__SPCO__load_reg_steps__reg_steps_to_load',
             EED_Single_Page_Checkout::get_reg_steps()
         );
@@ -314,25 +314,25 @@ 
         if (empty($reg_steps)) {
             $reg_steps = array(
                 10  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'attendee_information',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'attendee_information',
                     'class_name' => 'EE_SPCO_Reg_Step_Attendee_Information',
                     'slug'       => 'attendee_information',
                     'has_hooks'  => false,
                 ),
                 20  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'registration_confirmation',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'registration_confirmation',
                     'class_name' => 'EE_SPCO_Reg_Step_Registration_Confirmation',
                     'slug'       => 'registration_confirmation',
                     'has_hooks'  => false,
                 ),
                 30  => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'payment_options',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'payment_options',
                     'class_name' => 'EE_SPCO_Reg_Step_Payment_Options',
                     'slug'       => 'payment_options',
                     'has_hooks'  => true,
                 ),
                 999 => array(
-                    'file_path'  => SPCO_REG_STEPS_PATH . 'finalize_registration',
+                    'file_path'  => SPCO_REG_STEPS_PATH.'finalize_registration',
                     'class_name' => 'EE_SPCO_Reg_Step_Finalize_Registration',
                     'slug'       => 'finalize_registration',
                     'has_hooks'  => false,
@@ -516,7 +516,7 @@ 
             // DEBUG LOG
             //$this->checkout->log( __CLASS__, __FUNCTION__, __LINE__ );
             // get reg form
-            if( ! $this->_check_form_submission()) {
+            if ( ! $this->_check_form_submission()) {
                 EED_Single_Page_Checkout::$_initialized = true;
                 return;
             }
@@ -557,7 +557,7 @@ 
         );
         // is session still valid ?
         if ($clear_session_requested
-            || ( EE_Registry::instance()->SSN->expired()
+            || (EE_Registry::instance()->SSN->expired()
               && EE_Registry::instance()->REQ->get('e_reg_url_link', '') === ''
             )
         ) {
@@ -566,7 +566,7 @@ 
             // EE_Registry::instance()->SSN->reset_cart();
             // EE_Registry::instance()->SSN->reset_checkout();
             // EE_Registry::instance()->SSN->reset_transaction();
-            if (! $clear_session_requested) {
+            if ( ! $clear_session_requested) {
                 EE_Error::add_attention(
                     EE_Registry::$i18n_js_strings['registration_expiration_notice'],
                     __FILE__, __FUNCTION__, __LINE__
@@ -1121,7 +1121,7 @@ 
                     if ( ! $registration instanceof EE_Registration) {
                         throw new InvalidEntityException($registration, 'EE_Registration');
                     }
-                    $registrations[ $registration->ID() ] = $registration;
+                    $registrations[$registration->ID()] = $registration;
                 }
             }
             $registration_processor->fix_reg_final_price_rounding_issue($transaction);
@@ -1382,7 +1382,7 @@ 
                         ) {
                             EE_Error::add_success(
                                 $this->checkout->current_step->success_message()
-                                . '<br />' . $this->checkout->next_step->_instructions()
+                                . '<br />'.$this->checkout->next_step->_instructions()
                             );
                         }
                         // pack it up, pack it in...
@@ -1507,7 +1507,7 @@ 
             '</h4>',
             '<br />',
             '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+            '<a href="'.get_post_type_archive_link('espresso_events').'" title="',
             '">',
             '</a>',
             '</p>'
@@ -1539,7 +1539,7 @@ 
         // load css
         wp_register_style(
             'single_page_checkout',
-            SPCO_CSS_URL . 'single_page_checkout.css',
+            SPCO_CSS_URL.'single_page_checkout.css',
             array('espresso_default'),
             EVENT_ESPRESSO_VERSION
         );
@@ -1547,21 +1547,21 @@ 
         // load JS
         wp_register_script(
             'jquery_plugin',
-            EE_THIRD_PARTY_URL . 'jquery	.plugin.min.js',
+            EE_THIRD_PARTY_URL.'jquery	.plugin.min.js',
             array('jquery'),
             '1.0.1',
             true
         );
         wp_register_script(
             'jquery_countdown',
-            EE_THIRD_PARTY_URL . 'jquery	.countdown.min.js',
+            EE_THIRD_PARTY_URL.'jquery	.countdown.min.js',
             array('jquery_plugin'),
             '2.0.2',
             true
         );
         wp_register_script(
             'single_page_checkout',
-            SPCO_JS_URL . 'single_page_checkout.js',
+            SPCO_JS_URL.'single_page_checkout.js',
             array('espresso_core', 'underscore', 'ee_form_section_validation', 'jquery_countdown'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -1584,7 +1584,7 @@ 
          *      AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__attendee_information
          */
         do_action(
-            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__' . $this->checkout->current_step->slug(),
+            'AHEE__EED_Single_Page_Checkout__enqueue_styles_and_scripts__'.$this->checkout->current_step->slug(),
             $this
         );
     }
@@ -1638,7 +1638,7 @@ 
                     'layout_strategy' =>
                         new EE_Template_Layout(
                             array(
-                                'layout_template_file' => SPCO_TEMPLATES_PATH . 'registration_page_wrapper.template.php',
+                                'layout_template_file' => SPCO_TEMPLATES_PATH.'registration_page_wrapper.template.php',
                                 'template_args'        => array(
                                     'empty_cart'              => $empty_cart,
                                     'revisit'                 => $this->checkout->revisit,
@@ -1713,7 +1713,7 @@ 
         ) {
             add_filter(
                 'FHEE__EEH_Template__powered_by_event_espresso__url',
-                function ($url) {
+                function($url) {
                     return apply_filters('FHEE__EE_Front_Controller__registration_footer__url', $url);
                 }
             );

core/libraries/plugin_api/EE_Register_Capabilities.lib.php

Indentation +159 added lines, -159 removed lines

@@ -7,7 +7,7 @@ 
  * @since           4.5.0
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -21,174 +21,174 @@ 
 class EE_Register_Capabilities implements EEI_Plugin_API
 {
 
-    /**
-     * Holds the settings for a specific registration.
-     *
-     * @var array
-     */
-    protected static $_registry = array();
+	/**
+	 * Holds the settings for a specific registration.
+	 *
+	 * @var array
+	 */
+	protected static $_registry = array();
 
 
-    /**
-     * Used to register capability items with EE core.
-     *
-     * @since 4.5.0
-     * @param string $cap_reference                                                       usually will be a class name
-     *                                                                                    that references capability
-     *                                                                                    related items setup for
-     *                                                                                    something.
-     * @param array  $setup_args                                                          {
-     *                                                                                    An array of items related to
-     *                                                                                    registering capabilities.
-     * @type array   $capabilities                                                        An array mapping capability
-     *       strings to core WP Role. Something like: array(
-     *                                                                                    'administrator'    => array(
-     *                                                                                    'read_cap', 'edit_cap',
-     *                                                                                    'delete_cap'),
-     *                                                                                    'author'                =>
-     *                                                                                    array( 'read_cap' )
-     *                                                                                    ).
-     * @type array   $capability_maps                                                     EE_Meta_Capability_Map[]
-     * @see   EE_Capabilities.php for php docs on these objects.
-     *                                                                                    Should be indexed by the
-     *                                                                                    classname for the capability
-     *                                                                                    map and values representing
-     *                                                                                    the arguments for the map.
-     *                                                                                    }
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($cap_reference = null, $setup_args = array())
-    {
-        //required fields MUST be present, so let's make sure they are.
-        if ($cap_reference === null || ! is_array($setup_args) || empty($setup_args['capabilities'])) {
-            throw new EE_Error(
-                __('In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".',
-                    'event_espresso')
-            );
-        }
-        //make sure we don't register twice
-        if (isset(self::$_registry[$cap_reference])) {
-            return;
-        }
-        //make sure this is not registered too late or too early.
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) {
-            EE_Error::doing_it_wrong(__METHOD__,
-                sprintf(__('%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
-                    'event_espresso'), $cap_reference), '4.5.0');
-        }
-        //some preliminary sanitization and setting to the $_registry property
-        self::$_registry[ $cap_reference ] = array(
-            'caps'               => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
-                ? $setup_args['capabilities']
-                : array(),
-            'cap_maps'           => isset($setup_args['capability_maps'])
-                ? $setup_args['capability_maps']
-                : array(),
-        );
-        //set initial caps (note that EE_Capabilities takes care of making sure that the caps get added only once)
-        add_filter(
-            'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-            array('EE_Register_Capabilities', 'register_capabilities')
-        );
-        //add filter for cap maps
-        add_filter(
-            'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
-            array('EE_Register_Capabilities', 'register_cap_maps')
-        );
-    }
+	/**
+	 * Used to register capability items with EE core.
+	 *
+	 * @since 4.5.0
+	 * @param string $cap_reference                                                       usually will be a class name
+	 *                                                                                    that references capability
+	 *                                                                                    related items setup for
+	 *                                                                                    something.
+	 * @param array  $setup_args                                                          {
+	 *                                                                                    An array of items related to
+	 *                                                                                    registering capabilities.
+	 * @type array   $capabilities                                                        An array mapping capability
+	 *       strings to core WP Role. Something like: array(
+	 *                                                                                    'administrator'    => array(
+	 *                                                                                    'read_cap', 'edit_cap',
+	 *                                                                                    'delete_cap'),
+	 *                                                                                    'author'                =>
+	 *                                                                                    array( 'read_cap' )
+	 *                                                                                    ).
+	 * @type array   $capability_maps                                                     EE_Meta_Capability_Map[]
+	 * @see   EE_Capabilities.php for php docs on these objects.
+	 *                                                                                    Should be indexed by the
+	 *                                                                                    classname for the capability
+	 *                                                                                    map and values representing
+	 *                                                                                    the arguments for the map.
+	 *                                                                                    }
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($cap_reference = null, $setup_args = array())
+	{
+		//required fields MUST be present, so let's make sure they are.
+		if ($cap_reference === null || ! is_array($setup_args) || empty($setup_args['capabilities'])) {
+			throw new EE_Error(
+				__('In order to register capabilities with EE_Register_Capabilities::register, you must include a unique name to reference the capabilities being registered, plus an array containing the following keys: "capabilities".',
+					'event_espresso')
+			);
+		}
+		//make sure we don't register twice
+		if (isset(self::$_registry[$cap_reference])) {
+			return;
+		}
+		//make sure this is not registered too late or too early.
+		if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) {
+			EE_Error::doing_it_wrong(__METHOD__,
+				sprintf(__('%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
+					'event_espresso'), $cap_reference), '4.5.0');
+		}
+		//some preliminary sanitization and setting to the $_registry property
+		self::$_registry[ $cap_reference ] = array(
+			'caps'               => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
+				? $setup_args['capabilities']
+				: array(),
+			'cap_maps'           => isset($setup_args['capability_maps'])
+				? $setup_args['capability_maps']
+				: array(),
+		);
+		//set initial caps (note that EE_Capabilities takes care of making sure that the caps get added only once)
+		add_filter(
+			'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+			array('EE_Register_Capabilities', 'register_capabilities')
+		);
+		//add filter for cap maps
+		add_filter(
+			'FHEE__EE_Capabilities___set_meta_caps__meta_caps',
+			array('EE_Register_Capabilities', 'register_cap_maps')
+		);
+	}
 
 
-    /**
-     * callback for FHEE__EE_Capabilities__init_caps_map__caps filter.
-     * Takes care of registering additional capabilities to the caps map.   Note, that this also on the initial
-     * registration ensures that new capabilities are added to existing roles.
-     *
-     * @param array $incoming_caps The original caps map.
-     * @return array merged in new caps.
-     */
-    public static function register_capabilities($incoming_caps)
-    {
-        foreach (self::$_registry as $cap_reference => $caps_and_cap_map) {
-            $incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']);
-        }
-        return $incoming_caps;
-    }
+	/**
+	 * callback for FHEE__EE_Capabilities__init_caps_map__caps filter.
+	 * Takes care of registering additional capabilities to the caps map.   Note, that this also on the initial
+	 * registration ensures that new capabilities are added to existing roles.
+	 *
+	 * @param array $incoming_caps The original caps map.
+	 * @return array merged in new caps.
+	 */
+	public static function register_capabilities($incoming_caps)
+	{
+		foreach (self::$_registry as $cap_reference => $caps_and_cap_map) {
+			$incoming_caps = array_merge_recursive($incoming_caps, $caps_and_cap_map['caps']);
+		}
+		return $incoming_caps;
+	}
 
 
-    /**
-     * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of
-     * capability maps for the WP meta_caps filter called in EE_Capabilities.
-     *
-     * @since 4.5.0
-     * @param EE_Meta_Capability_Map[] $cap_maps The existing cap maps array.
-     * @return EE_Meta_Capability_Map[]
-     * @throws EE_Error
-     */
-    public static function register_cap_maps($cap_maps)
-    {
-        //loop through and instantiate cap maps.
-        foreach (self::$_registry as $cap_reference => $setup) {
-            if (! isset($setup['cap_maps'])) {
-                continue;
-            }
-            foreach ($setup['cap_maps'] as $cap_class => $args) {
+	/**
+	 * Callback for the 'FHEE__EE_Capabilities___set_meta_caps__meta_caps' filter which registers an array of
+	 * capability maps for the WP meta_caps filter called in EE_Capabilities.
+	 *
+	 * @since 4.5.0
+	 * @param EE_Meta_Capability_Map[] $cap_maps The existing cap maps array.
+	 * @return EE_Meta_Capability_Map[]
+	 * @throws EE_Error
+	 */
+	public static function register_cap_maps($cap_maps)
+	{
+		//loop through and instantiate cap maps.
+		foreach (self::$_registry as $cap_reference => $setup) {
+			if (! isset($setup['cap_maps'])) {
+				continue;
+			}
+			foreach ($setup['cap_maps'] as $cap_class => $args) {
 
-                /**
-                 * account for cases where capability maps may be indexed
-                 * numerically to allow for the same map class to be utilized
-                 * In those cases, maps will be setup in an array like:
-                 * array(
-                 *    0 => array( 'EE_Meta_Capability' => array(
-                 *        'ee_edit_cap', array( 'Object_Name',
-                 *        'ee_edit_published_cap',
-                 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
-                 *        ) )
-                 *    1 => ...
-                 * )
-                 * instead of:
-                 * array(
-                 *    'EE_Meta_Capability' => array(
-                 *        'ee_edit_cap', array( 'Object_Name',
-                 *        'ee_edit_published_cap',
-                 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
-                 *        ),
-                 *    ...
-                 * )
-                 */
-                if (is_numeric($cap_class)) {
-                    $cap_class = key($args);
-                    $args      = $args[$cap_class];
-                }
+				/**
+				 * account for cases where capability maps may be indexed
+				 * numerically to allow for the same map class to be utilized
+				 * In those cases, maps will be setup in an array like:
+				 * array(
+				 *    0 => array( 'EE_Meta_Capability' => array(
+				 *        'ee_edit_cap', array( 'Object_Name',
+				 *        'ee_edit_published_cap',
+				 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
+				 *        ) )
+				 *    1 => ...
+				 * )
+				 * instead of:
+				 * array(
+				 *    'EE_Meta_Capability' => array(
+				 *        'ee_edit_cap', array( 'Object_Name',
+				 *        'ee_edit_published_cap',
+				 *        'ee_edit_others_cap', 'ee_edit_private_cap' )
+				 *        ),
+				 *    ...
+				 * )
+				 */
+				if (is_numeric($cap_class)) {
+					$cap_class = key($args);
+					$args      = $args[$cap_class];
+				}
 
-                if (! class_exists($cap_class)) {
-                    throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
-                        'event_espresso'), $cap_reference));
-                }
+				if (! class_exists($cap_class)) {
+					throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
+						'event_espresso'), $cap_reference));
+				}
 
-                if (count($args) !== 2) {
-                    throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments.  The array should have two values the first being a string and the second an array.',
-                        'event_espresso'), $cap_reference));
-                }
-                $cap_maps[] = new $cap_class($args[0], $args[1]);
-            }
-        }
-        return $cap_maps;
-    }
+				if (count($args) !== 2) {
+					throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments.  The array should have two values the first being a string and the second an array.',
+						'event_espresso'), $cap_reference));
+				}
+				$cap_maps[] = new $cap_class($args[0], $args[1]);
+			}
+		}
+		return $cap_maps;
+	}
 
 
 
-    /**
-     * @param string $cap_reference
-     * @throws EE_Error
-     */
-    public static function deregister($cap_reference = '')
-    {
-        if (! empty(self::$_registry[$cap_reference])) {
-            if (! empty(self::$_registry[ $cap_reference ]['caps'])) {
-                EE_Capabilities::instance()->removeCaps(self::$_registry[ $cap_reference ]['caps']);
-            }
-            unset(self::$_registry[$cap_reference]);
-        }
-    }
+	/**
+	 * @param string $cap_reference
+	 * @throws EE_Error
+	 */
+	public static function deregister($cap_reference = '')
+	{
+		if (! empty(self::$_registry[$cap_reference])) {
+			if (! empty(self::$_registry[ $cap_reference ]['caps'])) {
+				EE_Capabilities::instance()->removeCaps(self::$_registry[ $cap_reference ]['caps']);
+			}
+			unset(self::$_registry[$cap_reference]);
+		}
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -6,7 +6,7 @@ 
  * @subpackage      plugin api, capabilities
  * @since           4.5.0
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -72,13 +72,13 @@ 
             return;
         }
         //make sure this is not registered too late or too early.
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')) {
             EE_Error::doing_it_wrong(__METHOD__,
                 sprintf(__('%s has been registered too late.  Please ensure that EE_Register_Capabilities::register has been called at some point before the "AHEE__EE_System___detect_if_activation_or_upgrade__begin" action hook has been called.',
                     'event_espresso'), $cap_reference), '4.5.0');
         }
         //some preliminary sanitization and setting to the $_registry property
-        self::$_registry[ $cap_reference ] = array(
+        self::$_registry[$cap_reference] = array(
             'caps'               => isset($setup_args['capabilities']) && is_array($setup_args['capabilities'])
                 ? $setup_args['capabilities']
                 : array(),
@@ -129,7 +129,7 @@ 
     {
         //loop through and instantiate cap maps.
         foreach (self::$_registry as $cap_reference => $setup) {
-            if (! isset($setup['cap_maps'])) {
+            if ( ! isset($setup['cap_maps'])) {
                 continue;
             }
             foreach ($setup['cap_maps'] as $cap_class => $args) {
@@ -161,7 +161,7 @@ 
                     $args      = $args[$cap_class];
                 }
 
-                if (! class_exists($cap_class)) {
+                if ( ! class_exists($cap_class)) {
                     throw new EE_Error(sprintf(__('An addon (%s) has tried to register a capability map improperly.  Capability map arrays must be indexed by capability map classname, and an array for the class arguments',
                         'event_espresso'), $cap_reference));
                 }
@@ -184,9 +184,9 @@ 
      */
     public static function deregister($cap_reference = '')
     {
-        if (! empty(self::$_registry[$cap_reference])) {
-            if (! empty(self::$_registry[ $cap_reference ]['caps'])) {
-                EE_Capabilities::instance()->removeCaps(self::$_registry[ $cap_reference ]['caps']);
+        if ( ! empty(self::$_registry[$cap_reference])) {
+            if ( ! empty(self::$_registry[$cap_reference]['caps'])) {
+                EE_Capabilities::instance()->removeCaps(self::$_registry[$cap_reference]['caps']);
             }
             unset(self::$_registry[$cap_reference]);
         }

core/libraries/payment_methods/EE_Payment_Method_Manager.lib.php

Spacing +22 added lines, -22 removed lines

@@ -20,7 +20,7 @@ 
     /**
      * prefix added to all payment method capabilities names
      */
-    const   CAPABILITIES_PREFIX= 'ee_payment_method_';
+    const   CAPABILITIES_PREFIX = 'ee_payment_method_';
 
     /**
      * @var EE_Payment_Method_Manager $_instance
@@ -76,7 +76,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+        if ( ! self::$_instance instanceof EE_Payment_Method_Manager) {
             EE_Registry::instance()->load_lib('PMT_Base');
             self::$_instance = new self();
         }
@@ -109,7 +109,7 @@ 
      */
     public function maybe_register_payment_methods($force_recheck = false)
     {
-        if (! $this->_payment_method_types || $force_recheck) {
+        if ( ! $this->_payment_method_types || $force_recheck) {
             $this->_register_payment_methods();
         }
     }
@@ -124,7 +124,7 @@ 
     protected function _register_payment_methods()
     {
         // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+        $pm_to_register = glob(EE_PAYMENT_METHODS.'*', GLOB_ONLYDIR);
         // filter list of modules to register
         $pm_to_register = apply_filters(
             'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
@@ -165,31 +165,31 @@ 
         // create class name from module directory name
         $module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
         // add class prefix
-        $module_class = 'EE_PMT_' . $module;
+        $module_class = 'EE_PMT_'.$module;
         // does the module exist ?
-        if (! is_readable($payment_method_path . DS . $module_class . $module_ext)) {
+        if ( ! is_readable($payment_method_path.DS.$module_class.$module_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %s payment method file could not be found or is not readable due to file permissions.',
                     'event_espresso'
                 ), $module
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the module class file
-        require_once($payment_method_path . DS . $module_class . $module_ext);
+        require_once($payment_method_path.DS.$module_class.$module_ext);
         // verify that class exists
-        if (! class_exists($module_class)) {
+        if ( ! class_exists($module_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s module class does not exist.', 'event_espresso'),
                 $module_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // add to array of registered modules
-        $this->_payment_method_types[$module] = $payment_method_path . DS . $module_class . $module_ext;
+        $this->_payment_method_types[$module] = $payment_method_path.DS.$module_class.$module_ext;
         return true;
     }
 
@@ -256,7 +256,7 @@ 
         if ($force_recheck || empty($this->payment_method_objects)) {
             $this->maybe_register_payment_methods($force_recheck);
             foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[$classname])) {
+                if ( ! isset($this->payment_method_objects[$classname])) {
                     $this->payment_method_objects[$classname] = new $classname;
                 }
             }
@@ -288,7 +288,7 @@ 
      */
     public function payment_method_class_from_type($type)
     {
-        return 'EE_PMT_' . $type;
+        return 'EE_PMT_'.$type;
     }
 
 
@@ -304,13 +304,13 @@ 
     {
         $this->maybe_register_payment_methods();
         $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
             if (class_exists($pm_type_class)) {
                 /** @var $pm_type_obj EE_PMT_Base */
                 $pm_type_obj = new $pm_type_class;
                 $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
+                if ( ! $payment_method) {
                     $payment_method = $this->create_payment_method_of_type($pm_type_obj);
                 }
                 $payment_method->set_type($payment_method_type);
@@ -341,7 +341,7 @@ 
                         'The Invoice payment method has been activated. It requires the invoice message type, html messenger, and pdf messenger be activated as well for the %1$smessages system%2$s, so it has been automatically verified that they are also active.',
                         'event_espresso'
                     ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages') . '">',
+                    '<a href="'.admin_url('admin.php?page=espresso_messages').'">',
                     '</a>'
                 ),
                 true
@@ -368,7 +368,7 @@ 
                 'PMD_type'       => $pm_type_obj->system_name(),
                 'PMD_name'       => $pm_type_obj->pretty_name(),
                 'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),//automatically converted to slug
+                'PMD_slug'       => $pm_type_obj->system_name(), //automatically converted to slug
                 'PMD_wp_user'    => $current_user->ID,
                 'PMD_order'      => EEM_Payment_Method::instance()->count(
                         array(array('PMD_type' => array('!=', 'Admin_Only')))
@@ -391,14 +391,14 @@ 
     {
         $pm_type_obj = $payment_method->type_obj();
         $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
+        if ( ! $payment_method->button_url()) {
             $payment_method->set_button_url($pm_type_obj->default_button_url());
         }
         //now add setup its default extra meta properties
         $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
+        if ( ! empty($extra_metas)) {
             //verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
+            if ( ! $payment_method->ID()) {
                 $payment_method->save();
             }
             foreach ($extra_metas as $meta_name => $input) {
@@ -506,7 +506,7 @@ 
     {
         $caps = array();
         foreach ($this->payment_method_type_names() as $payment_method_name) {
-            $caps = $this->addPaymentMethodCap($payment_method_name,$caps);
+            $caps = $this->addPaymentMethodCap($payment_method_name, $caps);
         }
         return $caps;
     }
@@ -541,7 +541,7 @@ 
                 )
             );
         }
-        if(! isset($payment_method_caps[$role])) {
+        if ( ! isset($payment_method_caps[$role])) {
             $payment_method_caps[$role] = array();
         }
         $payment_method_caps[$role][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX

Indentation +564 added lines, -564 removed lines

@@ -19,570 +19,570 @@
 class EE_Payment_Method_Manager implements ResettableInterface
 {
 
-    /**
-     * prefix added to all payment method capabilities names
-     */
-    const   CAPABILITIES_PREFIX= 'ee_payment_method_';
-
-    /**
-     * @var EE_Payment_Method_Manager $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var boolean
-     */
-    protected $payment_method_caps_initialized = false;
-
-    /**
-     * @var array keys are class names without 'EE_PMT_', values are their filepaths
-     */
-    protected $_payment_method_types = array();
-
-    /**
-     * @var EE_PMT_Base[]
-     */
-    protected $payment_method_objects = array();
-
-
-
-    /**
-     * EE_Payment_Method_Manager constructor.
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function __construct()
-    {
-        // if in admin lets ensure caps are set.
-        if (is_admin()) {
-            $this->_register_payment_methods();
-            // set them immediately
-            $this->initializePaymentMethodCaps();
-            // plus any time they get reset
-            add_filter(
-                'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-                array($this, 'addPaymentMethodCapsDuringReset')
-            );
-        }
-    }
-
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Payment_Method_Manager instance
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
-            EE_Registry::instance()->load_lib('PMT_Base');
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-
-    /**
-     * Resets the instance and returns a new one
-     *
-     * @return EE_Payment_Method_Manager
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-
-    /**
-     * If necessary, re-register payment methods
-     *
-     * @param boolean $force_recheck whether to recheck for payment method types,
-     *                               or just re-use the PMTs we found last time we checked during this request (if
-     *                               we have not yet checked during this request, then we need to check anyways)
-     */
-    public function maybe_register_payment_methods($force_recheck = false)
-    {
-        if (! $this->_payment_method_types || $force_recheck) {
-            $this->_register_payment_methods();
-        }
-    }
-
-
-
-    /**
-     * register_payment_methods
-     *
-     * @return array
-     */
-    protected function _register_payment_methods()
-    {
-        // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $pm_to_register = apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            $pm_to_register
-        );
-        // remove any duplicates if that should happen for some reason
-        $pm_to_register = array_unique($pm_to_register);
-        // loop through folders
-        foreach ($pm_to_register as $pm_path) {
-            $this->register_payment_method($pm_path);
-        }
-        do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
-        // filter list of installed modules
-        //keep them organized alphabetically by the payment method type's name
-        ksort($this->_payment_method_types);
-        return apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
-            $this->_payment_method_types
-        );
-    }
-
-
-
-    /**
-     * register_payment_method- makes core aware of this payment method
-     *
-     * @param string $payment_method_path - full path up to and including payment method folder
-     * @return boolean
-     */
-    public function register_payment_method($payment_method_path = '')
-    {
-        do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
-        $module_ext = '.pm.php';
-        // make all separators match
-        $payment_method_path = rtrim(str_replace('/\\', DS, $payment_method_path), DS);
-        // grab and sanitize module name
-        $module_dir = basename($payment_method_path);
-        // create class name from module directory name
-        $module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
-        // add class prefix
-        $module_class = 'EE_PMT_' . $module;
-        // does the module exist ?
-        if (! is_readable($payment_method_path . DS . $module_class . $module_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %s payment method file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ), $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($payment_method_path . DS . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s module class does not exist.', 'event_espresso'),
-                $module_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        $this->_payment_method_types[$module] = $payment_method_path . DS . $module_class . $module_ext;
-        return true;
-    }
-
-
-
-    /**
-     * Checks if a payment method has been registered, and if so includes it
-     *
-     * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
-     * @param boolean $force_recheck       whether to force re-checking for new payment method types
-     * @return boolean
-     */
-    public function payment_method_type_exists($payment_method_name, $force_recheck = false)
-    {
-        if (
-            $force_recheck
-            || ! is_array($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[$payment_method_name])
-        ) {
-            $this->maybe_register_payment_methods($force_recheck);
-        }
-        if (isset($this->_payment_method_types[$payment_method_name])) {
-            require_once($this->_payment_method_types[$payment_method_name]);
-            return true;
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Returns all the class names of the various payment method types
-     *
-     * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
-     *                               (what you'd find in wp_esp_payment_method.PMD_type)
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return array
-     */
-    public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
-    {
-        $this->maybe_register_payment_methods($force_recheck);
-        if ($with_prefixes) {
-            $classnames = array_keys($this->_payment_method_types);
-            $payment_methods = array();
-            foreach ($classnames as $classname) {
-                $payment_methods[] = $this->payment_method_class_from_type($classname);
-            }
-            return $payment_methods;
-        }
-        return array_keys($this->_payment_method_types);
-    }
-
-
-
-    /**
-     * Gets an object of each payment method type, none of which are bound to a
-     * payment method instance
-     *
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return EE_PMT_Base[]
-     */
-    public function payment_method_types($force_recheck = false)
-    {
-        if ($force_recheck || empty($this->payment_method_objects)) {
-            $this->maybe_register_payment_methods($force_recheck);
-            foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[$classname])) {
-                    $this->payment_method_objects[$classname] = new $classname;
-                }
-            }
-        }
-        return $this->payment_method_objects;
-    }
-
-
-
-    /**
-     * Changes the payment method's class name into the payment method type's name
-     * (as used on the payment method's table's PMD_type field)
-     *
-     * @param string $classname
-     * @return string
-     */
-    public function payment_method_type_sans_class_prefix($classname)
-    {
-        return str_replace('EE_PMT_', '', $classname);
-    }
-
-
-
-    /**
-     * Does the opposite of payment-method_type_sans_prefix
-     *
-     * @param string $type
-     * @return string
-     */
-    public function payment_method_class_from_type($type)
-    {
-        return 'EE_PMT_' . $type;
-    }
-
-
-
-    /**
-     * Activates a payment method of the given type.
-     *
-     * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function activate_a_payment_method_of_type($payment_method_type)
-    {
-        $this->maybe_register_payment_methods();
-        $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
-            $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
-            if (class_exists($pm_type_class)) {
-                /** @var $pm_type_obj EE_PMT_Base */
-                $pm_type_obj = new $pm_type_class;
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
-                    $payment_method = $this->create_payment_method_of_type($pm_type_obj);
-                }
-                $payment_method->set_type($payment_method_type);
-                $this->initialize_payment_method($payment_method);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'There is no payment method of type %1$s, so it could not be activated',
-                            'event_espresso'
-                        ),
-                        $pm_type_class
-                    )
-                );
-            }
-        }
-        $payment_method->set_active();
-        $payment_method->save();
-        if ($payment_method->type() === 'Invoice') {
-            /** @type EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            $message_resource_manager->ensure_message_type_is_active('invoice', 'html');
-            $message_resource_manager->ensure_messenger_is_active('pdf');
-            EE_Error::add_persistent_admin_notice(
-                'invoice_pm_requirements_notice',
-                sprintf(
-                    esc_html__(
-                        'The Invoice payment method has been activated. It requires the invoice message type, html messenger, and pdf messenger be activated as well for the %1$smessages system%2$s, so it has been automatically verified that they are also active.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages') . '">',
-                    '</a>'
-                ),
-                true
-            );
-        }
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Creates a payment method of the specified type. Does not save it.
-     *
-     * @global WP_User    $current_user
-     * @param EE_PMT_Base $pm_type_obj
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function create_payment_method_of_type($pm_type_obj)
-    {
-        global $current_user;
-        $payment_method = EE_Payment_Method::new_instance(
-            array(
-                'PMD_type'       => $pm_type_obj->system_name(),
-                'PMD_name'       => $pm_type_obj->pretty_name(),
-                'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),//automatically converted to slug
-                'PMD_wp_user'    => $current_user->ID,
-                'PMD_order'      => EEM_Payment_Method::instance()->count(
-                        array(array('PMD_type' => array('!=', 'Admin_Only')))
-                    ) * 10,
-            )
-        );
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Sets the initial payment method properties (including extra meta)
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function initialize_payment_method($payment_method)
-    {
-        $pm_type_obj = $payment_method->type_obj();
-        $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
-            $payment_method->set_button_url($pm_type_obj->default_button_url());
-        }
-        //now add setup its default extra meta properties
-        $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
-            //verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
-                $payment_method->save();
-            }
-            foreach ($extra_metas as $meta_name => $input) {
-                $payment_method->update_extra_meta($meta_name, $input->raw_value());
-            }
-        }
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Makes sure the payment method is related to the specified payment method
-     *
-     * @deprecated in 4.9.40 because the currency payment method table is being deprecated
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function set_usable_currencies_on_payment_method($payment_method)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
-            esc_html__(
-                'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
-                'event_espresso'
-            ),
-            '4.9.40'
-        );
-        return $payment_method;
-    }
-
-
-
-    /**
-     * Deactivates a payment method of the given payment method slug.
-     *
-     * @param string $payment_method_slug The slug for the payment method to deactivate.
-     * @return int count of rows updated.
-     * @throws EE_Error
-     */
-    public function deactivate_payment_method($payment_method_slug)
-    {
-        EE_Log::instance()->log(
-            __FILE__,
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'Payment method with slug %1$s is being deactivated by site admin',
-                    'event_espresso'
-                ),
-                $payment_method_slug
-            ),
-            'payment_method_change'
-        );
-        $count_updated = EEM_Payment_Method::instance()->update(
-            array('PMD_scope' => array()),
-            array(array('PMD_slug' => $payment_method_slug))
-        );
-        return $count_updated;
-    }
-
-
-
-    /**
-     * initializes payment method access caps via EE_Capabilities::init_role_caps()
-     * upon EE_Payment_Method_Manager construction
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    protected function initializePaymentMethodCaps()
-    {
-        // don't do this twice
-        if ($this->payment_method_caps_initialized) {
-            return;
-        }
-        EE_Capabilities::instance()->addCaps(
-            $this->getPaymentMethodCaps()
-        );
-        $this->payment_method_caps_initialized = true;
-    }
-
-
-
-    /**
-     * array  of dynamic payment method access caps.
-     * at the time of writing, october 20 2014, these are the caps added:
-     *  ee_payment_method_admin_only
-     *  ee_payment_method_aim
-     *  ee_payment_method_bank
-     *  ee_payment_method_check
-     *  ee_payment_method_invoice
-     *  ee_payment_method_mijireh
-     *  ee_payment_method_paypal_pro
-     *  ee_payment_method_paypal_standard
-     * Any other payment methods added to core or via addons will also get
-     * their related capability automatically added too, so long as they are
-     * registered properly using EE_Register_Payment_Method::register()
-     *
-     * @return array
-     * @throws DomainException
-     */
-    protected function getPaymentMethodCaps()
-    {
-        $caps = array();
-        foreach ($this->payment_method_type_names() as $payment_method_name) {
-            $caps = $this->addPaymentMethodCap($payment_method_name,$caps);
-        }
-        return $caps;
-    }
-
-
-
-    /**
-     * @param string $payment_method_name
-     * @param array  $payment_method_caps
-     * @param string $role
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCap($payment_method_name, array $payment_method_caps, $role = 'administrator')
-    {
-        if (empty($payment_method_name)) {
-            throw new DomainException(
-                esc_html__(
-                    'The name of a payment method must be specified to add capabilities.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (empty($role)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'No role was supplied while trying to add capabilities for the %1$s payment method.',
-                        'event_espresso'
-                    ),
-                    $payment_method_name
-                )
-            );
-        }
-        if(! isset($payment_method_caps[$role])) {
-            $payment_method_caps[$role] = array();
-        }
-        $payment_method_caps[$role][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
-                                                  . strtolower($payment_method_name);
-        return $payment_method_caps;
-    }
-
-
-
-    /**
-     * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
-     * to add dynamic payment method access caps when capabilities are reset
-     * (or if that filter is called and PM caps are not already set)
-     *
-     * @param array $caps capabilities being filtered
-     * @param bool  $reset
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCapsDuringReset(array $caps, $reset = false)
-    {
-        if ($reset || ! $this->payment_method_caps_initialized) {
-            $this->payment_method_caps_initialized = true;
-            $caps = array_merge_recursive($caps, $this->getPaymentMethodCaps());
-        }
-        return $caps;
-    }
-
-
-
-    /**
-     * @deprecated 4.9.42
-     * @param $caps
-     * @return mixed
-     */
-    public function add_payment_method_caps($caps)
-    {
-        return $caps;
-    }
+	/**
+	 * prefix added to all payment method capabilities names
+	 */
+	const   CAPABILITIES_PREFIX= 'ee_payment_method_';
+
+	/**
+	 * @var EE_Payment_Method_Manager $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var boolean
+	 */
+	protected $payment_method_caps_initialized = false;
+
+	/**
+	 * @var array keys are class names without 'EE_PMT_', values are their filepaths
+	 */
+	protected $_payment_method_types = array();
+
+	/**
+	 * @var EE_PMT_Base[]
+	 */
+	protected $payment_method_objects = array();
+
+
+
+	/**
+	 * EE_Payment_Method_Manager constructor.
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function __construct()
+	{
+		// if in admin lets ensure caps are set.
+		if (is_admin()) {
+			$this->_register_payment_methods();
+			// set them immediately
+			$this->initializePaymentMethodCaps();
+			// plus any time they get reset
+			add_filter(
+				'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+				array($this, 'addPaymentMethodCapsDuringReset')
+			);
+		}
+	}
+
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Payment_Method_Manager instance
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+			EE_Registry::instance()->load_lib('PMT_Base');
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+
+	/**
+	 * Resets the instance and returns a new one
+	 *
+	 * @return EE_Payment_Method_Manager
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+
+	/**
+	 * If necessary, re-register payment methods
+	 *
+	 * @param boolean $force_recheck whether to recheck for payment method types,
+	 *                               or just re-use the PMTs we found last time we checked during this request (if
+	 *                               we have not yet checked during this request, then we need to check anyways)
+	 */
+	public function maybe_register_payment_methods($force_recheck = false)
+	{
+		if (! $this->_payment_method_types || $force_recheck) {
+			$this->_register_payment_methods();
+		}
+	}
+
+
+
+	/**
+	 * register_payment_methods
+	 *
+	 * @return array
+	 */
+	protected function _register_payment_methods()
+	{
+		// grab list of installed modules
+		$pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$pm_to_register = apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			$pm_to_register
+		);
+		// remove any duplicates if that should happen for some reason
+		$pm_to_register = array_unique($pm_to_register);
+		// loop through folders
+		foreach ($pm_to_register as $pm_path) {
+			$this->register_payment_method($pm_path);
+		}
+		do_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods');
+		// filter list of installed modules
+		//keep them organized alphabetically by the payment method type's name
+		ksort($this->_payment_method_types);
+		return apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
+			$this->_payment_method_types
+		);
+	}
+
+
+
+	/**
+	 * register_payment_method- makes core aware of this payment method
+	 *
+	 * @param string $payment_method_path - full path up to and including payment method folder
+	 * @return boolean
+	 */
+	public function register_payment_method($payment_method_path = '')
+	{
+		do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
+		$module_ext = '.pm.php';
+		// make all separators match
+		$payment_method_path = rtrim(str_replace('/\\', DS, $payment_method_path), DS);
+		// grab and sanitize module name
+		$module_dir = basename($payment_method_path);
+		// create class name from module directory name
+		$module = str_replace(array('_', ' '), array(' ', '_'), $module_dir);
+		// add class prefix
+		$module_class = 'EE_PMT_' . $module;
+		// does the module exist ?
+		if (! is_readable($payment_method_path . DS . $module_class . $module_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %s payment method file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				), $module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($payment_method_path . DS . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s module class does not exist.', 'event_espresso'),
+				$module_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		$this->_payment_method_types[$module] = $payment_method_path . DS . $module_class . $module_ext;
+		return true;
+	}
+
+
+
+	/**
+	 * Checks if a payment method has been registered, and if so includes it
+	 *
+	 * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
+	 * @param boolean $force_recheck       whether to force re-checking for new payment method types
+	 * @return boolean
+	 */
+	public function payment_method_type_exists($payment_method_name, $force_recheck = false)
+	{
+		if (
+			$force_recheck
+			|| ! is_array($this->_payment_method_types)
+			|| ! isset($this->_payment_method_types[$payment_method_name])
+		) {
+			$this->maybe_register_payment_methods($force_recheck);
+		}
+		if (isset($this->_payment_method_types[$payment_method_name])) {
+			require_once($this->_payment_method_types[$payment_method_name]);
+			return true;
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Returns all the class names of the various payment method types
+	 *
+	 * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
+	 *                               (what you'd find in wp_esp_payment_method.PMD_type)
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return array
+	 */
+	public function payment_method_type_names($with_prefixes = false, $force_recheck = false)
+	{
+		$this->maybe_register_payment_methods($force_recheck);
+		if ($with_prefixes) {
+			$classnames = array_keys($this->_payment_method_types);
+			$payment_methods = array();
+			foreach ($classnames as $classname) {
+				$payment_methods[] = $this->payment_method_class_from_type($classname);
+			}
+			return $payment_methods;
+		}
+		return array_keys($this->_payment_method_types);
+	}
+
+
+
+	/**
+	 * Gets an object of each payment method type, none of which are bound to a
+	 * payment method instance
+	 *
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return EE_PMT_Base[]
+	 */
+	public function payment_method_types($force_recheck = false)
+	{
+		if ($force_recheck || empty($this->payment_method_objects)) {
+			$this->maybe_register_payment_methods($force_recheck);
+			foreach ($this->payment_method_type_names(true) as $classname) {
+				if (! isset($this->payment_method_objects[$classname])) {
+					$this->payment_method_objects[$classname] = new $classname;
+				}
+			}
+		}
+		return $this->payment_method_objects;
+	}
+
+
+
+	/**
+	 * Changes the payment method's class name into the payment method type's name
+	 * (as used on the payment method's table's PMD_type field)
+	 *
+	 * @param string $classname
+	 * @return string
+	 */
+	public function payment_method_type_sans_class_prefix($classname)
+	{
+		return str_replace('EE_PMT_', '', $classname);
+	}
+
+
+
+	/**
+	 * Does the opposite of payment-method_type_sans_prefix
+	 *
+	 * @param string $type
+	 * @return string
+	 */
+	public function payment_method_class_from_type($type)
+	{
+		return 'EE_PMT_' . $type;
+	}
+
+
+
+	/**
+	 * Activates a payment method of the given type.
+	 *
+	 * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function activate_a_payment_method_of_type($payment_method_type)
+	{
+		$this->maybe_register_payment_methods();
+		$payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
+		if (! $payment_method instanceof EE_Payment_Method) {
+			$pm_type_class = $this->payment_method_class_from_type($payment_method_type);
+			if (class_exists($pm_type_class)) {
+				/** @var $pm_type_obj EE_PMT_Base */
+				$pm_type_obj = new $pm_type_class;
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
+				if (! $payment_method) {
+					$payment_method = $this->create_payment_method_of_type($pm_type_obj);
+				}
+				$payment_method->set_type($payment_method_type);
+				$this->initialize_payment_method($payment_method);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'There is no payment method of type %1$s, so it could not be activated',
+							'event_espresso'
+						),
+						$pm_type_class
+					)
+				);
+			}
+		}
+		$payment_method->set_active();
+		$payment_method->save();
+		if ($payment_method->type() === 'Invoice') {
+			/** @type EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			$message_resource_manager->ensure_message_type_is_active('invoice', 'html');
+			$message_resource_manager->ensure_messenger_is_active('pdf');
+			EE_Error::add_persistent_admin_notice(
+				'invoice_pm_requirements_notice',
+				sprintf(
+					esc_html__(
+						'The Invoice payment method has been activated. It requires the invoice message type, html messenger, and pdf messenger be activated as well for the %1$smessages system%2$s, so it has been automatically verified that they are also active.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_messages') . '">',
+					'</a>'
+				),
+				true
+			);
+		}
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Creates a payment method of the specified type. Does not save it.
+	 *
+	 * @global WP_User    $current_user
+	 * @param EE_PMT_Base $pm_type_obj
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function create_payment_method_of_type($pm_type_obj)
+	{
+		global $current_user;
+		$payment_method = EE_Payment_Method::new_instance(
+			array(
+				'PMD_type'       => $pm_type_obj->system_name(),
+				'PMD_name'       => $pm_type_obj->pretty_name(),
+				'PMD_admin_name' => $pm_type_obj->pretty_name(),
+				'PMD_slug'       => $pm_type_obj->system_name(),//automatically converted to slug
+				'PMD_wp_user'    => $current_user->ID,
+				'PMD_order'      => EEM_Payment_Method::instance()->count(
+						array(array('PMD_type' => array('!=', 'Admin_Only')))
+					) * 10,
+			)
+		);
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Sets the initial payment method properties (including extra meta)
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function initialize_payment_method($payment_method)
+	{
+		$pm_type_obj = $payment_method->type_obj();
+		$payment_method->set_description($pm_type_obj->default_description());
+		if (! $payment_method->button_url()) {
+			$payment_method->set_button_url($pm_type_obj->default_button_url());
+		}
+		//now add setup its default extra meta properties
+		$extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
+		if (! empty($extra_metas)) {
+			//verify the payment method has an ID before adding extra meta
+			if (! $payment_method->ID()) {
+				$payment_method->save();
+			}
+			foreach ($extra_metas as $meta_name => $input) {
+				$payment_method->update_extra_meta($meta_name, $input->raw_value());
+			}
+		}
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Makes sure the payment method is related to the specified payment method
+	 *
+	 * @deprecated in 4.9.40 because the currency payment method table is being deprecated
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function set_usable_currencies_on_payment_method($payment_method)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
+			esc_html__(
+				'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
+				'event_espresso'
+			),
+			'4.9.40'
+		);
+		return $payment_method;
+	}
+
+
+
+	/**
+	 * Deactivates a payment method of the given payment method slug.
+	 *
+	 * @param string $payment_method_slug The slug for the payment method to deactivate.
+	 * @return int count of rows updated.
+	 * @throws EE_Error
+	 */
+	public function deactivate_payment_method($payment_method_slug)
+	{
+		EE_Log::instance()->log(
+			__FILE__,
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'Payment method with slug %1$s is being deactivated by site admin',
+					'event_espresso'
+				),
+				$payment_method_slug
+			),
+			'payment_method_change'
+		);
+		$count_updated = EEM_Payment_Method::instance()->update(
+			array('PMD_scope' => array()),
+			array(array('PMD_slug' => $payment_method_slug))
+		);
+		return $count_updated;
+	}
+
+
+
+	/**
+	 * initializes payment method access caps via EE_Capabilities::init_role_caps()
+	 * upon EE_Payment_Method_Manager construction
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	protected function initializePaymentMethodCaps()
+	{
+		// don't do this twice
+		if ($this->payment_method_caps_initialized) {
+			return;
+		}
+		EE_Capabilities::instance()->addCaps(
+			$this->getPaymentMethodCaps()
+		);
+		$this->payment_method_caps_initialized = true;
+	}
+
+
+
+	/**
+	 * array  of dynamic payment method access caps.
+	 * at the time of writing, october 20 2014, these are the caps added:
+	 *  ee_payment_method_admin_only
+	 *  ee_payment_method_aim
+	 *  ee_payment_method_bank
+	 *  ee_payment_method_check
+	 *  ee_payment_method_invoice
+	 *  ee_payment_method_mijireh
+	 *  ee_payment_method_paypal_pro
+	 *  ee_payment_method_paypal_standard
+	 * Any other payment methods added to core or via addons will also get
+	 * their related capability automatically added too, so long as they are
+	 * registered properly using EE_Register_Payment_Method::register()
+	 *
+	 * @return array
+	 * @throws DomainException
+	 */
+	protected function getPaymentMethodCaps()
+	{
+		$caps = array();
+		foreach ($this->payment_method_type_names() as $payment_method_name) {
+			$caps = $this->addPaymentMethodCap($payment_method_name,$caps);
+		}
+		return $caps;
+	}
+
+
+
+	/**
+	 * @param string $payment_method_name
+	 * @param array  $payment_method_caps
+	 * @param string $role
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCap($payment_method_name, array $payment_method_caps, $role = 'administrator')
+	{
+		if (empty($payment_method_name)) {
+			throw new DomainException(
+				esc_html__(
+					'The name of a payment method must be specified to add capabilities.',
+					'event_espresso'
+				)
+			);
+		}
+		if (empty($role)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'No role was supplied while trying to add capabilities for the %1$s payment method.',
+						'event_espresso'
+					),
+					$payment_method_name
+				)
+			);
+		}
+		if(! isset($payment_method_caps[$role])) {
+			$payment_method_caps[$role] = array();
+		}
+		$payment_method_caps[$role][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+												  . strtolower($payment_method_name);
+		return $payment_method_caps;
+	}
+
+
+
+	/**
+	 * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
+	 * to add dynamic payment method access caps when capabilities are reset
+	 * (or if that filter is called and PM caps are not already set)
+	 *
+	 * @param array $caps capabilities being filtered
+	 * @param bool  $reset
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCapsDuringReset(array $caps, $reset = false)
+	{
+		if ($reset || ! $this->payment_method_caps_initialized) {
+			$this->payment_method_caps_initialized = true;
+			$caps = array_merge_recursive($caps, $this->getPaymentMethodCaps());
+		}
+		return $caps;
+	}
+
+
+
+	/**
+	 * @deprecated 4.9.42
+	 * @param $caps
+	 * @return mixed
+	 */
+	public function add_payment_method_caps($caps)
+	{
+		return $caps;
+	}
 
 
 

modules/core_rest_api/EED_Core_Rest_Api.module.php

Doc Comments +1 added lines, -1 removed lines

@@ -421,7 +421,7 @@
     /**
      * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
      * in this versioned namespace of EE4
-     * @param $version
+     * @param string $version
      * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
      */
     public static function model_names_with_plural_routes($version){

Indentation +1221 added lines, -1221 removed lines

@@ -23,1228 +23,1228 @@
 class EED_Core_Rest_Api extends \EED_Module
 {
 
-    const ee_api_namespace           = 'ee/v';
+	const ee_api_namespace           = 'ee/v';
 
-    const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
-
-    const saved_routes_option_names  = 'ee_core_routes';
-
-    /**
-     * string used in _links response bodies to make them globally unique.
-     *
-     * @see http://v2.wp-api.org/extending/linking/
-     */
-    const ee_api_link_namespace = 'https://api.eventespresso.com/';
-
-    /**
-     * @var CalculatedModelFields
-     */
-    protected static $_field_calculator;
-
-
-
-    /**
-     * @return EED_Core_Rest_Api|EED_Module
-     */
-    public static function instance()
-    {
-        self::$_field_calculator = new CalculatedModelFields();
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        self::set_hooks_both();
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::set_hooks_both();
-    }
-
-
-
-    public static function set_hooks_both()
-    {
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
-        add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
-        add_filter('rest_index',
-            array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex'));
-        EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
-    }
-
-
-
-    /**
-     * sets up hooks which only need to be included as part of REST API requests;
-     * other requests like to the frontend or admin etc don't need them
-     *
-     * @throws \EE_Error
-     */
-    public static function set_hooks_rest_api()
-    {
-        //set hooks which account for changes made to the API
-        EED_Core_Rest_Api::_set_hooks_for_changes();
-    }
-
-
-
-    /**
-     * public wrapper of _set_hooks_for_changes.
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     *
-     * @throws EE_Error
-     */
-    public static function set_hooks_for_changes()
-    {
-        self::_set_hooks_for_changes();
-    }
-
-
-
-    /**
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     *
-     * @throws EE_Error
-     */
-    protected static function _set_hooks_for_changes()
-    {
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
-        foreach ($folder_contents as $classname_in_namespace => $filepath) {
-            //ignore the base parent class
-            //and legacy named classes
-            if ($classname_in_namespace === 'ChangesInBase'
-                || strpos($classname_in_namespace, 'Changes_In_') === 0
-            ) {
-                continue;
-            }
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
-            if (class_exists($full_classname)) {
-                $instance_of_class = new $full_classname;
-                if ($instance_of_class instanceof ChangesInBase) {
-                    $instance_of_class->setHooks();
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Filters the WP routes to add our EE-related ones. This takes a bit of time
-     * so we actually prefer to only do it when an EE plugin is activated or upgraded
-     *
-     * @throws \EE_Error
-     */
-    public static function register_routes()
-    {
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
-            foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
-                /**
-                 * @var array $data_for_multiple_endpoints numerically indexed array
-                 *                                         but can also contain route options like {
-                 * @type array    $schema                      {
-                 * @type callable $schema_callback
-                 * @type array    $callback_args               arguments that will be passed to the callback, after the
-                 * WP_REST_Request of course
-                 * }
-                 * }
-                 */
-                //when registering routes, register all the endpoints' data at the same time
-                $multiple_endpoint_args = array();
-                foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
-                    /**
-                     * @var array     $data_for_single_endpoint {
-                     * @type callable $callback
-                     * @type string methods
-                     * @type array args
-                     * @type array _links
-                     * @type array    $callback_args            arguments that will be passed to the callback, after the
-                     * WP_REST_Request of course
-                     * }
-                     */
-                    //skip route options
-                    if (! is_numeric($endpoint_key)) {
-                        continue;
-                    }
-                    if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
-                        throw new EE_Error(
-                            esc_html__(
-                                // @codingStandardsIgnoreStart
-                                'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso')
-                        );
-                    }
-                    $callback = $data_for_single_endpoint['callback'];
-                    $single_endpoint_args = array(
-                        'methods' => $data_for_single_endpoint['methods'],
-                        'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
-                            : array(),
-                    );
-                    if (isset($data_for_single_endpoint['_links'])) {
-                        $single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
-                    }
-                    if (isset($data_for_single_endpoint['callback_args'])) {
-                        $callback_args = $data_for_single_endpoint['callback_args'];
-                        $single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
-                            $callback,
-                            $callback_args
-                        ) {
-                            array_unshift($callback_args, $request);
-                            return call_user_func_array(
-                                $callback,
-                                $callback_args
-                            );
-                        };
-                    } else {
-                        $single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
-                    }
-                    $multiple_endpoint_args[] = $single_endpoint_args;
-                }
-                if (isset($data_for_multiple_endpoints['schema'])) {
-                    $schema_route_data = $data_for_multiple_endpoints['schema'];
-                    $schema_callback = $schema_route_data['schema_callback'];
-                    $callback_args = $schema_route_data['callback_args'];
-                    $multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
-                        return call_user_func_array(
-                            $schema_callback,
-                            $callback_args
-                        );
-                    };
-                }
-                register_rest_route(
-                    $namespace,
-                    $relative_route,
-                    $multiple_endpoint_args
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * Checks if there was a version change or something that merits invalidating the cached
-     * route data. If so, invalidates the cached route data so that it gets refreshed
-     * next time the WP API is used
-     */
-    public static function invalidate_cached_route_data_on_version_change()
-    {
-        if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
-            EED_Core_Rest_Api::invalidate_cached_route_data();
-        }
-        foreach (EE_Registry::instance()->addons as $addon) {
-            if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
-                EED_Core_Rest_Api::invalidate_cached_route_data();
-            }
-        }
-    }
-
-
-
-    /**
-     * Removes the cached route data so it will get refreshed next time the WP API is used
-     */
-    public static function invalidate_cached_route_data()
-    {
-        //delete the saved EE REST API routes
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
-        }
-    }
-
-
-
-    /**
-     * Gets the EE route data
-     *
-     * @return array top-level key is the namespace, next-level key is the route and its value is array{
-     * @throws \EE_Error
-     * @type string|array $callback
-     * @type string       $methods
-     * @type boolean      $hidden_endpoint
-     * }
-     */
-    public static function get_ee_route_data()
-    {
-        $ee_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version(
-                $version,
-                $hidden_endpoints
-            );
-        }
-        return $ee_routes;
-    }
-
-
-
-    /**
-     * Gets the EE route data from the wp options if it exists already,
-     * otherwise re-generates it and saves it to the option
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return array
-     * @throws \EE_Error
-     */
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
-        if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
-            $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-
-    /**
-     * Saves the EE REST API route data to a wp option and returns it
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return mixed|null
-     * @throws \EE_Error
-     */
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $instance = self::instance();
-        $routes = apply_filters(
-            'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
-            array_replace_recursive(
-                $instance->_get_config_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_model_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
-            )
-        );
-        $option_name = self::saved_routes_option_names . $version;
-        if (get_option($option_name)) {
-            update_option($option_name, $routes, true);
-        } else {
-            add_option($option_name, $routes, null, 'no');
-        }
-        return $routes;
-    }
-
-
-
-    /**
-     * Calculates all the EE routes and saves it to a WordPress option so we don't
-     * need to calculate it on every request
-     *
-     * @deprecated since version 4.9.1
-     * @return void
-     */
-    public static function save_ee_routes()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $instance = self::instance();
-            $routes = apply_filters(
-                'EED_Core_Rest_Api__save_ee_routes__routes',
-                array_replace_recursive(
-                    $instance->_register_config_routes(),
-                    $instance->_register_meta_routes(),
-                    $instance->_register_model_routes(),
-                    $instance->_register_rpc_routes()
-                )
-            );
-            update_option(self::saved_routes_option_names, $routes, true);
-        }
-    }
-
-
-
-    /**
-     * Gets all the route information relating to EE models
-     *
-     * @return array @see get_ee_route_data
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_model_routes()
-    {
-        $model_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $model_routes[EED_Core_Rest_Api::ee_api_namespace
-                          . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
-        }
-        return $model_routes;
-    }
-
-
-
-    /**
-     * Decides whether or not to add write endpoints for this model.
-     *
-     * Currently, this defaults to exclude all global tables and models
-     * which would allow inserting WP core data (we don't want to duplicate
-     * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
-     * @param EEM_Base $model
-     * @return bool
-     */
-    public static function should_have_write_endpoints(EEM_Base $model)
-    {
-        if ($model->is_wp_core_model()){
-            return false;
-        }
-        foreach($model->get_tables() as $table){
-            if( $table->is_global()){
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-
-    /**
-     * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
-     * in this versioned namespace of EE4
-     * @param $version
-     * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
-     */
-    public static function model_names_with_plural_routes($version){
-        $model_version_info = new ModelVersionInfo($version);
-        $models_to_register = $model_version_info->modelsForRequestedVersion();
-        //let's not bother having endpoints for extra metas
-        unset(
-            $models_to_register['Extra_Meta'],
-            $models_to_register['Extra_Join'],
-            $models_to_register['Post_Meta']
-        );
-        return apply_filters(
-            'FHEE__EED_Core_REST_API___register_model_routes',
-            $models_to_register
-        );
-    }
-
-
-
-    /**
-     * Gets the route data for EE models in the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $model_routes = array();
-        $model_version_info = new ModelVersionInfo($version);
-        foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
-            $model = \EE_Registry::instance()->load_model($model_name);
-            //if this isn't a valid model then let's skip iterate to the next item in the loop.
-            if (! $model instanceof EEM_Base) {
-                continue;
-            }
-            //yes we could just register one route for ALL models, but then they wouldn't show up in the index
-            $plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
-            $singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
-            $model_routes[$plural_model_route] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleRequestGetAll',
-                    ),
-                    'callback_args'   => array($version, $model_name),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_read_query_params($model, $version),
-                    '_links'          => array(
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
-                    ),
-                ),
-                'schema' => array(
-                    'schema_callback' => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleSchemaRequest',
-                    ),
-                    'callback_args'   => array($version, $model_name),
-                ),
-            );
-            $model_routes[$singular_model_route] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleRequestGetOne',
-                    ),
-                    'callback_args'   => array($version, $model_name),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_response_selection_query_params($model, $version),
-                ),
-            );
-            if( apply_filters(
-                'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
-                EED_Core_Rest_Api::should_have_write_endpoints($model),
-                $model
-            )){
-                $model_routes[$plural_model_route][] = array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                        'handleRequestInsert',
-                    ),
-                    'callback_args'   => array($version, $model_name),
-                    'methods'         => WP_REST_Server::CREATABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_write_params($model_name, $model_version_info, true),
-                );
-                $model_routes[$singular_model_route] = array_merge(
-                    $model_routes[$singular_model_route],
-                    array(
-                        array(
-                            'callback'        => array(
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                                'handleRequestUpdate',
-                            ),
-                            'callback_args'   => array($version, $model_name),
-                            'methods'         => WP_REST_Server::EDITABLE,
-                            'hidden_endpoint' => $hidden_endpoint,
-                            'args'            => $this->_get_write_params($model_name, $model_version_info),
-                        ),
-                        array(
-                            'callback'        => array(
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                                'handleRequestDelete',
-                            ),
-                            'callback_args'   => array($version, $model_name),
-                            'methods'         => WP_REST_Server::DELETABLE,
-                            'hidden_endpoint' => $hidden_endpoint,
-                            'args'            => $this->_get_delete_query_params($model, $version),
-                        )
-                    )
-                );
-            }
-            foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-
-                $related_route = EED_Core_Rest_Api::get_relation_route_via(
-                    $model,
-                    '(?P<id>[^\/]+)',
-                    $relation_obj
-                );
-                $endpoints = array(
-                    array(
-                        'callback'        => array(
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                            'handleRequestGetRelated',
-                        ),
-                        'callback_args'   => array($version, $model_name, $relation_name),
-                        'methods'         => WP_REST_Server::READABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
-                    ),
-                );
-                $model_routes[$related_route] = $endpoints;
-            }
-        }
-        return $model_routes;
-    }
-
-
-
-    /**
-     * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
-     * excluding the preceding slash.
-     * Eg you pass get_plural_route_to('Event') = 'events'
-     *
-     * @param EEM_Base $model
-     * @return string
-     */
-    public static function get_collection_route(EEM_Base $model)
-    {
-        return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-    }
-
-
-
-    /**
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
-     * excluding the preceding slash.
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
-     *
-     * @param EEM_Base $model eg Event or Venue
-     * @param string $id
-     * @return string
-     */
-    public static function get_entity_route($model, $id)
-    {
-        return EED_Core_Rest_Api::get_collection_route($model). '/' . $id;
-    }
-
-
-    /**
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
-     * excluding the preceding slash.
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
-     *
-     * @param EEM_Base                 $model eg Event or Venue
-     * @param string                 $id
-     * @param EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
-    {
-        $related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
-            $relation_obj->get_other_model()->get_this_model_name(),
-            $relation_obj
-        );
-        return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
-    }
-
-
-
-    /**
-     * Adds onto the $relative_route the EE4 REST API versioned namespace.
-     * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
-     * @param string $relative_route
-     * @param string $version
-     * @return string
-     */
-    public static function get_versioned_route_to($relative_route, $version = '4.8.36'){
-        return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
-    }
-
-
-
-    /**
-     * Adds all the RPC-style routes (remote procedure call-like routes, ie
-     * routes that don't conform to the traditional REST CRUD-style).
-     *
-     * @deprecated since 4.9.1
-     */
-    protected function _register_rpc_routes()
-    {
-        $routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version(
-                $version,
-                $hidden_endpoint
-            );
-        }
-        return $routes;
-    }
-
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $this_versions_routes = array();
-        //checkin endpoint
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
-            array(
-                'callback'        => array(
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
-                    'handleRequestToggleCheckin',
-                ),
-                'methods'         => WP_REST_Server::CREATABLE,
-                'hidden_endpoint' => $hidden_endpoint,
-                'args'            => array(
-                    'force' => array(
-                        'required'    => false,
-                        'default'     => false,
-                        'description' => __(
-                            // @codingStandardsIgnoreStart
-                            'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                    ),
-                ),
-                'callback_args'   => array($version),
-            ),
-        );
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-            $this_versions_routes,
-            $version,
-            $hidden_endpoint
-        );
-    }
-
-
-
-    /**
-     * Gets the query params that can be used when request one or many
-     *
-     * @param EEM_Base $model
-     * @param string   $version
-     * @return array
-     */
-    protected function _get_response_selection_query_params(\EEM_Base $model, $version)
-    {
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array(
-                'include'   => array(
-                    'required' => false,
-                    'default'  => '*',
-                    'type'     => 'string',
-                ),
-                'calculate' => array(
-                    'required'          => false,
-                    'default'           => '',
-                    'enum'              => self::$_field_calculator->retrieveCalculatedFieldsForModel($model),
-                    'type'              => 'string',
-                    //because we accept a CSV'd list of the enumerated strings, WP core validation and sanitization
-                    //freaks out. We'll just validate this argument while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ),
-            ),
-            $model,
-            $version
-        );
-    }
-
-
-
-    /**
-     * Gets the parameters acceptable for delete requests
-     *
-     * @param \EEM_Base $model
-     * @param string    $version
-     * @return array
-     */
-    protected function _get_delete_query_params(\EEM_Base $model, $version)
-    {
-        $params_for_delete = array(
-            'allow_blocking' => array(
-                'required' => false,
-                'default'  => true,
-                'type'     => 'boolean',
-            ),
-        );
-        $params_for_delete['force'] = array(
-            'required' => false,
-            'default'  => false,
-            'type'     => 'boolean',
-        );
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_delete_query_params',
-            $params_for_delete,
-            $model,
-            $version
-        );
-    }
-
-
-
-    /**
-     * Gets info about reading query params that are acceptable
-     *
-     * @param \EEM_Base $model eg 'Event' or 'Venue'
-     * @param  string   $version
-     * @return array    describing the args acceptable when querying this model
-     * @throws EE_Error
-     */
-    protected function _get_read_query_params(\EEM_Base $model, $version)
-    {
-        $default_orderby = array();
-        foreach ($model->get_combined_primary_key_fields() as $key_field) {
-            $default_orderby[$key_field->get_name()] = 'ASC';
-        }
-        return array_merge(
-            $this->_get_response_selection_query_params($model, $version),
-            array(
-                'where'    => array(
-                    'required' => false,
-                    'default'  => array(),
-                    'type'     => 'object',
-                ),
-                'limit'    => array(
-                    'required' => false,
-                    'default'  => EED_Core_Rest_Api::get_default_query_limit(),
-                    'type'     => array(
-                        'object',
-                        'string',
-                        'integer',
-                    ),
-                ),
-                'order_by' => array(
-                    'required' => false,
-                    'default'  => $default_orderby,
-                    'type'     => array(
-                        'object',
-                        'string',
-                    ),
-                ),
-                'group_by' => array(
-                    'required' => false,
-                    'default'  => null,
-                    'type'     => array(
-                        'object',
-                        'string',
-                    ),
-                ),
-                'having'   => array(
-                    'required' => false,
-                    'default'  => null,
-                    'type'     => 'object',
-                ),
-                'caps'     => array(
-                    'required' => false,
-                    'default'  => EEM_Base::caps_read,
-                    'type'     => 'string',
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets parameter information for a model regarding writing data
-     *
-     * @param string           $model_name
-     * @param ModelVersionInfo $model_version_info
-     * @param boolean          $create                                       whether this is for request to create (in which case we need
-     *                                                                       all required params) or just to update (in which case we don't need those on every request)
-     * @return array
-     */
-    protected function _get_write_params(
-        $model_name,
-        ModelVersionInfo $model_version_info,
-        $create = false
-    ) {
-        $model = EE_Registry::instance()->load_model($model_name);
-        $fields = $model_version_info->fieldsOnModelInThisVersion($model);
-        $args_info = array();
-        foreach ($fields as $field_name => $field_obj) {
-            if ($field_obj->is_auto_increment()) {
-                //totally ignore auto increment IDs
-                continue;
-            }
-            $arg_info = $field_obj->getSchema();
-            $required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
-            $arg_info['required'] = $required;
-            //remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
-            unset($arg_info['readonly']);
-            $schema_properties = $field_obj->getSchemaProperties();
-            if (
-                isset($schema_properties['raw'])
-                && $field_obj->getSchemaType() === 'object'
-            ) {
-                //if there's a "raw" form of this argument, use those properties instead
-                $arg_info = array_replace(
-                    $arg_info,
-                    $schema_properties['raw']
-                );
-            }
-            $arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                $field_obj,
-                $field_obj->get_default_value(),
-                $model_version_info->requestedVersion()
-            );
-            //we do our own validation and sanitization within the controller
-            $arg_info['sanitize_callback'] =
-                array(
-                    'EED_Core_Rest_Api',
-                    'default_sanitize_callback',
-                );
-            $args_info[$field_name] = $arg_info;
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $gmt_arg_info = $arg_info;
-                $gmt_arg_info['description'] = sprintf(
-                    esc_html__(
-                        '%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
-                        'event_espresso'
-                    ),
-                    $field_obj->get_nicename(),
-                    $field_name
-                );
-                $args_info[$field_name . '_gmt'] = $gmt_arg_info;
-            }
-        }
-        return $args_info;
-    }
-
-
-
-    /**
-     * Replacement for WP API's 'rest_parse_request_arg'.
-     * If the value is blank but not required, don't bother validating it.
-     * Also, it uses our email validation instead of WP API's default.
-     *
-     * @param                 $value
-     * @param WP_REST_Request $request
-     * @param                 $param
-     * @return bool|true|WP_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function default_sanitize_callback( $value, WP_REST_Request $request, $param)
-    {
-        $attributes = $request->get_attributes();
-        if (! isset($attributes['args'][$param])
-            || ! is_array($attributes['args'][$param])) {
-            $validation_result = true;
-        } else {
-            $args = $attributes['args'][$param];
-            if ((
-                    $value === ''
-                    || $value === null
-                )
-                && (! isset($args['required'])
-                    || $args['required'] === false
-                )
-            ) {
-                //not required and not provided? that's cool
-                $validation_result = true;
-            } elseif (isset($args['format'])
-                && $args['format'] === 'email'
-            ) {
-                $validation_result = true;
-                if (! self::_validate_email($value)) {
-                    $validation_result = new WP_Error(
-                        'rest_invalid_param',
-                        esc_html__(
-                            'The email address is not valid or does not exist.',
-                            'event_espresso'
-                        )
-                    );
-                }
-            } else {
-                $validation_result = rest_validate_value_from_schema($value, $args, $param);
-            }
-        }
-        if (is_wp_error($validation_result)) {
-            return $validation_result;
-        }
-        return rest_sanitize_request_arg($value, $request, $param);
-    }
-
-
-
-    /**
-     * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
-     *
-     * @param $email
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected static function _validate_email($email){
-        try {
-            EmailAddressFactory::create($email);
-            return true;
-        } catch (EmailValidationException $e) {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Gets routes for the config
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_config_routes()
-    {
-        $config_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version(
-                $version,
-                $hidden_endpoint
-            );
-        }
-        return $config_routes;
-    }
-
-
-
-    /**
-     * Gets routes for the config for the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_config_route_data_for_version($version, $hidden_endpoint)
-    {
-        return array(
-            'config'    => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handleRequest',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => array($version),
-                ),
-            ),
-            'site_info' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handleRequestSiteInfo',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => array($version),
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * Gets the meta info routes
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_meta_routes()
-    {
-        $meta_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version(
-                $version,
-                $hidden_endpoint
-            );
-        }
-        return $meta_routes;
-    }
-
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        return array(
-            'resources' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
-                        'handleRequestModelsMeta',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => array($version),
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * Tries to hide old 4.6 endpoints from the
-     *
-     * @param array $route_data
-     * @return array
-     * @throws \EE_Error
-     */
-    public static function hide_old_endpoints($route_data)
-    {
-        //allow API clients to override which endpoints get hidden, in case
-        //they want to discover particular endpoints
-        //also, we don't have access to the request so we have to just grab it from the superglobal
-        $force_show_ee_namespace = ltrim(
-            EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
-            '/'
-        );
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
-            foreach ($relative_urls as $resource_name => $endpoints) {
-                foreach ($endpoints as $key => $endpoint) {
-                    //skip schema and other route options
-                    if (! is_numeric($key)) {
-                        continue;
-                    }
-                    //by default, hide "hidden_endpoint"s, unless the request indicates
-                    //to $force_show_ee_namespace, in which case only show that one
-                    //namespace's endpoints (and hide all others)
-                    if (
-                        ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
-                        || ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
-                    ) {
-                        $full_route = '/' . ltrim($namespace, '/');
-                        $full_route .= '/' . ltrim($resource_name, '/');
-                        unset($route_data[$full_route]);
-                    }
-                }
-            }
-        }
-        return $route_data;
-    }
-
-
-
-    /**
-     * Returns an array describing which versions of core support serving requests for.
-     * Keys are core versions' major and minor version, and values are the
-     * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
-     * data by just removing a few models and fields from the responses. However, 4.15 might remove
-     * the answers table entirely, in which case it would be very difficult for
-     * it to serve 4.6-style responses.
-     * Versions of core that are missing from this array are unknowns.
-     * previous ver
-     *
-     * @return array
-     */
-    public static function version_compatibilities()
-    {
-        return apply_filters(
-            'FHEE__EED_Core_REST_API__version_compatibilities',
-            array(
-                '4.8.29' => '4.8.29',
-                '4.8.33' => '4.8.29',
-                '4.8.34' => '4.8.29',
-                '4.8.36' => '4.8.29',
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets the latest API version served. Eg if there
-     * are two versions served of the API, 4.8.29 and 4.8.32, and
-     * we are on core version 4.8.34, it will return the string "4.8.32"
-     *
-     * @return string
-     */
-    public static function latest_rest_api_version()
-    {
-        $versions_served = \EED_Core_Rest_Api::versions_served();
-        $versions_served_keys = array_keys($versions_served);
-        return end($versions_served_keys);
-    }
-
-
-
-    /**
-     * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
-     * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
-     * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
-     * We also indicate whether or not this version should be put in the index or not
-     *
-     * @return array keys are API version numbers (just major and minor numbers), and values
-     * are whether or not they should be hidden
-     */
-    public static function versions_served()
-    {
-        $versions_served = array();
-        $possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
-        $lowest_compatible_version = end($possibly_served_versions);
-        reset($possibly_served_versions);
-        $versions_served_historically = array_keys($possibly_served_versions);
-        $latest_version = end($versions_served_historically);
-        reset($versions_served_historically);
-        //for each version of core we have ever served:
-        foreach ($versions_served_historically as $key_versioned_endpoint) {
-            //if it's not above the current core version, and it's compatible with the current version of core
-            if ($key_versioned_endpoint === $latest_version) {
-                //don't hide the latest version in the index
-                $versions_served[$key_versioned_endpoint] = false;
-            } elseif (
-                $key_versioned_endpoint >= $lowest_compatible_version
-                && $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
-            ) {
-                //include, but hide, previous versions which are still supported
-                $versions_served[$key_versioned_endpoint] = true;
-            } elseif (apply_filters(
-                'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
-                false,
-                $possibly_served_versions
-            )) {
-                //if a version is no longer supported, don't include it in index or list of versions served
-                $versions_served[$key_versioned_endpoint] = true;
-            }
-        }
-        return $versions_served;
-    }
-
-
-
-    /**
-     * Gets the major and minor version of EE core's version string
-     *
-     * @return string
-     */
-    public static function core_version()
-    {
-        return apply_filters(
-            'FHEE__EED_Core_REST_API__core_version',
-            implode(
-                '.',
-                array_slice(
-                    explode(
-                        '.',
-                        espresso_version()
-                    ),
-                0,
-                3
-                )
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets the default limit that should be used when querying for resources
-     *
-     * @return int
-     */
-    public static function get_default_query_limit()
-    {
-        //we actually don't use a const because we want folks to always use
-        //this method, not the const directly
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api__get_default_query_limit',
-            50
-        );
-    }
-
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param  WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
+
+	const saved_routes_option_names  = 'ee_core_routes';
+
+	/**
+	 * string used in _links response bodies to make them globally unique.
+	 *
+	 * @see http://v2.wp-api.org/extending/linking/
+	 */
+	const ee_api_link_namespace = 'https://api.eventespresso.com/';
+
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected static $_field_calculator;
+
+
+
+	/**
+	 * @return EED_Core_Rest_Api|EED_Module
+	 */
+	public static function instance()
+	{
+		self::$_field_calculator = new CalculatedModelFields();
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		self::set_hooks_both();
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::set_hooks_both();
+	}
+
+
+
+	public static function set_hooks_both()
+	{
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
+		add_filter('rest_index',
+			array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex'));
+		EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
+	}
+
+
+
+	/**
+	 * sets up hooks which only need to be included as part of REST API requests;
+	 * other requests like to the frontend or admin etc don't need them
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function set_hooks_rest_api()
+	{
+		//set hooks which account for changes made to the API
+		EED_Core_Rest_Api::_set_hooks_for_changes();
+	}
+
+
+
+	/**
+	 * public wrapper of _set_hooks_for_changes.
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 *
+	 * @throws EE_Error
+	 */
+	public static function set_hooks_for_changes()
+	{
+		self::_set_hooks_for_changes();
+	}
+
+
+
+	/**
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 *
+	 * @throws EE_Error
+	 */
+	protected static function _set_hooks_for_changes()
+	{
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
+			//ignore the base parent class
+			//and legacy named classes
+			if ($classname_in_namespace === 'ChangesInBase'
+				|| strpos($classname_in_namespace, 'Changes_In_') === 0
+			) {
+				continue;
+			}
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
+			if (class_exists($full_classname)) {
+				$instance_of_class = new $full_classname;
+				if ($instance_of_class instanceof ChangesInBase) {
+					$instance_of_class->setHooks();
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Filters the WP routes to add our EE-related ones. This takes a bit of time
+	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function register_routes()
+	{
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
+			foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
+				/**
+				 * @var array $data_for_multiple_endpoints numerically indexed array
+				 *                                         but can also contain route options like {
+				 * @type array    $schema                      {
+				 * @type callable $schema_callback
+				 * @type array    $callback_args               arguments that will be passed to the callback, after the
+				 * WP_REST_Request of course
+				 * }
+				 * }
+				 */
+				//when registering routes, register all the endpoints' data at the same time
+				$multiple_endpoint_args = array();
+				foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
+					/**
+					 * @var array     $data_for_single_endpoint {
+					 * @type callable $callback
+					 * @type string methods
+					 * @type array args
+					 * @type array _links
+					 * @type array    $callback_args            arguments that will be passed to the callback, after the
+					 * WP_REST_Request of course
+					 * }
+					 */
+					//skip route options
+					if (! is_numeric($endpoint_key)) {
+						continue;
+					}
+					if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
+						throw new EE_Error(
+							esc_html__(
+								// @codingStandardsIgnoreStart
+								'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
+								// @codingStandardsIgnoreEnd
+								'event_espresso')
+						);
+					}
+					$callback = $data_for_single_endpoint['callback'];
+					$single_endpoint_args = array(
+						'methods' => $data_for_single_endpoint['methods'],
+						'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
+							: array(),
+					);
+					if (isset($data_for_single_endpoint['_links'])) {
+						$single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
+					}
+					if (isset($data_for_single_endpoint['callback_args'])) {
+						$callback_args = $data_for_single_endpoint['callback_args'];
+						$single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
+							$callback,
+							$callback_args
+						) {
+							array_unshift($callback_args, $request);
+							return call_user_func_array(
+								$callback,
+								$callback_args
+							);
+						};
+					} else {
+						$single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
+					}
+					$multiple_endpoint_args[] = $single_endpoint_args;
+				}
+				if (isset($data_for_multiple_endpoints['schema'])) {
+					$schema_route_data = $data_for_multiple_endpoints['schema'];
+					$schema_callback = $schema_route_data['schema_callback'];
+					$callback_args = $schema_route_data['callback_args'];
+					$multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
+						return call_user_func_array(
+							$schema_callback,
+							$callback_args
+						);
+					};
+				}
+				register_rest_route(
+					$namespace,
+					$relative_route,
+					$multiple_endpoint_args
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Checks if there was a version change or something that merits invalidating the cached
+	 * route data. If so, invalidates the cached route data so that it gets refreshed
+	 * next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data_on_version_change()
+	{
+		if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
+			EED_Core_Rest_Api::invalidate_cached_route_data();
+		}
+		foreach (EE_Registry::instance()->addons as $addon) {
+			if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
+				EED_Core_Rest_Api::invalidate_cached_route_data();
+			}
+		}
+	}
+
+
+
+	/**
+	 * Removes the cached route data so it will get refreshed next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data()
+	{
+		//delete the saved EE REST API routes
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
+			delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
+		}
+	}
+
+
+
+	/**
+	 * Gets the EE route data
+	 *
+	 * @return array top-level key is the namespace, next-level key is the route and its value is array{
+	 * @throws \EE_Error
+	 * @type string|array $callback
+	 * @type string       $methods
+	 * @type boolean      $hidden_endpoint
+	 * }
+	 */
+	public static function get_ee_route_data()
+	{
+		$ee_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoints) {
+			$ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version(
+				$version,
+				$hidden_endpoints
+			);
+		}
+		return $ee_routes;
+	}
+
+
+
+	/**
+	 * Gets the EE route data from the wp options if it exists already,
+	 * otherwise re-generates it and saves it to the option
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$ee_routes = get_option(self::saved_routes_option_names . $version, null);
+		if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
+			$ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+
+	/**
+	 * Saves the EE REST API route data to a wp option and returns it
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return mixed|null
+	 * @throws \EE_Error
+	 */
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$instance = self::instance();
+		$routes = apply_filters(
+			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
+			array_replace_recursive(
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
+			)
+		);
+		$option_name = self::saved_routes_option_names . $version;
+		if (get_option($option_name)) {
+			update_option($option_name, $routes, true);
+		} else {
+			add_option($option_name, $routes, null, 'no');
+		}
+		return $routes;
+	}
+
+
+
+	/**
+	 * Calculates all the EE routes and saves it to a WordPress option so we don't
+	 * need to calculate it on every request
+	 *
+	 * @deprecated since version 4.9.1
+	 * @return void
+	 */
+	public static function save_ee_routes()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$instance = self::instance();
+			$routes = apply_filters(
+				'EED_Core_Rest_Api__save_ee_routes__routes',
+				array_replace_recursive(
+					$instance->_register_config_routes(),
+					$instance->_register_meta_routes(),
+					$instance->_register_model_routes(),
+					$instance->_register_rpc_routes()
+				)
+			);
+			update_option(self::saved_routes_option_names, $routes, true);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the route information relating to EE models
+	 *
+	 * @return array @see get_ee_route_data
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_model_routes()
+	{
+		$model_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$model_routes[EED_Core_Rest_Api::ee_api_namespace
+						  . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
+		}
+		return $model_routes;
+	}
+
+
+
+	/**
+	 * Decides whether or not to add write endpoints for this model.
+	 *
+	 * Currently, this defaults to exclude all global tables and models
+	 * which would allow inserting WP core data (we don't want to duplicate
+	 * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
+	 * @param EEM_Base $model
+	 * @return bool
+	 */
+	public static function should_have_write_endpoints(EEM_Base $model)
+	{
+		if ($model->is_wp_core_model()){
+			return false;
+		}
+		foreach($model->get_tables() as $table){
+			if( $table->is_global()){
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+
+	/**
+	 * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
+	 * in this versioned namespace of EE4
+	 * @param $version
+	 * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
+	 */
+	public static function model_names_with_plural_routes($version){
+		$model_version_info = new ModelVersionInfo($version);
+		$models_to_register = $model_version_info->modelsForRequestedVersion();
+		//let's not bother having endpoints for extra metas
+		unset(
+			$models_to_register['Extra_Meta'],
+			$models_to_register['Extra_Join'],
+			$models_to_register['Post_Meta']
+		);
+		return apply_filters(
+			'FHEE__EED_Core_REST_API___register_model_routes',
+			$models_to_register
+		);
+	}
+
+
+
+	/**
+	 * Gets the route data for EE models in the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$model_routes = array();
+		$model_version_info = new ModelVersionInfo($version);
+		foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
+			$model = \EE_Registry::instance()->load_model($model_name);
+			//if this isn't a valid model then let's skip iterate to the next item in the loop.
+			if (! $model instanceof EEM_Base) {
+				continue;
+			}
+			//yes we could just register one route for ALL models, but then they wouldn't show up in the index
+			$plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
+			$singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
+			$model_routes[$plural_model_route] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleRequestGetAll',
+					),
+					'callback_args'   => array($version, $model_name),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_read_query_params($model, $version),
+					'_links'          => array(
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+					),
+				),
+				'schema' => array(
+					'schema_callback' => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleSchemaRequest',
+					),
+					'callback_args'   => array($version, $model_name),
+				),
+			);
+			$model_routes[$singular_model_route] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleRequestGetOne',
+					),
+					'callback_args'   => array($version, $model_name),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_response_selection_query_params($model, $version),
+				),
+			);
+			if( apply_filters(
+				'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
+				EED_Core_Rest_Api::should_have_write_endpoints($model),
+				$model
+			)){
+				$model_routes[$plural_model_route][] = array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+						'handleRequestInsert',
+					),
+					'callback_args'   => array($version, $model_name),
+					'methods'         => WP_REST_Server::CREATABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_write_params($model_name, $model_version_info, true),
+				);
+				$model_routes[$singular_model_route] = array_merge(
+					$model_routes[$singular_model_route],
+					array(
+						array(
+							'callback'        => array(
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+								'handleRequestUpdate',
+							),
+							'callback_args'   => array($version, $model_name),
+							'methods'         => WP_REST_Server::EDITABLE,
+							'hidden_endpoint' => $hidden_endpoint,
+							'args'            => $this->_get_write_params($model_name, $model_version_info),
+						),
+						array(
+							'callback'        => array(
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+								'handleRequestDelete',
+							),
+							'callback_args'   => array($version, $model_name),
+							'methods'         => WP_REST_Server::DELETABLE,
+							'hidden_endpoint' => $hidden_endpoint,
+							'args'            => $this->_get_delete_query_params($model, $version),
+						)
+					)
+				);
+			}
+			foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+
+				$related_route = EED_Core_Rest_Api::get_relation_route_via(
+					$model,
+					'(?P<id>[^\/]+)',
+					$relation_obj
+				);
+				$endpoints = array(
+					array(
+						'callback'        => array(
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+							'handleRequestGetRelated',
+						),
+						'callback_args'   => array($version, $model_name, $relation_name),
+						'methods'         => WP_REST_Server::READABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
+					),
+				);
+				$model_routes[$related_route] = $endpoints;
+			}
+		}
+		return $model_routes;
+	}
+
+
+
+	/**
+	 * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
+	 * excluding the preceding slash.
+	 * Eg you pass get_plural_route_to('Event') = 'events'
+	 *
+	 * @param EEM_Base $model
+	 * @return string
+	 */
+	public static function get_collection_route(EEM_Base $model)
+	{
+		return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+	}
+
+
+
+	/**
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
+	 * excluding the preceding slash.
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
+	 *
+	 * @param EEM_Base $model eg Event or Venue
+	 * @param string $id
+	 * @return string
+	 */
+	public static function get_entity_route($model, $id)
+	{
+		return EED_Core_Rest_Api::get_collection_route($model). '/' . $id;
+	}
+
+
+	/**
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
+	 * excluding the preceding slash.
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
+	 *
+	 * @param EEM_Base                 $model eg Event or Venue
+	 * @param string                 $id
+	 * @param EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
+	{
+		$related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
+			$relation_obj->get_other_model()->get_this_model_name(),
+			$relation_obj
+		);
+		return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
+	}
+
+
+
+	/**
+	 * Adds onto the $relative_route the EE4 REST API versioned namespace.
+	 * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
+	 * @param string $relative_route
+	 * @param string $version
+	 * @return string
+	 */
+	public static function get_versioned_route_to($relative_route, $version = '4.8.36'){
+		return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
+	}
+
+
+
+	/**
+	 * Adds all the RPC-style routes (remote procedure call-like routes, ie
+	 * routes that don't conform to the traditional REST CRUD-style).
+	 *
+	 * @deprecated since 4.9.1
+	 */
+	protected function _register_rpc_routes()
+	{
+		$routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version(
+				$version,
+				$hidden_endpoint
+			);
+		}
+		return $routes;
+	}
+
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$this_versions_routes = array();
+		//checkin endpoint
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
+			array(
+				'callback'        => array(
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
+					'handleRequestToggleCheckin',
+				),
+				'methods'         => WP_REST_Server::CREATABLE,
+				'hidden_endpoint' => $hidden_endpoint,
+				'args'            => array(
+					'force' => array(
+						'required'    => false,
+						'default'     => false,
+						'description' => __(
+							// @codingStandardsIgnoreStart
+							'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+					),
+				),
+				'callback_args'   => array($version),
+			),
+		);
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
+			$this_versions_routes,
+			$version,
+			$hidden_endpoint
+		);
+	}
+
+
+
+	/**
+	 * Gets the query params that can be used when request one or many
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $version
+	 * @return array
+	 */
+	protected function _get_response_selection_query_params(\EEM_Base $model, $version)
+	{
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array(
+				'include'   => array(
+					'required' => false,
+					'default'  => '*',
+					'type'     => 'string',
+				),
+				'calculate' => array(
+					'required'          => false,
+					'default'           => '',
+					'enum'              => self::$_field_calculator->retrieveCalculatedFieldsForModel($model),
+					'type'              => 'string',
+					//because we accept a CSV'd list of the enumerated strings, WP core validation and sanitization
+					//freaks out. We'll just validate this argument while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				),
+			),
+			$model,
+			$version
+		);
+	}
+
+
+
+	/**
+	 * Gets the parameters acceptable for delete requests
+	 *
+	 * @param \EEM_Base $model
+	 * @param string    $version
+	 * @return array
+	 */
+	protected function _get_delete_query_params(\EEM_Base $model, $version)
+	{
+		$params_for_delete = array(
+			'allow_blocking' => array(
+				'required' => false,
+				'default'  => true,
+				'type'     => 'boolean',
+			),
+		);
+		$params_for_delete['force'] = array(
+			'required' => false,
+			'default'  => false,
+			'type'     => 'boolean',
+		);
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_delete_query_params',
+			$params_for_delete,
+			$model,
+			$version
+		);
+	}
+
+
+
+	/**
+	 * Gets info about reading query params that are acceptable
+	 *
+	 * @param \EEM_Base $model eg 'Event' or 'Venue'
+	 * @param  string   $version
+	 * @return array    describing the args acceptable when querying this model
+	 * @throws EE_Error
+	 */
+	protected function _get_read_query_params(\EEM_Base $model, $version)
+	{
+		$default_orderby = array();
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
+			$default_orderby[$key_field->get_name()] = 'ASC';
+		}
+		return array_merge(
+			$this->_get_response_selection_query_params($model, $version),
+			array(
+				'where'    => array(
+					'required' => false,
+					'default'  => array(),
+					'type'     => 'object',
+				),
+				'limit'    => array(
+					'required' => false,
+					'default'  => EED_Core_Rest_Api::get_default_query_limit(),
+					'type'     => array(
+						'object',
+						'string',
+						'integer',
+					),
+				),
+				'order_by' => array(
+					'required' => false,
+					'default'  => $default_orderby,
+					'type'     => array(
+						'object',
+						'string',
+					),
+				),
+				'group_by' => array(
+					'required' => false,
+					'default'  => null,
+					'type'     => array(
+						'object',
+						'string',
+					),
+				),
+				'having'   => array(
+					'required' => false,
+					'default'  => null,
+					'type'     => 'object',
+				),
+				'caps'     => array(
+					'required' => false,
+					'default'  => EEM_Base::caps_read,
+					'type'     => 'string',
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets parameter information for a model regarding writing data
+	 *
+	 * @param string           $model_name
+	 * @param ModelVersionInfo $model_version_info
+	 * @param boolean          $create                                       whether this is for request to create (in which case we need
+	 *                                                                       all required params) or just to update (in which case we don't need those on every request)
+	 * @return array
+	 */
+	protected function _get_write_params(
+		$model_name,
+		ModelVersionInfo $model_version_info,
+		$create = false
+	) {
+		$model = EE_Registry::instance()->load_model($model_name);
+		$fields = $model_version_info->fieldsOnModelInThisVersion($model);
+		$args_info = array();
+		foreach ($fields as $field_name => $field_obj) {
+			if ($field_obj->is_auto_increment()) {
+				//totally ignore auto increment IDs
+				continue;
+			}
+			$arg_info = $field_obj->getSchema();
+			$required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
+			$arg_info['required'] = $required;
+			//remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
+			unset($arg_info['readonly']);
+			$schema_properties = $field_obj->getSchemaProperties();
+			if (
+				isset($schema_properties['raw'])
+				&& $field_obj->getSchemaType() === 'object'
+			) {
+				//if there's a "raw" form of this argument, use those properties instead
+				$arg_info = array_replace(
+					$arg_info,
+					$schema_properties['raw']
+				);
+			}
+			$arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
+				$field_obj,
+				$field_obj->get_default_value(),
+				$model_version_info->requestedVersion()
+			);
+			//we do our own validation and sanitization within the controller
+			$arg_info['sanitize_callback'] =
+				array(
+					'EED_Core_Rest_Api',
+					'default_sanitize_callback',
+				);
+			$args_info[$field_name] = $arg_info;
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$gmt_arg_info = $arg_info;
+				$gmt_arg_info['description'] = sprintf(
+					esc_html__(
+						'%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
+						'event_espresso'
+					),
+					$field_obj->get_nicename(),
+					$field_name
+				);
+				$args_info[$field_name . '_gmt'] = $gmt_arg_info;
+			}
+		}
+		return $args_info;
+	}
+
+
+
+	/**
+	 * Replacement for WP API's 'rest_parse_request_arg'.
+	 * If the value is blank but not required, don't bother validating it.
+	 * Also, it uses our email validation instead of WP API's default.
+	 *
+	 * @param                 $value
+	 * @param WP_REST_Request $request
+	 * @param                 $param
+	 * @return bool|true|WP_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function default_sanitize_callback( $value, WP_REST_Request $request, $param)
+	{
+		$attributes = $request->get_attributes();
+		if (! isset($attributes['args'][$param])
+			|| ! is_array($attributes['args'][$param])) {
+			$validation_result = true;
+		} else {
+			$args = $attributes['args'][$param];
+			if ((
+					$value === ''
+					|| $value === null
+				)
+				&& (! isset($args['required'])
+					|| $args['required'] === false
+				)
+			) {
+				//not required and not provided? that's cool
+				$validation_result = true;
+			} elseif (isset($args['format'])
+				&& $args['format'] === 'email'
+			) {
+				$validation_result = true;
+				if (! self::_validate_email($value)) {
+					$validation_result = new WP_Error(
+						'rest_invalid_param',
+						esc_html__(
+							'The email address is not valid or does not exist.',
+							'event_espresso'
+						)
+					);
+				}
+			} else {
+				$validation_result = rest_validate_value_from_schema($value, $args, $param);
+			}
+		}
+		if (is_wp_error($validation_result)) {
+			return $validation_result;
+		}
+		return rest_sanitize_request_arg($value, $request, $param);
+	}
+
+
+
+	/**
+	 * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
+	 *
+	 * @param $email
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected static function _validate_email($email){
+		try {
+			EmailAddressFactory::create($email);
+			return true;
+		} catch (EmailValidationException $e) {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Gets routes for the config
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_config_routes()
+	{
+		$config_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version(
+				$version,
+				$hidden_endpoint
+			);
+		}
+		return $config_routes;
+	}
+
+
+
+	/**
+	 * Gets routes for the config for the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint)
+	{
+		return array(
+			'config'    => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handleRequest',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => array($version),
+				),
+			),
+			'site_info' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handleRequestSiteInfo',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => array($version),
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * Gets the meta info routes
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_meta_routes()
+	{
+		$meta_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version(
+				$version,
+				$hidden_endpoint
+			);
+		}
+		return $meta_routes;
+	}
+
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		return array(
+			'resources' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
+						'handleRequestModelsMeta',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => array($version),
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * Tries to hide old 4.6 endpoints from the
+	 *
+	 * @param array $route_data
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public static function hide_old_endpoints($route_data)
+	{
+		//allow API clients to override which endpoints get hidden, in case
+		//they want to discover particular endpoints
+		//also, we don't have access to the request so we have to just grab it from the superglobal
+		$force_show_ee_namespace = ltrim(
+			EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
+			'/'
+		);
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $resource_name => $endpoints) {
+				foreach ($endpoints as $key => $endpoint) {
+					//skip schema and other route options
+					if (! is_numeric($key)) {
+						continue;
+					}
+					//by default, hide "hidden_endpoint"s, unless the request indicates
+					//to $force_show_ee_namespace, in which case only show that one
+					//namespace's endpoints (and hide all others)
+					if (
+						($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
+						|| ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
+					) {
+						$full_route = '/' . ltrim($namespace, '/');
+						$full_route .= '/' . ltrim($resource_name, '/');
+						unset($route_data[$full_route]);
+					}
+				}
+			}
+		}
+		return $route_data;
+	}
+
+
+
+	/**
+	 * Returns an array describing which versions of core support serving requests for.
+	 * Keys are core versions' major and minor version, and values are the
+	 * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
+	 * data by just removing a few models and fields from the responses. However, 4.15 might remove
+	 * the answers table entirely, in which case it would be very difficult for
+	 * it to serve 4.6-style responses.
+	 * Versions of core that are missing from this array are unknowns.
+	 * previous ver
+	 *
+	 * @return array
+	 */
+	public static function version_compatibilities()
+	{
+		return apply_filters(
+			'FHEE__EED_Core_REST_API__version_compatibilities',
+			array(
+				'4.8.29' => '4.8.29',
+				'4.8.33' => '4.8.29',
+				'4.8.34' => '4.8.29',
+				'4.8.36' => '4.8.29',
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets the latest API version served. Eg if there
+	 * are two versions served of the API, 4.8.29 and 4.8.32, and
+	 * we are on core version 4.8.34, it will return the string "4.8.32"
+	 *
+	 * @return string
+	 */
+	public static function latest_rest_api_version()
+	{
+		$versions_served = \EED_Core_Rest_Api::versions_served();
+		$versions_served_keys = array_keys($versions_served);
+		return end($versions_served_keys);
+	}
+
+
+
+	/**
+	 * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
+	 * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
+	 * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
+	 * We also indicate whether or not this version should be put in the index or not
+	 *
+	 * @return array keys are API version numbers (just major and minor numbers), and values
+	 * are whether or not they should be hidden
+	 */
+	public static function versions_served()
+	{
+		$versions_served = array();
+		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
+		$lowest_compatible_version = end($possibly_served_versions);
+		reset($possibly_served_versions);
+		$versions_served_historically = array_keys($possibly_served_versions);
+		$latest_version = end($versions_served_historically);
+		reset($versions_served_historically);
+		//for each version of core we have ever served:
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
+			//if it's not above the current core version, and it's compatible with the current version of core
+			if ($key_versioned_endpoint === $latest_version) {
+				//don't hide the latest version in the index
+				$versions_served[$key_versioned_endpoint] = false;
+			} elseif (
+				$key_versioned_endpoint >= $lowest_compatible_version
+				&& $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
+			) {
+				//include, but hide, previous versions which are still supported
+				$versions_served[$key_versioned_endpoint] = true;
+			} elseif (apply_filters(
+				'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
+				false,
+				$possibly_served_versions
+			)) {
+				//if a version is no longer supported, don't include it in index or list of versions served
+				$versions_served[$key_versioned_endpoint] = true;
+			}
+		}
+		return $versions_served;
+	}
+
+
+
+	/**
+	 * Gets the major and minor version of EE core's version string
+	 *
+	 * @return string
+	 */
+	public static function core_version()
+	{
+		return apply_filters(
+			'FHEE__EED_Core_REST_API__core_version',
+			implode(
+				'.',
+				array_slice(
+					explode(
+						'.',
+						espresso_version()
+					),
+				0,
+				3
+				)
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets the default limit that should be used when querying for resources
+	 *
+	 * @return int
+	 */
+	public static function get_default_query_limit()
+	{
+		//we actually don't use a const because we want folks to always use
+		//this method, not the const directly
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api__get_default_query_limit',
+			50
+		);
+	}
+
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param  WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 }
 
 // End of file EED_Core_Rest_Api.module.php

Spacing +35 added lines, -35 removed lines

@@ -128,7 +128,7 @@ 
      */
     protected static function _set_hooks_for_changes()
     {
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
+        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES.'rest_api'.DS.'changes'), false);
         foreach ($folder_contents as $classname_in_namespace => $filepath) {
             //ignore the base parent class
             //and legacy named classes
@@ -137,7 +137,7 @@ 
             ) {
                 continue;
             }
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
+            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\'.$classname_in_namespace;
             if (class_exists($full_classname)) {
                 $instance_of_class = new $full_classname;
                 if ($instance_of_class instanceof ChangesInBase) {
@@ -183,10 +183,10 @@ 
                      * }
                      */
                     //skip route options
-                    if (! is_numeric($endpoint_key)) {
+                    if ( ! is_numeric($endpoint_key)) {
                         continue;
                     }
-                    if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
+                    if ( ! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
                         throw new EE_Error(
                             esc_html__(
                                 // @codingStandardsIgnoreStart
@@ -206,7 +206,7 @@ 
                     }
                     if (isset($data_for_single_endpoint['callback_args'])) {
                         $callback_args = $data_for_single_endpoint['callback_args'];
-                        $single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
+                        $single_endpoint_args['callback'] = function(\WP_REST_Request $request) use (
                             $callback,
                             $callback_args
                         ) {
@@ -225,7 +225,7 @@ 
                     $schema_route_data = $data_for_multiple_endpoints['schema'];
                     $schema_callback = $schema_route_data['schema_callback'];
                     $callback_args = $schema_route_data['callback_args'];
-                    $multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
+                    $multiple_endpoint_args['schema'] = function() use ($schema_callback, $callback_args) {
                         return call_user_func_array(
                             $schema_callback,
                             $callback_args
@@ -269,7 +269,7 @@ 
     {
         //delete the saved EE REST API routes
         foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
+            delete_option(EED_Core_Rest_Api::saved_routes_option_names.$version);
         }
     }
 
@@ -289,7 +289,7 @@ 
     {
         $ee_routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version(
+            $ee_routes[self::ee_api_namespace.$version] = self::_get_ee_route_data_for_version(
                 $version,
                 $hidden_endpoints
             );
@@ -310,8 +310,8 @@ 
      */
     protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
     {
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
-        if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
+        $ee_routes = get_option(self::saved_routes_option_names.$version, null);
+        if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
             $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
         }
         return $ee_routes;
@@ -339,7 +339,7 @@ 
                 $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
             )
         );
-        $option_name = self::saved_routes_option_names . $version;
+        $option_name = self::saved_routes_option_names.$version;
         if (get_option($option_name)) {
             update_option($option_name, $routes, true);
         } else {
@@ -405,11 +405,11 @@ 
      */
     public static function should_have_write_endpoints(EEM_Base $model)
     {
-        if ($model->is_wp_core_model()){
+        if ($model->is_wp_core_model()) {
             return false;
         }
-        foreach($model->get_tables() as $table){
-            if( $table->is_global()){
+        foreach ($model->get_tables() as $table) {
+            if ($table->is_global()) {
                 return false;
             }
         }
@@ -424,7 +424,7 @@ 
      * @param $version
      * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
      */
-    public static function model_names_with_plural_routes($version){
+    public static function model_names_with_plural_routes($version) {
         $model_version_info = new ModelVersionInfo($version);
         $models_to_register = $model_version_info->modelsForRequestedVersion();
         //let's not bother having endpoints for extra metas
@@ -456,7 +456,7 @@ 
         foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
             $model = \EE_Registry::instance()->load_model($model_name);
             //if this isn't a valid model then let's skip iterate to the next item in the loop.
-            if (! $model instanceof EEM_Base) {
+            if ( ! $model instanceof EEM_Base) {
                 continue;
             }
             //yes we could just register one route for ALL models, but then they wouldn't show up in the index
@@ -473,7 +473,7 @@ 
                     'hidden_endpoint' => $hidden_endpoint,
                     'args'            => $this->_get_read_query_params($model, $version),
                     '_links'          => array(
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace.$version.$singular_model_route),
                     ),
                 ),
                 'schema' => array(
@@ -496,11 +496,11 @@ 
                     'args'            => $this->_get_response_selection_query_params($model, $version),
                 ),
             );
-            if( apply_filters(
+            if (apply_filters(
                 'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
                 EED_Core_Rest_Api::should_have_write_endpoints($model),
                 $model
-            )){
+            )) {
                 $model_routes[$plural_model_route][] = array(
                     'callback'        => array(
                         'EventEspresso\core\libraries\rest_api\controllers\model\Write',
@@ -590,7 +590,7 @@ 
      */
     public static function get_entity_route($model, $id)
     {
-        return EED_Core_Rest_Api::get_collection_route($model). '/' . $id;
+        return EED_Core_Rest_Api::get_collection_route($model).'/'.$id;
     }
 
 
@@ -610,7 +610,7 @@ 
             $relation_obj->get_other_model()->get_this_model_name(),
             $relation_obj
         );
-        return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
+        return EED_Core_Rest_Api::get_entity_route($model, $id).'/'.$related_model_name_endpoint_part;
     }
 
 
@@ -622,8 +622,8 @@ 
      * @param string $version
      * @return string
      */
-    public static function get_versioned_route_to($relative_route, $version = '4.8.36'){
-        return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
+    public static function get_versioned_route_to($relative_route, $version = '4.8.36') {
+        return '/'.EED_Core_Rest_Api::ee_api_namespace.$version.'/'.$relative_route;
     }
 
 
@@ -638,7 +638,7 @@ 
     {
         $routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version(
+            $routes[self::ee_api_namespace.$version] = $this->_get_rpc_route_data_for_version(
                 $version,
                 $hidden_endpoint
             );
@@ -879,7 +879,7 @@ 
                     $field_obj->get_nicename(),
                     $field_name
                 );
-                $args_info[$field_name . '_gmt'] = $gmt_arg_info;
+                $args_info[$field_name.'_gmt'] = $gmt_arg_info;
             }
         }
         return $args_info;
@@ -900,10 +900,10 @@ 
      * @throws InvalidInterfaceException
      * @throws InvalidDataTypeException
      */
-    public static function default_sanitize_callback( $value, WP_REST_Request $request, $param)
+    public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
     {
         $attributes = $request->get_attributes();
-        if (! isset($attributes['args'][$param])
+        if ( ! isset($attributes['args'][$param])
             || ! is_array($attributes['args'][$param])) {
             $validation_result = true;
         } else {
@@ -912,7 +912,7 @@ 
                     $value === ''
                     || $value === null
                 )
-                && (! isset($args['required'])
+                && ( ! isset($args['required'])
                     || $args['required'] === false
                 )
             ) {
@@ -922,7 +922,7 @@ 
                 && $args['format'] === 'email'
             ) {
                 $validation_result = true;
-                if (! self::_validate_email($value)) {
+                if ( ! self::_validate_email($value)) {
                     $validation_result = new WP_Error(
                         'rest_invalid_param',
                         esc_html__(
@@ -952,7 +952,7 @@ 
      * @throws InvalidInterfaceException
      * @throws InvalidDataTypeException
      */
-    protected static function _validate_email($email){
+    protected static function _validate_email($email) {
         try {
             EmailAddressFactory::create($email);
             return true;
@@ -973,7 +973,7 @@ 
     {
         $config_routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version(
+            $config_routes[self::ee_api_namespace.$version] = $this->_get_config_route_data_for_version(
                 $version,
                 $hidden_endpoint
             );
@@ -1030,7 +1030,7 @@ 
     {
         $meta_routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version(
+            $meta_routes[self::ee_api_namespace.$version] = $this->_get_meta_route_data_for_version(
                 $version,
                 $hidden_endpoint
             );
@@ -1084,7 +1084,7 @@ 
             foreach ($relative_urls as $resource_name => $endpoints) {
                 foreach ($endpoints as $key => $endpoint) {
                     //skip schema and other route options
-                    if (! is_numeric($key)) {
+                    if ( ! is_numeric($key)) {
                         continue;
                     }
                     //by default, hide "hidden_endpoint"s, unless the request indicates
@@ -1094,8 +1094,8 @@ 
                         ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
                         || ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
                     ) {
-                        $full_route = '/' . ltrim($namespace, '/');
-                        $full_route .= '/' . ltrim($resource_name, '/');
+                        $full_route = '/'.ltrim($namespace, '/');
+                        $full_route .= '/'.ltrim($resource_name, '/');
                         unset($route_data[$full_route]);
                     }
                 }

core/db_models/fields/EE_Email_Field.php

Indentation +31 added lines, -31 removed lines

@@ -16,38 +16,38 @@
 {
 
 
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @throws InvalidArgumentException
-     */
-    public function __construct($table_column, $nice_name, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-        $this->setSchemaFormat('email');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($table_column, $nice_name, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->setSchemaFormat('email');
+	}
 
 
 
-    /**
-     * In form inputs, we should have called htmlentities and addslashes() on form inputs,
-     * so we need to undo that on setting of these fields
-     *
-     * @param string $email_address
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function prepare_for_set($email_address)
-    {
-        try {
-            $email_address = EmailAddressFactory::create($email_address);
-            return $email_address->get();
-        } catch (EmailValidationException $e) {
-            return '';
-        }
-    }
+	/**
+	 * In form inputs, we should have called htmlentities and addslashes() on form inputs,
+	 * so we need to undo that on setting of these fields
+	 *
+	 * @param string $email_address
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function prepare_for_set($email_address)
+	{
+		try {
+			$email_address = EmailAddressFactory::create($email_address);
+			return $email_address->get();
+		} catch (EmailValidationException $e) {
+			return '';
+		}
+	}
 }