eventespresso / event-espresso-core

core/db_classes/EE_Registration.class.php

Spacing +15 added lines, -15 removed lines

@@ -119,7 +119,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;
@@ -400,7 +400,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;
@@ -443,7 +443,7 @@ 
     {
         // 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(false, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+        $this->release_reserved_ticket(false, "REG: {$this->ID()} (ln:".__LINE__.')');
         $ticket = $this->ticket();
         $ticket->increaseSold();
         // possibly set event status to sold out
@@ -497,7 +497,7 @@ 
                 && $update_ticket
             ) {
                 $ticket = $this->ticket();
-                $ticket->increaseReserved(1, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+                $ticket->increaseReserved(1, "REG: {$this->ID()} (ln:".__LINE__.')');
                 $ticket->save();
             }
         }
@@ -528,7 +528,7 @@ 
                 && $update_ticket
             ) {
                 $ticket = $this->ticket();
-                $ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+                $ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:".__LINE__.')');
             }
         }
     }
@@ -1202,7 +1202,7 @@ 
                     : '';
                 break;
         }
-        return $icon . $status[ $this->status_ID() ];
+        return $icon.$status[$this->status_ID()];
     }
 
 
@@ -1420,7 +1420,7 @@ 
             return false;
         }
         // is there a datetime ticket that matches this dtt_ID?
-        if (! (EEM_Datetime_Ticket::instance()->exists(
+        if ( ! (EEM_Datetime_Ticket::instance()->exists(
             array(
                 array(
                     'TKT_ID' => $this->get('TKT_ID'),
@@ -1451,7 +1451,7 @@ 
     {
         $DTT_ID = EEM_Datetime::instance()->ensure_is_ID($DTT_OR_ID);
 
-        if (! $DTT_ID) {
+        if ( ! $DTT_ID) {
             return false;
         }
 
@@ -1459,7 +1459,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;
         }
 
@@ -1519,7 +1519,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__(
@@ -1542,7 +1542,7 @@ 
         );
         // 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 ];
+        $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;
@@ -1707,7 +1707,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;
@@ -1761,11 +1761,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'
             );
@@ -1916,7 +1916,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;

Indentation +2107 added lines, -2107 removed lines

@@ -17,2111 +17,2111 @@
 {
 
 
-    /**
-     * 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 ContextInterface|null $context
-     * @return bool
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws UnexpectedEntityException
-     */
-    public function set_status($new_STS_ID = null, $use_default = false, ContextInterface $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
-        ) {
-            // update internal status first
-            parent::set('STS_ID', $new_STS_ID, $use_default);
-            // THEN handle other changes that occur when reg status changes
-            // TO approved
-            if ($new_STS_ID === EEM_Registration::status_id_approved) {
-                // reserve a space by incrementing ticket and datetime sold values
-                $this->reserveRegistrationSpace();
-                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->releaseRegistrationSpace();
-                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->updateIfCanceledOrReinstated($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 ContextInterface|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateIfCanceledOrReinstated($new_STS_ID, $old_STS_ID, ContextInterface $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->updateIfReinstated(
-            $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 ContextInterface|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    private function updateIfCanceled(
-        array $closed_reg_statuses,
-        $new_STS_ID,
-        $old_STS_ID,
-        ContextInterface $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 ContextInterface|null $context
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function updateIfReinstated(
-        array $closed_reg_statuses,
-        $new_STS_ID,
-        $old_STS_ID,
-        ContextInterface $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 ContextInterface|null $context
-     * @return bool
-     */
-    private function statusChangeUpdatesTransaction(ContextInterface $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 ContextInterface
-            && 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');
-    }
-
-
-    /**
-     * 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;
-    }
-
-
-    /**
-     * increments this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    private function reserveRegistrationSpace()
-    {
-        // 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(false, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
-        $ticket = $this->ticket();
-        $ticket->increaseSold();
-        // possibly set event status to sold out
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
-     *
-     * @return void
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    private function releaseRegistrationSpace()
-    {
-        $ticket = $this->ticket();
-        $ticket->decreaseSold();
-        // possibly change event status from sold out back to previous status
-        $this->event()->perform_sold_out_status_check();
-    }
-
-
-    /**
-     * 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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function reserve_ticket($update_ticket = false, $source = 'unknown')
-    {
-        // only reserve ticket if space is not currently reserved
-        if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) !== true) {
-            $this->update_extra_meta('reserve_ticket', "{$this->ticket_ID()} from {$source}");
-            // IMPORTANT !!!
-            // 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)
-                && $update_ticket
-            ) {
-                $ticket = $this->ticket();
-                $ticket->increaseReserved(1, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
-                $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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function release_reserved_ticket($update_ticket = false, $source = 'unknown')
-    {
-        // only release ticket if space is currently reserved
-        if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) === true) {
-            $this->update_extra_meta('release_reserved_ticket', "{$this->ticket_ID()} from {$source}");
-            // IMPORTANT !!!
-            // 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, false)
-                && $update_ticket
-            ) {
-                $ticket = $this->ticket();
-                $ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
-            }
-        }
-    }
-
-
-    /**
-     * 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');
-    }
-
-    /**
-     * Gets the name of the attendee.
-     * @since $VID:$
-     * @param bool $apply_html_entities set to true if you want to use HTML entities.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function attendeeName($apply_html_entities = false)
-    {
-        $attendee = $this->get_first_related('Attendee');
-        if ($attendee instanceof EE_Attendee) {
-            $attendee_name = $attendee->full_name($apply_html_entities);
-        } else {
-            $attendee_name = esc_html__('Unknown', 'event_espresso');
-        }
-        return $attendee_name;
-    }
-
-
-    /**
-     *        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 for the checkout payment options reg step
-     * with this registration's 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 InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function payment_overview_url($clear_session = false)
-    {
-        return add_query_arg(
-            (array) apply_filters(
-                'FHEE__EE_Registration__payment_overview_url__query_args',
-                array(
-                    'e_reg_url_link' => $this->reg_url_link(),
-                    'step'           => 'payment_options',
-                    'revisit'        => true,
-                    'clear_session'  => (bool) $clear_session,
-                ),
-                $this
-            ),
-            EE_Registry::instance()->CFG->core->reg_page_url()
-        );
-    }
-
-
-    /**
-     * Gets the URL for the checkout attendee information reg step
-     * with this registration's REG_url_link added as a query parameter
-     *
-     * @return string
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function edit_attendee_information_url()
-    {
-        return add_query_arg(
-            (array) apply_filters(
-                'FHEE__EE_Registration__edit_attendee_information_url__query_args',
-                array(
-                    'e_reg_url_link' => $this->reg_url_link(),
-                    'step'           => 'attendee_information',
-                    'revisit'        => true,
-                ),
-                $this
-            ),
-            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 @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @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 InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function question_groups()
-    {
-        return EEM_Event::instance()->get_question_groups_for_event($this->event_ID(), $this);
-    }
-
-
-    /**
-     * count_question_groups
-     * returns a count of the number of EE_Question_Group objects for this registration
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws EntityNotFoundException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function count_question_groups()
-    {
-        return EEM_Event::instance()->count_related(
-            $this->event_ID(),
-            'Question_Group',
-            [
-                [
-                    'Event_Question_Group.'
-                    . EEM_Event_Question_Group::instance()->fieldNameForContext($this->is_primary_registrant()) => true,
-                ]
-            ]
-        );
-    }
-
-
-    /**
-     * 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();
-    }
-
-
-    /**
-     * possibly toggle Registration status based on comparison of REG_paid vs REG_final_price
-     *
-     * @param  boolean $trigger_set_status_logic EE_Registration::set_status() can trigger additional logic
-     *                                           depending on whether the reg status changes to or from "Approved"
-     * @return boolean whether the Registration status was updated
-     * @throws EE_Error
-     * @throws RuntimeException
-     */
-    public function updateStatusBasedOnTotalPaid($trigger_set_status_logic = true)
-    {
-        $paid = $this->paid();
-        $price = $this->final_price();
-        switch (true) {
-            // overpaid or paid
-            case EEH_Money::compare_floats($paid, $price, '>'):
-            case EEH_Money::compare_floats($paid, $price):
-                $new_status = EEM_Registration::status_id_approved;
-                break;
-            //  underpaid
-            case EEH_Money::compare_floats($paid, $price, '<'):
-                $new_status = EEM_Registration::status_id_pending_payment;
-                break;
-            // uhhh Houston...
-            default:
-                throw new RuntimeException(
-                    esc_html__('The total paid calculation for this registration is inaccurate.', 'event_espresso')
-                );
-        }
-        if ($new_status !== $this->status_ID()) {
-            if ($trigger_set_status_logic) {
-                return $this->set_status($new_status);
-            }
-            parent::set('STS_ID', $new_status);
-            return true;
-        }
-        return false;
-    }
-
-
-    /*************************** 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();
-    }
-
-    public function name()
-    {
-        $attendee = $this->attendee();
-        if ($attendee instanceof EE_Attendee) {
-            $attendee_name = $attendee->full_name();
-        } else {
-            $attendee_name = esc_html__('Unknown', 'event_espresso');
-        }
-        return esc_html(
-            sprintf(
-                // translators: 1: registration code, 2: number, 3: group size, 4: attendee name.
-                __('Registration with code "%1$s", %2$d of %3$d for %4$s', 'event_espresso'),
-                $this->reg_code(),
-                $this->count(),
-                $this->group_size(),
-                $attendee_name
-            )
-        );
-    }
+	/**
+	 * 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 ContextInterface|null $context
+	 * @return bool
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws UnexpectedEntityException
+	 */
+	public function set_status($new_STS_ID = null, $use_default = false, ContextInterface $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
+		) {
+			// update internal status first
+			parent::set('STS_ID', $new_STS_ID, $use_default);
+			// THEN handle other changes that occur when reg status changes
+			// TO approved
+			if ($new_STS_ID === EEM_Registration::status_id_approved) {
+				// reserve a space by incrementing ticket and datetime sold values
+				$this->reserveRegistrationSpace();
+				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->releaseRegistrationSpace();
+				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->updateIfCanceledOrReinstated($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 ContextInterface|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateIfCanceledOrReinstated($new_STS_ID, $old_STS_ID, ContextInterface $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->updateIfReinstated(
+			$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 ContextInterface|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	private function updateIfCanceled(
+		array $closed_reg_statuses,
+		$new_STS_ID,
+		$old_STS_ID,
+		ContextInterface $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 ContextInterface|null $context
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function updateIfReinstated(
+		array $closed_reg_statuses,
+		$new_STS_ID,
+		$old_STS_ID,
+		ContextInterface $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 ContextInterface|null $context
+	 * @return bool
+	 */
+	private function statusChangeUpdatesTransaction(ContextInterface $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 ContextInterface
+			&& 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');
+	}
+
+
+	/**
+	 * 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;
+	}
+
+
+	/**
+	 * increments this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	private function reserveRegistrationSpace()
+	{
+		// 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(false, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+		$ticket = $this->ticket();
+		$ticket->increaseSold();
+		// possibly set event status to sold out
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * decrements (subtracts) this registration's related ticket sold and corresponding datetime sold values
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	private function releaseRegistrationSpace()
+	{
+		$ticket = $this->ticket();
+		$ticket->decreaseSold();
+		// possibly change event status from sold out back to previous status
+		$this->event()->perform_sold_out_status_check();
+	}
+
+
+	/**
+	 * 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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function reserve_ticket($update_ticket = false, $source = 'unknown')
+	{
+		// only reserve ticket if space is not currently reserved
+		if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) !== true) {
+			$this->update_extra_meta('reserve_ticket', "{$this->ticket_ID()} from {$source}");
+			// IMPORTANT !!!
+			// 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)
+				&& $update_ticket
+			) {
+				$ticket = $this->ticket();
+				$ticket->increaseReserved(1, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+				$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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function release_reserved_ticket($update_ticket = false, $source = 'unknown')
+	{
+		// only release ticket if space is currently reserved
+		if ((bool) $this->get_extra_meta(EE_Registration::HAS_RESERVED_TICKET_KEY, true) === true) {
+			$this->update_extra_meta('release_reserved_ticket', "{$this->ticket_ID()} from {$source}");
+			// IMPORTANT !!!
+			// 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, false)
+				&& $update_ticket
+			) {
+				$ticket = $this->ticket();
+				$ticket->decreaseReserved(1, true, "REG: {$this->ID()} (ln:" . __LINE__ . ')');
+			}
+		}
+	}
+
+
+	/**
+	 * 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');
+	}
+
+	/**
+	 * Gets the name of the attendee.
+	 * @since $VID:$
+	 * @param bool $apply_html_entities set to true if you want to use HTML entities.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function attendeeName($apply_html_entities = false)
+	{
+		$attendee = $this->get_first_related('Attendee');
+		if ($attendee instanceof EE_Attendee) {
+			$attendee_name = $attendee->full_name($apply_html_entities);
+		} else {
+			$attendee_name = esc_html__('Unknown', 'event_espresso');
+		}
+		return $attendee_name;
+	}
+
+
+	/**
+	 *        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 for the checkout payment options reg step
+	 * with this registration's 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 InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function payment_overview_url($clear_session = false)
+	{
+		return add_query_arg(
+			(array) apply_filters(
+				'FHEE__EE_Registration__payment_overview_url__query_args',
+				array(
+					'e_reg_url_link' => $this->reg_url_link(),
+					'step'           => 'payment_options',
+					'revisit'        => true,
+					'clear_session'  => (bool) $clear_session,
+				),
+				$this
+			),
+			EE_Registry::instance()->CFG->core->reg_page_url()
+		);
+	}
+
+
+	/**
+	 * Gets the URL for the checkout attendee information reg step
+	 * with this registration's REG_url_link added as a query parameter
+	 *
+	 * @return string
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function edit_attendee_information_url()
+	{
+		return add_query_arg(
+			(array) apply_filters(
+				'FHEE__EE_Registration__edit_attendee_information_url__query_args',
+				array(
+					'e_reg_url_link' => $this->reg_url_link(),
+					'step'           => 'attendee_information',
+					'revisit'        => true,
+				),
+				$this
+			),
+			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 @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @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 InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function question_groups()
+	{
+		return EEM_Event::instance()->get_question_groups_for_event($this->event_ID(), $this);
+	}
+
+
+	/**
+	 * count_question_groups
+	 * returns a count of the number of EE_Question_Group objects for this registration
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws EntityNotFoundException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function count_question_groups()
+	{
+		return EEM_Event::instance()->count_related(
+			$this->event_ID(),
+			'Question_Group',
+			[
+				[
+					'Event_Question_Group.'
+					. EEM_Event_Question_Group::instance()->fieldNameForContext($this->is_primary_registrant()) => true,
+				]
+			]
+		);
+	}
+
+
+	/**
+	 * 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();
+	}
+
+
+	/**
+	 * possibly toggle Registration status based on comparison of REG_paid vs REG_final_price
+	 *
+	 * @param  boolean $trigger_set_status_logic EE_Registration::set_status() can trigger additional logic
+	 *                                           depending on whether the reg status changes to or from "Approved"
+	 * @return boolean whether the Registration status was updated
+	 * @throws EE_Error
+	 * @throws RuntimeException
+	 */
+	public function updateStatusBasedOnTotalPaid($trigger_set_status_logic = true)
+	{
+		$paid = $this->paid();
+		$price = $this->final_price();
+		switch (true) {
+			// overpaid or paid
+			case EEH_Money::compare_floats($paid, $price, '>'):
+			case EEH_Money::compare_floats($paid, $price):
+				$new_status = EEM_Registration::status_id_approved;
+				break;
+			//  underpaid
+			case EEH_Money::compare_floats($paid, $price, '<'):
+				$new_status = EEM_Registration::status_id_pending_payment;
+				break;
+			// uhhh Houston...
+			default:
+				throw new RuntimeException(
+					esc_html__('The total paid calculation for this registration is inaccurate.', 'event_espresso')
+				);
+		}
+		if ($new_status !== $this->status_ID()) {
+			if ($trigger_set_status_logic) {
+				return $this->set_status($new_status);
+			}
+			parent::set('STS_ID', $new_status);
+			return true;
+		}
+		return false;
+	}
+
+
+	/*************************** 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();
+	}
+
+	public function name()
+	{
+		$attendee = $this->attendee();
+		if ($attendee instanceof EE_Attendee) {
+			$attendee_name = $attendee->full_name();
+		} else {
+			$attendee_name = esc_html__('Unknown', 'event_espresso');
+		}
+		return esc_html(
+			sprintf(
+				// translators: 1: registration code, 2: number, 3: group size, 4: attendee name.
+				__('Registration with code "%1$s", %2$d of %3$d for %4$s', 'event_espresso'),
+				$this->reg_code(),
+				$this->count(),
+				$this->group_size(),
+				$attendee_name
+			)
+		);
+	}
 }

modules/single_page_checkout/EED_Single_Page_Checkout.module.php

Indentation +1792 added lines, -1792 removed lines

@@ -15,1796 +15,1796 @@
 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('\\', '/'), '/', plugin_dir_path(__FILE__)), '/') . '/'
-        );
-        define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css/');
-        define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img/');
-        define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js/');
-        define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc/');
-        define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps/');
-        define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates/');
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] = EED_Single_Page_Checkout::getRegistrationExpirationNotice(
-        );
-    }
-
-
-    /**
-     * load_reg_steps
-     * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
-     *
-     * @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,
-                ),
-                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($this);
-            // kk... SPCO has successfully run
-            EED_Single_Page_Checkout::$_initialized = true;
-            // set no cache headers and constants
-            EE_System::do_not_cache();
-            // add anchor
-            add_action('loop_start', 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(esc_html__('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(esc_html__('The EE_Checkout class could not be loaded.', 'event_espresso'));
-        }
-        // reset anything that needs a clean slate for each request
-        $checkout->reset_for_current_request();
-        return $checkout;
-    }
-
-
-    /**
-     *    _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', '');
-        // add reg url link to registration query params
-        if ($this->checkout->reg_url_link && strpos($this->checkout->reg_url_link, '1-') !== 0) {
-            $this->checkout->reg_cache_where_params[0]['REG_url_link'] = $this->checkout->reg_url_link;
-        }
-        // or some other kind of revisit ?
-        $this->checkout->revisit = 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';
-    }
-
-
-    /**
-     * instantiates each reg step based on the loaded reg_steps array
-     *
-     * @return    bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    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;
-                }
-            }
-            if (isset($this->checkout->reg_steps['registration_confirmation'])) {
-                // 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);
-                } elseif (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(
-                esc_html__('No Reg Steps were loaded..', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // make reg step details available to JS
-        $this->checkout->set_reg_step_JSON_info();
-        return true;
-    }
-
-
-    /**
-     *     _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(
-                    esc_html__('The current step could not be set.', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        } else {
-            if (WP_DEBUG) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s',
-                            'event_espresso'
-                        ),
-                        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(
-                    esc_html__(
-                        'Your Registration and Transaction information could not be retrieved from the db.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                $this->checkout->transaction = EE_Transaction::new_instance();
-                // add some style and make it dance
-                $this->add_styles_and_scripts($this);
-                EED_Single_Page_Checkout::$_initialized = true;
-                return false;
-            }
-            // and the registrations for the transaction
-            $this->_get_registrations($this->checkout->transaction);
-        }
-        return true;
-    }
-
-
-    /**
-     * _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(
-            esc_html__('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(
-                esc_html__('A Valid Transaction could not be initialized.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return $transaction;
-    }
-
-
-    /**
-     *    generates a new EE_Transaction object and adds it to the $_transaction property.
-     *
-     * @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, false);
-        $this->checkout->total_ticket_count = count($registrations);
-        // verify registrations have been set
-        if (empty($registrations)) {
-            // if no cached registrations, then check the db
-            $registrations = $transaction->registrations($this->checkout->reg_cache_where_params, 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->total_ticket_count--;
-                }
-                $this->checkout->set_reg_status_updated($registration->ID(), false);
-            }
-        }
-    }
-
-
-    /**
-     *    adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
-     *
-     * @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(
-                esc_html__(
-                    'We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // if returning to SPCO, then verify that primary registrant is set
-        if (! empty($this->checkout->reg_url_link)) {
-            $valid_registrant = $this->checkout->transaction->primary_registration();
-            if (! $valid_registrant instanceof EE_Registration) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            $valid_registrant = null;
-            foreach ($this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) as $registration) {
-                if ($registration instanceof EE_Registration
-                    && $registration->reg_url_link() === $this->checkout->reg_url_link
-                ) {
-                    $valid_registrant = $registration;
-                }
-            }
-            if (! $valid_registrant instanceof EE_Registration) {
-                // hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
-                if (EED_Single_Page_Checkout::$_checkout_verified) {
-                    // clear the session, mark the checkout as unverified, and try again
-                    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(
-                    esc_html__(
-                        'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        // now that things have been kinda sufficiently verified,
-        // let's add the checkout to the session so that it's available to other systems
-        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
-            $this->add_styles_and_scripts($reg_step);
-            if ($reg_step->is_current_step()) {
-                // the text that appears on the reg step form submit button
-                $reg_step->set_submit_button_text();
-            }
-        }
-        // dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
-        do_action(
-            "AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}",
-            $this->checkout->current_step
-        );
-    }
-
-
-    /**
-     * _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() !== '') {
-                            EE_Error::add_error(
-                                $this->checkout->current_step->reg_form->submission_error_message(),
-                                __FILE__,
-                                __FUNCTION__,
-                                __LINE__
-                            );
-                        }
-                        // well not really... what will happen is
-                        // we'll just get redirected back to redo the current step
-                        $this->go_to_next_step();
-                        return false;
-                    }
-                }
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * _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(
-                            esc_html__(
-                                'The requested form action "%s" does not exist for the current "%s" registration step.',
-                                'event_espresso'
-                            ),
-                            $this->checkout->action,
-                            $this->checkout->current_step->name()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            // end default
-        }
-        // store our progress so far
-        $this->checkout->stash_transaction_and_checkout();
-        // advance to the next step! If you pass GO, collect $200
-        $this->go_to_next_step();
-    }
-
-
-    /**
-     * @param EED_Single_Page_Checkout|EE_SPCO_Reg_Step $target
-     * @param object $target an object with the method `translate_js_strings` and `enqueue_styles_and_scripts`.
-     * @return        void
-     */
-    public function add_styles_and_scripts($target)
-    {
-        // i18n
-        $target->translate_js_strings();
-        if ($this->checkout->admin_request) {
-            add_action('admin_enqueue_scripts', array($target, 'enqueue_styles_and_scripts'), 10);
-        } else {
-            add_action('wp_enqueue_scripts', array($target, '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'] = esc_html__(
-            'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_json_response'] = esc_html__(
-            'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['validation_error'] = esc_html__(
-            'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
-            'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['reg_step_error'] = esc_html__(
-            'This registration step could not be completed. Please refresh the page and try again.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['invalid_coupon'] = esc_html__(
-            'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.',
-            'event_espresso'
-        );
-        EE_Registry::$i18n_js_strings['process_registration'] = sprintf(
-            esc_html__(
-                'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.',
-                'event_espresso'
-            ),
-            '<br/>',
-            '<br/>'
-        );
-        EE_Registry::$i18n_js_strings['language'] = get_bloginfo('language');
-        EE_Registry::$i18n_js_strings['EESID'] = 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'] = esc_html__('years', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_months'] = esc_html__('months', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_weeks'] = esc_html__('weeks', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_days'] = esc_html__('days', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hours'] = esc_html__('hours', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minutes'] = esc_html__('minutes', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_seconds'] = esc_html__('seconds', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_year'] = esc_html__('year', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_month'] = esc_html__('month', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_week'] = esc_html__('week', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_day'] = esc_html__('day', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_hour'] = esc_html__('hour', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_minute'] = esc_html__('minute', 'event_espresso');
-        EE_Registry::$i18n_js_strings['timer_second'] = esc_html__('second', 'event_espresso');
-        EE_Registry::$i18n_js_strings['registration_expiration_notice'] = EED_Single_Page_Checkout::getRegistrationExpirationNotice(
-        );
-        EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters(
-            'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
-            true
-        );
-        EE_Registry::$i18n_js_strings['session_extension'] = absint(
-            apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
-        );
-        EE_Registry::$i18n_js_strings['session_expiration'] = 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.1.0',
-            true
-        );
-        wp_register_script(
-            'single_page_checkout',
-            SPCO_JS_URL . 'single_page_checkout.js',
-            array('espresso_core', 'underscore', 'ee_form_section_validation'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->registration_form->enqueue_js();
-        }
-        if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
-            $this->checkout->current_step->reg_form->enqueue_js();
-        }
-        wp_enqueue_script('single_page_checkout');
-        if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) {
-            wp_enqueue_script('jquery_countdown');
-        }
-        /**
-         * 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) {
-                $cookies_not_set_msg = apply_filters(
-                    'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
-                    sprintf(
-                        esc_html__(
-                            '%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
-                            'event_espresso'
-                        ),
-                        '<div class="ee-attention hidden" id="ee-cookies-not-set-msg">',
-                        '</div>',
-                        '<h6 class="important-notice">',
-                        '</h6>',
-                        '<p>',
-                        '</p>',
-                        '<br />',
-                        '<a href="http://www.whatarecookies.com/enable.asp" target="_blank" rel="noopener noreferrer">',
-                        '</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()
-                                        : '',
-                                    'empty_msg'               => apply_filters(
-                                        'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
-                                        sprintf(
-                                            esc_html__(
-                                                'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
-                                                'event_espresso'
-                                            ),
-                                            '<a href="'
-                                            . get_post_type_archive_link('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) {
-            $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);
-            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>';
-    }
-
-    /**
-     *    getRegistrationExpirationNotice
-     *
-     * @since     4.9.59.p
-     * @access    public
-     * @return    string
-     */
-    public static function getRegistrationExpirationNotice()
-    {
-        return sprintf(
-            esc_html__(
-                '%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please accept our apologies for any inconvenience this may have caused.%8$s',
-                'event_espresso'
-            ),
-            '<h4 class="important-notice">',
-            '</h4>',
-            '<br />',
-            '<p>',
-            '<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
-            '">',
-            '</a>',
-            '</p>'
-        );
-    }
+	/**
+	 * $_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('\\', '/'), '/', plugin_dir_path(__FILE__)), '/') . '/'
+		);
+		define('SPCO_CSS_URL', plugin_dir_url(__FILE__) . 'css/');
+		define('SPCO_IMG_URL', plugin_dir_url(__FILE__) . 'img/');
+		define('SPCO_JS_URL', plugin_dir_url(__FILE__) . 'js/');
+		define('SPCO_INC_PATH', SPCO_BASE_PATH . 'inc/');
+		define('SPCO_REG_STEPS_PATH', SPCO_BASE_PATH . 'reg_steps/');
+		define('SPCO_TEMPLATES_PATH', SPCO_BASE_PATH . 'templates/');
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(SPCO_BASE_PATH, true);
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] = EED_Single_Page_Checkout::getRegistrationExpirationNotice(
+		);
+	}
+
+
+	/**
+	 * load_reg_steps
+	 * loads and instantiates each reg step based on the EE_Registry::instance()->CFG->registration->reg_steps array
+	 *
+	 * @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,
+				),
+				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($this);
+			// kk... SPCO has successfully run
+			EED_Single_Page_Checkout::$_initialized = true;
+			// set no cache headers and constants
+			EE_System::do_not_cache();
+			// add anchor
+			add_action('loop_start', 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(esc_html__('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(esc_html__('The EE_Checkout class could not be loaded.', 'event_espresso'));
+		}
+		// reset anything that needs a clean slate for each request
+		$checkout->reset_for_current_request();
+		return $checkout;
+	}
+
+
+	/**
+	 *    _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', '');
+		// add reg url link to registration query params
+		if ($this->checkout->reg_url_link && strpos($this->checkout->reg_url_link, '1-') !== 0) {
+			$this->checkout->reg_cache_where_params[0]['REG_url_link'] = $this->checkout->reg_url_link;
+		}
+		// or some other kind of revisit ?
+		$this->checkout->revisit = 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';
+	}
+
+
+	/**
+	 * instantiates each reg step based on the loaded reg_steps array
+	 *
+	 * @return    bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	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;
+				}
+			}
+			if (isset($this->checkout->reg_steps['registration_confirmation'])) {
+				// 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);
+				} elseif (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(
+				esc_html__('No Reg Steps were loaded..', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// make reg step details available to JS
+		$this->checkout->set_reg_step_JSON_info();
+		return true;
+	}
+
+
+	/**
+	 *     _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(
+					esc_html__('The current step could not be set.', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		} else {
+			if (WP_DEBUG) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'A registration step could not be loaded. One or more of the following data points is invalid:%4$s%5$sFile Path: %1$s%6$s%5$sClass Name: %2$s%6$s%5$sSlug: %3$s%6$s%7$s',
+							'event_espresso'
+						),
+						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(
+					esc_html__(
+						'Your Registration and Transaction information could not be retrieved from the db.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				$this->checkout->transaction = EE_Transaction::new_instance();
+				// add some style and make it dance
+				$this->add_styles_and_scripts($this);
+				EED_Single_Page_Checkout::$_initialized = true;
+				return false;
+			}
+			// and the registrations for the transaction
+			$this->_get_registrations($this->checkout->transaction);
+		}
+		return true;
+	}
+
+
+	/**
+	 * _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(
+			esc_html__('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(
+				esc_html__('A Valid Transaction could not be initialized.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 *    generates a new EE_Transaction object and adds it to the $_transaction property.
+	 *
+	 * @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, false);
+		$this->checkout->total_ticket_count = count($registrations);
+		// verify registrations have been set
+		if (empty($registrations)) {
+			// if no cached registrations, then check the db
+			$registrations = $transaction->registrations($this->checkout->reg_cache_where_params, 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->total_ticket_count--;
+				}
+				$this->checkout->set_reg_status_updated($registration->ID(), false);
+			}
+		}
+	}
+
+
+	/**
+	 *    adds related EE_Registration objects for each ticket in the cart to the current EE_Transaction object
+	 *
+	 * @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(
+				esc_html__(
+					'We\'re sorry but the registration process can not proceed because one or more registration steps were not setup correctly. Please refresh the page and try again or contact support.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// if returning to SPCO, then verify that primary registrant is set
+		if (! empty($this->checkout->reg_url_link)) {
+			$valid_registrant = $this->checkout->transaction->primary_registration();
+			if (! $valid_registrant instanceof EE_Registration) {
+				EE_Error::add_error(
+					esc_html__(
+						'We\'re sorry but there appears to be an error with the "reg_url_link" or the primary registrant for this transaction. Please refresh the page and try again or contact support.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			$valid_registrant = null;
+			foreach ($this->checkout->transaction->registrations($this->checkout->reg_cache_where_params) as $registration) {
+				if ($registration instanceof EE_Registration
+					&& $registration->reg_url_link() === $this->checkout->reg_url_link
+				) {
+					$valid_registrant = $registration;
+				}
+			}
+			if (! $valid_registrant instanceof EE_Registration) {
+				// hmmm... maybe we have the wrong session because the user is opening multiple tabs ?
+				if (EED_Single_Page_Checkout::$_checkout_verified) {
+					// clear the session, mark the checkout as unverified, and try again
+					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(
+					esc_html__(
+						'We\'re sorry but there appears to be an error with the "reg_url_link" or the transaction itself. Please refresh the page and try again or contact support.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		// now that things have been kinda sufficiently verified,
+		// let's add the checkout to the session so that it's available to other systems
+		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
+			$this->add_styles_and_scripts($reg_step);
+			if ($reg_step->is_current_step()) {
+				// the text that appears on the reg step form submit button
+				$reg_step->set_submit_button_text();
+			}
+		}
+		// dynamically creates hook point like: AHEE__Single_Page_Checkout___initialize_reg_step__attendee_information
+		do_action(
+			"AHEE__Single_Page_Checkout___initialize_reg_step__{$this->checkout->current_step->slug()}",
+			$this->checkout->current_step
+		);
+	}
+
+
+	/**
+	 * _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() !== '') {
+							EE_Error::add_error(
+								$this->checkout->current_step->reg_form->submission_error_message(),
+								__FILE__,
+								__FUNCTION__,
+								__LINE__
+							);
+						}
+						// well not really... what will happen is
+						// we'll just get redirected back to redo the current step
+						$this->go_to_next_step();
+						return false;
+					}
+				}
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * _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(
+							esc_html__(
+								'The requested form action "%s" does not exist for the current "%s" registration step.',
+								'event_espresso'
+							),
+							$this->checkout->action,
+							$this->checkout->current_step->name()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			// end default
+		}
+		// store our progress so far
+		$this->checkout->stash_transaction_and_checkout();
+		// advance to the next step! If you pass GO, collect $200
+		$this->go_to_next_step();
+	}
+
+
+	/**
+	 * @param EED_Single_Page_Checkout|EE_SPCO_Reg_Step $target
+	 * @param object $target an object with the method `translate_js_strings` and `enqueue_styles_and_scripts`.
+	 * @return        void
+	 */
+	public function add_styles_and_scripts($target)
+	{
+		// i18n
+		$target->translate_js_strings();
+		if ($this->checkout->admin_request) {
+			add_action('admin_enqueue_scripts', array($target, 'enqueue_styles_and_scripts'), 10);
+		} else {
+			add_action('wp_enqueue_scripts', array($target, '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'] = esc_html__(
+			'An unknown error occurred on the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_json_response'] = esc_html__(
+			'An invalid response was returned from the server while attempting to process your request. Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['validation_error'] = esc_html__(
+			'There appears to be a problem with the form validation configuration! Please check the admin settings or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_payment_method'] = esc_html__(
+			'There appears to be a problem with the payment method configuration! Please refresh the page and try again or contact support.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['reg_step_error'] = esc_html__(
+			'This registration step could not be completed. Please refresh the page and try again.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['invalid_coupon'] = esc_html__(
+			'We\'re sorry but that coupon code does not appear to be valid. If this is incorrect, please contact the site administrator.',
+			'event_espresso'
+		);
+		EE_Registry::$i18n_js_strings['process_registration'] = sprintf(
+			esc_html__(
+				'Please wait while we process your registration.%sDo not refresh the page or navigate away while this is happening.%sThank you for your patience.',
+				'event_espresso'
+			),
+			'<br/>',
+			'<br/>'
+		);
+		EE_Registry::$i18n_js_strings['language'] = get_bloginfo('language');
+		EE_Registry::$i18n_js_strings['EESID'] = 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'] = esc_html__('years', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_months'] = esc_html__('months', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_weeks'] = esc_html__('weeks', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_days'] = esc_html__('days', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hours'] = esc_html__('hours', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minutes'] = esc_html__('minutes', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_seconds'] = esc_html__('seconds', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_year'] = esc_html__('year', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_month'] = esc_html__('month', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_week'] = esc_html__('week', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_day'] = esc_html__('day', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_hour'] = esc_html__('hour', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_minute'] = esc_html__('minute', 'event_espresso');
+		EE_Registry::$i18n_js_strings['timer_second'] = esc_html__('second', 'event_espresso');
+		EE_Registry::$i18n_js_strings['registration_expiration_notice'] = EED_Single_Page_Checkout::getRegistrationExpirationNotice(
+		);
+		EE_Registry::$i18n_js_strings['ajax_submit'] = apply_filters(
+			'FHEE__Single_Page_Checkout__translate_js_strings__ajax_submit',
+			true
+		);
+		EE_Registry::$i18n_js_strings['session_extension'] = absint(
+			apply_filters('FHEE__EE_Session__extend_expiration__seconds_added', 10 * MINUTE_IN_SECONDS)
+		);
+		EE_Registry::$i18n_js_strings['session_expiration'] = 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.1.0',
+			true
+		);
+		wp_register_script(
+			'single_page_checkout',
+			SPCO_JS_URL . 'single_page_checkout.js',
+			array('espresso_core', 'underscore', 'ee_form_section_validation'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		if ($this->checkout->registration_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->registration_form->enqueue_js();
+		}
+		if ($this->checkout->current_step->reg_form instanceof EE_Form_Section_Proper) {
+			$this->checkout->current_step->reg_form->enqueue_js();
+		}
+		wp_enqueue_script('single_page_checkout');
+		if (apply_filters('FHEE__registration_page_wrapper_template__display_time_limit', false)) {
+			wp_enqueue_script('jquery_countdown');
+		}
+		/**
+		 * 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) {
+				$cookies_not_set_msg = apply_filters(
+					'FHEE__Single_Page_Checkout__display_spco_reg_form__cookies_not_set_msg',
+					sprintf(
+						esc_html__(
+							'%1$s%3$sIt appears your browser is not currently set to accept Cookies%4$s%5$sIn order to register for events, you need to enable cookies.%7$sIf you require assistance, then click the following link to learn how to %8$senable cookies%9$s%6$s%2$s',
+							'event_espresso'
+						),
+						'<div class="ee-attention hidden" id="ee-cookies-not-set-msg">',
+						'</div>',
+						'<h6 class="important-notice">',
+						'</h6>',
+						'<p>',
+						'</p>',
+						'<br />',
+						'<a href="http://www.whatarecookies.com/enable.asp" target="_blank" rel="noopener noreferrer">',
+						'</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()
+										: '',
+									'empty_msg'               => apply_filters(
+										'FHEE__Single_Page_Checkout__display_spco_reg_form__empty_msg',
+										sprintf(
+											esc_html__(
+												'You need to %1$sReturn to Events list%2$sselect at least one event%3$s before you can proceed with the registration process.',
+												'event_espresso'
+											),
+											'<a href="'
+											. get_post_type_archive_link('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) {
+			$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);
+			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>';
+	}
+
+	/**
+	 *    getRegistrationExpirationNotice
+	 *
+	 * @since     4.9.59.p
+	 * @access    public
+	 * @return    string
+	 */
+	public static function getRegistrationExpirationNotice()
+	{
+		return sprintf(
+			esc_html__(
+				'%1$sWe\'re sorry, but your registration time has expired.%2$s%3$s%4$sIf you still wish to complete your registration, please return to the %5$sEvent List%6$sEvent List%7$s and reselect your tickets if available. Please accept our apologies for any inconvenience this may have caused.%8$s',
+				'event_espresso'
+			),
+			'<h4 class="important-notice">',
+			'</h4>',
+			'<br />',
+			'<p>',
+			'<a href="' . get_post_type_archive_link('espresso_events') . '" title="',
+			'">',
+			'</a>',
+			'</p>'
+		);
+	}
 }

modules/ticket_selector/DisplayTicketSelector.php

Indentation +718 added lines, -718 removed lines

@@ -33,725 +33,725 @@
 class DisplayTicketSelector
 {
 
-    /**
-     * event that ticket selector is being generated for
-     *
-     * @access protected
-     * @var EE_Event $event
-     */
-    protected $event;
-
-    /**
-     * Used to flag when the ticket selector is being called from an external iframe.
-     *
-     * @var bool $iframe
-     */
-    protected $iframe = false;
-
-    /**
-     * max attendees that can register for event at one time
-     *
-     * @var int $max_attendees
-     */
-    private $max_attendees = EE_INF;
-
-    /**
-     * @var string $date_format
-     */
-    private $date_format;
-
-    /**
-     * @var string $time_format
-     */
-    private $time_format;
-
-    /**
-     * @var boolean $display_full_ui
-     */
-    private $display_full_ui;
-
-
-    /**
-     * DisplayTicketSelector constructor.
-     *
-     * @param bool $iframe
-     */
-    public function __construct($iframe = false)
-    {
-        $this->iframe = $iframe;
-        $this->date_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
-            get_option('date_format')
-        );
-        $this->time_format = apply_filters(
-            'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
-            get_option('time_format')
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->iframe;
-    }
-
-
-    /**
-     * @param boolean $iframe
-     */
-    public function setIframe($iframe = true)
-    {
-        $this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * finds and sets the \EE_Event object for use throughout class
-     *
-     * @param mixed $event
-     * @return bool
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function setEvent($event = null)
-    {
-        if ($event === null) {
-            global $post;
-            $event = $post;
-        }
-        if ($event instanceof EE_Event) {
-            $this->event = $event;
-        } elseif ($event instanceof WP_Post) {
-            if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
-                $this->event = $event->EE_Event;
-            } elseif ($event->post_type === 'espresso_events') {
-                $event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
-                $this->event = $event->EE_Event;
-            }
-        } else {
-            $user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
-            $dev_msg = $user_msg . __(
-                'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
-                'event_espresso'
-            );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function getMaxAttendees()
-    {
-        return $this->max_attendees;
-    }
-
-
-    /**
-     * @param int $max_attendees
-     */
-    public function setMaxAttendees($max_attendees)
-    {
-        $this->max_attendees = absint(
-            apply_filters(
-                'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
-                $max_attendees
-            )
-        );
-    }
-
-
-    /**
-     * Returns whether or not the full ticket selector should be shown or not.
-     * Currently, it displays on the frontend (including ajax requests) but not the backend
-     *
-     * @return bool
-     */
-    private function display_full_ui()
-    {
-        if ($this->display_full_ui === null) {
-            $this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
-        }
-        return $this->display_full_ui;
-    }
-
-
-    /**
-     * creates buttons for selecting number of attendees for an event
-     *
-     * @param WP_Post|int $event
-     * @param bool        $view_details
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function display($event = null, $view_details = false)
-    {
-        // reset filter for displaying submit button
-        remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        // poke and prod incoming event till it tells us what it is
-        if (! $this->setEvent($event)) {
-            return false;
-        }
-        // begin gathering template arguments by getting event status
-        $template_args = array('event_status' => $this->event->get_active_status());
-        if ($this->activeEventAndShowTicketSelector(
-            $event,
-            $template_args['event_status'],
-            $view_details
-        )) {
-            return ! is_single() ? $this->displayViewDetailsButton() : '';
-        }
-        // filter the maximum qty that can appear in the Ticket Selector qty dropdowns
-        $this->setMaxAttendees($this->event->additional_limit());
-        if ($this->getMaxAttendees() < 1) {
-            return $this->ticketSalesClosedMessage();
-        }
-        // is the event expired ?
-        $template_args['event_is_expired'] = ! is_admin() ? $this->event->is_expired() : false;
-        if ($template_args['event_is_expired']) {
-            return $this->expiredEventMessage();
-        }
-        // get all tickets for this event ordered by the datetime
-        $tickets = $this->getTickets();
-        if (count($tickets) < 1) {
-            return $this->noTicketAvailableMessage();
-        }
-        // redirecting to another site for registration ??
-        $external_url = (string) $this->event->external_url()
-            && $this->event->external_url() !== get_the_permalink()
-            ? $this->event->external_url()
-            : '';
-        // if redirecting to another site for registration, then we don't load the TS
-        $ticket_selector = $external_url
-            ? $this->externalEventRegistration()
-            : $this->loadTicketSelector($tickets, $template_args);
-        // now set up the form (but not for the admin)
-        $ticket_selector = $this->display_full_ui()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
-            : $ticket_selector;
-        // submit button and form close tag
-        $ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
-        return $ticket_selector;
-    }
-
-
-    /**
-     * displayTicketSelector
-     * examines the event properties and determines whether a Ticket Selector should be displayed
-     *
-     * @param WP_Post|int $event
-     * @param string      $_event_active_status
-     * @param bool        $view_details
-     * @return bool
-     * @throws EE_Error
-     */
-    protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
-    {
-        $event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
-        return $this->display_full_ui()
-               && (
-                   ! $this->event->display_ticket_selector()
-                   || $view_details
-                   || post_password_required($event_post)
-                   || (
-                       $_event_active_status !== EE_Datetime::active
-                       && $_event_active_status !== EE_Datetime::upcoming
-                       && $_event_active_status !== EE_Datetime::sold_out
-                       && ! (
-                           $_event_active_status === EE_Datetime::inactive
-                           && is_user_logged_in()
-                       )
-                   )
-               );
-    }
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event is expired
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function expiredEventMessage()
-    {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
-            'We\'re sorry, but all tickets sales have ended because the event is expired.',
-            'event_espresso'
-        ) . '</span></div><!-- .ee-event-expired-notice -->';
-    }
-
-
-    /**
-     * noTicketAvailableMessage
-     * notice displayed if event has no more tickets available
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function noTicketAvailableMessage()
-    {
-        $no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $no_ticket_available_msg .= sprintf(
-                esc_html__(
-                    '%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'
-                . get_edit_post_link($this->event->ID())
-                . '">',
-                '</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
-            );
-        }
-        return '
+	/**
+	 * event that ticket selector is being generated for
+	 *
+	 * @access protected
+	 * @var EE_Event $event
+	 */
+	protected $event;
+
+	/**
+	 * Used to flag when the ticket selector is being called from an external iframe.
+	 *
+	 * @var bool $iframe
+	 */
+	protected $iframe = false;
+
+	/**
+	 * max attendees that can register for event at one time
+	 *
+	 * @var int $max_attendees
+	 */
+	private $max_attendees = EE_INF;
+
+	/**
+	 * @var string $date_format
+	 */
+	private $date_format;
+
+	/**
+	 * @var string $time_format
+	 */
+	private $time_format;
+
+	/**
+	 * @var boolean $display_full_ui
+	 */
+	private $display_full_ui;
+
+
+	/**
+	 * DisplayTicketSelector constructor.
+	 *
+	 * @param bool $iframe
+	 */
+	public function __construct($iframe = false)
+	{
+		$this->iframe = $iframe;
+		$this->date_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__date_format',
+			get_option('date_format')
+		);
+		$this->time_format = apply_filters(
+			'FHEE__EED_Ticket_Selector__display_ticket_selector__time_format',
+			get_option('time_format')
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->iframe;
+	}
+
+
+	/**
+	 * @param boolean $iframe
+	 */
+	public function setIframe($iframe = true)
+	{
+		$this->iframe = filter_var($iframe, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * finds and sets the \EE_Event object for use throughout class
+	 *
+	 * @param mixed $event
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function setEvent($event = null)
+	{
+		if ($event === null) {
+			global $post;
+			$event = $post;
+		}
+		if ($event instanceof EE_Event) {
+			$this->event = $event;
+		} elseif ($event instanceof WP_Post) {
+			if (isset($event->EE_Event) && $event->EE_Event instanceof EE_Event) {
+				$this->event = $event->EE_Event;
+			} elseif ($event->post_type === 'espresso_events') {
+				$event->EE_Event = EEM_Event::instance()->instantiate_class_from_post_object($event);
+				$this->event = $event->EE_Event;
+			}
+		} else {
+			$user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
+			$dev_msg = $user_msg . __(
+				'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
+				'event_espresso'
+			);
+			EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function getMaxAttendees()
+	{
+		return $this->max_attendees;
+	}
+
+
+	/**
+	 * @param int $max_attendees
+	 */
+	public function setMaxAttendees($max_attendees)
+	{
+		$this->max_attendees = absint(
+			apply_filters(
+				'FHEE__EE_Ticket_Selector__display_ticket_selector__max_tickets',
+				$max_attendees
+			)
+		);
+	}
+
+
+	/**
+	 * Returns whether or not the full ticket selector should be shown or not.
+	 * Currently, it displays on the frontend (including ajax requests) but not the backend
+	 *
+	 * @return bool
+	 */
+	private function display_full_ui()
+	{
+		if ($this->display_full_ui === null) {
+			$this->display_full_ui = ! is_admin() || (defined('DOING_AJAX') && DOING_AJAX);
+		}
+		return $this->display_full_ui;
+	}
+
+
+	/**
+	 * creates buttons for selecting number of attendees for an event
+	 *
+	 * @param WP_Post|int $event
+	 * @param bool        $view_details
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function display($event = null, $view_details = false)
+	{
+		// reset filter for displaying submit button
+		remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		// poke and prod incoming event till it tells us what it is
+		if (! $this->setEvent($event)) {
+			return false;
+		}
+		// begin gathering template arguments by getting event status
+		$template_args = array('event_status' => $this->event->get_active_status());
+		if ($this->activeEventAndShowTicketSelector(
+			$event,
+			$template_args['event_status'],
+			$view_details
+		)) {
+			return ! is_single() ? $this->displayViewDetailsButton() : '';
+		}
+		// filter the maximum qty that can appear in the Ticket Selector qty dropdowns
+		$this->setMaxAttendees($this->event->additional_limit());
+		if ($this->getMaxAttendees() < 1) {
+			return $this->ticketSalesClosedMessage();
+		}
+		// is the event expired ?
+		$template_args['event_is_expired'] = ! is_admin() ? $this->event->is_expired() : false;
+		if ($template_args['event_is_expired']) {
+			return $this->expiredEventMessage();
+		}
+		// get all tickets for this event ordered by the datetime
+		$tickets = $this->getTickets();
+		if (count($tickets) < 1) {
+			return $this->noTicketAvailableMessage();
+		}
+		// redirecting to another site for registration ??
+		$external_url = (string) $this->event->external_url()
+			&& $this->event->external_url() !== get_the_permalink()
+			? $this->event->external_url()
+			: '';
+		// if redirecting to another site for registration, then we don't load the TS
+		$ticket_selector = $external_url
+			? $this->externalEventRegistration()
+			: $this->loadTicketSelector($tickets, $template_args);
+		// now set up the form (but not for the admin)
+		$ticket_selector = $this->display_full_ui()
+			? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+			: $ticket_selector;
+		// submit button and form close tag
+		$ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
+		return $ticket_selector;
+	}
+
+
+	/**
+	 * displayTicketSelector
+	 * examines the event properties and determines whether a Ticket Selector should be displayed
+	 *
+	 * @param WP_Post|int $event
+	 * @param string      $_event_active_status
+	 * @param bool        $view_details
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	protected function activeEventAndShowTicketSelector($event, $_event_active_status, $view_details)
+	{
+		$event_post = $this->event instanceof EE_Event ? $this->event->ID() : $event;
+		return $this->display_full_ui()
+			   && (
+				   ! $this->event->display_ticket_selector()
+				   || $view_details
+				   || post_password_required($event_post)
+				   || (
+					   $_event_active_status !== EE_Datetime::active
+					   && $_event_active_status !== EE_Datetime::upcoming
+					   && $_event_active_status !== EE_Datetime::sold_out
+					   && ! (
+						   $_event_active_status === EE_Datetime::inactive
+						   && is_user_logged_in()
+					   )
+				   )
+			   );
+	}
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event is expired
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function expiredEventMessage()
+	{
+		return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
+			'We\'re sorry, but all tickets sales have ended because the event is expired.',
+			'event_espresso'
+		) . '</span></div><!-- .ee-event-expired-notice -->';
+	}
+
+
+	/**
+	 * noTicketAvailableMessage
+	 * notice displayed if event has no more tickets available
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function noTicketAvailableMessage()
+	{
+		$no_ticket_available_msg = esc_html__('We\'re sorry, but all ticket sales have ended.', 'event_espresso');
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$no_ticket_available_msg .= sprintf(
+				esc_html__(
+					'%1$sNote to Event Admin:%2$sNo tickets were found for this event. This effectively turns off ticket sales. Please ensure that at least one ticket is available for if you want people to be able to register.%3$s(click to edit this event)%4$s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'
+				. get_edit_post_link($this->event->ID())
+				. '">',
+				'</a></span></div><!-- .ee-attention noTicketAvailableMessage -->'
+			);
+		}
+		return '
             <div class="ee-event-expired-notice">
                 <span class="important-notice">' . $no_ticket_available_msg . '</span>
             </div><!-- .ee-event-expired-notice -->';
-    }
-
-
-    /**
-     * ticketSalesClosed
-     * notice displayed if event ticket sales are turned off
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    protected function ticketSalesClosedMessage()
-    {
-        $sales_closed_msg = esc_html__(
-            'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
-            'event_espresso'
-        );
-        if (current_user_can('edit_post', $this->event->ID())) {
-            $sales_closed_msg .= sprintf(
-                esc_html__(
-                    '%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
-                    'event_espresso'
-                ),
-                '<div class="ee-attention" style="text-align: left;"><b>',
-                '</b><br />',
-                '<span class="edit-link"><a class="post-edit-link" href="'
-                . get_edit_post_link($this->event->ID())
-                . '">',
-                '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
-            );
-        }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
-    }
-
-
-    /**
-     * getTickets
-     *
-     * @return \EE_Base_Class[]|\EE_Ticket[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function getTickets()
-    {
-        $show_expired_tickets = is_admin() || (
-            EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
-            && EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
-        );
-
-        $ticket_query_args = array(
-            array('Datetime.EVT_ID' => $this->event->ID()),
-            'order_by' => array(
-                'TKT_order'              => 'ASC',
-                'TKT_required'           => 'DESC',
-                'TKT_start_date'         => 'ASC',
-                'TKT_end_date'           => 'ASC',
-                'Datetime.DTT_EVT_start' => 'DESC',
-            ),
-        );
-        if (! $show_expired_tickets) {
-            // use the correct applicable time query depending on what version of core is being run.
-            $current_time = method_exists('EEM_Datetime', 'current_time_for_query')
-                ? time()
-                : current_time('timestamp');
-            $ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
-        }
-        return EEM_Ticket::instance()->get_all($ticket_query_args);
-    }
-
-
-    /**
-     * loadTicketSelector
-     * begins to assemble template arguments
-     * and decides whether to load a "simple" ticket selector, or the standard
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array        $template_args
-     * @return string
-     * @throws EE_Error
-     */
-    protected function loadTicketSelector(array $tickets, array $template_args)
-    {
-        $template_args['event'] = $this->event;
-        $template_args['EVT_ID'] = $this->event->ID();
-        $template_args['event_is_expired'] = $this->event->is_expired();
-        $template_args['max_atndz'] = $this->getMaxAttendees();
-        $template_args['date_format'] = $this->date_format;
-        $template_args['time_format'] = $this->time_format;
-        /**
-         * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
-         *
-         * @since 4.9.13
-         * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
-         * @param int $EVT_ID The Event ID
-         */
-        $template_args['anchor_id'] = apply_filters(
-            'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
-            $this->event->ID()
-        );
-        $template_args['tickets'] = $tickets;
-        $template_args['ticket_count'] = count($tickets);
-        $ticket_selector = $this->simpleTicketSelector($tickets, $template_args);
-        return $ticket_selector instanceof TicketSelectorSimple
-            ? $ticket_selector
-            : new TicketSelectorStandard(
-                $this->event,
-                $tickets,
-                $this->getMaxAttendees(),
-                $template_args,
-                $this->date_format,
-                $this->time_format
-            );
-    }
-
-
-    /**
-     * simpleTicketSelector
-     * there's one ticket, and max attendees is set to one,
-     * so if the event is free, then this is a "simple" ticket selector
-     * a.k.a. "Dude Where's my Ticket Selector?"
-     *
-     * @param \EE_Ticket[] $tickets
-     * @param array        $template_args
-     * @return string
-     * @throws EE_Error
-     */
-    protected function simpleTicketSelector($tickets, array $template_args)
-    {
-        // if there is only ONE ticket with a max qty of ONE
-        if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
-            return '';
-        }
-        /** @var \EE_Ticket $ticket */
-        $ticket = reset($tickets);
-        // if the ticket is free... then not much need for the ticket selector
-        if (apply_filters(
-            'FHEE__ticket_selector_chart_template__hide_ticket_selector',
-            $ticket->is_free(),
-            $this->event->ID()
-        )) {
-            return new TicketSelectorSimple(
-                $this->event,
-                $ticket,
-                $this->getMaxAttendees(),
-                $template_args
-            );
-        }
-        return '';
-    }
-
-
-    /**
-     * externalEventRegistration
-     *
-     * @return string
-     */
-    public function externalEventRegistration()
-    {
-        // if not we still need to trigger the display of the submit button
-        add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
-        // display notice to admin that registration is external
-        return $this->display_full_ui()
-            ? esc_html__(
-                'Registration is at an external URL for this event.',
-                'event_espresso'
-            )
-            : '';
-    }
-
-
-    /**
-     * formOpen
-     *
-     * @param        int    $ID
-     * @param        string $external_url
-     * @return        string
-     */
-    public function formOpen($ID = 0, $external_url = '')
-    {
-        // if redirecting, we don't need any anything else
-        if ($external_url) {
-            $html = '<form method="GET" ';
-            $html .= 'action="' . EEH_URL::refactor_url($external_url) . '" ';
-            $html .= 'name="ticket-selector-form-' . $ID . '"';
-            // open link in new window ?
-            $html .= apply_filters(
-                'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
-                $this->isIframe(),
-                $this
-            )
-                ? ' target="_blank"'
-                : '';
-            $html .= '>';
-            $query_args = EEH_URL::get_query_string($external_url);
-            foreach ((array) $query_args as $query_arg => $value) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
-            }
-            return $html;
-        }
-        // if there is no submit button, then don't start building a form
-        // because the "View Details" button will build its own form
-        if (! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-            return '';
-        }
-        $checkout_url = EEH_Event_View::event_link_url($ID);
-        if (! $checkout_url) {
-            EE_Error::add_error(
-                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        // set no cache headers and constants
-        EE_System::do_not_cache();
-        $html = '<form method="POST" ';
-        $html .= 'action="' . $checkout_url . '" ';
-        $html .= 'name="ticket-selector-form-' . $ID . '"';
-        $html .= $this->iframe ? ' target="_blank"' : '';
-        $html .= '>';
-        $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
-        $html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
-        return $html;
-    }
-
-
-    /**
-     * displaySubmitButton
-     *
-     * @param  string $external_url
-     * @return string
-     * @throws EE_Error
-     */
-    public function displaySubmitButton($external_url = '')
-    {
-        $html = '';
-        if ($this->display_full_ui()) {
-            // standard TS displayed with submit button, ie: "Register Now"
-            if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
-                $html .= $this->displayRegisterNowButton();
-                $html .= empty($external_url)
-                    ? $this->ticketSelectorEndDiv()
-                    : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
-            } elseif ($this->getMaxAttendees() === 1) {
-                // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
-                if ($this->event->is_sold_out()) {
-                    // then instead of a View Details or Submit button, just display a "Sold Out" message
-                    $html .= apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
-                        sprintf(
-                            __(
-                                '%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
-                                'event_espresso'
-                            ),
-                            '<p class="no-ticket-selector-msg clear-float">',
-                            $this->event->name(),
-                            '</p>',
-                            '<br />'
-                        ),
-                        $this->event
-                    );
-                    if (apply_filters(
-                        'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                        false,
-                        $this->event
-                    )) {
-                        $html .= $this->displayRegisterNowButton();
-                    }
-                    // sold out DWMTS event, no TS, no submit or view details button, but has additional content
-                    $html .= $this->ticketSelectorEndDiv();
-                } elseif (apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
-                          && ! is_single()
-                ) {
-                    // this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
-                    // but no tickets are available, so display event's "View Details" button.
-                    // it is being viewed via somewhere other than a single post
-                    $html .= $this->displayViewDetailsButton(true);
-                } else {
-                    $html .= $this->ticketSelectorEndDiv();
-                }
-            } elseif (is_archive()) {
-                // event list, no tickets available so display event's "View Details" button
-                $html .= $this->ticketSelectorEndDiv();
-                $html .= $this->displayViewDetailsButton();
-            } else {
-                if (apply_filters(
-                    'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
-                    false,
-                    $this->event
-                )) {
-                    $html .= $this->displayRegisterNowButton();
-                }
-                // no submit or view details button, and no additional content
-                $html .= $this->ticketSelectorEndDiv();
-            }
-            if (! $this->iframe && ! is_archive()) {
-                $html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
-            $html,
-            $this->event,
-            $this
-        );
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function displayRegisterNowButton()
-    {
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
-            __('Register Now', 'event_espresso'),
-            $this->event
-        );
-        $external_url = (string) $this->event->external_url()
-            && $this->event->external_url() !== get_the_permalink()
-            ? $this->event->external_url()
-            : '';
-        $html = EEH_HTML::div(
-            '',
-            'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap',
-            'ticket-selector-submit-btn-wrap'
-        );
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
-        $html .= ' class="ticket-selector-submit-btn ';
-        $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
-        $html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
-        $html .= apply_filters(
-            'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
-            '',
-            $this->event,
-            $this->iframe
-        );
-        return $html;
-    }
-
-
-    /**
-     * displayViewDetailsButton
-     *
-     * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
-     *                    (ie: $_max_atndz === 1) where there are no available tickets,
-     *                    either because they are sold out, expired, or not yet on sale.
-     *                    In this case, we need to close the form BEFORE adding any closing divs
-     * @return string
-     * @throws EE_Error
-     */
-    public function displayViewDetailsButton($DWMTS = false)
-    {
-        if (! $this->event->get_permalink()) {
-            EE_Error::add_error(
-                esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $view_details_btn = '<form method="POST" action="';
-        $view_details_btn .= apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
-            $this->event->get_permalink(),
-            $this->event
-        );
-        $view_details_btn .= '"';
-        // open link in new window ?
-        $view_details_btn .= apply_filters(
-            'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
-            $this->isIframe(),
-            $this
-        )
-            ? ' target="_blank"'
-            : '';
-        $view_details_btn .= '>';
-        $btn_text = apply_filters(
-            'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
-            esc_html__('View Details', 'event_espresso'),
-            $this->event
-        );
-        $view_details_btn .= '<input id="ticket-selector-submit-'
-                             . $this->event->ID()
-                             . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
-                             . $btn_text
-                             . '" />';
-        $view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
-        if ($DWMTS) {
-            $view_details_btn .= $this->formClose();
-            $view_details_btn .= $this->ticketSelectorEndDiv();
-            $view_details_btn .= '<br/>';
-        } else {
-            $view_details_btn .= $this->clearTicketSelector();
-            $view_details_btn .= '<br/>';
-            $view_details_btn .= $this->formClose();
-        }
-        return $view_details_btn;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ticketSelectorEndDiv()
-    {
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function clearTicketSelector()
-    {
-        // standard TS displayed, appears after a "Register Now" or "view Details" button
-        return '<div class="clear"></div><!-- clearTicketSelector -->';
-    }
-
-
-    /**
-     * @access        public
-     * @return        string
-     */
-    public function formClose()
-    {
-        return '</form>';
-    }
+	}
+
+
+	/**
+	 * ticketSalesClosed
+	 * notice displayed if event ticket sales are turned off
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function ticketSalesClosedMessage()
+	{
+		$sales_closed_msg = esc_html__(
+			'We\'re sorry, but ticket sales have been closed at this time. Please check back again later.',
+			'event_espresso'
+		);
+		if (current_user_can('edit_post', $this->event->ID())) {
+			$sales_closed_msg .= sprintf(
+				esc_html__(
+					'%sNote to Event Admin:%sThe "Maximum number of tickets allowed per order for this event" in the Event Registration Options has been set to "0". This effectively turns off ticket sales. %s(click to edit this event)%s',
+					'event_espresso'
+				),
+				'<div class="ee-attention" style="text-align: left;"><b>',
+				'</b><br />',
+				'<span class="edit-link"><a class="post-edit-link" href="'
+				. get_edit_post_link($this->event->ID())
+				. '">',
+				'</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
+			);
+		}
+		return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+	}
+
+
+	/**
+	 * getTickets
+	 *
+	 * @return \EE_Base_Class[]|\EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function getTickets()
+	{
+		$show_expired_tickets = is_admin() || (
+			EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
+			&& EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector->show_expired_tickets
+		);
+
+		$ticket_query_args = array(
+			array('Datetime.EVT_ID' => $this->event->ID()),
+			'order_by' => array(
+				'TKT_order'              => 'ASC',
+				'TKT_required'           => 'DESC',
+				'TKT_start_date'         => 'ASC',
+				'TKT_end_date'           => 'ASC',
+				'Datetime.DTT_EVT_start' => 'DESC',
+			),
+		);
+		if (! $show_expired_tickets) {
+			// use the correct applicable time query depending on what version of core is being run.
+			$current_time = method_exists('EEM_Datetime', 'current_time_for_query')
+				? time()
+				: current_time('timestamp');
+			$ticket_query_args[0]['TKT_end_date'] = array('>', $current_time);
+		}
+		return EEM_Ticket::instance()->get_all($ticket_query_args);
+	}
+
+
+	/**
+	 * loadTicketSelector
+	 * begins to assemble template arguments
+	 * and decides whether to load a "simple" ticket selector, or the standard
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array        $template_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function loadTicketSelector(array $tickets, array $template_args)
+	{
+		$template_args['event'] = $this->event;
+		$template_args['EVT_ID'] = $this->event->ID();
+		$template_args['event_is_expired'] = $this->event->is_expired();
+		$template_args['max_atndz'] = $this->getMaxAttendees();
+		$template_args['date_format'] = $this->date_format;
+		$template_args['time_format'] = $this->time_format;
+		/**
+		 * Filters the anchor ID used when redirecting to the Ticket Selector if no quantity selected
+		 *
+		 * @since 4.9.13
+		 * @param     string  '#tkt-slctr-tbl-' . $EVT_ID The html ID to anchor to
+		 * @param int $EVT_ID The Event ID
+		 */
+		$template_args['anchor_id'] = apply_filters(
+			'FHEE__EE_Ticket_Selector__redirect_anchor_id',
+			'#tkt-slctr-tbl-' . $this->event->ID(),
+			$this->event->ID()
+		);
+		$template_args['tickets'] = $tickets;
+		$template_args['ticket_count'] = count($tickets);
+		$ticket_selector = $this->simpleTicketSelector($tickets, $template_args);
+		return $ticket_selector instanceof TicketSelectorSimple
+			? $ticket_selector
+			: new TicketSelectorStandard(
+				$this->event,
+				$tickets,
+				$this->getMaxAttendees(),
+				$template_args,
+				$this->date_format,
+				$this->time_format
+			);
+	}
+
+
+	/**
+	 * simpleTicketSelector
+	 * there's one ticket, and max attendees is set to one,
+	 * so if the event is free, then this is a "simple" ticket selector
+	 * a.k.a. "Dude Where's my Ticket Selector?"
+	 *
+	 * @param \EE_Ticket[] $tickets
+	 * @param array        $template_args
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function simpleTicketSelector($tickets, array $template_args)
+	{
+		// if there is only ONE ticket with a max qty of ONE
+		if (count($tickets) > 1 || $this->getMaxAttendees() !== 1) {
+			return '';
+		}
+		/** @var \EE_Ticket $ticket */
+		$ticket = reset($tickets);
+		// if the ticket is free... then not much need for the ticket selector
+		if (apply_filters(
+			'FHEE__ticket_selector_chart_template__hide_ticket_selector',
+			$ticket->is_free(),
+			$this->event->ID()
+		)) {
+			return new TicketSelectorSimple(
+				$this->event,
+				$ticket,
+				$this->getMaxAttendees(),
+				$template_args
+			);
+		}
+		return '';
+	}
+
+
+	/**
+	 * externalEventRegistration
+	 *
+	 * @return string
+	 */
+	public function externalEventRegistration()
+	{
+		// if not we still need to trigger the display of the submit button
+		add_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
+		// display notice to admin that registration is external
+		return $this->display_full_ui()
+			? esc_html__(
+				'Registration is at an external URL for this event.',
+				'event_espresso'
+			)
+			: '';
+	}
+
+
+	/**
+	 * formOpen
+	 *
+	 * @param        int    $ID
+	 * @param        string $external_url
+	 * @return        string
+	 */
+	public function formOpen($ID = 0, $external_url = '')
+	{
+		// if redirecting, we don't need any anything else
+		if ($external_url) {
+			$html = '<form method="GET" ';
+			$html .= 'action="' . EEH_URL::refactor_url($external_url) . '" ';
+			$html .= 'name="ticket-selector-form-' . $ID . '"';
+			// open link in new window ?
+			$html .= apply_filters(
+				'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
+				$this->isIframe(),
+				$this
+			)
+				? ' target="_blank"'
+				: '';
+			$html .= '>';
+			$query_args = EEH_URL::get_query_string($external_url);
+			foreach ((array) $query_args as $query_arg => $value) {
+				$html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+			}
+			return $html;
+		}
+		// if there is no submit button, then don't start building a form
+		// because the "View Details" button will build its own form
+		if (! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+			return '';
+		}
+		$checkout_url = EEH_Event_View::event_link_url($ID);
+		if (! $checkout_url) {
+			EE_Error::add_error(
+				esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		// set no cache headers and constants
+		EE_System::do_not_cache();
+		$html = '<form method="POST" ';
+		$html .= 'action="' . $checkout_url . '" ';
+		$html .= 'name="ticket-selector-form-' . $ID . '"';
+		$html .= $this->iframe ? ' target="_blank"' : '';
+		$html .= '>';
+		$html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
+		$html = apply_filters('FHEE__EE_Ticket_Selector__ticket_selector_form_open__html', $html, $this->event);
+		return $html;
+	}
+
+
+	/**
+	 * displaySubmitButton
+	 *
+	 * @param  string $external_url
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displaySubmitButton($external_url = '')
+	{
+		$html = '';
+		if ($this->display_full_ui()) {
+			// standard TS displayed with submit button, ie: "Register Now"
+			if (apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+				$html .= $this->displayRegisterNowButton();
+				$html .= empty($external_url)
+					? $this->ticketSelectorEndDiv()
+					: $this->clearTicketSelector();
+				$html .= '<br/>' . $this->formClose();
+			} elseif ($this->getMaxAttendees() === 1) {
+				// its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
+				if ($this->event->is_sold_out()) {
+					// then instead of a View Details or Submit button, just display a "Sold Out" message
+					$html .= apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__sold_out_msg',
+						sprintf(
+							__(
+								'%1$s"%2$s" is currently sold out.%4$sPlease check back again later, as spots may become available.%3$s',
+								'event_espresso'
+							),
+							'<p class="no-ticket-selector-msg clear-float">',
+							$this->event->name(),
+							'</p>',
+							'<br />'
+						),
+						$this->event
+					);
+					if (apply_filters(
+						'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+						false,
+						$this->event
+					)) {
+						$html .= $this->displayRegisterNowButton();
+					}
+					// sold out DWMTS event, no TS, no submit or view details button, but has additional content
+					$html .= $this->ticketSelectorEndDiv();
+				} elseif (apply_filters('FHEE__EE_Ticket_Selector__hide_ticket_selector', false)
+						  && ! is_single()
+				) {
+					// this is a "Dude Where's my Ticket Selector?" (DWMTS) type event,
+					// but no tickets are available, so display event's "View Details" button.
+					// it is being viewed via somewhere other than a single post
+					$html .= $this->displayViewDetailsButton(true);
+				} else {
+					$html .= $this->ticketSelectorEndDiv();
+				}
+			} elseif (is_archive()) {
+				// event list, no tickets available so display event's "View Details" button
+				$html .= $this->ticketSelectorEndDiv();
+				$html .= $this->displayViewDetailsButton();
+			} else {
+				if (apply_filters(
+					'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__no_tickets_but_display_register_now_button',
+					false,
+					$this->event
+				)) {
+					$html .= $this->displayRegisterNowButton();
+				}
+				// no submit or view details button, and no additional content
+				$html .= $this->ticketSelectorEndDiv();
+			}
+			if (! $this->iframe && ! is_archive()) {
+				$html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displaySubmitButton__html',
+			$html,
+			$this->event,
+			$this
+		);
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displayRegisterNowButton()
+	{
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_ticket_selector_submit__btn_text',
+			__('Register Now', 'event_espresso'),
+			$this->event
+		);
+		$external_url = (string) $this->event->external_url()
+			&& $this->event->external_url() !== get_the_permalink()
+			? $this->event->external_url()
+			: '';
+		$html = EEH_HTML::div(
+			'',
+			'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap',
+			'ticket-selector-submit-btn-wrap'
+		);
+		$html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+		$html .= ' class="ticket-selector-submit-btn ';
+		$html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
+		$html .= ' type="submit" value="' . $btn_text . '" />';
+		$html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
+		$html .= apply_filters(
+			'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
+			'',
+			$this->event,
+			$this->iframe
+		);
+		return $html;
+	}
+
+
+	/**
+	 * displayViewDetailsButton
+	 *
+	 * @param bool $DWMTS indicates a "Dude Where's my Ticket Selector?" (DWMTS) type event
+	 *                    (ie: $_max_atndz === 1) where there are no available tickets,
+	 *                    either because they are sold out, expired, or not yet on sale.
+	 *                    In this case, we need to close the form BEFORE adding any closing divs
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function displayViewDetailsButton($DWMTS = false)
+	{
+		if (! $this->event->get_permalink()) {
+			EE_Error::add_error(
+				esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$view_details_btn = '<form method="POST" action="';
+		$view_details_btn .= apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_url',
+			$this->event->get_permalink(),
+			$this->event
+		);
+		$view_details_btn .= '"';
+		// open link in new window ?
+		$view_details_btn .= apply_filters(
+			'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__displayViewDetailsButton__url_target_blank',
+			$this->isIframe(),
+			$this
+		)
+			? ' target="_blank"'
+			: '';
+		$view_details_btn .= '>';
+		$btn_text = apply_filters(
+			'FHEE__EE_Ticket_Selector__display_view_details_btn__btn_text',
+			esc_html__('View Details', 'event_espresso'),
+			$this->event
+		);
+		$view_details_btn .= '<input id="ticket-selector-submit-'
+							 . $this->event->ID()
+							 . '-btn" class="ticket-selector-submit-btn view-details-btn" type="submit" value="'
+							 . $btn_text
+							 . '" />';
+		$view_details_btn .= apply_filters('FHEE__EE_Ticket_Selector__after_view_details_btn', '', $this->event);
+		if ($DWMTS) {
+			$view_details_btn .= $this->formClose();
+			$view_details_btn .= $this->ticketSelectorEndDiv();
+			$view_details_btn .= '<br/>';
+		} else {
+			$view_details_btn .= $this->clearTicketSelector();
+			$view_details_btn .= '<br/>';
+			$view_details_btn .= $this->formClose();
+		}
+		return $view_details_btn;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ticketSelectorEndDiv()
+	{
+		return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function clearTicketSelector()
+	{
+		// standard TS displayed, appears after a "Register Now" or "view Details" button
+		return '<div class="clear"></div><!-- clearTicketSelector -->';
+	}
+
+
+	/**
+	 * @access        public
+	 * @return        string
+	 */
+	public function formClose()
+	{
+		return '</form>';
+	}
 }

Spacing +25 added lines, -25 removed lines

@@ -135,11 +135,11 @@ 
             }
         } else {
             $user_msg = __('No Event object or an invalid Event object was supplied.', 'event_espresso');
-            $dev_msg = $user_msg . __(
+            $dev_msg = $user_msg.__(
                 'In order to generate a ticket selector, please ensure you are passing either an EE_Event object or a WP_Post object of the post type "espresso_event" to the EE_Ticket_Selector class constructor.',
                 'event_espresso'
             );
-            EE_Error::add_error($user_msg . '||' . $dev_msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($user_msg.'||'.$dev_msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         return true;
@@ -200,7 +200,7 @@ 
         // reset filter for displaying submit button
         remove_filter('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', '__return_true');
         // poke and prod incoming event till it tells us what it is
-        if (! $this->setEvent($event)) {
+        if ( ! $this->setEvent($event)) {
             return false;
         }
         // begin gathering template arguments by getting event status
@@ -238,7 +238,7 @@ 
             : $this->loadTicketSelector($tickets, $template_args);
         // now set up the form (but not for the admin)
         $ticket_selector = $this->display_full_ui()
-            ? $this->formOpen($this->event->ID(), $external_url) . $ticket_selector
+            ? $this->formOpen($this->event->ID(), $external_url).$ticket_selector
             : $ticket_selector;
         // submit button and form close tag
         $ticket_selector .= $this->display_full_ui() ? $this->displaySubmitButton($external_url) : '';
@@ -286,10 +286,10 @@ 
      */
     protected function expiredEventMessage()
     {
-        return '<div class="ee-event-expired-notice"><span class="important-notice">' . esc_html__(
+        return '<div class="ee-event-expired-notice"><span class="important-notice">'.esc_html__(
             'We\'re sorry, but all tickets sales have ended because the event is expired.',
             'event_espresso'
-        ) . '</span></div><!-- .ee-event-expired-notice -->';
+        ).'</span></div><!-- .ee-event-expired-notice -->';
     }
 
 
@@ -319,7 +319,7 @@ 
         }
         return '
             <div class="ee-event-expired-notice">
-                <span class="important-notice">' . $no_ticket_available_msg . '</span>
+                <span class="important-notice">' . $no_ticket_available_msg.'</span>
             </div><!-- .ee-event-expired-notice -->';
     }
 
@@ -351,7 +351,7 @@ 
                 '</a></span></div><!-- .ee-attention ticketSalesClosedMessage -->'
             );
         }
-        return '<p><span class="important-notice">' . $sales_closed_msg . '</span></p>';
+        return '<p><span class="important-notice">'.$sales_closed_msg.'</span></p>';
     }
 
 
@@ -381,7 +381,7 @@ 
                 'Datetime.DTT_EVT_start' => 'DESC',
             ),
         );
-        if (! $show_expired_tickets) {
+        if ( ! $show_expired_tickets) {
             // use the correct applicable time query depending on what version of core is being run.
             $current_time = method_exists('EEM_Datetime', 'current_time_for_query')
                 ? time()
@@ -419,7 +419,7 @@ 
          */
         $template_args['anchor_id'] = apply_filters(
             'FHEE__EE_Ticket_Selector__redirect_anchor_id',
-            '#tkt-slctr-tbl-' . $this->event->ID(),
+            '#tkt-slctr-tbl-'.$this->event->ID(),
             $this->event->ID()
         );
         $template_args['tickets'] = $tickets;
@@ -505,8 +505,8 @@ 
         // if redirecting, we don't need any anything else
         if ($external_url) {
             $html = '<form method="GET" ';
-            $html .= 'action="' . EEH_URL::refactor_url($external_url) . '" ';
-            $html .= 'name="ticket-selector-form-' . $ID . '"';
+            $html .= 'action="'.EEH_URL::refactor_url($external_url).'" ';
+            $html .= 'name="ticket-selector-form-'.$ID.'"';
             // open link in new window ?
             $html .= apply_filters(
                 'FHEE__EventEspresso_modules_ticket_selector_DisplayTicketSelector__formOpen__external_url_target_blank',
@@ -518,17 +518,17 @@ 
             $html .= '>';
             $query_args = EEH_URL::get_query_string($external_url);
             foreach ((array) $query_args as $query_arg => $value) {
-                $html .= '<input type="hidden" name="' . $query_arg . '" value="' . $value . '">';
+                $html .= '<input type="hidden" name="'.$query_arg.'" value="'.$value.'">';
             }
             return $html;
         }
         // if there is no submit button, then don't start building a form
         // because the "View Details" button will build its own form
-        if (! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
+        if ( ! apply_filters('FHEE__EE_Ticket_Selector__display_ticket_selector_submit', false)) {
             return '';
         }
         $checkout_url = EEH_Event_View::event_link_url($ID);
-        if (! $checkout_url) {
+        if ( ! $checkout_url) {
             EE_Error::add_error(
                 esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
                 __FILE__,
@@ -539,8 +539,8 @@ 
         // set no cache headers and constants
         EE_System::do_not_cache();
         $html = '<form method="POST" ';
-        $html .= 'action="' . $checkout_url . '" ';
-        $html .= 'name="ticket-selector-form-' . $ID . '"';
+        $html .= 'action="'.$checkout_url.'" ';
+        $html .= 'name="ticket-selector-form-'.$ID.'"';
         $html .= $this->iframe ? ' target="_blank"' : '';
         $html .= '>';
         $html .= '<input type="hidden" name="ee" value="process_ticket_selections">';
@@ -566,7 +566,7 @@ 
                 $html .= empty($external_url)
                     ? $this->ticketSelectorEndDiv()
                     : $this->clearTicketSelector();
-                $html .= '<br/>' . $this->formClose();
+                $html .= '<br/>'.$this->formClose();
             } elseif ($this->getMaxAttendees() === 1) {
                 // its a "Dude Where's my Ticket Selector?" (DWMTS) type event (ie: $_max_atndz === 1)
                 if ($this->event->is_sold_out()) {
@@ -619,7 +619,7 @@ 
                 // no submit or view details button, and no additional content
                 $html .= $this->ticketSelectorEndDiv();
             }
-            if (! $this->iframe && ! is_archive()) {
+            if ( ! $this->iframe && ! is_archive()) {
                 $html .= EEH_Template::powered_by_event_espresso('', '', array('utm_content' => 'ticket_selector'));
             }
         }
@@ -649,14 +649,14 @@ 
             : '';
         $html = EEH_HTML::div(
             '',
-            'ticket-selector-submit-' . $this->event->ID() . '-btn-wrap',
+            'ticket-selector-submit-'.$this->event->ID().'-btn-wrap',
             'ticket-selector-submit-btn-wrap'
         );
-        $html .= '<input id="ticket-selector-submit-' . $this->event->ID() . '-btn"';
+        $html .= '<input id="ticket-selector-submit-'.$this->event->ID().'-btn"';
         $html .= ' class="ticket-selector-submit-btn ';
         $html .= empty($external_url) ? 'ticket-selector-submit-ajax"' : '"';
-        $html .= ' type="submit" value="' . $btn_text . '" />';
-        $html .= EEH_HTML::divx() . '<!-- .ticket-selector-submit-btn-wrap -->';
+        $html .= ' type="submit" value="'.$btn_text.'" />';
+        $html .= EEH_HTML::divx().'<!-- .ticket-selector-submit-btn-wrap -->';
         $html .= apply_filters(
             'FHEE__EE_Ticket_Selector__after_ticket_selector_submit',
             '',
@@ -679,7 +679,7 @@ 
      */
     public function displayViewDetailsButton($DWMTS = false)
     {
-        if (! $this->event->get_permalink()) {
+        if ( ! $this->event->get_permalink()) {
             EE_Error::add_error(
                 esc_html__('The URL for the Event Details page could not be retrieved.', 'event_espresso'),
                 __FILE__,
@@ -732,7 +732,7 @@ 
      */
     public function ticketSelectorEndDiv()
     {
-        return $this->clearTicketSelector() . '</div><!-- ticketSelectorEndDiv -->';
+        return $this->clearTicketSelector().'</div><!-- ticketSelectorEndDiv -->';
     }
 
 

modules/single_page_checkout/reg_steps/attendee_information/attendee_info_single.template.php

Indentation +42 added lines, -42 removed lines

@@ -6,16 +6,16 @@ 
 <?php if (!is_admin()) : ?>
     <p id="spco-attendee_information-pg" class="spco-steps-pg small-text drk-grey-text">
         <?php echo apply_filters(
-            'FHEE__registration_page_attendee_information__attendee_information_pg',
-            sprintf(
-                esc_html__(
-                    'In order to process your registration, we ask you to provide the following information.%1$sPlease note that all fields marked with an asterisk (%2$s) are required.',
-                    'event_espresso'
-                ),
-                '<br />',
-                '<span class="asterisk">*</span>'
-            )
-        ); ?>
+			'FHEE__registration_page_attendee_information__attendee_information_pg',
+			sprintf(
+				esc_html__(
+					'In order to process your registration, we ask you to provide the following information.%1$sPlease note that all fields marked with an asterisk (%2$s) are required.',
+					'event_espresso'
+				),
+				'<br />',
+				'<span class="asterisk">*</span>'
+			)
+		); ?>
 </p>
 <?php endif; ?>
 
@@ -25,8 +25,8 @@ 
 $prev_ticket = 0;
 
 if (count($registrations) > 0) {
-    $ticketID = key($template_args['ticket_count']);
-    ?>
+	$ticketID = key($template_args['ticket_count']);
+	?>
 
     <div id="spco-attendee-panel-dv-<?php echo $ticketID; ?>"
         class="spco-attendee-panel-dv spco-attendee-ticket-<?php echo $ticketID; ?>">
@@ -41,52 +41,52 @@ 
                     <th scope="col" width="" class="jst-left"><?php esc_html_e('Name and Description', 'event_espresso'); ?></th>
                     <th scope="col" width="7.5%" class="jst-rght">
                         <?php esc_html_e(
-                            'Qty',
-                            'event_espresso'
-                        ); ?></th>
+							'Qty',
+							'event_espresso'
+						); ?></th>
                     <th scope="col" width="17.5%" class="jst-rght">
                         <?php esc_html_e(
-                            'Price',
-                            'event_espresso'
-                        ); ?></th>
+							'Price',
+							'event_espresso'
+						); ?></th>
                     <th scope="col" width="17.5%" class="jst-rght">
                         <?php esc_html_e(
-                            'Total',
-                            'event_espresso'
-                        ); ?></th>
+							'Total',
+							'event_espresso'
+						); ?></th>
                 </tr>
                 </thead>
                 <tbody>
                 <?php
-                // Store previous values to avoid duplicated rows.
-                $prev_ticket = 0;
-                // Display all tickets inside.
-                foreach ($registrations as $registration) {
-                    if ($registration instanceof EE_Registration) {
-                        if ($registration->ticket()->ID() !== $prev_ticket) {
-                            echo $ticket_line_item[ $registration->ticket()->ID() ];
-                        }
+				// Store previous values to avoid duplicated rows.
+				$prev_ticket = 0;
+				// Display all tickets inside.
+				foreach ($registrations as $registration) {
+					if ($registration instanceof EE_Registration) {
+						if ($registration->ticket()->ID() !== $prev_ticket) {
+							echo $ticket_line_item[ $registration->ticket()->ID() ];
+						}
 
-                        $prev_ticket = $registration->ticket()->ID();
-                    }
-                }
-                ?>
+						$prev_ticket = $registration->ticket()->ID();
+					}
+				}
+				?>
                 </tbody>
             </table>
         </div>
     </div>
 
     <?php
-    // Display the forms below the table.
-    foreach ($registrations as $registration) {
-        if ($registration instanceof EE_Registration) {
-            // Attendee Questions.
-            $reg_form = EE_Template_Layout::get_subform_name($registration->reg_url_link());
-            echo ${$reg_form};
-        } // if ( $registration instanceof EE_Registration )
-    } // end foreach ( $registrations as $registration )
+	// Display the forms below the table.
+	foreach ($registrations as $registration) {
+		if ($registration instanceof EE_Registration) {
+			// Attendee Questions.
+			$reg_form = EE_Template_Layout::get_subform_name($registration->reg_url_link());
+			echo ${$reg_form};
+		} // if ( $registration instanceof EE_Registration )
+	} // end foreach ( $registrations as $registration )
 
-    echo $default_hidden_inputs;
+	echo $default_hidden_inputs;
 } // end if ( count( $registrations ) > 0 )
 
 ?>

Spacing +3 added lines, -3 removed lines

@@ -3,7 +3,7 @@ 
 /** @var array $ticket_line_item */
 /** @var string $default_hidden_inputs */
 ?>
-<?php if (!is_admin()) : ?>
+<?php if ( ! is_admin()) : ?>
     <p id="spco-attendee_information-pg" class="spco-steps-pg small-text drk-grey-text">
         <?php echo apply_filters(
             'FHEE__registration_page_attendee_information__attendee_information_pg',
@@ -32,7 +32,7 @@ 
         class="spco-attendee-panel-dv spco-attendee-ticket-<?php echo $ticketID; ?>">
 
         <div class="spco-ticket-info-dv small-text">
-            <?php if (!is_admin()) : ?>
+            <?php if ( ! is_admin()) : ?>
                 <h5><?php esc_html_e('Details', 'event_espresso'); ?></h5>
             <?php endif; ?>
             <table class="spco-ticket-details">
@@ -64,7 +64,7 @@ 
                 foreach ($registrations as $registration) {
                     if ($registration instanceof EE_Registration) {
                         if ($registration->ticket()->ID() !== $prev_ticket) {
-                            echo $ticket_line_item[ $registration->ticket()->ID() ];
+                            echo $ticket_line_item[$registration->ticket()->ID()];
                         }
 
                         $prev_ticket = $registration->ticket()->ID();

core/db_models/EEM_Line_Item.model.php

Indentation +595 added lines, -595 removed lines

@@ -28,602 +28,602 @@
 class EEM_Line_Item extends EEM_Base
 {
 
-    /**
-     * Tax sub-total is just the total of all the taxes, which should be children
-     * of this line item. There should only ever be one tax sub-total, and it should
-     * be a direct child of. Its quantity and LIN_unit_price = 1.
-     */
-    const type_tax_sub_total = 'tax-sub-total';
-
-    /**
-     * Tax line items indicate a tax applied to all the taxable line items.
-     * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
-     * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
-     */
-    const type_tax = 'tax';
-
-    /**
-     * Indicating individual items purchased, or discounts or surcharges.
-     * The sum of all the regular line items  plus the tax items should equal the grand total.
-     * Possible children are sub-line-items and cancellations.
-     * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
-     * LIN_totals. Its LIN_percent = 0.
-     * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
-     * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
-     */
-    const type_line_item = 'line-item';
-
-    /**
-     * Line item indicating all the factors that make a single line item.
-     * Sub-line items should have NO children line items.
-     * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
-     * contribution towards the price of ONE of their parent items, and its LIN_total should be
-     *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
-     * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
-     * = LIN_percent / 100 * sum of lower-priority sibling line items..
-     */
-    const type_sub_line_item = 'sub-item';
-
-    /**
-     * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
-     * Direct children should be event subtotals.
-     * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
-     */
-    const type_sub_total = 'sub-total';
-
-    /**
-     * Line item for the grand total of an order.
-     * Its direct children should be tax subtotals and (pre-tax) subtotals,
-     * and possibly a regular line item indicating a transaction-wide discount/surcharge.
-     * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
-     */
-    const type_total = 'total';
-
-    /**
-     * When a line item is cancelled, a sub-line-item of type 'cancellation'
-     * should be created, indicating the quantity that were cancelled
-     * (because a line item could have a quantity of 1, and its cancellation item
-     * could be for 3, indicating that originally 4 were purchased, but 3 have been
-     * cancelled, and only one remains).
-     * When items are refunded, a cancellation line item should be made, which points
-     * to teh payment model object which actually refunded the payment.
-     * Cancellations should NOT have any children line items; the should NOT affect
-     * any calculations, and are only meant as a record that cancellations have occurred.
-     * Their LIN_percent should be 0.
-     */
-    const type_cancellation = 'cancellation';
-
-    // various line item object types
-    const OBJ_TYPE_EVENT = 'Event';
-
-    const OBJ_TYPE_PRICE = 'Price';
-
-    const OBJ_TYPE_PROMOTION = 'Promotion';
-
-    const OBJ_TYPE_TICKET = 'Ticket';
-
-    const OBJ_TYPE_TRANSACTION = 'Transaction';
-
-    /**
-     * @var EEM_Line_Item $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
-     *                         (and any incoming timezone data that gets saved).
-     *                         Note this just sends the timezone info to the date time model field objects.
-     *                         Default is NULL
-     *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = esc_html__('Line Item', 'event_espresso');
-        $this->plural_item = esc_html__('Line Items', 'event_espresso');
-
-        $this->_tables = array(
-            'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
-        );
-        $line_items_can_be_for = apply_filters(
-            'FHEE__EEM_Line_Item__line_items_can_be_for',
-            array('Ticket', 'Price', 'Event')
-        );
-        $this->_fields = array(
-            'Line_Item' => array(
-                'LIN_ID'         => new EE_Primary_Key_Int_Field(
-                    'LIN_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'LIN_code'       => new EE_Slug_Field(
-                    'LIN_code',
-                    esc_html__('Code for index into Cart', 'event_espresso'),
-                    true
-                ),
-                'TXN_ID'         => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    true,
-                    null,
-                    'Transaction'
-                ),
-                'LIN_name'       => new EE_Full_HTML_Field(
-                    'LIN_name',
-                    esc_html__('Line Item Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'LIN_desc'       => new EE_Full_HTML_Field(
-                    'LIN_desc',
-                    esc_html__('Line Item Description', 'event_espresso'),
-                    true
-                ),
-                'LIN_unit_price' => new EE_Money_Field(
-                    'LIN_unit_price',
-                    esc_html__('Unit Price', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_percent'    => new EE_Float_Field(
-                    'LIN_percent',
-                    esc_html__('Percent', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_is_taxable' => new EE_Boolean_Field(
-                    'LIN_is_taxable',
-                    esc_html__('Taxable', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'LIN_order'      => new EE_Integer_Field(
-                    'LIN_order',
-                    esc_html__('Order of Application towards total of parent', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'LIN_total'      => new EE_Money_Field(
-                    'LIN_total',
-                    esc_html__('Total (unit price x quantity)', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'LIN_quantity'   => new EE_Integer_Field(
-                    'LIN_quantity',
-                    esc_html__('Quantity', 'event_espresso'),
-                    true,
-                    1
-                ),
-                'LIN_parent'     => new EE_Integer_Field(
-                    'LIN_parent',
-                    esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'),
-                    true,
-                    null
-                ),
-                'LIN_type'       => new EE_Enum_Text_Field(
-                    'LIN_type',
-                    esc_html__('Type', 'event_espresso'),
-                    false,
-                    'line-item',
-                    array(
-                        self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
-                        self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
-                        self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
-                        self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
-                        self::type_tax           => esc_html__('Tax', 'event_espresso'),
-                        self::type_total         => esc_html__('Total', 'event_espresso'),
-                        self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
-                    )
-                ),
-                'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
-                    'OBJ_ID',
-                    esc_html__('ID of Item purchased.', 'event_espresso'),
-                    true,
-                    null,
-                    $line_items_can_be_for
-                ),
-                'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
-                    'OBJ_type',
-                    esc_html__('Model Name this Line Item is for', 'event_espresso'),
-                    true,
-                    null,
-                    $line_items_can_be_for
-                ),
-                'LIN_timestamp'  => new EE_Datetime_Field(
-                    'LIN_timestamp',
-                    esc_html__('When the line item was created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Transaction' => new EE_Belongs_To_Relation(),
-            'Ticket'      => new EE_Belongs_To_Any_Relation(),
-            'Price'       => new EE_Belongs_To_Any_Relation(),
-            'Event'       => new EE_Belongs_To_Any_Relation(),
-        );
-        $this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
-        $this->_caps_slug = 'transactions';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets all the line items for this transaction of the given type
-     *
-     * @param string             $line_item_type like one of EEM_Line_Item::type_*
-     * @param EE_Transaction|int $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_all_of_type_for_transaction($line_item_type, $transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(array(
-            array(
-                'LIN_type' => $line_item_type,
-                'TXN_ID'   => $transaction,
-            ),
-        ));
-    }
-
-
-    /**
-     * Gets all line items unrelated to tickets that are normal line items
-     * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
-     *
-     * @param EE_Transaction|int $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_all_non_ticket_line_items_for_transaction($transaction)
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
-        return $this->get_all(array(
-            array(
-                'LIN_type' => self::type_line_item,
-                'TXN_ID'   => $transaction,
-                'OR'       => array(
-                    'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET),
-                    'OBJ_type*null'      => array('IS_NULL'),
-                ),
-            ),
-        ));
-    }
-
-
-    /**
-     * Deletes line items with no transaction who have passed the transaction cutoff time.
-     * This needs to be very efficient
-     * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
-     * deleting and joining tables like this.
-     *
-     * @return int count of how many deleted
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function delete_line_items_with_no_transaction()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
-            WEEK_IN_SECONDS
-        );
-        $query = $wpdb->prepare(
-            'DELETE li
+	/**
+	 * Tax sub-total is just the total of all the taxes, which should be children
+	 * of this line item. There should only ever be one tax sub-total, and it should
+	 * be a direct child of. Its quantity and LIN_unit_price = 1.
+	 */
+	const type_tax_sub_total = 'tax-sub-total';
+
+	/**
+	 * Tax line items indicate a tax applied to all the taxable line items.
+	 * Should not have any children line items. Its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal
+	 * (eg 10% tax = 10, not 0.1). Its LIN_total = LIN_unit_price * pre-tax-total. Quantity = 1.
+	 */
+	const type_tax = 'tax';
+
+	/**
+	 * Indicating individual items purchased, or discounts or surcharges.
+	 * The sum of all the regular line items  plus the tax items should equal the grand total.
+	 * Possible children are sub-line-items and cancellations.
+	 * For flat items, LIN_unit_price * LIN_quantity = LIN_total. Its LIN_total is the sum of all the children
+	 * LIN_totals. Its LIN_percent = 0.
+	 * For percent items, its LIN_unit_price = 0. Its LIN_percent is a percent, not a decimal (eg 10% = 10, not 0.1).
+	 * Its LIN_total is LIN_percent / 100 * sum of lower-priority sibling line items. Quantity = 1.
+	 */
+	const type_line_item = 'line-item';
+
+	/**
+	 * Line item indicating all the factors that make a single line item.
+	 * Sub-line items should have NO children line items.
+	 * For flat sub-items, their quantity should match their parent item, their LIN_unit_price should be this sub-item's
+	 * contribution towards the price of ONE of their parent items, and its LIN_total should be
+	 *  = LIN_quantity * LIN_unit_price. Its LIN_percent = 0.
+	 * For percent sub-items, the quantity should be 1, LIN_unit_price should be 0, and its LIN_total should
+	 * = LIN_percent / 100 * sum of lower-priority sibling line items..
+	 */
+	const type_sub_line_item = 'sub-item';
+
+	/**
+	 * Line item indicating a sub-total (eg total for an event, or pre-tax subtotal).
+	 * Direct children should be event subtotals.
+	 * Should have quantity of 1, and a LIN_total and LIN_unit_price of the sum of all its sub-items' LIN_totals.
+	 */
+	const type_sub_total = 'sub-total';
+
+	/**
+	 * Line item for the grand total of an order.
+	 * Its direct children should be tax subtotals and (pre-tax) subtotals,
+	 * and possibly a regular line item indicating a transaction-wide discount/surcharge.
+	 * Should have a quantity of 1, a LIN_total and LIN_unit_price of the entire order's amount.
+	 */
+	const type_total = 'total';
+
+	/**
+	 * When a line item is cancelled, a sub-line-item of type 'cancellation'
+	 * should be created, indicating the quantity that were cancelled
+	 * (because a line item could have a quantity of 1, and its cancellation item
+	 * could be for 3, indicating that originally 4 were purchased, but 3 have been
+	 * cancelled, and only one remains).
+	 * When items are refunded, a cancellation line item should be made, which points
+	 * to teh payment model object which actually refunded the payment.
+	 * Cancellations should NOT have any children line items; the should NOT affect
+	 * any calculations, and are only meant as a record that cancellations have occurred.
+	 * Their LIN_percent should be 0.
+	 */
+	const type_cancellation = 'cancellation';
+
+	// various line item object types
+	const OBJ_TYPE_EVENT = 'Event';
+
+	const OBJ_TYPE_PRICE = 'Price';
+
+	const OBJ_TYPE_PROMOTION = 'Promotion';
+
+	const OBJ_TYPE_TICKET = 'Ticket';
+
+	const OBJ_TYPE_TRANSACTION = 'Transaction';
+
+	/**
+	 * @var EEM_Line_Item $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
+	 *                         (and any incoming timezone data that gets saved).
+	 *                         Note this just sends the timezone info to the date time model field objects.
+	 *                         Default is NULL
+	 *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = esc_html__('Line Item', 'event_espresso');
+		$this->plural_item = esc_html__('Line Items', 'event_espresso');
+
+		$this->_tables = array(
+			'Line_Item' => new EE_Primary_Table('esp_line_item', 'LIN_ID'),
+		);
+		$line_items_can_be_for = apply_filters(
+			'FHEE__EEM_Line_Item__line_items_can_be_for',
+			array('Ticket', 'Price', 'Event')
+		);
+		$this->_fields = array(
+			'Line_Item' => array(
+				'LIN_ID'         => new EE_Primary_Key_Int_Field(
+					'LIN_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'LIN_code'       => new EE_Slug_Field(
+					'LIN_code',
+					esc_html__('Code for index into Cart', 'event_espresso'),
+					true
+				),
+				'TXN_ID'         => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					true,
+					null,
+					'Transaction'
+				),
+				'LIN_name'       => new EE_Full_HTML_Field(
+					'LIN_name',
+					esc_html__('Line Item Name', 'event_espresso'),
+					false,
+					''
+				),
+				'LIN_desc'       => new EE_Full_HTML_Field(
+					'LIN_desc',
+					esc_html__('Line Item Description', 'event_espresso'),
+					true
+				),
+				'LIN_unit_price' => new EE_Money_Field(
+					'LIN_unit_price',
+					esc_html__('Unit Price', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_percent'    => new EE_Float_Field(
+					'LIN_percent',
+					esc_html__('Percent', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_is_taxable' => new EE_Boolean_Field(
+					'LIN_is_taxable',
+					esc_html__('Taxable', 'event_espresso'),
+					false,
+					false
+				),
+				'LIN_order'      => new EE_Integer_Field(
+					'LIN_order',
+					esc_html__('Order of Application towards total of parent', 'event_espresso'),
+					false,
+					1
+				),
+				'LIN_total'      => new EE_Money_Field(
+					'LIN_total',
+					esc_html__('Total (unit price x quantity)', 'event_espresso'),
+					false,
+					0
+				),
+				'LIN_quantity'   => new EE_Integer_Field(
+					'LIN_quantity',
+					esc_html__('Quantity', 'event_espresso'),
+					true,
+					1
+				),
+				'LIN_parent'     => new EE_Integer_Field(
+					'LIN_parent',
+					esc_html__("Parent ID (this item goes towards that Line Item's total)", 'event_espresso'),
+					true,
+					null
+				),
+				'LIN_type'       => new EE_Enum_Text_Field(
+					'LIN_type',
+					esc_html__('Type', 'event_espresso'),
+					false,
+					'line-item',
+					array(
+						self::type_line_item     => esc_html__('Line Item', 'event_espresso'),
+						self::type_sub_line_item => esc_html__('Sub-Item', 'event_espresso'),
+						self::type_sub_total     => esc_html__('Subtotal', 'event_espresso'),
+						self::type_tax_sub_total => esc_html__('Tax Subtotal', 'event_espresso'),
+						self::type_tax           => esc_html__('Tax', 'event_espresso'),
+						self::type_total         => esc_html__('Total', 'event_espresso'),
+						self::type_cancellation  => esc_html__('Cancellation', 'event_espresso'),
+					)
+				),
+				'OBJ_ID'         => new EE_Foreign_Key_Int_Field(
+					'OBJ_ID',
+					esc_html__('ID of Item purchased.', 'event_espresso'),
+					true,
+					null,
+					$line_items_can_be_for
+				),
+				'OBJ_type'       => new EE_Any_Foreign_Model_Name_Field(
+					'OBJ_type',
+					esc_html__('Model Name this Line Item is for', 'event_espresso'),
+					true,
+					null,
+					$line_items_can_be_for
+				),
+				'LIN_timestamp'  => new EE_Datetime_Field(
+					'LIN_timestamp',
+					esc_html__('When the line item was created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Transaction' => new EE_Belongs_To_Relation(),
+			'Ticket'      => new EE_Belongs_To_Any_Relation(),
+			'Price'       => new EE_Belongs_To_Any_Relation(),
+			'Event'       => new EE_Belongs_To_Any_Relation(),
+		);
+		$this->_model_chain_to_wp_user = 'Transaction.Registration.Event';
+		$this->_caps_slug = 'transactions';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets all the line items for this transaction of the given type
+	 *
+	 * @param string             $line_item_type like one of EEM_Line_Item::type_*
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_all_of_type_for_transaction($line_item_type, $transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(
+			array(
+				'LIN_type' => $line_item_type,
+				'TXN_ID'   => $transaction,
+			),
+		));
+	}
+
+
+	/**
+	 * Gets all line items unrelated to tickets that are normal line items
+	 * (eg shipping, promotions, and miscellaneous other stuff should probably fit in this category)
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_all_non_ticket_line_items_for_transaction($transaction)
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_ID($transaction);
+		return $this->get_all(array(
+			array(
+				'LIN_type' => self::type_line_item,
+				'TXN_ID'   => $transaction,
+				'OR'       => array(
+					'OBJ_type*notticket' => array('!=', EEM_Line_Item::OBJ_TYPE_TICKET),
+					'OBJ_type*null'      => array('IS_NULL'),
+				),
+			),
+		));
+	}
+
+
+	/**
+	 * Deletes line items with no transaction who have passed the transaction cutoff time.
+	 * This needs to be very efficient
+	 * because if there are spam bots afoot there will be LOTS of line items. Also MySQL doesn't allow a limit when
+	 * deleting and joining tables like this.
+	 *
+	 * @return int count of how many deleted
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function delete_line_items_with_no_transaction()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Line_Item__delete_line_items_with_no_transaction__time_to_leave_alone',
+			WEEK_IN_SECONDS
+		);
+		$query = $wpdb->prepare(
+			'DELETE li
 				FROM ' . $this->table() . ' li
 				LEFT JOIN ' . EEM_Transaction::instance()->table() . ' t ON li.TXN_ID = t.TXN_ID
 				WHERE t.TXN_ID IS NULL AND li.LIN_timestamp < %s',
-            // use GMT time because that's what TXN_timestamps are in
-            date('Y-m-d H:i:s', time() - $time_to_leave_alone)
-        );
-        return $wpdb->query($query);
-    }
-
-
-    /**
-     * get_line_item_for_transaction_object
-     * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
-     *
-     * @param int           $TXN_ID
-     * @param EE_Base_Class $object
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
-    {
-        return $this->get_all(array(
-            array(
-                'TXN_ID'   => $TXN_ID,
-                'OBJ_type' => str_replace('EE_', '', get_class($object)),
-                'OBJ_ID'   => $object->ID(),
-            ),
-        ));
-    }
-
-
-    /**
-     * get_object_line_items_for_transaction
-     * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
-     *
-     * @param int    $TXN_ID
-     * @param string $OBJ_type
-     * @param array  $OBJ_IDs
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     */
-    public function get_object_line_items_for_transaction(
-        $TXN_ID,
-        $OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
-        $OBJ_IDs = array()
-    ) {
-        $query_params = array(
-            'OBJ_type' => $OBJ_type,
-            // if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
-            'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs,
-        );
-        if ($TXN_ID) {
-            $query_params['TXN_ID'] = $TXN_ID;
-        }
-        return $this->get_all(array($query_params));
-    }
-
-
-    /**
-     * get_all_ticket_line_items_for_transaction
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
-    {
-        return $this->get_all(array(
-            array(
-                'TXN_ID'   => $transaction->ID(),
-                'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-            ),
-        ));
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction
-     *
-     * @param int $TXN_ID
-     * @param int $TKT_ID
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
-    {
-        return $this->get_one(array(
-            array(
-                'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
-                'OBJ_ID'   => $TKT_ID,
-                'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-            ),
-        ));
-    }
-
-
-    /**
-     * get_existing_promotion_line_item
-     * searches the cart for existing line items for the specified promotion
-     *
-     * @since 1.0.0
-     * @param EE_Line_Item $parent_line_item
-     * @param EE_Promotion $promotion
-     * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
-    {
-        return $this->get_one(array(
-            array(
-                'TXN_ID'     => $parent_line_item->TXN_ID(),
-                'LIN_parent' => $parent_line_item->ID(),
-                'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-                'OBJ_ID'     => $promotion->ID(),
-            ),
-        ));
-    }
-
-
-    /**
-     * get_all_promotion_line_items
-     * searches the cart for any and all existing promotion line items
-     *
-     * @since   1.0.0
-     * @param EE_Line_Item $parent_line_item
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
-    {
-        return $this->get_all(array(
-            array(
-                'TXN_ID'     => $parent_line_item->TXN_ID(),
-                'LIN_parent' => $parent_line_item->ID(),
-                'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
-            ),
-        ));
-    }
-
-
-    /**
-     * Gets the registration's corresponding line item.
-     * Note: basically does NOT support having multiple line items for a single ticket,
-     * which would happen if some of the registrations had a price modifier while others didn't.
-     * In order to support that, we'd probably need a LIN_ID on registrations or something.
-     *
-     * @param EE_Registration $registration
-     * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_line_item_for_registration(EE_Registration $registration)
-    {
-        return $this->get_one($this->line_item_for_registration_query_params($registration));
-    }
-
-
-    /**
-     * Gets the query params used to retrieve a specific line item for the given registration
-     *
-     * @param EE_Registration $registration
-     * @param array           $original_query_params any extra query params you'd like to be merged with
-     * @return array @see
-     *      https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    public function line_item_for_registration_query_params(
-        EE_Registration $registration,
-        $original_query_params = array()
-    ) {
-        return array_replace_recursive($original_query_params, array(
-            array(
-                'OBJ_ID'   => $registration->ticket_ID(),
-                'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
-                'TXN_ID'   => $registration->transaction_ID(),
-            ),
-        ));
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_with_no_transaction()
-    {
-        return $this->get_total_line_items_for_carts();
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_active_carts()
-    {
-        return $this->get_total_line_items_for_carts(false);
-    }
-
-
-    /**
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function get_total_line_items_for_expired_carts()
-    {
-        return $this->get_total_line_items_for_carts(true);
-    }
-
-
-    /**
-     * Returns an array of grand total line items where the TXN_ID is 0.
-     * If $expired is set to true, then only line items for expired sessions will be returned.
-     * If $expired is set to false, then only line items for active sessions will be returned.
-     *
-     * @param null $expired
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function get_total_line_items_for_carts($expired = null)
-    {
-        $where_params = array(
-            'TXN_ID'   => 0,
-            'LIN_type' => 'total',
-        );
-        if ($expired !== null) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $where_params['LIN_timestamp'] = array(
-                $expired ? '<=' : '>',
-                $session_lifespan->expiration(),
-            );
-        }
-        return $this->get_all(array($where_params));
-    }
-
-
-    /**
-     * Returns an array of ticket total line items where the TXN_ID is 0
-     * AND the timestamp is older than the session lifespan.
-     *
-     * @param int $timestamp
-     * @return EE_Base_Class[]|EE_Line_Item[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getTicketLineItemsForExpiredCarts($timestamp = 0)
-    {
-        if (! absint($timestamp)) {
-            /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-            $session_lifespan = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\values\session\SessionLifespan'
-            );
-            $timestamp = $session_lifespan->expiration();
-        }
-        return $this->get_all(
-            array(
-                array(
-                    'TXN_ID'        => 0,
-                    'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
-                    'LIN_timestamp' => array('<=', $timestamp),
-                ),
-            )
-        );
-    }
+			// use GMT time because that's what TXN_timestamps are in
+			date('Y-m-d H:i:s', time() - $time_to_leave_alone)
+		);
+		return $wpdb->query($query);
+	}
+
+
+	/**
+	 * get_line_item_for_transaction_object
+	 * Gets a transaction's line item record for a specific object such as a EE_Event or EE_Ticket
+	 *
+	 * @param int           $TXN_ID
+	 * @param EE_Base_Class $object
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_line_item_for_transaction_object($TXN_ID, EE_Base_Class $object)
+	{
+		return $this->get_all(array(
+			array(
+				'TXN_ID'   => $TXN_ID,
+				'OBJ_type' => str_replace('EE_', '', get_class($object)),
+				'OBJ_ID'   => $object->ID(),
+			),
+		));
+	}
+
+
+	/**
+	 * get_object_line_items_for_transaction
+	 * Gets all of the the object line items for a transaction, based on an object type plus an array of object IDs
+	 *
+	 * @param int    $TXN_ID
+	 * @param string $OBJ_type
+	 * @param array  $OBJ_IDs
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 */
+	public function get_object_line_items_for_transaction(
+		$TXN_ID,
+		$OBJ_type = EEM_Line_Item::OBJ_TYPE_EVENT,
+		$OBJ_IDs = array()
+	) {
+		$query_params = array(
+			'OBJ_type' => $OBJ_type,
+			// if incoming $OBJ_IDs is an array, then make sure it is formatted correctly for the query
+			'OBJ_ID'   => is_array($OBJ_IDs) && ! isset($OBJ_IDs['IN']) ? array('IN', $OBJ_IDs) : $OBJ_IDs,
+		);
+		if ($TXN_ID) {
+			$query_params['TXN_ID'] = $TXN_ID;
+		}
+		return $this->get_all(array($query_params));
+	}
+
+
+	/**
+	 * get_all_ticket_line_items_for_transaction
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_all_ticket_line_items_for_transaction(EE_Transaction $transaction)
+	{
+		return $this->get_all(array(
+			array(
+				'TXN_ID'   => $transaction->ID(),
+				'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+			),
+		));
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction
+	 *
+	 * @param int $TXN_ID
+	 * @param int $TKT_ID
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_ticket_line_item_for_transaction($TXN_ID, $TKT_ID)
+	{
+		return $this->get_one(array(
+			array(
+				'TXN_ID'   => EEM_Transaction::instance()->ensure_is_ID($TXN_ID),
+				'OBJ_ID'   => $TKT_ID,
+				'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+			),
+		));
+	}
+
+
+	/**
+	 * get_existing_promotion_line_item
+	 * searches the cart for existing line items for the specified promotion
+	 *
+	 * @since 1.0.0
+	 * @param EE_Line_Item $parent_line_item
+	 * @param EE_Promotion $promotion
+	 * @return EE_Base_Class|EE_Line_Item|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_existing_promotion_line_item(EE_Line_Item $parent_line_item, EE_Promotion $promotion)
+	{
+		return $this->get_one(array(
+			array(
+				'TXN_ID'     => $parent_line_item->TXN_ID(),
+				'LIN_parent' => $parent_line_item->ID(),
+				'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+				'OBJ_ID'     => $promotion->ID(),
+			),
+		));
+	}
+
+
+	/**
+	 * get_all_promotion_line_items
+	 * searches the cart for any and all existing promotion line items
+	 *
+	 * @since   1.0.0
+	 * @param EE_Line_Item $parent_line_item
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_all_promotion_line_items(EE_Line_Item $parent_line_item)
+	{
+		return $this->get_all(array(
+			array(
+				'TXN_ID'     => $parent_line_item->TXN_ID(),
+				'LIN_parent' => $parent_line_item->ID(),
+				'OBJ_type'   => EEM_Line_Item::OBJ_TYPE_PROMOTION,
+			),
+		));
+	}
+
+
+	/**
+	 * Gets the registration's corresponding line item.
+	 * Note: basically does NOT support having multiple line items for a single ticket,
+	 * which would happen if some of the registrations had a price modifier while others didn't.
+	 * In order to support that, we'd probably need a LIN_ID on registrations or something.
+	 *
+	 * @param EE_Registration $registration
+	 * @return EE_Base_Class|EE_Line_ITem|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_line_item_for_registration(EE_Registration $registration)
+	{
+		return $this->get_one($this->line_item_for_registration_query_params($registration));
+	}
+
+
+	/**
+	 * Gets the query params used to retrieve a specific line item for the given registration
+	 *
+	 * @param EE_Registration $registration
+	 * @param array           $original_query_params any extra query params you'd like to be merged with
+	 * @return array @see
+	 *      https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	public function line_item_for_registration_query_params(
+		EE_Registration $registration,
+		$original_query_params = array()
+	) {
+		return array_replace_recursive($original_query_params, array(
+			array(
+				'OBJ_ID'   => $registration->ticket_ID(),
+				'OBJ_type' => EEM_Line_Item::OBJ_TYPE_TICKET,
+				'TXN_ID'   => $registration->transaction_ID(),
+			),
+		));
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_with_no_transaction()
+	{
+		return $this->get_total_line_items_for_carts();
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_active_carts()
+	{
+		return $this->get_total_line_items_for_carts(false);
+	}
+
+
+	/**
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function get_total_line_items_for_expired_carts()
+	{
+		return $this->get_total_line_items_for_carts(true);
+	}
+
+
+	/**
+	 * Returns an array of grand total line items where the TXN_ID is 0.
+	 * If $expired is set to true, then only line items for expired sessions will be returned.
+	 * If $expired is set to false, then only line items for active sessions will be returned.
+	 *
+	 * @param null $expired
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function get_total_line_items_for_carts($expired = null)
+	{
+		$where_params = array(
+			'TXN_ID'   => 0,
+			'LIN_type' => 'total',
+		);
+		if ($expired !== null) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$where_params['LIN_timestamp'] = array(
+				$expired ? '<=' : '>',
+				$session_lifespan->expiration(),
+			);
+		}
+		return $this->get_all(array($where_params));
+	}
+
+
+	/**
+	 * Returns an array of ticket total line items where the TXN_ID is 0
+	 * AND the timestamp is older than the session lifespan.
+	 *
+	 * @param int $timestamp
+	 * @return EE_Base_Class[]|EE_Line_Item[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getTicketLineItemsForExpiredCarts($timestamp = 0)
+	{
+		if (! absint($timestamp)) {
+			/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+			$session_lifespan = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\values\session\SessionLifespan'
+			);
+			$timestamp = $session_lifespan->expiration();
+		}
+		return $this->get_all(
+			array(
+				array(
+					'TXN_ID'        => 0,
+					'OBJ_type'      => EEM_Line_Item::OBJ_TYPE_TICKET,
+					'LIN_timestamp' => array('<=', $timestamp),
+				),
+			)
+		);
+	}
 }

core/db_models/EEM_Registration.model.php

Indentation +867 added lines, -867 removed lines

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

core/db_models/EEM_Message.model.php

Indentation +617 added lines, -617 removed lines

@@ -9,628 +9,628 @@
 class EEM_Message extends EEM_Base implements EEI_Query_Filter
 {
 
-    // private instance of the Message object
-    protected static $_instance = null;
+	// private instance of the Message object
+	protected static $_instance = null;
 
 
-    /**
-     * This priority indicates a message should be generated and sent ASAP
-     *
-     * @type int
-     */
-    const priority_high = 10;
-
-
-    /**
-     * This priority indicates a message should be generated ASAP and queued for sending.
-     *
-     * @type
-     */
-    const priority_medium = 20;
-
-
-    /**
-     * This priority indicates a message should be queued for generating.
-     *
-     * @type int
-     */
-    const priority_low = 30;
-
-
-    /**
-     * indicates this message was sent at the time modified
-     */
-    const status_sent = 'MSN';
-
-
-    /**
-     * indicates this message is waiting to be sent
-     */
-    const status_idle = 'MID';
-
-
-    /**
-     * indicates an attempt was a made to send this message
-     * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
-     * appear to the end user.
-     */
-    const status_failed = 'MFL';
-
-
-    /**
-     * indicates the message has been flagged for resending (at the time modified).
-     */
-    const status_resend = 'MRS';
-
-
-    /**
-     * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
-     * this status when added to the queue.
-     */
-    const status_incomplete = 'MIC';
-
-
-    /**
-     * Indicates everything was generated fine for the message, however, the messenger was unable to send.
-     * This status means that its possible to retry sending the message.
-     */
-    const status_retry = 'MRT';
-
-
-    /**
-     * This is used for more informational messages that may not indicate anything is broken but still cannot be
-     * generated or sent correctly. An example of a message that would get flagged this way would be when a not
-     * approved message was queued for generation, but at time of generation, the attached registration(s) are
-     * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
-     * in the db and be viewable in the message activity list table when the messages system is in debug mode.
-     *
-     * @see EEM_Message::debug()
-     */
-    const status_debug_only = 'MDO';
-
-
-    /**
-     * This status is given to messages it is processed by the messenger send method.
-     * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
-     * indicative of a PHP timeout or memory limit issue.
-     */
-    const status_messenger_executing = 'MEX';
-
-
-    /**
-     *    Private constructor to prevent direct creation.
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
-     *                         the date time model field objects.  Default is null (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     * @return EEM_Message
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = __('Message', 'event_espresso');
-        $this->plural_item   = __('Messages', 'event_espresso');
-
-        // used for token generator
-        EE_Registry::instance()->load_helper('URL');
-
-        $this->_tables = array(
-            'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
-        );
-
-        $allowed_priority = array(
-            self::priority_high   => __('high', 'event_espresso'),
-            self::priority_medium => __('medium', 'event_espresso'),
-            self::priority_low    => __('low', 'event_espresso'),
-        );
-
-        $this->_fields          = array(
-            'Message' => array(
-                'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', __('Message ID', 'event_espresso')),
-                'MSG_token'          => new EE_Plain_Text_Field(
-                    'MSG_token',
-                    __(
-                        'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
-                        'event_espresso'
-                    ),
-                    false,
-                    EEH_URL::generate_unique_token()
-                ),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    __('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
-                    true,
-                    0,
-                    'Message_Template_Group'
-                ),
-                'TXN_ID'             => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    __(
-                        'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
-                        'event_espresso'
-                    ),
-                    true,
-                    0,
-                    'Transaction'
-                ),
-                'MSG_messenger'      => new EE_Plain_Text_Field(
-                    'MSG_messenger',
-                    __(
-                        'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
-                        'event_espresso'
-                    ),
-                    false,
-                    'email'
-                ),
-                'MSG_message_type'   => new EE_Plain_Text_Field(
-                    'MSG_message_type',
-                    __('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
-                    false,
-                    'receipt'
-                ),
-                'MSG_context'        => new EE_Plain_Text_Field('MSG_context', __('Context', 'event_espresso'), false),
-                'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
-                    'MSG_recipient_ID',
-                    __('Recipient ID', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
-                    'MSG_recipient_type',
-                    __('Recipient Type', 'event_espresso'),
-                    true,
-                    null,
-                    array('Registration', 'Attendee', 'WP_User')
-                ),
-                'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_content',
-                    __('Content', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_to',
-                    __('Address To', 'event_espresso'),
-                    true
-                ),
-                'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_from',
-                    __('Address From', 'event_espresso'),
-                    true
-                ),
-                'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
-                    'MSG_subject',
-                    __('Subject', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'MSG_priority'       => new EE_Enum_Integer_Field(
-                    'MSG_priority',
-                    __('Priority', 'event_espresso'),
-                    false,
-                    self::priority_low,
-                    $allowed_priority
-                ),
-                'STS_ID'             => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    __('Status', 'event_espresso'),
-                    false,
-                    self::status_incomplete,
-                    'Status'
-                ),
-                'MSG_created'        => new EE_Datetime_Field(
-                    'MSG_created',
-                    __('Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'MSG_modified'       => new EE_Datetime_Field(
-                    'MSG_modified',
-                    __('Modified', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-            ),
-        );
-        $this->_model_relations = array(
-            'Attendee'               => new EE_Belongs_To_Any_Relation(),
-            'Registration'           => new EE_Belongs_To_Any_Relation(),
-            'WP_User'                => new EE_Belongs_To_Any_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-            'Transaction'            => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return \EE_Message
-     */
-    public function create_default_object()
-    {
-        /** @type EE_Message $message */
-        $message = parent::create_default_object();
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values
-     * @return \EE_Message
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        /** @type EE_Message $message */
-        $message = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($message instanceof EE_Message) {
-            return EE_Message_Factory::set_messenger_and_message_type($message);
-        }
-        return null;
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given attendee.
-     *
-     * @param EE_Attendee|int $attendee
-     * @param string          $message_type the message type slug
-     * @return boolean
-     */
-    public function message_sent_for_attendee($attendee, $message_type)
-    {
-        $attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
-        return $this->exists(array(
-            array(
-                'Attendee.ATT_ID'  => $attendee_ID,
-                'MSG_message_type' => $message_type,
-                'STS_ID'           => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns whether or not a message of that type was sent for a given registration
-     *
-     * @param EE_Registration|int $registration
-     * @param string              $message_type the message type slug
-     * @return boolean
-     */
-    public function message_sent_for_registration($registration, $message_type)
-    {
-        $registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
-        return $this->exists(array(
-            array(
-                'Registration.REG_ID' => $registrationID,
-                'MSG_message_type'    => $message_type,
-                'STS_ID'              => array('IN', $this->stati_indicating_sent()),
-            ),
-        ));
-    }
-
-
-    /**
-     * This retrieves an EE_Message object from the db matching the given token string.
-     *
-     * @param string $token
-     * @return EE_Message
-     */
-    public function get_one_by_token($token)
-    {
-        return $this->get_one(array(
-            array(
-                'MSG_token' => $token,
-            ),
-        ));
-    }
-
-
-    /**
-     * Returns stati that indicate the message HAS been sent
-     *
-     * @return array of strings for possible stati
-     */
-    public function stati_indicating_sent()
-    {
-        return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
-    }
-
-
-    /**
-     * Returns stati that indicate the message is waiting to be sent.
-     *
-     * @return array of strings for possible stati.
-     */
-    public function stati_indicating_to_send()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__stati_indicating_to_send',
-            array(self::status_idle, self::status_resend)
-        );
-    }
-
-
-    /**
-     * Returns stati that indicate the message has failed sending
-     *
-     * @return array  array of strings for possible stati.
-     */
-    public function stati_indicating_failed_sending()
-    {
-        $failed_stati = array(
-            self::status_failed,
-            self::status_retry,
-            self::status_messenger_executing,
-        );
-        // if WP_DEBUG is set, then let's include debug_only fails
-        if (WP_DEBUG) {
-            $failed_stati[] = self::status_debug_only;
-        }
-        return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
-    }
-
-
-    /**
-     * Returns filterable array of all EEM_Message statuses.
-     *
-     * @return array
-     */
-    public function all_statuses()
-    {
-        return apply_filters(
-            'FHEE__EEM_Message__all_statuses',
-            array(
-                EEM_Message::status_sent,
-                EEM_Message::status_incomplete,
-                EEM_Message::status_idle,
-                EEM_Message::status_resend,
-                EEM_Message::status_retry,
-                EEM_Message::status_failed,
-                EEM_Message::status_messenger_executing,
-                EEM_Message::status_debug_only,
-            )
-        );
-    }
-
-    /**
-     * Detects any specific query variables in the request and uses those to setup appropriate
-     * filter for any queries.
-     *
-     * @return array
-     */
-    public function filter_by_query_params()
-    {
-        // expected possible query_vars, the key in this array matches an expected key in the request,
-        // the value, matches the corresponding EEM_Base child reference.
-        $expected_vars   = $this->_expected_vars_for_query_inject();
-        $query_params[0] = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $request_value = EE_Registry::instance()->REQ->get($request_key);
-            if ($request_value) {
-                // special case
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
-                            'Transaction.Registration.REG_ID' => $request_value,
-                        );
-                        break;
-                    case 'EVT_ID':
-                        $query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
-                            'Transaction.Registration.EVT_ID' => $request_value,
-                        );
-                        break;
-                    default:
-                        $query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
-                        break;
-                }
-            }
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function get_pretty_label_for_results()
-    {
-        $expected_vars = $this->_expected_vars_for_query_inject();
-        $pretty_label  = '';
-        $label_parts   = array();
-        foreach ($expected_vars as $request_key => $model_name) {
-            $model = EE_Registry::instance()->load_model($model_name);
-            if ($model_field_value = EE_Registry::instance()->REQ->get($request_key)) {
-                switch ($request_key) {
-                    case '_REG_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Registration with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'ATT_ID':
-                        /** @var EE_Attendee $attendee */
-                        $attendee      = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $attendee instanceof EE_Attendee
-                            ? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
-                            : sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'ID':
-                        /** @var EE_WP_User $wpUser */
-                        $wpUser        = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $wpUser instanceof EE_WP_User
-                            ? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
-                            : sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                    case 'TXN_ID':
-                        $label_parts[] = sprintf(
-                            esc_html__('Transaction with the ID: %s', 'event_espresso'),
-                            $model_field_value
-                        );
-                        break;
-                    case 'EVT_ID':
-                        /** @var EE_Event $Event */
-                        $Event         = $model->get_one_by_ID($model_field_value);
-                        $label_parts[] = $Event instanceof EE_Event
-                            ? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
-                            : sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
-                        break;
-                }
-            }
-        }
-
-        if ($label_parts) {
-            // prepend to the last element of $label_parts an "and".
-            if (count($label_parts) > 1) {
-                $label_parts_index_to_prepend               = count($label_parts) - 1;
-                $label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
-            }
-
-            $pretty_label .= sprintf(
-                esc_html_x(
-                    'Showing messages for %s',
-                    'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
-                    'event_espresso'
-                ),
-                implode(', ', $label_parts)
-            );
-        }
-        return $pretty_label;
-    }
-
-
-    /**
-     * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
-     * The array is in the format:
-     * array(
-     *  {$field_name} => {$model_name}
-     * );
-     *
-     * @since 4.9.0
-     * @return array
-     */
-    protected function _expected_vars_for_query_inject()
-    {
-        return array(
-            '_REG_ID' => 'Registration',
-            'ATT_ID'  => 'Attendee',
-            'ID'      => 'WP_User',
-            'TXN_ID'  => 'Transaction',
-            'EVT_ID'  => 'Event',
-        );
-    }
-
-
-    /**
-     * This returns whether EEM_Message is in debug mode or not.
-     * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
-     * generating/sending messages. Debug mode can be set by either:
-     * 1. Sending in a value for the $set_debug argument
-     * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
-     * 3. Overriding the above via the provided filter.
-     *
-     * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
-     *                                  provided boolean. When no argument is provided (default null) then the debug
-     *                                  mode will be returned.
-     * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
-     */
-    public static function debug($set_debug = null)
-    {
-        static $is_debugging = null;
-
-        // initialize (use constant if set).
-        if (is_null($set_debug) && is_null($is_debugging)) {
-            $is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
-        }
-
-        if (! is_null($set_debug)) {
-            $is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
-        }
-
-        // return filtered value
-        return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
-    }
-
-
-    /**
-     * Deletes old messages meeting certain criteria for removal from the database.
-     * By default, this will delete messages that:
-     * - are older than the value of the delete_threshold in months.
-     * - have a STS_ID other than EEM_Message::status_idle
-     *
-     * @param int $delete_threshold  This integer will be used to set the boundary for what messages are deleted in months.
-     * @return bool|false|int Either the number of records affected or false if there was an error (you can call
-     *                         $wpdb->last_error to find out what the error was.
-     */
-    public function delete_old_messages($delete_threshold = 6)
-    {
-        $number_deleted = 0;
-        /**
-         * Allows code to change the boundary for what messages are kept.
-         * Uses the value of the `delete_threshold` variable by default.
-         *
-         * @param int $seconds seconds that will be subtracted from the timestamp for now.
-         * @return int
-         */
-        $time_to_leave_alone = absint(
-            apply_filters(
-                'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
-                ((int) $delete_threshold) * MONTH_IN_SECONDS
-            )
-        );
-
-
-        /**
-         * Allows code to change what message stati are ignored when deleting.
-         * Defaults to only ignore EEM_Message::status_idle messages.
-         *
-         * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
-         */
-        $message_stati_to_keep = (array) apply_filters(
-            'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
-            array(
-                EEM_Message::status_idle
-            )
-        );
-
-        // first get all the ids of messages being deleted
-        $message_ids_to_delete = EEM_Message::instance()->get_col(
-            array(
-                0 => array(
-                    'STS_ID' => array('NOT_IN', $message_stati_to_keep),
-                    'MSG_modified' => array('<', time() - $time_to_leave_alone)
-                ),
-                'limit' => apply_filters(
-                    'EEM_Message__delete_old_messages__limit',
-                    2000,
-                    $delete_threshold
-                )
-            )
-        );
-
-        if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
-            global $wpdb;
-            $number_deleted = $wpdb->query('
+	/**
+	 * This priority indicates a message should be generated and sent ASAP
+	 *
+	 * @type int
+	 */
+	const priority_high = 10;
+
+
+	/**
+	 * This priority indicates a message should be generated ASAP and queued for sending.
+	 *
+	 * @type
+	 */
+	const priority_medium = 20;
+
+
+	/**
+	 * This priority indicates a message should be queued for generating.
+	 *
+	 * @type int
+	 */
+	const priority_low = 30;
+
+
+	/**
+	 * indicates this message was sent at the time modified
+	 */
+	const status_sent = 'MSN';
+
+
+	/**
+	 * indicates this message is waiting to be sent
+	 */
+	const status_idle = 'MID';
+
+
+	/**
+	 * indicates an attempt was a made to send this message
+	 * at the scheduled time, but it failed at the time modified.  This differs from MDO status in that it will ALWAYS
+	 * appear to the end user.
+	 */
+	const status_failed = 'MFL';
+
+
+	/**
+	 * indicates the message has been flagged for resending (at the time modified).
+	 */
+	const status_resend = 'MRS';
+
+
+	/**
+	 * indicates the message has been flagged for generation but has not been generated yet.  Messages always start as
+	 * this status when added to the queue.
+	 */
+	const status_incomplete = 'MIC';
+
+
+	/**
+	 * Indicates everything was generated fine for the message, however, the messenger was unable to send.
+	 * This status means that its possible to retry sending the message.
+	 */
+	const status_retry = 'MRT';
+
+
+	/**
+	 * This is used for more informational messages that may not indicate anything is broken but still cannot be
+	 * generated or sent correctly. An example of a message that would get flagged this way would be when a not
+	 * approved message was queued for generation, but at time of generation, the attached registration(s) are
+	 * approved. So the message queued for generation is no longer valid.  Messages for this status will only persist
+	 * in the db and be viewable in the message activity list table when the messages system is in debug mode.
+	 *
+	 * @see EEM_Message::debug()
+	 */
+	const status_debug_only = 'MDO';
+
+
+	/**
+	 * This status is given to messages it is processed by the messenger send method.
+	 * Messages with this status should rarely be seen in the Message List table, but if they are, that's usually
+	 * indicative of a PHP timeout or memory limit issue.
+	 */
+	const status_messenger_executing = 'MEX';
+
+
+	/**
+	 *    Private constructor to prevent direct creation.
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                         any incoming timezone data that gets saved).  Note this just sends the timezone info to
+	 *                         the date time model field objects.  Default is null (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 * @return EEM_Message
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = __('Message', 'event_espresso');
+		$this->plural_item   = __('Messages', 'event_espresso');
+
+		// used for token generator
+		EE_Registry::instance()->load_helper('URL');
+
+		$this->_tables = array(
+			'Message' => new EE_Primary_Table('esp_message', 'MSG_ID'),
+		);
+
+		$allowed_priority = array(
+			self::priority_high   => __('high', 'event_espresso'),
+			self::priority_medium => __('medium', 'event_espresso'),
+			self::priority_low    => __('low', 'event_espresso'),
+		);
+
+		$this->_fields          = array(
+			'Message' => array(
+				'MSG_ID'             => new EE_Primary_Key_Int_Field('MSG_ID', __('Message ID', 'event_espresso')),
+				'MSG_token'          => new EE_Plain_Text_Field(
+					'MSG_token',
+					__(
+						'Unique Token used to represent this row in publicly viewable contexts (eg. a url).',
+						'event_espresso'
+					),
+					false,
+					EEH_URL::generate_unique_token()
+				),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					__('Foreign key to the EEM_Message_Template_Group table.', 'event_espresso'),
+					true,
+					0,
+					'Message_Template_Group'
+				),
+				'TXN_ID'             => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					__(
+						'Foreign key to the related EE_Transaction.  This is required to give context for regenerating the specific message',
+						'event_espresso'
+					),
+					true,
+					0,
+					'Transaction'
+				),
+				'MSG_messenger'      => new EE_Plain_Text_Field(
+					'MSG_messenger',
+					__(
+						'Corresponds to the EE_messenger::name used to send this message. This will also be used to attempt any resending of the message.',
+						'event_espresso'
+					),
+					false,
+					'email'
+				),
+				'MSG_message_type'   => new EE_Plain_Text_Field(
+					'MSG_message_type',
+					__('Corresponds to the EE_message_type::name used to generate this message.', 'event_espresso'),
+					false,
+					'receipt'
+				),
+				'MSG_context'        => new EE_Plain_Text_Field('MSG_context', __('Context', 'event_espresso'), false),
+				'MSG_recipient_ID'   => new EE_Foreign_Key_Int_Field(
+					'MSG_recipient_ID',
+					__('Recipient ID', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_recipient_type' => new EE_Any_Foreign_Model_Name_Field(
+					'MSG_recipient_type',
+					__('Recipient Type', 'event_espresso'),
+					true,
+					null,
+					array('Registration', 'Attendee', 'WP_User')
+				),
+				'MSG_content'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_content',
+					__('Content', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_to'             => new EE_Maybe_Serialized_Text_Field(
+					'MSG_to',
+					__('Address To', 'event_espresso'),
+					true
+				),
+				'MSG_from'           => new EE_Maybe_Serialized_Text_Field(
+					'MSG_from',
+					__('Address From', 'event_espresso'),
+					true
+				),
+				'MSG_subject'        => new EE_Maybe_Serialized_Text_Field(
+					'MSG_subject',
+					__('Subject', 'event_espresso'),
+					true,
+					''
+				),
+				'MSG_priority'       => new EE_Enum_Integer_Field(
+					'MSG_priority',
+					__('Priority', 'event_espresso'),
+					false,
+					self::priority_low,
+					$allowed_priority
+				),
+				'STS_ID'             => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					__('Status', 'event_espresso'),
+					false,
+					self::status_incomplete,
+					'Status'
+				),
+				'MSG_created'        => new EE_Datetime_Field(
+					'MSG_created',
+					__('Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'MSG_modified'       => new EE_Datetime_Field(
+					'MSG_modified',
+					__('Modified', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+			),
+		);
+		$this->_model_relations = array(
+			'Attendee'               => new EE_Belongs_To_Any_Relation(),
+			'Registration'           => new EE_Belongs_To_Any_Relation(),
+			'WP_User'                => new EE_Belongs_To_Any_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+			'Transaction'            => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return \EE_Message
+	 */
+	public function create_default_object()
+	{
+		/** @type EE_Message $message */
+		$message = parent::create_default_object();
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values
+	 * @return \EE_Message
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		/** @type EE_Message $message */
+		$message = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($message instanceof EE_Message) {
+			return EE_Message_Factory::set_messenger_and_message_type($message);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given attendee.
+	 *
+	 * @param EE_Attendee|int $attendee
+	 * @param string          $message_type the message type slug
+	 * @return boolean
+	 */
+	public function message_sent_for_attendee($attendee, $message_type)
+	{
+		$attendee_ID = EEM_Attendee::instance()->ensure_is_ID($attendee);
+		return $this->exists(array(
+			array(
+				'Attendee.ATT_ID'  => $attendee_ID,
+				'MSG_message_type' => $message_type,
+				'STS_ID'           => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * Returns whether or not a message of that type was sent for a given registration
+	 *
+	 * @param EE_Registration|int $registration
+	 * @param string              $message_type the message type slug
+	 * @return boolean
+	 */
+	public function message_sent_for_registration($registration, $message_type)
+	{
+		$registrationID = EEM_Registration::instance()->ensure_is_ID($registration);
+		return $this->exists(array(
+			array(
+				'Registration.REG_ID' => $registrationID,
+				'MSG_message_type'    => $message_type,
+				'STS_ID'              => array('IN', $this->stati_indicating_sent()),
+			),
+		));
+	}
+
+
+	/**
+	 * This retrieves an EE_Message object from the db matching the given token string.
+	 *
+	 * @param string $token
+	 * @return EE_Message
+	 */
+	public function get_one_by_token($token)
+	{
+		return $this->get_one(array(
+			array(
+				'MSG_token' => $token,
+			),
+		));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message HAS been sent
+	 *
+	 * @return array of strings for possible stati
+	 */
+	public function stati_indicating_sent()
+	{
+		return apply_filters('FHEE__EEM_Message__stati_indicating_sent', array(self::status_sent));
+	}
+
+
+	/**
+	 * Returns stati that indicate the message is waiting to be sent.
+	 *
+	 * @return array of strings for possible stati.
+	 */
+	public function stati_indicating_to_send()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__stati_indicating_to_send',
+			array(self::status_idle, self::status_resend)
+		);
+	}
+
+
+	/**
+	 * Returns stati that indicate the message has failed sending
+	 *
+	 * @return array  array of strings for possible stati.
+	 */
+	public function stati_indicating_failed_sending()
+	{
+		$failed_stati = array(
+			self::status_failed,
+			self::status_retry,
+			self::status_messenger_executing,
+		);
+		// if WP_DEBUG is set, then let's include debug_only fails
+		if (WP_DEBUG) {
+			$failed_stati[] = self::status_debug_only;
+		}
+		return apply_filters('FHEE__EEM_Message__stati_indicating_failed_sending', $failed_stati);
+	}
+
+
+	/**
+	 * Returns filterable array of all EEM_Message statuses.
+	 *
+	 * @return array
+	 */
+	public function all_statuses()
+	{
+		return apply_filters(
+			'FHEE__EEM_Message__all_statuses',
+			array(
+				EEM_Message::status_sent,
+				EEM_Message::status_incomplete,
+				EEM_Message::status_idle,
+				EEM_Message::status_resend,
+				EEM_Message::status_retry,
+				EEM_Message::status_failed,
+				EEM_Message::status_messenger_executing,
+				EEM_Message::status_debug_only,
+			)
+		);
+	}
+
+	/**
+	 * Detects any specific query variables in the request and uses those to setup appropriate
+	 * filter for any queries.
+	 *
+	 * @return array
+	 */
+	public function filter_by_query_params()
+	{
+		// expected possible query_vars, the key in this array matches an expected key in the request,
+		// the value, matches the corresponding EEM_Base child reference.
+		$expected_vars   = $this->_expected_vars_for_query_inject();
+		$query_params[0] = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$request_value = EE_Registry::instance()->REQ->get($request_key);
+			if ($request_value) {
+				// special case
+				switch ($request_key) {
+					case '_REG_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_REG_ID'] = array(
+							'Transaction.Registration.REG_ID' => $request_value,
+						);
+						break;
+					case 'EVT_ID':
+						$query_params[0]['AND**filter_by']['OR**filter_by_EVT_ID'] = array(
+							'Transaction.Registration.EVT_ID' => $request_value,
+						);
+						break;
+					default:
+						$query_params[0]['AND**filter_by'][ 'OR**filter_by_' . $request_key ][ $model_name . '.' . $request_key ] = $request_value;
+						break;
+				}
+			}
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function get_pretty_label_for_results()
+	{
+		$expected_vars = $this->_expected_vars_for_query_inject();
+		$pretty_label  = '';
+		$label_parts   = array();
+		foreach ($expected_vars as $request_key => $model_name) {
+			$model = EE_Registry::instance()->load_model($model_name);
+			if ($model_field_value = EE_Registry::instance()->REQ->get($request_key)) {
+				switch ($request_key) {
+					case '_REG_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Registration with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'ATT_ID':
+						/** @var EE_Attendee $attendee */
+						$attendee      = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $attendee instanceof EE_Attendee
+							? sprintf(esc_html__('Attendee %s', 'event_espresso'), $attendee->full_name())
+							: sprintf(esc_html__('Attendee ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'ID':
+						/** @var EE_WP_User $wpUser */
+						$wpUser        = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $wpUser instanceof EE_WP_User
+							? sprintf(esc_html__('WP User: %s', 'event_espresso'), $wpUser->name())
+							: sprintf(esc_html__('WP User ID: %s', 'event_espresso'), $model_field_value);
+						break;
+					case 'TXN_ID':
+						$label_parts[] = sprintf(
+							esc_html__('Transaction with the ID: %s', 'event_espresso'),
+							$model_field_value
+						);
+						break;
+					case 'EVT_ID':
+						/** @var EE_Event $Event */
+						$Event         = $model->get_one_by_ID($model_field_value);
+						$label_parts[] = $Event instanceof EE_Event
+							? sprintf(esc_html__('for the Event: %s', 'event_espresso'), $Event->name())
+							: sprintf(esc_html__('for the Event with ID: %s', 'event_espresso'), $model_field_value);
+						break;
+				}
+			}
+		}
+
+		if ($label_parts) {
+			// prepend to the last element of $label_parts an "and".
+			if (count($label_parts) > 1) {
+				$label_parts_index_to_prepend               = count($label_parts) - 1;
+				$label_parts[ $label_parts_index_to_prepend ] = 'and' . $label_parts[ $label_parts_index_to_prepend ];
+			}
+
+			$pretty_label .= sprintf(
+				esc_html_x(
+					'Showing messages for %s',
+					'A label for the messages returned in a query that are filtered by items in the query. This could be Transaction, Event, Attendee, Registration, or WP_User.',
+					'event_espresso'
+				),
+				implode(', ', $label_parts)
+			);
+		}
+		return $pretty_label;
+	}
+
+
+	/**
+	 * This returns the array of expected variables for the EEI_Query_Filter methods being implemented
+	 * The array is in the format:
+	 * array(
+	 *  {$field_name} => {$model_name}
+	 * );
+	 *
+	 * @since 4.9.0
+	 * @return array
+	 */
+	protected function _expected_vars_for_query_inject()
+	{
+		return array(
+			'_REG_ID' => 'Registration',
+			'ATT_ID'  => 'Attendee',
+			'ID'      => 'WP_User',
+			'TXN_ID'  => 'Transaction',
+			'EVT_ID'  => 'Event',
+		);
+	}
+
+
+	/**
+	 * This returns whether EEM_Message is in debug mode or not.
+	 * Currently "debug mode" is used to control the handling of the EEM_Message::debug_only status when
+	 * generating/sending messages. Debug mode can be set by either:
+	 * 1. Sending in a value for the $set_debug argument
+	 * 2. Defining `EE_DEBUG_MESSAGES` constant in wp-config.php
+	 * 3. Overriding the above via the provided filter.
+	 *
+	 * @param bool|null $set_debug      If provided, then the debug mode will be set internally until reset via the
+	 *                                  provided boolean. When no argument is provided (default null) then the debug
+	 *                                  mode will be returned.
+	 * @return bool         true means Messages is in debug mode.  false means messages system is not in debug mode.
+	 */
+	public static function debug($set_debug = null)
+	{
+		static $is_debugging = null;
+
+		// initialize (use constant if set).
+		if (is_null($set_debug) && is_null($is_debugging)) {
+			$is_debugging = defined('EE_DEBUG_MESSAGES') && EE_DEBUG_MESSAGES;
+		}
+
+		if (! is_null($set_debug)) {
+			$is_debugging = filter_var($set_debug, FILTER_VALIDATE_BOOLEAN);
+		}
+
+		// return filtered value
+		return apply_filters('FHEE__EEM_Message__debug', $is_debugging);
+	}
+
+
+	/**
+	 * Deletes old messages meeting certain criteria for removal from the database.
+	 * By default, this will delete messages that:
+	 * - are older than the value of the delete_threshold in months.
+	 * - have a STS_ID other than EEM_Message::status_idle
+	 *
+	 * @param int $delete_threshold  This integer will be used to set the boundary for what messages are deleted in months.
+	 * @return bool|false|int Either the number of records affected or false if there was an error (you can call
+	 *                         $wpdb->last_error to find out what the error was.
+	 */
+	public function delete_old_messages($delete_threshold = 6)
+	{
+		$number_deleted = 0;
+		/**
+		 * Allows code to change the boundary for what messages are kept.
+		 * Uses the value of the `delete_threshold` variable by default.
+		 *
+		 * @param int $seconds seconds that will be subtracted from the timestamp for now.
+		 * @return int
+		 */
+		$time_to_leave_alone = absint(
+			apply_filters(
+				'FHEE__EEM_Message__delete_old_messages__time_to_leave_alone',
+				((int) $delete_threshold) * MONTH_IN_SECONDS
+			)
+		);
+
+
+		/**
+		 * Allows code to change what message stati are ignored when deleting.
+		 * Defaults to only ignore EEM_Message::status_idle messages.
+		 *
+		 * @param string $message_stati_to_keep  An array of message statuses that will be ignored when deleting.
+		 */
+		$message_stati_to_keep = (array) apply_filters(
+			'FHEE__EEM_Message__delete_old_messages__message_stati_to_keep',
+			array(
+				EEM_Message::status_idle
+			)
+		);
+
+		// first get all the ids of messages being deleted
+		$message_ids_to_delete = EEM_Message::instance()->get_col(
+			array(
+				0 => array(
+					'STS_ID' => array('NOT_IN', $message_stati_to_keep),
+					'MSG_modified' => array('<', time() - $time_to_leave_alone)
+				),
+				'limit' => apply_filters(
+					'EEM_Message__delete_old_messages__limit',
+					2000,
+					$delete_threshold
+				)
+			)
+		);
+
+		if (! empty($message_ids_to_delete) && is_array($message_ids_to_delete)) {
+			global $wpdb;
+			$number_deleted = $wpdb->query('
                 DELETE
                 FROM ' . $this->table() . '
                 WHERE
                     MSG_ID IN (' . implode(",", $message_ids_to_delete) . ')
             ');
-        }
-
-        /**
-         * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
-         * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
-         * below.
-         */
-        if ($number_deleted !== false) {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
-        } else {
-            do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
-        }
-        return $number_deleted;
-    }
+		}
+
+		/**
+		 * This will get called if the number of records deleted 0 or greater.  So a successful deletion is one where
+		 * there were no errors.  An unsuccessful deletion is where there were errors.  Keep that in mind for the actions
+		 * below.
+		 */
+		if ($number_deleted !== false) {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_successful_deletion', $message_ids_to_delete, $number_deleted);
+		} else {
+			do_action('AHEE__EEM_Message__delete_old_messages__after_deletion_fail', $message_ids_to_delete, $number_deleted);
+		}
+		return $number_deleted;
+	}
 }

core/db_models/EEM_Transaction.model.php

Indentation +452 added lines, -452 removed lines

@@ -16,230 +16,230 @@ 
 class EEM_Transaction extends EEM_Base
 {
 
-    // private instance of the Transaction object
-    protected static $_instance;
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction is complete,
-     * but payment is pending. This is the state for transactions where payment is promised
-     * from an offline gateway.
-     */
-    //  const open_status_code = 'TPN';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction failed,
-     * either due to a technical reason (server or computer crash during registration),
-     *  or some other reason that prevent the collection of any useful contact information from any of the registrants
-     */
-    const failed_status_code = 'TFL';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate the transaction was abandoned,
-     * either due to a technical reason (server or computer crash during registration),
-     * or due to an abandoned cart after registrant chose not to complete the registration process
-     * HOWEVER...
-     * an abandoned TXN differs from a failed TXN in that it was able to capture contact information for at least one
-     * registrant
-     */
-    const abandoned_status_code = 'TAB';
-
-    /**
-     * Status ID(STS_ID on esp_status table) to indicate an incomplete transaction,
-     * meaning that monies are still owing: TXN_paid < TXN_total
-     */
-    const incomplete_status_code = 'TIN';
-
-    /**
-     * Status ID (STS_ID on esp_status table) to indicate a complete transaction.
-     * meaning that NO monies are owing: TXN_paid == TXN_total
-     */
-    const complete_status_code = 'TCM';
-
-    /**
-     *  Status ID(STS_ID on esp_status table) to indicate the transaction is overpaid.
-     *  This is the same as complete, but site admins actually owe clients the moneys!  TXN_paid > TXN_total
-     */
-    const overpaid_status_code = 'TOP';
-
-
-    /**
-     *    private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access protected
-     *
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
-     *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
-     *                         date time model field objects.  Default is NULL (and will be assumed using the set
-     *                         timezone in the 'timezone_string' wp option)
-     *
-     * @return EEM_Transaction
-     * @throws \EE_Error
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = __('Transaction', 'event_espresso');
-        $this->plural_item   = __('Transactions', 'event_espresso');
-
-        $this->_tables                 = array(
-            'TransactionTable' => new EE_Primary_Table('esp_transaction', 'TXN_ID')
-        );
-        $this->_fields                 = array(
-            'TransactionTable' => array(
-                'TXN_ID'           => new EE_Primary_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso')),
-                'TXN_timestamp'    => new EE_Datetime_Field(
-                    'TXN_timestamp',
-                    __('date when transaction was created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'TXN_total'        => new EE_Money_Field(
-                    'TXN_total',
-                    __('Total value of Transaction', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TXN_paid'         => new EE_Money_Field(
-                    'TXN_paid',
-                    __('Amount paid towards transaction to date', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'STS_ID'           => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    __('Status ID', 'event_espresso'),
-                    false,
-                    EEM_Transaction::failed_status_code,
-                    'Status'
-                ),
-                'TXN_session_data' => new EE_Serialized_Text_Field(
-                    'TXN_session_data',
-                    __('Serialized session data', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'TXN_hash_salt'    => new EE_Plain_Text_Field(
-                    'TXN_hash_salt',
-                    __('Transaction Hash Salt', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'PMD_ID'           => new EE_Foreign_Key_Int_Field(
-                    'PMD_ID',
-                    __("Last Used Payment Method", 'event_espresso'),
-                    true,
-                    null,
-                    'Payment_Method'
-                ),
-                'TXN_reg_steps'    => new EE_Serialized_Text_Field(
-                    'TXN_reg_steps',
-                    __('Registration Steps', 'event_espresso'),
-                    false,
-                    array()
-                ),
-            )
-        );
-        $this->_model_relations        = array(
-            'Registration'   => new EE_Has_Many_Relation(),
-            'Payment'        => new EE_Has_Many_Relation(),
-            'Status'         => new EE_Belongs_To_Relation(),
-            'Line_Item'      => new EE_Has_Many_Relation(false),
-            // you can delete a transaction without needing to delete its line items
-            'Payment_Method' => new EE_Belongs_To_Relation(),
-            'Message'        => new EE_Has_Many_Relation()
-        );
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     *    txn_status_array
-     * get list of transaction statuses
-     *
-     * @access public
-     * @return array
-     */
-    public static function txn_status_array()
-    {
-        return apply_filters(
-            'FHEE__EEM_Transaction__txn_status_array',
-            array(
-                EEM_Transaction::overpaid_status_code,
-                EEM_Transaction::complete_status_code,
-                EEM_Transaction::incomplete_status_code,
-                EEM_Transaction::abandoned_status_code,
-                EEM_Transaction::failed_status_code,
-            )
-        );
-    }
-
-    /**
-     *        get the revenue per day  for the Transaction Admin page Reports Tab
-     *
-     * @access        public
-     *
-     * @param string $period
-     *
-     * @return \stdClass[]
-     */
-    public function get_revenue_per_day_report($period = '-1 month')
-    {
-        $sql_date = $this->convert_datetime_for_query(
-            'TXN_timestamp',
-            date('Y-m-d H:i:s', strtotime($period)),
-            'Y-m-d H:i:s',
-            'UTC'
-        );
-
-        $query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'TXN_timestamp');
-
-        return $this->_get_all_wpdb_results(
-            array(
-                array(
-                    'TXN_timestamp' => array('>=', $sql_date)
-                ),
-                'group_by' => 'txnDate',
-                'order_by' => array('TXN_timestamp' => 'ASC')
-            ),
-            OBJECT,
-            array(
-                'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
-                'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
-            )
-        );
-    }
-
-
-    /**
-     *        get the revenue per event  for the Transaction Admin page Reports Tab
-     *
-     * @access        public
-     *
-     * @param string $period
-     *
-     * @throws \EE_Error
-     * @return mixed
-     */
-    public function get_revenue_per_event_report($period = '-1 month')
-    {
-        global $wpdb;
-        $transaction_table          = $wpdb->prefix . 'esp_transaction';
-        $registration_table         = $wpdb->prefix . 'esp_registration';
-        $registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
-        $event_table                = $wpdb->posts;
-        $payment_table              = $wpdb->prefix . 'esp_payment';
-        $sql_date                   = date('Y-m-d H:i:s', strtotime($period));
-        $approved_payment_status    = EEM_Payment::status_id_approved;
-        $extra_event_on_join        = '';
-        // exclude events not authored by user if permissions in effect
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
-        }
-
-        return $wpdb->get_results(
-            "SELECT
+	// private instance of the Transaction object
+	protected static $_instance;
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction is complete,
+	 * but payment is pending. This is the state for transactions where payment is promised
+	 * from an offline gateway.
+	 */
+	//  const open_status_code = 'TPN';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction failed,
+	 * either due to a technical reason (server or computer crash during registration),
+	 *  or some other reason that prevent the collection of any useful contact information from any of the registrants
+	 */
+	const failed_status_code = 'TFL';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate the transaction was abandoned,
+	 * either due to a technical reason (server or computer crash during registration),
+	 * or due to an abandoned cart after registrant chose not to complete the registration process
+	 * HOWEVER...
+	 * an abandoned TXN differs from a failed TXN in that it was able to capture contact information for at least one
+	 * registrant
+	 */
+	const abandoned_status_code = 'TAB';
+
+	/**
+	 * Status ID(STS_ID on esp_status table) to indicate an incomplete transaction,
+	 * meaning that monies are still owing: TXN_paid < TXN_total
+	 */
+	const incomplete_status_code = 'TIN';
+
+	/**
+	 * Status ID (STS_ID on esp_status table) to indicate a complete transaction.
+	 * meaning that NO monies are owing: TXN_paid == TXN_total
+	 */
+	const complete_status_code = 'TCM';
+
+	/**
+	 *  Status ID(STS_ID on esp_status table) to indicate the transaction is overpaid.
+	 *  This is the same as complete, but site admins actually owe clients the moneys!  TXN_paid > TXN_total
+	 */
+	const overpaid_status_code = 'TOP';
+
+
+	/**
+	 *    private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access protected
+	 *
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings (and any
+	 *                         incoming timezone data that gets saved). Note this just sends the timezone info to the
+	 *                         date time model field objects.  Default is NULL (and will be assumed using the set
+	 *                         timezone in the 'timezone_string' wp option)
+	 *
+	 * @return EEM_Transaction
+	 * @throws \EE_Error
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = __('Transaction', 'event_espresso');
+		$this->plural_item   = __('Transactions', 'event_espresso');
+
+		$this->_tables                 = array(
+			'TransactionTable' => new EE_Primary_Table('esp_transaction', 'TXN_ID')
+		);
+		$this->_fields                 = array(
+			'TransactionTable' => array(
+				'TXN_ID'           => new EE_Primary_Key_Int_Field('TXN_ID', __('Transaction ID', 'event_espresso')),
+				'TXN_timestamp'    => new EE_Datetime_Field(
+					'TXN_timestamp',
+					__('date when transaction was created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'TXN_total'        => new EE_Money_Field(
+					'TXN_total',
+					__('Total value of Transaction', 'event_espresso'),
+					false,
+					0
+				),
+				'TXN_paid'         => new EE_Money_Field(
+					'TXN_paid',
+					__('Amount paid towards transaction to date', 'event_espresso'),
+					false,
+					0
+				),
+				'STS_ID'           => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					__('Status ID', 'event_espresso'),
+					false,
+					EEM_Transaction::failed_status_code,
+					'Status'
+				),
+				'TXN_session_data' => new EE_Serialized_Text_Field(
+					'TXN_session_data',
+					__('Serialized session data', 'event_espresso'),
+					true,
+					''
+				),
+				'TXN_hash_salt'    => new EE_Plain_Text_Field(
+					'TXN_hash_salt',
+					__('Transaction Hash Salt', 'event_espresso'),
+					true,
+					''
+				),
+				'PMD_ID'           => new EE_Foreign_Key_Int_Field(
+					'PMD_ID',
+					__("Last Used Payment Method", 'event_espresso'),
+					true,
+					null,
+					'Payment_Method'
+				),
+				'TXN_reg_steps'    => new EE_Serialized_Text_Field(
+					'TXN_reg_steps',
+					__('Registration Steps', 'event_espresso'),
+					false,
+					array()
+				),
+			)
+		);
+		$this->_model_relations        = array(
+			'Registration'   => new EE_Has_Many_Relation(),
+			'Payment'        => new EE_Has_Many_Relation(),
+			'Status'         => new EE_Belongs_To_Relation(),
+			'Line_Item'      => new EE_Has_Many_Relation(false),
+			// you can delete a transaction without needing to delete its line items
+			'Payment_Method' => new EE_Belongs_To_Relation(),
+			'Message'        => new EE_Has_Many_Relation()
+		);
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 *    txn_status_array
+	 * get list of transaction statuses
+	 *
+	 * @access public
+	 * @return array
+	 */
+	public static function txn_status_array()
+	{
+		return apply_filters(
+			'FHEE__EEM_Transaction__txn_status_array',
+			array(
+				EEM_Transaction::overpaid_status_code,
+				EEM_Transaction::complete_status_code,
+				EEM_Transaction::incomplete_status_code,
+				EEM_Transaction::abandoned_status_code,
+				EEM_Transaction::failed_status_code,
+			)
+		);
+	}
+
+	/**
+	 *        get the revenue per day  for the Transaction Admin page Reports Tab
+	 *
+	 * @access        public
+	 *
+	 * @param string $period
+	 *
+	 * @return \stdClass[]
+	 */
+	public function get_revenue_per_day_report($period = '-1 month')
+	{
+		$sql_date = $this->convert_datetime_for_query(
+			'TXN_timestamp',
+			date('Y-m-d H:i:s', strtotime($period)),
+			'Y-m-d H:i:s',
+			'UTC'
+		);
+
+		$query_interval = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(), 'TXN_timestamp');
+
+		return $this->_get_all_wpdb_results(
+			array(
+				array(
+					'TXN_timestamp' => array('>=', $sql_date)
+				),
+				'group_by' => 'txnDate',
+				'order_by' => array('TXN_timestamp' => 'ASC')
+			),
+			OBJECT,
+			array(
+				'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
+				'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
+			)
+		);
+	}
+
+
+	/**
+	 *        get the revenue per event  for the Transaction Admin page Reports Tab
+	 *
+	 * @access        public
+	 *
+	 * @param string $period
+	 *
+	 * @throws \EE_Error
+	 * @return mixed
+	 */
+	public function get_revenue_per_event_report($period = '-1 month')
+	{
+		global $wpdb;
+		$transaction_table          = $wpdb->prefix . 'esp_transaction';
+		$registration_table         = $wpdb->prefix . 'esp_registration';
+		$registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+		$event_table                = $wpdb->posts;
+		$payment_table              = $wpdb->prefix . 'esp_payment';
+		$sql_date                   = date('Y-m-d H:i:s', strtotime($period));
+		$approved_payment_status    = EEM_Payment::status_id_approved;
+		$extra_event_on_join        = '';
+		// exclude events not authored by user if permissions in effect
+		if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+			$extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+		}
+
+		return $wpdb->get_results(
+			"SELECT
 			Transaction_Event.event_name AS event_name,
 			SUM(Transaction_Event.paid) AS revenue
 			FROM
@@ -267,233 +267,233 @@ 
 					$extra_event_on_join
 				) AS Transaction_Event
 			GROUP BY event_name",
-            OBJECT
-        );
-    }
-
-
-    /**
-     * Gets the current transaction given the reg_url_link, or assumes the reg_url_link is in the
-     * $_REQUEST global variable. Either way, tries to find the current transaction (through
-     * the registration pointed to by reg_url_link), if not returns null
-     *
-     * @param string $reg_url_link
-     *
-     * @return EE_Transaction
-     */
-    public function get_transaction_from_reg_url_link($reg_url_link = '')
-    {
-        return $this->get_one(array(
-            array(
-                'Registration.REG_url_link' => ! empty($reg_url_link) ? $reg_url_link : EE_Registry::instance()->REQ->get(
-                    'e_reg_url_link',
-                    ''
-                )
-            )
-        ));
-    }
-
-
-    /**
-     * Updates the provided EE_Transaction with all the applicable payments
-     * (or fetch the EE_Transaction from its ID)
-     *
-     * @deprecated
-     *
-     * @param EE_Transaction|int $transaction_obj_or_id
-     * @param boolean            $save_txn whether or not to save the transaction during this function call
-     *
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                __('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
-            ),
-            '4.6.0'
-        );
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-
-        return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-            $this->ensure_is_obj($transaction_obj_or_id)
-        );
-    }
-
-    /**
-     * Deletes "junk" transactions that were probably added by bots. There might be TONS
-     * of these, so we are very careful to NOT select (which the models do even when deleting),
-     * and so we only use wpdb directly and only do minimal joins.
-     * Transactions are considered "junk" if they're failed for longer than a week.
-     * Also, there is an extra check for payments related to the transaction, because if a transaction has a payment on
-     * it, it's probably not junk (regardless of what status it has).
-     * The downside to this approach is that is addons are listening for object deletions
-     * on EEM_Base::delete() they won't be notified of this.  However, there is an action that plugins can hook into
-     * to catch these types of deletions.
-     *
-     * @global WPDB $wpdb
-     * @return mixed
-     */
-    public function delete_junk_transactions()
-    {
-        /** @type WPDB $wpdb */
-        global $wpdb;
-        $deleted             = false;
-        $time_to_leave_alone = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__time_to_leave_alone',
-            WEEK_IN_SECONDS
-        );
-
-
-        /**
-         * This allows code to filter the query arguments used for retrieving the transaction IDs to delete.
-         * Useful for plugins that want to exclude transactions matching certain query parameters.
-         * The query parameters should be in the format accepted by the EEM_Base model queries.
-         */
-        $ids_query = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__initial_query_args',
-            array(
-                0 => array(
-                    'STS_ID'        => EEM_Transaction::failed_status_code,
-                    'Payment.PAY_ID' => array( 'IS NULL' ),
-                    'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
-                ),
-                'order_by' => ['TXN_timestamp' => 'ASC'],
-                'limit' => 1000
-            ),
-            $time_to_leave_alone
-        );
-
-
-        /**
-         * This filter is for when code needs to filter the list of transaction ids that represent transactions
-         * about to be deleted based on some other criteria that isn't easily done via the query args filter.
-         */
-        $txn_ids = apply_filters(
-            'FHEE__EEM_Transaction__delete_junk_transactions__transaction_ids_to_delete',
-            EEM_Transaction::instance()->get_col($ids_query, 'TXN_ID'),
-            $time_to_leave_alone
-        );
-        // now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
-            // first, make sure these TXN's are removed the "ee_locked_transactions" array
-            EEM_Transaction::unset_locked_transactions($txn_ids);
-
-            // Create IDs placeholder.
-            $placeholders = array_fill(0, count($txn_ids), '%d');
+			OBJECT
+		);
+	}
+
+
+	/**
+	 * Gets the current transaction given the reg_url_link, or assumes the reg_url_link is in the
+	 * $_REQUEST global variable. Either way, tries to find the current transaction (through
+	 * the registration pointed to by reg_url_link), if not returns null
+	 *
+	 * @param string $reg_url_link
+	 *
+	 * @return EE_Transaction
+	 */
+	public function get_transaction_from_reg_url_link($reg_url_link = '')
+	{
+		return $this->get_one(array(
+			array(
+				'Registration.REG_url_link' => ! empty($reg_url_link) ? $reg_url_link : EE_Registry::instance()->REQ->get(
+					'e_reg_url_link',
+					''
+				)
+			)
+		));
+	}
+
+
+	/**
+	 * Updates the provided EE_Transaction with all the applicable payments
+	 * (or fetch the EE_Transaction from its ID)
+	 *
+	 * @deprecated
+	 *
+	 * @param EE_Transaction|int $transaction_obj_or_id
+	 * @param boolean            $save_txn whether or not to save the transaction during this function call
+	 *
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
+			),
+			'4.6.0'
+		);
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+
+		return $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+			$this->ensure_is_obj($transaction_obj_or_id)
+		);
+	}
+
+	/**
+	 * Deletes "junk" transactions that were probably added by bots. There might be TONS
+	 * of these, so we are very careful to NOT select (which the models do even when deleting),
+	 * and so we only use wpdb directly and only do minimal joins.
+	 * Transactions are considered "junk" if they're failed for longer than a week.
+	 * Also, there is an extra check for payments related to the transaction, because if a transaction has a payment on
+	 * it, it's probably not junk (regardless of what status it has).
+	 * The downside to this approach is that is addons are listening for object deletions
+	 * on EEM_Base::delete() they won't be notified of this.  However, there is an action that plugins can hook into
+	 * to catch these types of deletions.
+	 *
+	 * @global WPDB $wpdb
+	 * @return mixed
+	 */
+	public function delete_junk_transactions()
+	{
+		/** @type WPDB $wpdb */
+		global $wpdb;
+		$deleted             = false;
+		$time_to_leave_alone = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__time_to_leave_alone',
+			WEEK_IN_SECONDS
+		);
+
+
+		/**
+		 * This allows code to filter the query arguments used for retrieving the transaction IDs to delete.
+		 * Useful for plugins that want to exclude transactions matching certain query parameters.
+		 * The query parameters should be in the format accepted by the EEM_Base model queries.
+		 */
+		$ids_query = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__initial_query_args',
+			array(
+				0 => array(
+					'STS_ID'        => EEM_Transaction::failed_status_code,
+					'Payment.PAY_ID' => array( 'IS NULL' ),
+					'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
+				),
+				'order_by' => ['TXN_timestamp' => 'ASC'],
+				'limit' => 1000
+			),
+			$time_to_leave_alone
+		);
+
+
+		/**
+		 * This filter is for when code needs to filter the list of transaction ids that represent transactions
+		 * about to be deleted based on some other criteria that isn't easily done via the query args filter.
+		 */
+		$txn_ids = apply_filters(
+			'FHEE__EEM_Transaction__delete_junk_transactions__transaction_ids_to_delete',
+			EEM_Transaction::instance()->get_col($ids_query, 'TXN_ID'),
+			$time_to_leave_alone
+		);
+		// now that we have the ids to delete
+		if (! empty($txn_ids) && is_array($txn_ids)) {
+			// first, make sure these TXN's are removed the "ee_locked_transactions" array
+			EEM_Transaction::unset_locked_transactions($txn_ids);
+
+			// Create IDs placeholder.
+			$placeholders = array_fill(0, count($txn_ids), '%d');
             
-            // Glue it together to use inside $wpdb->prepare.
-            $format = implode(', ', $placeholders);
-
-            // let's get deletin'...
-            // We got the ids from the original query to get them FROM
-            // the db (which is sanitized) so no need to prepare them again.
-            $query   = $wpdb->prepare("DELETE FROM " . $this->table() . " WHERE TXN_ID IN ( $format )", $txn_ids);
-            $deleted = $wpdb->query($query);
-        }
-        if ($deleted) {
-            /**
-             * Allows code to do something after the transactions have been deleted.
-             */
-            do_action('AHEE__EEM_Transaction__delete_junk_transactions__successful_deletion', $txn_ids);
-        }
-
-        return $deleted;
-    }
-
-
-    /**
-     * @param array $transaction_IDs
-     *
-     * @return bool
-     */
-    public static function unset_locked_transactions(array $transaction_IDs)
-    {
-        $locked_transactions = get_option('ee_locked_transactions', array());
-        $update              = false;
-        foreach ($transaction_IDs as $TXN_ID) {
-            if (isset($locked_transactions[ $TXN_ID ])) {
-                unset($locked_transactions[ $TXN_ID ]);
-                $update = true;
-            }
-        }
-        if ($update) {
-            update_option('ee_locked_transactions', $locked_transactions);
-        }
-
-        return $update;
-    }
-
-
-
-    /**
-     * returns an array of EE_Transaction objects whose timestamp is greater than
-     * the current time minus the session lifespan, which defaults to 60 minutes
-     *
-     * @return EE_Base_Class[]|EE_Transaction[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_transactions_in_progress()
-    {
-        return $this->_get_transactions_in_progress();
-    }
-
-
-
-    /**
-     * returns an array of EE_Transaction objects whose timestamp is less than
-     * the current time minus the session lifespan, which defaults to 60 minutes
-     *
-     * @return EE_Base_Class[]|EE_Transaction[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_transactions_not_in_progress()
-    {
-        return $this->_get_transactions_in_progress('<=');
-    }
-
-
-
-    /**
-     * @param string $comparison
-     * @return EE_Base_Class[]|EE_Transaction[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _get_transactions_in_progress($comparison = '>=')
-    {
-        $comparison = $comparison === '>=' || $comparison === '<='
-            ? $comparison
-            : '>=';
-        /** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
-        $session_lifespan = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\domain\values\session\SessionLifespan'
-        );
-        return $this->get_all(
-            array(
-                array(
-                    'TXN_timestamp' => array(
-                        $comparison,
-                        $session_lifespan->expiration()
-                    ),
-                    'STS_ID' => array(
-                        '!=',
-                        EEM_Transaction::complete_status_code
-                    ),
-                )
-            )
-        );
-    }
+			// Glue it together to use inside $wpdb->prepare.
+			$format = implode(', ', $placeholders);
+
+			// let's get deletin'...
+			// We got the ids from the original query to get them FROM
+			// the db (which is sanitized) so no need to prepare them again.
+			$query   = $wpdb->prepare("DELETE FROM " . $this->table() . " WHERE TXN_ID IN ( $format )", $txn_ids);
+			$deleted = $wpdb->query($query);
+		}
+		if ($deleted) {
+			/**
+			 * Allows code to do something after the transactions have been deleted.
+			 */
+			do_action('AHEE__EEM_Transaction__delete_junk_transactions__successful_deletion', $txn_ids);
+		}
+
+		return $deleted;
+	}
+
+
+	/**
+	 * @param array $transaction_IDs
+	 *
+	 * @return bool
+	 */
+	public static function unset_locked_transactions(array $transaction_IDs)
+	{
+		$locked_transactions = get_option('ee_locked_transactions', array());
+		$update              = false;
+		foreach ($transaction_IDs as $TXN_ID) {
+			if (isset($locked_transactions[ $TXN_ID ])) {
+				unset($locked_transactions[ $TXN_ID ]);
+				$update = true;
+			}
+		}
+		if ($update) {
+			update_option('ee_locked_transactions', $locked_transactions);
+		}
+
+		return $update;
+	}
+
+
+
+	/**
+	 * returns an array of EE_Transaction objects whose timestamp is greater than
+	 * the current time minus the session lifespan, which defaults to 60 minutes
+	 *
+	 * @return EE_Base_Class[]|EE_Transaction[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_transactions_in_progress()
+	{
+		return $this->_get_transactions_in_progress();
+	}
+
+
+
+	/**
+	 * returns an array of EE_Transaction objects whose timestamp is less than
+	 * the current time minus the session lifespan, which defaults to 60 minutes
+	 *
+	 * @return EE_Base_Class[]|EE_Transaction[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_transactions_not_in_progress()
+	{
+		return $this->_get_transactions_in_progress('<=');
+	}
+
+
+
+	/**
+	 * @param string $comparison
+	 * @return EE_Base_Class[]|EE_Transaction[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _get_transactions_in_progress($comparison = '>=')
+	{
+		$comparison = $comparison === '>=' || $comparison === '<='
+			? $comparison
+			: '>=';
+		/** @var EventEspresso\core\domain\values\session\SessionLifespan $session_lifespan */
+		$session_lifespan = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\domain\values\session\SessionLifespan'
+		);
+		return $this->get_all(
+			array(
+				array(
+					'TXN_timestamp' => array(
+						$comparison,
+						$session_lifespan->expiration()
+					),
+					'STS_ID' => array(
+						'!=',
+						EEM_Transaction::complete_status_code
+					),
+				)
+			)
+		);
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -140,7 +140,7 @@ 
                 ),
             )
         );
-        $this->_model_relations        = array(
+        $this->_model_relations = array(
             'Registration'   => new EE_Has_Many_Relation(),
             'Payment'        => new EE_Has_Many_Relation(),
             'Status'         => new EE_Belongs_To_Relation(),
@@ -205,7 +205,7 @@ 
             ),
             OBJECT,
             array(
-                'txnDate' => array('DATE(' . $query_interval . ')', '%s'),
+                'txnDate' => array('DATE('.$query_interval.')', '%s'),
                 'revenue' => array('SUM(TransactionTable.TXN_paid)', '%d')
             )
         );
@@ -225,17 +225,17 @@ 
     public function get_revenue_per_event_report($period = '-1 month')
     {
         global $wpdb;
-        $transaction_table          = $wpdb->prefix . 'esp_transaction';
-        $registration_table         = $wpdb->prefix . 'esp_registration';
-        $registration_payment_table = $wpdb->prefix . 'esp_registration_payment';
+        $transaction_table          = $wpdb->prefix.'esp_transaction';
+        $registration_table         = $wpdb->prefix.'esp_registration';
+        $registration_payment_table = $wpdb->prefix.'esp_registration_payment';
         $event_table                = $wpdb->posts;
-        $payment_table              = $wpdb->prefix . 'esp_payment';
+        $payment_table              = $wpdb->prefix.'esp_payment';
         $sql_date                   = date('Y-m-d H:i:s', strtotime($period));
         $approved_payment_status    = EEM_Payment::status_id_approved;
         $extra_event_on_join        = '';
         // exclude events not authored by user if permissions in effect
-        if (! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
-            $extra_event_on_join = ' AND Event.post_author = ' . get_current_user_id();
+        if ( ! EE_Registry::instance()->CAP->current_user_can('ee_read_others_registrations', 'reg_per_event_report')) {
+            $extra_event_on_join = ' AND Event.post_author = '.get_current_user_id();
         }
 
         return $wpdb->get_results(
@@ -309,7 +309,7 @@ 
     public function update_based_on_payments($transaction_obj_or_id, $save_txn = true)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 __('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()'
@@ -359,7 +359,7 @@ 
             array(
                 0 => array(
                     'STS_ID'        => EEM_Transaction::failed_status_code,
-                    'Payment.PAY_ID' => array( 'IS NULL' ),
+                    'Payment.PAY_ID' => array('IS NULL'),
                     'TXN_timestamp' => array('<', time() - $time_to_leave_alone)
                 ),
                 'order_by' => ['TXN_timestamp' => 'ASC'],
@@ -379,7 +379,7 @@ 
             $time_to_leave_alone
         );
         // now that we have the ids to delete
-        if (! empty($txn_ids) && is_array($txn_ids)) {
+        if ( ! empty($txn_ids) && is_array($txn_ids)) {
             // first, make sure these TXN's are removed the "ee_locked_transactions" array
             EEM_Transaction::unset_locked_transactions($txn_ids);
 
@@ -392,7 +392,7 @@ 
             // let's get deletin'...
             // We got the ids from the original query to get them FROM
             // the db (which is sanitized) so no need to prepare them again.
-            $query   = $wpdb->prepare("DELETE FROM " . $this->table() . " WHERE TXN_ID IN ( $format )", $txn_ids);
+            $query   = $wpdb->prepare("DELETE FROM ".$this->table()." WHERE TXN_ID IN ( $format )", $txn_ids);
             $deleted = $wpdb->query($query);
         }
         if ($deleted) {
@@ -416,8 +416,8 @@ 
         $locked_transactions = get_option('ee_locked_transactions', array());
         $update              = false;
         foreach ($transaction_IDs as $TXN_ID) {
-            if (isset($locked_transactions[ $TXN_ID ])) {
-                unset($locked_transactions[ $TXN_ID ]);
+            if (isset($locked_transactions[$TXN_ID])) {
+                unset($locked_transactions[$TXN_ID]);
                 $update = true;
             }
         }

caffeinated/admin/extend/registrations/Extend_Registrations_Admin_Page.core.php

Indentation +1210 added lines, -1210 removed lines

@@ -16,1267 +16,1267 @@
 {
 
 
-    /**
-     * This is used to hold the reports template data which is setup early in the request.
-     *
-     * @type array
-     */
-    protected $_reports_template_data = array();
+	/**
+	 * This is used to hold the reports template data which is setup early in the request.
+	 *
+	 * @type array
+	 */
+	protected $_reports_template_data = array();
 
 
-    /**
-     * Extend_Registrations_Admin_Page constructor.
-     *
-     * @param bool $routing
-     */
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-        if (! defined('REG_CAF_TEMPLATE_PATH')) {
-            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
-            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
-            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
-        }
-    }
+	/**
+	 * Extend_Registrations_Admin_Page constructor.
+	 *
+	 * @param bool $routing
+	 */
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+		if (! defined('REG_CAF_TEMPLATE_PATH')) {
+			define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
+			define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
+			define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
+		}
+	}
 
 
-    /**
-     * Extending page configuration.
-     */
-    protected function _extend_page_config()
-    {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
-        $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
-            ? $this->_req_data['_REG_ID']
-            : 0;
-        $new_page_routes = array(
-            'reports'                      => array(
-                'func'       => '_registration_reports',
-                'capability' => 'ee_read_registrations',
-            ),
-            'registration_checkins'        => array(
-                'func'       => '_registration_checkin_list_table',
-                'capability' => 'ee_read_checkins',
-            ),
-            'newsletter_selected_send'     => array(
-                'func'       => '_newsletter_selected_send',
-                'noheader'   => true,
-                'capability' => 'ee_send_message',
-            ),
-            'delete_checkin_rows'          => array(
-                'func'       => '_delete_checkin_rows',
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkins',
-            ),
-            'delete_checkin_row'           => array(
-                'func'       => '_delete_checkin_row',
-                'noheader'   => true,
-                'capability' => 'ee_delete_checkin',
-                'obj_id'     => $reg_id,
-            ),
-            'toggle_checkin_status'        => array(
-                'func'       => '_toggle_checkin_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_checkin',
-                'obj_id'     => $reg_id,
-            ),
-            'toggle_checkin_status_bulk'   => array(
-                'func'       => '_toggle_checkin_status',
-                'noheader'   => true,
-                'capability' => 'ee_edit_checkins',
-            ),
-            'event_registrations'          => array(
-                'func'       => '_event_registrations_list_table',
-                'capability' => 'ee_read_checkins',
-            ),
-            'registrations_checkin_report' => array(
-                'func'       => '_registrations_checkin_report',
-                'noheader'   => true,
-                'capability' => 'ee_read_registrations',
-            ),
-        );
-        $this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
-        $new_page_config = array(
-            'reports'               => array(
-                'nav'           => array(
-                    'label' => esc_html__('Reports', 'event_espresso'),
-                    'order' => 30,
-                ),
-                'help_tabs'     => array(
-                    'registrations_reports_help_tab' => array(
-                        'title'    => esc_html__('Registration Reports', 'event_espresso'),
-                        'filename' => 'registrations_reports',
-                    ),
-                ),
-                /*'help_tour' => array( 'Registration_Reports_Help_Tour' ),*/
-                'require_nonce' => false,
-            ),
-            'event_registrations'   => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Event Check-In', 'event_espresso'),
-                    'order'      => 10,
-                    'persistent' => true,
-                ),
-                'help_tabs'     => array(
-                    'registrations_event_checkin_help_tab'                       => array(
-                        'title'    => esc_html__('Registrations Event Check-In', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin',
-                    ),
-                    'registrations_event_checkin_table_column_headings_help_tab' => array(
-                        'title'    => esc_html__('Event Check-In Table Column Headings', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_table_column_headings',
-                    ),
-                    'registrations_event_checkin_filters_help_tab'               => array(
-                        'title'    => esc_html__('Event Check-In Filters', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_filters',
-                    ),
-                    'registrations_event_checkin_views_help_tab'                 => array(
-                        'title'    => esc_html__('Event Check-In Views', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_views',
-                    ),
-                    'registrations_event_checkin_other_help_tab'                 => array(
-                        'title'    => esc_html__('Event Check-In Other', 'event_espresso'),
-                        'filename' => 'registrations_event_checkin_other',
-                    ),
-                ),
-                'help_tour'     => array('Event_Checkin_Help_Tour'),
-                'qtips'         => array('Registration_List_Table_Tips'),
-                'list_table'    => 'EE_Event_Registrations_List_Table',
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-            'registration_checkins' => array(
-                'nav'           => array(
-                    'label'      => esc_html__('Check-In Records', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => '',
-                ),
-                'list_table'    => 'EE_Registration_CheckIn_List_Table',
-                // 'help_tour' => array( 'Checkin_Toggle_View_Help_Tour' ),
-                'metaboxes'     => array(),
-                'require_nonce' => false,
-            ),
-        );
-        $this->_page_config = array_merge($this->_page_config, $new_page_config);
-        $this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table';
-        $this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table';
-    }
+	/**
+	 * Extending page configuration.
+	 */
+	protected function _extend_page_config()
+	{
+		$this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
+		$reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
+			? $this->_req_data['_REG_ID']
+			: 0;
+		$new_page_routes = array(
+			'reports'                      => array(
+				'func'       => '_registration_reports',
+				'capability' => 'ee_read_registrations',
+			),
+			'registration_checkins'        => array(
+				'func'       => '_registration_checkin_list_table',
+				'capability' => 'ee_read_checkins',
+			),
+			'newsletter_selected_send'     => array(
+				'func'       => '_newsletter_selected_send',
+				'noheader'   => true,
+				'capability' => 'ee_send_message',
+			),
+			'delete_checkin_rows'          => array(
+				'func'       => '_delete_checkin_rows',
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkins',
+			),
+			'delete_checkin_row'           => array(
+				'func'       => '_delete_checkin_row',
+				'noheader'   => true,
+				'capability' => 'ee_delete_checkin',
+				'obj_id'     => $reg_id,
+			),
+			'toggle_checkin_status'        => array(
+				'func'       => '_toggle_checkin_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_checkin',
+				'obj_id'     => $reg_id,
+			),
+			'toggle_checkin_status_bulk'   => array(
+				'func'       => '_toggle_checkin_status',
+				'noheader'   => true,
+				'capability' => 'ee_edit_checkins',
+			),
+			'event_registrations'          => array(
+				'func'       => '_event_registrations_list_table',
+				'capability' => 'ee_read_checkins',
+			),
+			'registrations_checkin_report' => array(
+				'func'       => '_registrations_checkin_report',
+				'noheader'   => true,
+				'capability' => 'ee_read_registrations',
+			),
+		);
+		$this->_page_routes = array_merge($this->_page_routes, $new_page_routes);
+		$new_page_config = array(
+			'reports'               => array(
+				'nav'           => array(
+					'label' => esc_html__('Reports', 'event_espresso'),
+					'order' => 30,
+				),
+				'help_tabs'     => array(
+					'registrations_reports_help_tab' => array(
+						'title'    => esc_html__('Registration Reports', 'event_espresso'),
+						'filename' => 'registrations_reports',
+					),
+				),
+				/*'help_tour' => array( 'Registration_Reports_Help_Tour' ),*/
+				'require_nonce' => false,
+			),
+			'event_registrations'   => array(
+				'nav'           => array(
+					'label'      => esc_html__('Event Check-In', 'event_espresso'),
+					'order'      => 10,
+					'persistent' => true,
+				),
+				'help_tabs'     => array(
+					'registrations_event_checkin_help_tab'                       => array(
+						'title'    => esc_html__('Registrations Event Check-In', 'event_espresso'),
+						'filename' => 'registrations_event_checkin',
+					),
+					'registrations_event_checkin_table_column_headings_help_tab' => array(
+						'title'    => esc_html__('Event Check-In Table Column Headings', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_table_column_headings',
+					),
+					'registrations_event_checkin_filters_help_tab'               => array(
+						'title'    => esc_html__('Event Check-In Filters', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_filters',
+					),
+					'registrations_event_checkin_views_help_tab'                 => array(
+						'title'    => esc_html__('Event Check-In Views', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_views',
+					),
+					'registrations_event_checkin_other_help_tab'                 => array(
+						'title'    => esc_html__('Event Check-In Other', 'event_espresso'),
+						'filename' => 'registrations_event_checkin_other',
+					),
+				),
+				'help_tour'     => array('Event_Checkin_Help_Tour'),
+				'qtips'         => array('Registration_List_Table_Tips'),
+				'list_table'    => 'EE_Event_Registrations_List_Table',
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+			'registration_checkins' => array(
+				'nav'           => array(
+					'label'      => esc_html__('Check-In Records', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => '',
+				),
+				'list_table'    => 'EE_Registration_CheckIn_List_Table',
+				// 'help_tour' => array( 'Checkin_Toggle_View_Help_Tour' ),
+				'metaboxes'     => array(),
+				'require_nonce' => false,
+			),
+		);
+		$this->_page_config = array_merge($this->_page_config, $new_page_config);
+		$this->_page_config['contact_list']['list_table'] = 'Extend_EE_Attendee_Contact_List_Table';
+		$this->_page_config['default']['list_table'] = 'Extend_EE_Registrations_List_Table';
+	}
 
 
-    /**
-     * Ajax hooks for all routes in this page.
-     */
-    protected function _ajax_hooks()
-    {
-        parent::_ajax_hooks();
-        add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content'));
-    }
+	/**
+	 * Ajax hooks for all routes in this page.
+	 */
+	protected function _ajax_hooks()
+	{
+		parent::_ajax_hooks();
+		add_action('wp_ajax_get_newsletter_form_content', array($this, 'get_newsletter_form_content'));
+	}
 
 
-    /**
-     * Global scripts for all routes in this page.
-     */
-    public function load_scripts_styles()
-    {
-        parent::load_scripts_styles();
-        // if newsletter message type is active then let's add filter and load js for it.
-        if (EEH_MSG_Template::is_mt_active('newsletter')) {
-            // enqueue newsletter js
-            wp_enqueue_script(
-                'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
-                array('ee-dialog'),
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_style(
-                'ee-newsletter-trigger-css',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
-                array(),
-                EVENT_ESPRESSO_VERSION
-            );
-            // hook in buttons for newsletter message type trigger.
-            add_action(
-                'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
-                array($this, 'add_newsletter_action_buttons'),
-                10
-            );
-        }
-    }
+	/**
+	 * Global scripts for all routes in this page.
+	 */
+	public function load_scripts_styles()
+	{
+		parent::load_scripts_styles();
+		// if newsletter message type is active then let's add filter and load js for it.
+		if (EEH_MSG_Template::is_mt_active('newsletter')) {
+			// enqueue newsletter js
+			wp_enqueue_script(
+				'ee-newsletter-trigger',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+				array('ee-dialog'),
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_style(
+				'ee-newsletter-trigger-css',
+				REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
+				array(),
+				EVENT_ESPRESSO_VERSION
+			);
+			// hook in buttons for newsletter message type trigger.
+			add_action(
+				'AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons',
+				array($this, 'add_newsletter_action_buttons'),
+				10
+			);
+		}
+	}
 
 
-    /**
-     * Scripts and styles for just the reports route.
-     */
-    public function load_scripts_styles_reports()
-    {
-        wp_register_script(
-            'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
-            array('google-charts'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('ee-reg-reports-js');
-        $this->_registration_reports_js_setup();
-    }
+	/**
+	 * Scripts and styles for just the reports route.
+	 */
+	public function load_scripts_styles_reports()
+	{
+		wp_register_script(
+			'ee-reg-reports-js',
+			REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+			array('google-charts'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('ee-reg-reports-js');
+		$this->_registration_reports_js_setup();
+	}
 
 
-    /**
-     * Register screen options for event_registrations route.
-     */
-    protected function _add_screen_options_event_registrations()
-    {
-        $this->_per_page_screen_option();
-    }
+	/**
+	 * Register screen options for event_registrations route.
+	 */
+	protected function _add_screen_options_event_registrations()
+	{
+		$this->_per_page_screen_option();
+	}
 
 
-    /**
-     * Register screen options for registration_checkins route
-     */
-    protected function _add_screen_options_registration_checkins()
-    {
-        $page_title = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Check-In Records', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
+	/**
+	 * Register screen options for registration_checkins route
+	 */
+	protected function _add_screen_options_registration_checkins()
+	{
+		$page_title = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Check-In Records', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
 
 
-    /**
-     * Set views property for event_registrations route.
-     */
-    protected function _set_list_table_views_event_registrations()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => ! isset($this->_req_data['event_id'])
-                    ? array()
-                    : array(
-                        'toggle_checkin_status_bulk' => esc_html__('Toggle Check-In', 'event_espresso'),
-                    ),
-            ),
-        );
-    }
+	/**
+	 * Set views property for event_registrations route.
+	 */
+	protected function _set_list_table_views_event_registrations()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => ! isset($this->_req_data['event_id'])
+					? array()
+					: array(
+						'toggle_checkin_status_bulk' => esc_html__('Toggle Check-In', 'event_espresso'),
+					),
+			),
+		);
+	}
 
 
-    /**
-     * Set views property for registration_checkins route.
-     */
-    protected function _set_list_table_views_registration_checkins()
-    {
-        $this->_views = array(
-            'all' => array(
-                'slug'        => 'all',
-                'label'       => esc_html__('All', 'event_espresso'),
-                'count'       => 0,
-                'bulk_action' => array('delete_checkin_rows' => esc_html__('Delete Check-In Rows', 'event_espresso')),
-            ),
-        );
-    }
+	/**
+	 * Set views property for registration_checkins route.
+	 */
+	protected function _set_list_table_views_registration_checkins()
+	{
+		$this->_views = array(
+			'all' => array(
+				'slug'        => 'all',
+				'label'       => esc_html__('All', 'event_espresso'),
+				'count'       => 0,
+				'bulk_action' => array('delete_checkin_rows' => esc_html__('Delete Check-In Rows', 'event_espresso')),
+			),
+		);
+	}
 
 
-    /**
-     * callback for ajax action.
-     *
-     * @since 4.3.0
-     * @return void (JSON)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_newsletter_form_content()
-    {
-        // do a nonce check cause we're not coming in from an normal route here.
-        $nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field(
-            $this->_req_data['get_newsletter_form_content_nonce']
-        ) : '';
-        $nonce_ref = 'get_newsletter_form_content_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        // let's get the mtp for the incoming MTP_ ID
-        if (! isset($this->_req_data['GRP_ID'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
-        if (! $MTPG instanceof EE_Message_Template_Group) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The GRP_ID given (%d) does not appear to have a corresponding row in the database.',
-                        'event_espresso'
-                    ),
-                    $this->_req_data['GRP_ID']
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        }
-        $MTPs = $MTPG->context_templates();
-        $MTPs = $MTPs['attendee'];
-        $template_fields = array();
-        /** @var EE_Message_Template $MTP */
-        foreach ($MTPs as $MTP) {
-            $field = $MTP->get('MTP_template_field');
-            if ($field === 'content') {
-                $content = $MTP->get('MTP_content');
-                if (! empty($content['newsletter_content'])) {
-                    $template_fields['newsletter_content'] = $content['newsletter_content'];
-                }
-                continue;
-            }
-            $template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content');
-        }
-        $this->_template_args['success'] = true;
-        $this->_template_args['error'] = false;
-        $this->_template_args['data'] = array(
-            'batch_message_from'    => isset($template_fields['from'])
-                ? $template_fields['from']
-                : '',
-            'batch_message_subject' => isset($template_fields['subject'])
-                ? $template_fields['subject']
-                : '',
-            'batch_message_content' => isset($template_fields['newsletter_content'])
-                ? $template_fields['newsletter_content']
-                : '',
-        );
-        $this->_return_json();
-    }
+	/**
+	 * callback for ajax action.
+	 *
+	 * @since 4.3.0
+	 * @return void (JSON)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_newsletter_form_content()
+	{
+		// do a nonce check cause we're not coming in from an normal route here.
+		$nonce = isset($this->_req_data['get_newsletter_form_content_nonce']) ? sanitize_text_field(
+			$this->_req_data['get_newsletter_form_content_nonce']
+		) : '';
+		$nonce_ref = 'get_newsletter_form_content_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		// let's get the mtp for the incoming MTP_ ID
+		if (! isset($this->_req_data['GRP_ID'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+		$MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
+		if (! $MTPG instanceof EE_Message_Template_Group) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The GRP_ID given (%d) does not appear to have a corresponding row in the database.',
+						'event_espresso'
+					),
+					$this->_req_data['GRP_ID']
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		}
+		$MTPs = $MTPG->context_templates();
+		$MTPs = $MTPs['attendee'];
+		$template_fields = array();
+		/** @var EE_Message_Template $MTP */
+		foreach ($MTPs as $MTP) {
+			$field = $MTP->get('MTP_template_field');
+			if ($field === 'content') {
+				$content = $MTP->get('MTP_content');
+				if (! empty($content['newsletter_content'])) {
+					$template_fields['newsletter_content'] = $content['newsletter_content'];
+				}
+				continue;
+			}
+			$template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content');
+		}
+		$this->_template_args['success'] = true;
+		$this->_template_args['error'] = false;
+		$this->_template_args['data'] = array(
+			'batch_message_from'    => isset($template_fields['from'])
+				? $template_fields['from']
+				: '',
+			'batch_message_subject' => isset($template_fields['subject'])
+				? $template_fields['subject']
+				: '',
+			'batch_message_content' => isset($template_fields['newsletter_content'])
+				? $template_fields['newsletter_content']
+				: '',
+		);
+		$this->_return_json();
+	}
 
 
-    /**
-     * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
-     *
-     * @since 4.3.0
-     * @param EE_Admin_List_Table $list_table
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
-    {
-        if (! EE_Registry::instance()->CAP->current_user_can(
-            'ee_send_message',
-            'espresso_registrations_newsletter_selected_send'
-        )
-        ) {
-            return;
-        }
-        $routes_to_add_to = array(
-            'contact_list',
-            'event_registrations',
-            'default',
-        );
-        if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) {
-            if (($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id']))
-                || (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash')
-            ) {
-                echo '';
-            } else {
-                $button_text = sprintf(
-                    esc_html__('Send Batch Message (%s selected)', 'event_espresso'),
-                    '<span class="send-selected-newsletter-count">0</span>'
-                );
-                echo '<button id="selected-batch-send-trigger" class="button secondary-button">'
-                     . '<span class="dashicons dashicons-email "></span>'
-                     . $button_text
-                     . '</button>';
-                add_action('admin_footer', array($this, 'newsletter_send_form_skeleton'));
-            }
-        }
-    }
+	/**
+	 * callback for AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons action
+	 *
+	 * @since 4.3.0
+	 * @param EE_Admin_List_Table $list_table
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
+	{
+		if (! EE_Registry::instance()->CAP->current_user_can(
+			'ee_send_message',
+			'espresso_registrations_newsletter_selected_send'
+		)
+		) {
+			return;
+		}
+		$routes_to_add_to = array(
+			'contact_list',
+			'event_registrations',
+			'default',
+		);
+		if ($this->_current_page === 'espresso_registrations' && in_array($this->_req_action, $routes_to_add_to)) {
+			if (($this->_req_action === 'event_registrations' && empty($this->_req_data['event_id']))
+				|| (isset($this->_req_data['status']) && $this->_req_data['status'] === 'trash')
+			) {
+				echo '';
+			} else {
+				$button_text = sprintf(
+					esc_html__('Send Batch Message (%s selected)', 'event_espresso'),
+					'<span class="send-selected-newsletter-count">0</span>'
+				);
+				echo '<button id="selected-batch-send-trigger" class="button secondary-button">'
+					 . '<span class="dashicons dashicons-email "></span>'
+					 . $button_text
+					 . '</button>';
+				add_action('admin_footer', array($this, 'newsletter_send_form_skeleton'));
+			}
+		}
+	}
 
 
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function newsletter_send_form_skeleton()
-    {
-        $list_table = $this->_list_table_object;
-        $codes = array();
-        // need to templates for the newsletter message type for the template selector.
-        $values[] = array('text' => esc_html__('Select Template to Use', 'event_espresso'), 'id' => 0);
-        $mtps = EEM_Message_Template_Group::instance()->get_all(
-            array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email'))
-        );
-        foreach ($mtps as $mtp) {
-            $name = $mtp->name();
-            $values[] = array(
-                'text' => empty($name) ? esc_html__('Global', 'event_espresso') : $name,
-                'id'   => $mtp->ID(),
-            );
-        }
-        // need to get a list of shortcodes that are available for the newsletter message type.
-        $shortcodes = EEH_MSG_Template::get_shortcodes(
-            'newsletter',
-            'email',
-            array(),
-            'attendee',
-            false
-        );
-        foreach ($shortcodes as $field => $shortcode_array) {
-            $available_shortcodes = array();
-            foreach ($shortcode_array as $shortcode => $shortcode_details) {
-                $field_id = $field === '[NEWSLETTER_CONTENT]'
-                    ? 'content'
-                    : $field;
-                $field_id = 'batch-message-' . strtolower($field_id);
-                $available_shortcodes[] = '<span class="js-shortcode-selection" data-value="'
-                                          . $shortcode
-                                          . '" data-linked-input-id="' . $field_id . '">'
-                                          . $shortcode
-                                          . '</span>';
-            }
-            $codes[ $field ] = implode(', ', $available_shortcodes);
-        }
-        $shortcodes = $codes;
-        $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
-        $form_template_args = array(
-            'form_action'       => admin_url('admin.php?page=espresso_registrations'),
-            'form_route'        => 'newsletter_selected_send',
-            'form_nonce_name'   => 'newsletter_selected_send_nonce',
-            'form_nonce'        => wp_create_nonce('newsletter_selected_send_nonce'),
-            'redirect_back_to'  => $this->_req_action,
-            'ajax_nonce'        => wp_create_nonce('get_newsletter_form_content_nonce'),
-            'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values),
-            'shortcodes'        => $shortcodes,
-            'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration',
-        );
-        EEH_Template::display_template($form_template, $form_template_args);
-    }
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function newsletter_send_form_skeleton()
+	{
+		$list_table = $this->_list_table_object;
+		$codes = array();
+		// need to templates for the newsletter message type for the template selector.
+		$values[] = array('text' => esc_html__('Select Template to Use', 'event_espresso'), 'id' => 0);
+		$mtps = EEM_Message_Template_Group::instance()->get_all(
+			array(array('MTP_message_type' => 'newsletter', 'MTP_messenger' => 'email'))
+		);
+		foreach ($mtps as $mtp) {
+			$name = $mtp->name();
+			$values[] = array(
+				'text' => empty($name) ? esc_html__('Global', 'event_espresso') : $name,
+				'id'   => $mtp->ID(),
+			);
+		}
+		// need to get a list of shortcodes that are available for the newsletter message type.
+		$shortcodes = EEH_MSG_Template::get_shortcodes(
+			'newsletter',
+			'email',
+			array(),
+			'attendee',
+			false
+		);
+		foreach ($shortcodes as $field => $shortcode_array) {
+			$available_shortcodes = array();
+			foreach ($shortcode_array as $shortcode => $shortcode_details) {
+				$field_id = $field === '[NEWSLETTER_CONTENT]'
+					? 'content'
+					: $field;
+				$field_id = 'batch-message-' . strtolower($field_id);
+				$available_shortcodes[] = '<span class="js-shortcode-selection" data-value="'
+										  . $shortcode
+										  . '" data-linked-input-id="' . $field_id . '">'
+										  . $shortcode
+										  . '</span>';
+			}
+			$codes[ $field ] = implode(', ', $available_shortcodes);
+		}
+		$shortcodes = $codes;
+		$form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
+		$form_template_args = array(
+			'form_action'       => admin_url('admin.php?page=espresso_registrations'),
+			'form_route'        => 'newsletter_selected_send',
+			'form_nonce_name'   => 'newsletter_selected_send_nonce',
+			'form_nonce'        => wp_create_nonce('newsletter_selected_send_nonce'),
+			'redirect_back_to'  => $this->_req_action,
+			'ajax_nonce'        => wp_create_nonce('get_newsletter_form_content_nonce'),
+			'template_selector' => EEH_Form_Fields::select_input('newsletter_mtp_selected', $values),
+			'shortcodes'        => $shortcodes,
+			'id_type'           => $list_table instanceof EE_Attendee_Contact_List_Table ? 'contact' : 'registration',
+		);
+		EEH_Template::display_template($form_template, $form_template_args);
+	}
 
 
-    /**
-     * Handles sending selected registrations/contacts a newsletter.
-     *
-     * @since  4.3.0
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _newsletter_selected_send()
-    {
-        $success = true;
-        // first we need to make sure we have a GRP_ID so we know what template we're sending and updating!
-        if (empty($this->_req_data['newsletter_mtp_selected'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $success = false;
-        }
-        if ($success) {
-            // update Message template in case there are any changes
-            $Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID(
-                $this->_req_data['newsletter_mtp_selected']
-            );
-            $Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group
-                ? $Message_Template_Group->context_templates()
-                : array();
-            if (empty($Message_Templates)) {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Unable to retrieve message template fields from the db. Messages not sent.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            // let's just update the specific fields
-            foreach ($Message_Templates['attendee'] as $Message_Template) {
-                if ($Message_Template instanceof EE_Message_Template) {
-                    $field = $Message_Template->get('MTP_template_field');
-                    $content = $Message_Template->get('MTP_content');
-                    $new_content = $content;
-                    switch ($field) {
-                        case 'from':
-                            $new_content = ! empty($this->_req_data['batch_message']['from'])
-                                ? $this->_req_data['batch_message']['from']
-                                : $content;
-                            break;
-                        case 'subject':
-                            $new_content = ! empty($this->_req_data['batch_message']['subject'])
-                                ? $this->_req_data['batch_message']['subject']
-                                : $content;
-                            break;
-                        case 'content':
-                            $new_content = $content;
-                            $new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content'])
-                                ? $this->_req_data['batch_message']['content']
-                                : $content['newsletter_content'];
-                            break;
-                        default:
-                            // continue the foreach loop, we don't want to set $new_content nor save.
-                            continue 2;
-                    }
-                    $Message_Template->set('MTP_content', $new_content);
-                    $Message_Template->save();
-                }
-            }
-            // great fields are updated!  now let's make sure we just have contact objects (EE_Attendee).
-            $id_type = ! empty($this->_req_data['batch_message']['id_type'])
-                ? $this->_req_data['batch_message']['id_type']
-                : 'registration';
-            // id_type will affect how we assemble the ids.
-            $ids = ! empty($this->_req_data['batch_message']['ids'])
-                ? json_decode(stripslashes($this->_req_data['batch_message']['ids']))
-                : array();
-            $registrations_used_for_contact_data = array();
-            // using switch because eventually we'll have other contexts that will be used for generating messages.
-            switch ($id_type) {
-                case 'registration':
-                    $registrations_used_for_contact_data = EEM_Registration::instance()->get_all(
-                        array(
-                            array(
-                                'REG_ID' => array('IN', $ids),
-                            ),
-                        )
-                    );
-                    break;
-                case 'contact':
-                    $registrations_used_for_contact_data = EEM_Registration::instance()
-                                                                           ->get_latest_registration_for_each_of_given_contacts(
-                                                                               $ids
-                                                                           );
-                    break;
-            }
-            do_action_ref_array(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
-                array(
-                    $registrations_used_for_contact_data,
-                    $Message_Template_Group->ID(),
-                )
-            );
-            // kept for backward compat, internally we no longer use this action.
-            // @deprecated 4.8.36.rc.002
-            $contacts = $id_type === 'registration'
-                ? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids)
-                : EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids))));
-            do_action_ref_array(
-                'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
-                array(
-                    $contacts,
-                    $Message_Template_Group->ID(),
-                )
-            );
-        }
-        $query_args = array(
-            'action' => ! empty($this->_req_data['redirect_back_to'])
-                ? $this->_req_data['redirect_back_to']
-                : 'default',
-        );
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * Handles sending selected registrations/contacts a newsletter.
+	 *
+	 * @since  4.3.0
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _newsletter_selected_send()
+	{
+		$success = true;
+		// first we need to make sure we have a GRP_ID so we know what template we're sending and updating!
+		if (empty($this->_req_data['newsletter_mtp_selected'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to send a message, a Message Template GRP_ID is needed. It was not provided so messages were not sent.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$success = false;
+		}
+		if ($success) {
+			// update Message template in case there are any changes
+			$Message_Template_Group = EEM_Message_Template_Group::instance()->get_one_by_ID(
+				$this->_req_data['newsletter_mtp_selected']
+			);
+			$Message_Templates = $Message_Template_Group instanceof EE_Message_Template_Group
+				? $Message_Template_Group->context_templates()
+				: array();
+			if (empty($Message_Templates)) {
+				EE_Error::add_error(
+					esc_html__(
+						'Unable to retrieve message template fields from the db. Messages not sent.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			// let's just update the specific fields
+			foreach ($Message_Templates['attendee'] as $Message_Template) {
+				if ($Message_Template instanceof EE_Message_Template) {
+					$field = $Message_Template->get('MTP_template_field');
+					$content = $Message_Template->get('MTP_content');
+					$new_content = $content;
+					switch ($field) {
+						case 'from':
+							$new_content = ! empty($this->_req_data['batch_message']['from'])
+								? $this->_req_data['batch_message']['from']
+								: $content;
+							break;
+						case 'subject':
+							$new_content = ! empty($this->_req_data['batch_message']['subject'])
+								? $this->_req_data['batch_message']['subject']
+								: $content;
+							break;
+						case 'content':
+							$new_content = $content;
+							$new_content['newsletter_content'] = ! empty($this->_req_data['batch_message']['content'])
+								? $this->_req_data['batch_message']['content']
+								: $content['newsletter_content'];
+							break;
+						default:
+							// continue the foreach loop, we don't want to set $new_content nor save.
+							continue 2;
+					}
+					$Message_Template->set('MTP_content', $new_content);
+					$Message_Template->save();
+				}
+			}
+			// great fields are updated!  now let's make sure we just have contact objects (EE_Attendee).
+			$id_type = ! empty($this->_req_data['batch_message']['id_type'])
+				? $this->_req_data['batch_message']['id_type']
+				: 'registration';
+			// id_type will affect how we assemble the ids.
+			$ids = ! empty($this->_req_data['batch_message']['ids'])
+				? json_decode(stripslashes($this->_req_data['batch_message']['ids']))
+				: array();
+			$registrations_used_for_contact_data = array();
+			// using switch because eventually we'll have other contexts that will be used for generating messages.
+			switch ($id_type) {
+				case 'registration':
+					$registrations_used_for_contact_data = EEM_Registration::instance()->get_all(
+						array(
+							array(
+								'REG_ID' => array('IN', $ids),
+							),
+						)
+					);
+					break;
+				case 'contact':
+					$registrations_used_for_contact_data = EEM_Registration::instance()
+																		   ->get_latest_registration_for_each_of_given_contacts(
+																			   $ids
+																		   );
+					break;
+			}
+			do_action_ref_array(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send__with_registrations',
+				array(
+					$registrations_used_for_contact_data,
+					$Message_Template_Group->ID(),
+				)
+			);
+			// kept for backward compat, internally we no longer use this action.
+			// @deprecated 4.8.36.rc.002
+			$contacts = $id_type === 'registration'
+				? EEM_Attendee::instance()->get_array_of_contacts_from_reg_ids($ids)
+				: EEM_Attendee::instance()->get_all(array(array('ATT_ID' => array('in', $ids))));
+			do_action_ref_array(
+				'AHEE__Extend_Registrations_Admin_Page___newsletter_selected_send',
+				array(
+					$contacts,
+					$Message_Template_Group->ID(),
+				)
+			);
+		}
+		$query_args = array(
+			'action' => ! empty($this->_req_data['redirect_back_to'])
+				? $this->_req_data['redirect_back_to']
+				: 'default',
+		);
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     * This is called when javascript is being enqueued to setup the various data needed for the reports js.
-     * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method.
-     */
-    protected function _registration_reports_js_setup()
-    {
-        $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report();
-        $this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report();
-    }
+	/**
+	 * This is called when javascript is being enqueued to setup the various data needed for the reports js.
+	 * Also $this->{$_reports_template_data} property is set for later usage by the _registration_reports method.
+	 */
+	protected function _registration_reports_js_setup()
+	{
+		$this->_reports_template_data['admin_reports'][] = $this->_registrations_per_day_report();
+		$this->_reports_template_data['admin_reports'][] = $this->_registrations_per_event_report();
+	}
 
 
-    /**
-     *        generates Business Reports regarding Registrations
-     *
-     * @access protected
-     * @return void
-     * @throws DomainException
-     */
-    protected function _registration_reports()
-    {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $template_path,
-            $this->_reports_template_data,
-            true
-        );
-        // the final template wrapper
-        $this->display_admin_page_with_no_sidebar();
-    }
+	/**
+	 *        generates Business Reports regarding Registrations
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws DomainException
+	 */
+	protected function _registration_reports()
+	{
+		$template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$template_path,
+			$this->_reports_template_data,
+			true
+		);
+		// the final template wrapper
+		$this->display_admin_page_with_no_sidebar();
+	}
 
 
-    /**
-     * Generates Business Report showing total registrations per day.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _registrations_per_day_report($period = '-1 month')
-    {
-        $report_ID = 'reg-admin-registrations-per-day-report-dv';
-        $results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
-        $results = (array) $results;
-        $regs = array();
-        $subtitle = '';
-        if ($results) {
-            $column_titles = array();
-            $tracker = 0;
-            foreach ($results as $result) {
-                $report_column_values = array();
-                foreach ($result as $property_name => $property_value) {
-                    $property_value = $property_name === 'Registration_REG_date' ? $property_value
-                        : (int) $property_value;
-                    $report_column_values[] = $property_value;
-                    if ($tracker === 0) {
-                        if ($property_name === 'Registration_REG_date') {
-                            $column_titles[] = esc_html__(
-                                'Date (only days with registrations are shown)',
-                                'event_espresso'
-                            );
-                        } else {
-                            $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
-                        }
-                    }
-                }
-                $tracker++;
-                $regs[] = $report_column_values;
-            }
-            // make sure the column_titles is pushed to the beginning of the array
-            array_unshift($regs, $column_titles);
-            // setup the date range.
-            $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
-            $ending_date = new DateTime("now", $DateTimeZone);
-            $subtitle = sprintf(
-                _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-        $report_title = esc_html__('Total Registrations per Day', 'event_espresso');
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'regs'      => $regs,
-            'noResults' => empty($regs),
-            'noRegsMsg' => sprintf(
-                esc_html__(
-                    '%sThere are currently no registration records in the last month for this report.%s',
-                    'event_espresso'
-                ),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params);
-        return $report_ID;
-    }
+	/**
+	 * Generates Business Report showing total registrations per day.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _registrations_per_day_report($period = '-1 month')
+	{
+		$report_ID = 'reg-admin-registrations-per-day-report-dv';
+		$results = EEM_Registration::instance()->get_registrations_per_day_and_per_status_report($period);
+		$results = (array) $results;
+		$regs = array();
+		$subtitle = '';
+		if ($results) {
+			$column_titles = array();
+			$tracker = 0;
+			foreach ($results as $result) {
+				$report_column_values = array();
+				foreach ($result as $property_name => $property_value) {
+					$property_value = $property_name === 'Registration_REG_date' ? $property_value
+						: (int) $property_value;
+					$report_column_values[] = $property_value;
+					if ($tracker === 0) {
+						if ($property_name === 'Registration_REG_date') {
+							$column_titles[] = esc_html__(
+								'Date (only days with registrations are shown)',
+								'event_espresso'
+							);
+						} else {
+							$column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
+						}
+					}
+				}
+				$tracker++;
+				$regs[] = $report_column_values;
+			}
+			// make sure the column_titles is pushed to the beginning of the array
+			array_unshift($regs, $column_titles);
+			// setup the date range.
+			$DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+			$beginning_date = new DateTime("now " . $period, $DateTimeZone);
+			$ending_date = new DateTime("now", $DateTimeZone);
+			$subtitle = sprintf(
+				_x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+		$report_title = esc_html__('Total Registrations per Day', 'event_espresso');
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'regs'      => $regs,
+			'noResults' => empty($regs),
+			'noRegsMsg' => sprintf(
+				esc_html__(
+					'%sThere are currently no registration records in the last month for this report.%s',
+					'event_espresso'
+				),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-reg-reports-js', 'regPerDay', $report_params);
+		return $report_ID;
+	}
 
 
-    /**
-     * Generates Business Report showing total registrations per event.
-     *
-     * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _registrations_per_event_report($period = '-1 month')
-    {
-        $report_ID = 'reg-admin-registrations-per-event-report-dv';
-        $results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
-        $results = (array) $results;
-        $regs = array();
-        $subtitle = '';
-        if ($results) {
-            $column_titles = array();
-            $tracker = 0;
-            foreach ($results as $result) {
-                $report_column_values = array();
-                foreach ($result as $property_name => $property_value) {
-                    $property_value = $property_name === 'Registration_Event' ? wp_trim_words(
-                        $property_value,
-                        4,
-                        '...'
-                    ) : (int) $property_value;
-                    $report_column_values[] = $property_value;
-                    if ($tracker === 0) {
-                        if ($property_name === 'Registration_Event') {
-                            $column_titles[] = esc_html__('Event', 'event_espresso');
-                        } else {
-                            $column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
-                        }
-                    }
-                }
-                $tracker++;
-                $regs[] = $report_column_values;
-            }
-            // make sure the column_titles is pushed to the beginning of the array
-            array_unshift($regs, $column_titles);
-            // setup the date range.
-            $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
-            $ending_date = new DateTime("now", $DateTimeZone);
-            $subtitle = sprintf(
-                _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
-                $beginning_date->format('Y-m-d'),
-                $ending_date->format('Y-m-d')
-            );
-        }
-        $report_title = esc_html__('Total Registrations per Event', 'event_espresso');
-        $report_params = array(
-            'title'     => $report_title,
-            'subtitle'  => $subtitle,
-            'id'        => $report_ID,
-            'regs'      => $regs,
-            'noResults' => empty($regs),
-            'noRegsMsg' => sprintf(
-                esc_html__(
-                    '%sThere are currently no registration records in the last month for this report.%s',
-                    'event_espresso'
-                ),
-                '<h2>' . $report_title . '</h2><p>',
-                '</p>'
-            ),
-        );
-        wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params);
-        return $report_ID;
-    }
+	/**
+	 * Generates Business Report showing total registrations per event.
+	 *
+	 * @param string $period The period (acceptable by PHP Datetime constructor) for which the report is generated.
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _registrations_per_event_report($period = '-1 month')
+	{
+		$report_ID = 'reg-admin-registrations-per-event-report-dv';
+		$results = EEM_Registration::instance()->get_registrations_per_event_and_per_status_report($period);
+		$results = (array) $results;
+		$regs = array();
+		$subtitle = '';
+		if ($results) {
+			$column_titles = array();
+			$tracker = 0;
+			foreach ($results as $result) {
+				$report_column_values = array();
+				foreach ($result as $property_name => $property_value) {
+					$property_value = $property_name === 'Registration_Event' ? wp_trim_words(
+						$property_value,
+						4,
+						'...'
+					) : (int) $property_value;
+					$report_column_values[] = $property_value;
+					if ($tracker === 0) {
+						if ($property_name === 'Registration_Event') {
+							$column_titles[] = esc_html__('Event', 'event_espresso');
+						} else {
+							$column_titles[] = EEH_Template::pretty_status($property_name, false, 'sentence');
+						}
+					}
+				}
+				$tracker++;
+				$regs[] = $report_column_values;
+			}
+			// make sure the column_titles is pushed to the beginning of the array
+			array_unshift($regs, $column_titles);
+			// setup the date range.
+			$DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
+			$beginning_date = new DateTime("now " . $period, $DateTimeZone);
+			$ending_date = new DateTime("now", $DateTimeZone);
+			$subtitle = sprintf(
+				_x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
+				$beginning_date->format('Y-m-d'),
+				$ending_date->format('Y-m-d')
+			);
+		}
+		$report_title = esc_html__('Total Registrations per Event', 'event_espresso');
+		$report_params = array(
+			'title'     => $report_title,
+			'subtitle'  => $subtitle,
+			'id'        => $report_ID,
+			'regs'      => $regs,
+			'noResults' => empty($regs),
+			'noRegsMsg' => sprintf(
+				esc_html__(
+					'%sThere are currently no registration records in the last month for this report.%s',
+					'event_espresso'
+				),
+				'<h2>' . $report_title . '</h2><p>',
+				'</p>'
+			),
+		);
+		wp_localize_script('ee-reg-reports-js', 'regPerEvent', $report_params);
+		return $report_ID;
+	}
 
 
-    /**
-     * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration)
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\EntityNotFoundException
-     */
-    protected function _registration_checkin_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $reg_id = isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : null;
-        /** @var EE_Registration $registration */
-        $registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $registration instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('An error occurred. There is no registration with ID (%d)', 'event_espresso'),
-                    $reg_id
-                )
-            );
-        }
-        $attendee = $registration->attendee();
-        $this->_admin_page_title .= $this->get_action_link_or_button(
-            'new_registration',
-            'add-registrant',
-            array('event_id' => $registration->event_ID()),
-            'add-new-h2'
-        );
-        $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
-        $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
-        $legend_items = array(
-            'checkin'  => array(
-                'class' => $checked_in->cssClasses(),
-                'desc'  => $checked_in->legendLabel(),
-            ),
-            'checkout' => array(
-                'class' => $checked_out->cssClasses(),
-                'desc'  => $checked_out->legendLabel(),
-            ),
-        );
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-        $dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
-        /** @var EE_Datetime $datetime */
-        $datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id);
-        $datetime_label = '';
-        if ($datetime instanceof EE_Datetime) {
-            $datetime_label = $datetime->get_dtt_display_name(true);
-            $datetime_label .= ! empty($datetime_label)
-                ? ' (' . $datetime->get_dtt_display_name() . ')'
-                : $datetime->get_dtt_display_name();
-        }
-        $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
-            ? EE_Admin_Page::add_query_args_and_nonce(
-                array(
-                    'action'   => 'event_registrations',
-                    'event_id' => $registration->event_ID(),
-                    'DTT_ID'   => $dtt_id,
-                ),
-                $this->_admin_base_url
-            )
-            : '';
-        $datetime_link = ! empty($datetime_link)
-            ? '<a href="' . $datetime_link . '">'
-              . '<span id="checkin-dtt">'
-              . $datetime_label
-              . '</span></a>'
-            : $datetime_label;
-        $attendee_name = $attendee instanceof EE_Attendee
-            ? $attendee->full_name()
-            : '';
-        $attendee_link = $attendee instanceof EE_Attendee
-            ? $attendee->get_admin_details_link()
-            : '';
-        $attendee_link = ! empty($attendee_link)
-            ? '<a href="' . $attendee->get_admin_details_link() . '"'
-              . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
-              . '<span id="checkin-attendee-name">'
-              . $attendee_name
-              . '</span></a>'
-            : '';
-        $event_link = $registration->event() instanceof EE_Event
-            ? $registration->event()->get_admin_details_link()
-            : '';
-        $event_link = ! empty($event_link)
-            ? '<a href="' . $event_link . '"'
-              . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
-              . '<span id="checkin-event-name">'
-              . $registration->event_name()
-              . '</span>'
-              . '</a>'
-            : '';
-        $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
-            ? '<h2>' . sprintf(
-                esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
-                $attendee_link,
-                $datetime_link,
-                $event_link
-            ) . '</h2>'
-            : '';
-        $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
-            ? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : '';
-        $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
-            ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
+	/**
+	 * generates HTML for the Registration Check-in list table (showing all Check-ins for a specific registration)
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\EntityNotFoundException
+	 */
+	protected function _registration_checkin_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$reg_id = isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : null;
+		/** @var EE_Registration $registration */
+		$registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
+		if (! $registration instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('An error occurred. There is no registration with ID (%d)', 'event_espresso'),
+					$reg_id
+				)
+			);
+		}
+		$attendee = $registration->attendee();
+		$this->_admin_page_title .= $this->get_action_link_or_button(
+			'new_registration',
+			'add-registrant',
+			array('event_id' => $registration->event_ID()),
+			'add-new-h2'
+		);
+		$checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
+		$checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
+		$legend_items = array(
+			'checkin'  => array(
+				'class' => $checked_in->cssClasses(),
+				'desc'  => $checked_in->legendLabel(),
+			),
+			'checkout' => array(
+				'class' => $checked_out->cssClasses(),
+				'desc'  => $checked_out->legendLabel(),
+			),
+		);
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+		$dtt_id = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
+		/** @var EE_Datetime $datetime */
+		$datetime = EEM_Datetime::instance()->get_one_by_ID($dtt_id);
+		$datetime_label = '';
+		if ($datetime instanceof EE_Datetime) {
+			$datetime_label = $datetime->get_dtt_display_name(true);
+			$datetime_label .= ! empty($datetime_label)
+				? ' (' . $datetime->get_dtt_display_name() . ')'
+				: $datetime->get_dtt_display_name();
+		}
+		$datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
+			? EE_Admin_Page::add_query_args_and_nonce(
+				array(
+					'action'   => 'event_registrations',
+					'event_id' => $registration->event_ID(),
+					'DTT_ID'   => $dtt_id,
+				),
+				$this->_admin_base_url
+			)
+			: '';
+		$datetime_link = ! empty($datetime_link)
+			? '<a href="' . $datetime_link . '">'
+			  . '<span id="checkin-dtt">'
+			  . $datetime_label
+			  . '</span></a>'
+			: $datetime_label;
+		$attendee_name = $attendee instanceof EE_Attendee
+			? $attendee->full_name()
+			: '';
+		$attendee_link = $attendee instanceof EE_Attendee
+			? $attendee->get_admin_details_link()
+			: '';
+		$attendee_link = ! empty($attendee_link)
+			? '<a href="' . $attendee->get_admin_details_link() . '"'
+			  . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
+			  . '<span id="checkin-attendee-name">'
+			  . $attendee_name
+			  . '</span></a>'
+			: '';
+		$event_link = $registration->event() instanceof EE_Event
+			? $registration->event()->get_admin_details_link()
+			: '';
+		$event_link = ! empty($event_link)
+			? '<a href="' . $event_link . '"'
+			  . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
+			  . '<span id="checkin-event-name">'
+			  . $registration->event_name()
+			  . '</span>'
+			  . '</a>'
+			: '';
+		$this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
+			? '<h2>' . sprintf(
+				esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
+				$attendee_link,
+				$datetime_link,
+				$event_link
+			) . '</h2>'
+			: '';
+		$this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
+			? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : '';
+		$this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
+			? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
 
 
-    /**
-     * toggle the Check-in status for the given registration (coming from ajax)
-     *
-     * @return void (JSON)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function toggle_checkin_status()
-    {
-        // first make sure we have the necessary data
-        if (! isset($this->_req_data['_regid'])) {
-            EE_Error::add_error(
-                esc_html__(
-                    'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_template_args['success'] = false;
-            $this->_template_args['error'] = true;
-            $this->_return_json();
-        };
-        // do a nonce check cause we're not coming in from an normal route here.
-        $nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce'])
-            : '';
-        $nonce_ref = 'checkin_nonce';
-        $this->_verify_nonce($nonce, $nonce_ref);
-        // beautiful! Made it this far so let's get the status.
-        $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
-        // setup new class to return via ajax
-        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
-        $this->_template_args['success'] = true;
-        $this->_return_json();
-    }
+	/**
+	 * toggle the Check-in status for the given registration (coming from ajax)
+	 *
+	 * @return void (JSON)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function toggle_checkin_status()
+	{
+		// first make sure we have the necessary data
+		if (! isset($this->_req_data['_regid'])) {
+			EE_Error::add_error(
+				esc_html__(
+					'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_template_args['success'] = false;
+			$this->_template_args['error'] = true;
+			$this->_return_json();
+		};
+		// do a nonce check cause we're not coming in from an normal route here.
+		$nonce = isset($this->_req_data['checkinnonce']) ? sanitize_text_field($this->_req_data['checkinnonce'])
+			: '';
+		$nonce_ref = 'checkin_nonce';
+		$this->_verify_nonce($nonce, $nonce_ref);
+		// beautiful! Made it this far so let's get the status.
+		$new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
+		// setup new class to return via ajax
+		$this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
+		$this->_template_args['success'] = true;
+		$this->_return_json();
+	}
 
 
-    /**
-     * handles toggling the checkin status for the registration,
-     *
-     * @access protected
-     * @return int|void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _toggle_checkin_status()
-    {
-        // first let's get the query args out of the way for the redirect
-        $query_args = array(
-            'action'   => 'event_registrations',
-            'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
-            'DTT_ID'   => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null,
-        );
-        $new_status = false;
-        // bulk action check in toggle
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            // cycle thru checkboxes
-            while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) {
-                $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
-                $new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
-            }
-        } elseif (isset($this->_req_data['_regid'])) {
-            // coming from ajax request
-            $DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null;
-            $query_args['DTT_ID'] = $DTT_ID;
-            $new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID);
-        } else {
-            EE_Error::add_error(
-                esc_html__('Missing some required data to toggle the Check-in', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        if (defined('DOING_AJAX')) {
-            return $new_status;
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * handles toggling the checkin status for the registration,
+	 *
+	 * @access protected
+	 * @return int|void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _toggle_checkin_status()
+	{
+		// first let's get the query args out of the way for the redirect
+		$query_args = array(
+			'action'   => 'event_registrations',
+			'event_id' => isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null,
+			'DTT_ID'   => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null,
+		);
+		$new_status = false;
+		// bulk action check in toggle
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			// cycle thru checkboxes
+			while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) {
+				$DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
+				$new_status = $this->_toggle_checkin($REG_ID, $DTT_ID);
+			}
+		} elseif (isset($this->_req_data['_regid'])) {
+			// coming from ajax request
+			$DTT_ID = isset($this->_req_data['dttid']) ? $this->_req_data['dttid'] : null;
+			$query_args['DTT_ID'] = $DTT_ID;
+			$new_status = $this->_toggle_checkin($this->_req_data['_regid'], $DTT_ID);
+		} else {
+			EE_Error::add_error(
+				esc_html__('Missing some required data to toggle the Check-in', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		if (defined('DOING_AJAX')) {
+			return $new_status;
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     * This is toggles a single Check-in for the given registration and datetime.
-     *
-     * @param  int $REG_ID The registration we're toggling
-     * @param  int $DTT_ID The datetime we're toggling
-     * @return int The new status toggled to.
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function _toggle_checkin($REG_ID, $DTT_ID)
-    {
-        /** @var EE_Registration $REG */
-        $REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
-        $new_status = $REG->toggle_checkin_status($DTT_ID);
-        if ($new_status !== false) {
-            EE_Error::add_success($REG->get_checkin_msg($DTT_ID));
-        } else {
-            EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__);
-            $new_status = false;
-        }
-        return $new_status;
-    }
+	/**
+	 * This is toggles a single Check-in for the given registration and datetime.
+	 *
+	 * @param  int $REG_ID The registration we're toggling
+	 * @param  int $DTT_ID The datetime we're toggling
+	 * @return int The new status toggled to.
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function _toggle_checkin($REG_ID, $DTT_ID)
+	{
+		/** @var EE_Registration $REG */
+		$REG = EEM_Registration::instance()->get_one_by_ID($REG_ID);
+		$new_status = $REG->toggle_checkin_status($DTT_ID);
+		if ($new_status !== false) {
+			EE_Error::add_success($REG->get_checkin_msg($DTT_ID));
+		} else {
+			EE_Error::add_error($REG->get_checkin_msg($DTT_ID, true), __FILE__, __FUNCTION__, __LINE__);
+			$new_status = false;
+		}
+		return $new_status;
+	}
 
 
-    /**
-     * Takes care of deleting multiple EE_Checkin table rows
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_checkin_rows()
-    {
-        $query_args = array(
-            'action'  => 'registration_checkins',
-            'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
-            '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
-        );
-        $errors = 0;
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
-            while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) {
-                if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
-                    $errors++;
-                }
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            $this->_redirect_after_action(false, '', '', $query_args, true);
-        }
-        if ($errors > 0) {
-            EE_Error::add_error(
-                sprintf(__('There were %d records that did not delete successfully', 'event_espresso'), $errors),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        } else {
-            EE_Error::add_success(__('Records were successfully deleted', 'event_espresso'));
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * Takes care of deleting multiple EE_Checkin table rows
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_checkin_rows()
+	{
+		$query_args = array(
+			'action'  => 'registration_checkins',
+			'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
+			'_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
+		);
+		$errors = 0;
+		if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+			while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) {
+				if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
+					$errors++;
+				}
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'So, something went wrong with the bulk delete because there was no data received for instructions on WHAT to delete!',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			$this->_redirect_after_action(false, '', '', $query_args, true);
+		}
+		if ($errors > 0) {
+			EE_Error::add_error(
+				sprintf(__('There were %d records that did not delete successfully', 'event_espresso'), $errors),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		} else {
+			EE_Error::add_success(__('Records were successfully deleted', 'event_espresso'));
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     * Deletes a single EE_Checkin row
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _delete_checkin_row()
-    {
-        $query_args = array(
-            'action'  => 'registration_checkins',
-            'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
-            '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
-        );
-        if (! empty($this->_req_data['CHK_ID'])) {
-            if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
-                EE_Error::add_error(
-                    esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_success(__('Check-In record successfully deleted', 'event_espresso'));
-            }
-        } else {
-            EE_Error::add_error(
-                esc_html__(
-                    'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $this->_redirect_after_action(false, '', '', $query_args, true);
-    }
+	/**
+	 * Deletes a single EE_Checkin row
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _delete_checkin_row()
+	{
+		$query_args = array(
+			'action'  => 'registration_checkins',
+			'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
+			'_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
+		);
+		if (! empty($this->_req_data['CHK_ID'])) {
+			if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
+				EE_Error::add_error(
+					esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_success(__('Check-In record successfully deleted', 'event_espresso'));
+			}
+		} else {
+			EE_Error::add_error(
+				esc_html__(
+					'In order to delete a Check-in record, there must be a Check-In ID available. There is not. It is not your fault, there is just a gremlin living in the code',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$this->_redirect_after_action(false, '', '', $query_args, true);
+	}
 
 
-    /**
-     *        generates HTML for the Event Registrations List Table
-     *
-     * @access protected
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _event_registrations_list_table()
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $this->_admin_page_title .= isset($this->_req_data['event_id'])
-            ? $this->get_action_link_or_button(
-                'new_registration',
-                'add-registrant',
-                array('event_id' => $this->_req_data['event_id']),
-                'add-new-h2',
-                '',
-                false
-            )
-            : '';
-        $checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
-        $checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
-        $checked_never = new CheckinStatusDashicon(EE_Checkin::status_checked_never);
-        $legend_items = array(
-            'star-icon'        => array(
-                'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
-                'desc'  => esc_html__('This Registrant is the Primary Registrant', 'event_espresso'),
-            ),
-            'checkin'          => array(
-                'class' => $checked_in->cssClasses(),
-                'desc'  => $checked_in->legendLabel(),
-            ),
-            'checkout'         => array(
-                'class' => $checked_out->cssClasses(),
-                'desc'  => $checked_out->legendLabel(),
-            ),
-            'nocheckinrecord'  => array(
-                'class' => $checked_never->cssClasses(),
-                'desc'  => $checked_never->legendLabel(),
-            ),
-            'approved_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
-            ),
-            'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
-            ),
-            'declined_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
-            ),
-            'not_approved'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
-            ),
-            'pending_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
-            ),
-            'wait_list'        => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
-                'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
-            ),
-        );
-        $this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
-        $event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
-        /** @var EE_Event $event */
-        $event = EEM_Event::instance()->get_one_by_ID($event_id);
-        $this->_template_args['before_list_table'] = $event instanceof EE_Event
-            ? '<h2>' . sprintf(
-                esc_html__('Viewing Registrations for Event: %s', 'event_espresso'),
-                EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
-            ) . '</h2>'
-            : '';
-        // need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on
-        // the event.
-        $DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0;
-        $datetime = null;
-        if ($event instanceof EE_Event) {
-            $datetimes_on_event = $event->datetimes();
-            if (count($datetimes_on_event) === 1) {
-                $datetime = reset($datetimes_on_event);
-            }
-        }
-        $datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') {
-            $this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5);
-            $this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
-            $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
-            $this->_template_args['before_list_table'] .= $datetime->name();
-            $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
-            $this->_template_args['before_list_table'] .= '</span></h2>';
-        }
-        // if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status
-        // column represents
-        if (! $datetime instanceof EE_Datetime) {
-            $this->_template_args['before_list_table'] .= '<br><p class="description">'
-                                                          . esc_html__(
-                                                              'In this view, the check-in status represents the latest check-in record for the registration in that row.',
-                                                              'event_espresso'
-                                                          )
-                                                          . '</p>';
-        }
-        $this->display_admin_list_table_page_with_no_sidebar();
-    }
+	/**
+	 *        generates HTML for the Event Registrations List Table
+	 *
+	 * @access protected
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _event_registrations_list_table()
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$this->_admin_page_title .= isset($this->_req_data['event_id'])
+			? $this->get_action_link_or_button(
+				'new_registration',
+				'add-registrant',
+				array('event_id' => $this->_req_data['event_id']),
+				'add-new-h2',
+				'',
+				false
+			)
+			: '';
+		$checked_in = new CheckinStatusDashicon(EE_Checkin::status_checked_in);
+		$checked_out = new CheckinStatusDashicon(EE_Checkin::status_checked_out);
+		$checked_never = new CheckinStatusDashicon(EE_Checkin::status_checked_never);
+		$legend_items = array(
+			'star-icon'        => array(
+				'class' => 'dashicons dashicons-star-filled lt-blue-icon ee-icon-size-8',
+				'desc'  => esc_html__('This Registrant is the Primary Registrant', 'event_espresso'),
+			),
+			'checkin'          => array(
+				'class' => $checked_in->cssClasses(),
+				'desc'  => $checked_in->legendLabel(),
+			),
+			'checkout'         => array(
+				'class' => $checked_out->cssClasses(),
+				'desc'  => $checked_out->legendLabel(),
+			),
+			'nocheckinrecord'  => array(
+				'class' => $checked_never->cssClasses(),
+				'desc'  => $checked_never->legendLabel(),
+			),
+			'approved_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
+			),
+			'cancelled_status' => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
+			),
+			'declined_status'  => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
+			),
+			'not_approved'     => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
+			),
+			'pending_status'   => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
+			),
+			'wait_list'        => array(
+				'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+				'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
+			),
+		);
+		$this->_template_args['after_list_table'] = $this->_display_legend($legend_items);
+		$event_id = isset($this->_req_data['event_id']) ? $this->_req_data['event_id'] : null;
+		/** @var EE_Event $event */
+		$event = EEM_Event::instance()->get_one_by_ID($event_id);
+		$this->_template_args['before_list_table'] = $event instanceof EE_Event
+			? '<h2>' . sprintf(
+				esc_html__('Viewing Registrations for Event: %s', 'event_espresso'),
+				EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
+			) . '</h2>'
+			: '';
+		// need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on
+		// the event.
+		$DTT_ID = ! empty($this->_req_data['DTT_ID']) ? absint($this->_req_data['DTT_ID']) : 0;
+		$datetime = null;
+		if ($event instanceof EE_Event) {
+			$datetimes_on_event = $event->datetimes();
+			if (count($datetimes_on_event) === 1) {
+				$datetime = reset($datetimes_on_event);
+			}
+		}
+		$datetime = $datetime instanceof EE_Datetime ? $datetime : EEM_Datetime::instance()->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime && $this->_template_args['before_list_table'] !== '') {
+			$this->_template_args['before_list_table'] = substr($this->_template_args['before_list_table'], 0, -5);
+			$this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
+			$this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
+			$this->_template_args['before_list_table'] .= $datetime->name();
+			$this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
+			$this->_template_args['before_list_table'] .= '</span></h2>';
+		}
+		// if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status
+		// column represents
+		if (! $datetime instanceof EE_Datetime) {
+			$this->_template_args['before_list_table'] .= '<br><p class="description">'
+														  . esc_html__(
+															  'In this view, the check-in status represents the latest check-in record for the registration in that row.',
+															  'event_espresso'
+														  )
+														  . '</p>';
+		}
+		$this->display_admin_list_table_page_with_no_sidebar();
+	}
 
-    /**
-     * Download the registrations check-in report (same as the normal registration report, but with different where
-     * conditions)
-     *
-     * @return void ends the request by a redirect or download
-     */
-    public function _registrations_checkin_report()
-    {
-        $this->_registrations_report_base('_get_checkin_query_params_from_request');
-    }
+	/**
+	 * Download the registrations check-in report (same as the normal registration report, but with different where
+	 * conditions)
+	 *
+	 * @return void ends the request by a redirect or download
+	 */
+	public function _registrations_checkin_report()
+	{
+		$this->_registrations_report_base('_get_checkin_query_params_from_request');
+	}
 
-    /**
-     * Gets the query params from the request, plus adds a where condition for the registration status,
-     * because on the checkin page we only ever want to see approved and pending-approval registrations
-     *
-     * @param array $request
-     * @param int   $per_page
-     * @param bool  $count
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_checkin_query_params_from_request(
-        $request,
-        $per_page = 10,
-        $count = false
-    ) {
-        $query_params = $this->_get_registration_query_parameters($request, $per_page, $count);
-        // unlike the regular registrations list table,
-        $status_ids_array = apply_filters(
-            'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
-            array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
-        );
-        $query_params[0]['STS_ID'] = array('IN', $status_ids_array);
-        return $query_params;
-    }
+	/**
+	 * Gets the query params from the request, plus adds a where condition for the registration status,
+	 * because on the checkin page we only ever want to see approved and pending-approval registrations
+	 *
+	 * @param array $request
+	 * @param int   $per_page
+	 * @param bool  $count
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_checkin_query_params_from_request(
+		$request,
+		$per_page = 10,
+		$count = false
+	) {
+		$query_params = $this->_get_registration_query_parameters($request, $per_page, $count);
+		// unlike the regular registrations list table,
+		$status_ids_array = apply_filters(
+			'FHEE__Extend_Registrations_Admin_Page__get_event_attendees__status_ids_array',
+			array(EEM_Registration::status_id_pending_payment, EEM_Registration::status_id_approved)
+		);
+		$query_params[0]['STS_ID'] = array('IN', $status_ids_array);
+		return $query_params;
+	}
 
 
-    /**
-     * Gets registrations for an event
-     *
-     * @param int    $per_page
-     * @param bool   $count whether to return count or data.
-     * @param bool   $trash
-     * @param string $orderby
-     * @return EE_Registration[]|int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname')
-    {
-        // normalize some request params that get setup by the parent `get_registrations` method.
-        $request = $this->_req_data;
-        $request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby;
-        $request['order'] = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
-        if ($trash) {
-            $request['status'] = 'trash';
-        }
-        $query_params = $this->_get_checkin_query_params_from_request($request, $per_page, $count);
-        /**
-         * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
-         *
-         * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
-         * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-         *                             or if you have the development copy of EE you can view this at the path:
-         *                             /docs/G--Model-System/model-query-params.md
-         */
-        $query_params['group_by'] = '';
+	/**
+	 * Gets registrations for an event
+	 *
+	 * @param int    $per_page
+	 * @param bool   $count whether to return count or data.
+	 * @param bool   $trash
+	 * @param string $orderby
+	 * @return EE_Registration[]|int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_event_attendees($per_page = 10, $count = false, $trash = false, $orderby = 'ATT_fname')
+	{
+		// normalize some request params that get setup by the parent `get_registrations` method.
+		$request = $this->_req_data;
+		$request['orderby'] = ! empty($this->_req_data['orderby']) ? $this->_req_data['orderby'] : $orderby;
+		$request['order'] = ! empty($this->_req_data['order']) ? $this->_req_data['order'] : 'ASC';
+		if ($trash) {
+			$request['status'] = 'trash';
+		}
+		$query_params = $this->_get_checkin_query_params_from_request($request, $per_page, $count);
+		/**
+		 * Override the default groupby added by EEM_Base so that sorts with multiple order bys work as expected
+		 *
+		 * @link https://events.codebasehq.com/projects/event-espresso/tickets/10093
+		 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+		 *                             or if you have the development copy of EE you can view this at the path:
+		 *                             /docs/G--Model-System/model-query-params.md
+		 */
+		$query_params['group_by'] = '';
 
-        return $count
-            ? EEM_Registration::instance()->count($query_params)
-            /** @type EE_Registration[] */
-            : EEM_Registration::instance()->get_all($query_params);
-    }
+		return $count
+			? EEM_Registration::instance()->count($query_params)
+			/** @type EE_Registration[] */
+			: EEM_Registration::instance()->get_all($query_params);
+	}
 }

Spacing +50 added lines, -50 removed lines

@@ -32,10 +32,10 @@ 
     public function __construct($routing = true)
     {
         parent::__construct($routing);
-        if (! defined('REG_CAF_TEMPLATE_PATH')) {
-            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/templates/');
-            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND . 'registrations/assets/');
-            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL . 'registrations/assets/');
+        if ( ! defined('REG_CAF_TEMPLATE_PATH')) {
+            define('REG_CAF_TEMPLATE_PATH', EE_CORE_CAF_ADMIN_EXTEND.'registrations/templates/');
+            define('REG_CAF_ASSETS', EE_CORE_CAF_ADMIN_EXTEND.'registrations/assets/');
+            define('REG_CAF_ASSETS_URL', EE_CORE_CAF_ADMIN_EXTEND_URL.'registrations/assets/');
         }
     }
 
@@ -45,7 +45,7 @@ 
      */
     protected function _extend_page_config()
     {
-        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND . 'registrations';
+        $this->_admin_base_path = EE_CORE_CAF_ADMIN_EXTEND.'registrations';
         $reg_id = ! empty($this->_req_data['_REG_ID']) && ! is_array($this->_req_data['_REG_ID'])
             ? $this->_req_data['_REG_ID']
             : 0;
@@ -185,14 +185,14 @@ 
             // enqueue newsletter js
             wp_enqueue_script(
                 'ee-newsletter-trigger',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.js',
+                REG_CAF_ASSETS_URL.'ee-newsletter-trigger.js',
                 array('ee-dialog'),
                 EVENT_ESPRESSO_VERSION,
                 true
             );
             wp_enqueue_style(
                 'ee-newsletter-trigger-css',
-                REG_CAF_ASSETS_URL . 'ee-newsletter-trigger.css',
+                REG_CAF_ASSETS_URL.'ee-newsletter-trigger.css',
                 array(),
                 EVENT_ESPRESSO_VERSION
             );
@@ -213,7 +213,7 @@ 
     {
         wp_register_script(
             'ee-reg-reports-js',
-            REG_CAF_ASSETS_URL . 'ee-registration-admin-reports.js',
+            REG_CAF_ASSETS_URL.'ee-registration-admin-reports.js',
             array('google-charts'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -299,7 +299,7 @@ 
         $nonce_ref = 'get_newsletter_form_content_nonce';
         $this->_verify_nonce($nonce, $nonce_ref);
         // let's get the mtp for the incoming MTP_ ID
-        if (! isset($this->_req_data['GRP_ID'])) {
+        if ( ! isset($this->_req_data['GRP_ID'])) {
             EE_Error::add_error(
                 esc_html__(
                     'There must be something broken with the js or html structure because the required data for getting a message template group is not present (need an GRP_ID).',
@@ -314,7 +314,7 @@ 
             $this->_return_json();
         }
         $MTPG = EEM_Message_Template_Group::instance()->get_one_by_ID($this->_req_data['GRP_ID']);
-        if (! $MTPG instanceof EE_Message_Template_Group) {
+        if ( ! $MTPG instanceof EE_Message_Template_Group) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -339,12 +339,12 @@ 
             $field = $MTP->get('MTP_template_field');
             if ($field === 'content') {
                 $content = $MTP->get('MTP_content');
-                if (! empty($content['newsletter_content'])) {
+                if ( ! empty($content['newsletter_content'])) {
                     $template_fields['newsletter_content'] = $content['newsletter_content'];
                 }
                 continue;
             }
-            $template_fields[ $MTP->get('MTP_template_field') ] = $MTP->get('MTP_content');
+            $template_fields[$MTP->get('MTP_template_field')] = $MTP->get('MTP_content');
         }
         $this->_template_args['success'] = true;
         $this->_template_args['error'] = false;
@@ -375,7 +375,7 @@ 
      */
     public function add_newsletter_action_buttons(EE_Admin_List_Table $list_table)
     {
-        if (! EE_Registry::instance()->CAP->current_user_can(
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
             'ee_send_message',
             'espresso_registrations_newsletter_selected_send'
         )
@@ -444,17 +444,17 @@ 
                 $field_id = $field === '[NEWSLETTER_CONTENT]'
                     ? 'content'
                     : $field;
-                $field_id = 'batch-message-' . strtolower($field_id);
+                $field_id = 'batch-message-'.strtolower($field_id);
                 $available_shortcodes[] = '<span class="js-shortcode-selection" data-value="'
                                           . $shortcode
-                                          . '" data-linked-input-id="' . $field_id . '">'
+                                          . '" data-linked-input-id="'.$field_id.'">'
                                           . $shortcode
                                           . '</span>';
             }
-            $codes[ $field ] = implode(', ', $available_shortcodes);
+            $codes[$field] = implode(', ', $available_shortcodes);
         }
         $shortcodes = $codes;
-        $form_template = REG_CAF_TEMPLATE_PATH . 'newsletter-send-form.template.php';
+        $form_template = REG_CAF_TEMPLATE_PATH.'newsletter-send-form.template.php';
         $form_template_args = array(
             'form_action'       => admin_url('admin.php?page=espresso_registrations'),
             'form_route'        => 'newsletter_selected_send',
@@ -622,7 +622,7 @@ 
      */
     protected function _registration_reports()
     {
-        $template_path = EE_ADMIN_TEMPLATE . 'admin_reports.template.php';
+        $template_path = EE_ADMIN_TEMPLATE.'admin_reports.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
             $template_path,
             $this->_reports_template_data,
@@ -677,7 +677,7 @@ 
             array_unshift($regs, $column_titles);
             // setup the date range.
             $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
+            $beginning_date = new DateTime("now ".$period, $DateTimeZone);
             $ending_date = new DateTime("now", $DateTimeZone);
             $subtitle = sprintf(
                 _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
@@ -697,7 +697,7 @@ 
                     '%sThere are currently no registration records in the last month for this report.%s',
                     'event_espresso'
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -750,7 +750,7 @@ 
             array_unshift($regs, $column_titles);
             // setup the date range.
             $DateTimeZone = new DateTimeZone(EEH_DTT_Helper::get_timezone());
-            $beginning_date = new DateTime("now " . $period, $DateTimeZone);
+            $beginning_date = new DateTime("now ".$period, $DateTimeZone);
             $ending_date = new DateTime("now", $DateTimeZone);
             $subtitle = sprintf(
                 _x('For the period: %1$s to %2$s', 'Used to give date range', 'event_espresso'),
@@ -770,7 +770,7 @@ 
                     '%sThere are currently no registration records in the last month for this report.%s',
                     'event_espresso'
                 ),
-                '<h2>' . $report_title . '</h2><p>',
+                '<h2>'.$report_title.'</h2><p>',
                 '</p>'
             ),
         );
@@ -796,7 +796,7 @@ 
         $reg_id = isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : null;
         /** @var EE_Registration $registration */
         $registration = EEM_Registration::instance()->get_one_by_ID($reg_id);
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('An error occurred. There is no registration with ID (%d)', 'event_espresso'),
@@ -831,7 +831,7 @@ 
         if ($datetime instanceof EE_Datetime) {
             $datetime_label = $datetime->get_dtt_display_name(true);
             $datetime_label .= ! empty($datetime_label)
-                ? ' (' . $datetime->get_dtt_display_name() . ')'
+                ? ' ('.$datetime->get_dtt_display_name().')'
                 : $datetime->get_dtt_display_name();
         }
         $datetime_link = ! empty($dtt_id) && $registration instanceof EE_Registration
@@ -845,7 +845,7 @@ 
             )
             : '';
         $datetime_link = ! empty($datetime_link)
-            ? '<a href="' . $datetime_link . '">'
+            ? '<a href="'.$datetime_link.'">'
               . '<span id="checkin-dtt">'
               . $datetime_label
               . '</span></a>'
@@ -857,8 +857,8 @@ 
             ? $attendee->get_admin_details_link()
             : '';
         $attendee_link = ! empty($attendee_link)
-            ? '<a href="' . $attendee->get_admin_details_link() . '"'
-              . ' title="' . esc_html__('Click for attendee details', 'event_espresso') . '">'
+            ? '<a href="'.$attendee->get_admin_details_link().'"'
+              . ' title="'.esc_html__('Click for attendee details', 'event_espresso').'">'
               . '<span id="checkin-attendee-name">'
               . $attendee_name
               . '</span></a>'
@@ -867,25 +867,25 @@ 
             ? $registration->event()->get_admin_details_link()
             : '';
         $event_link = ! empty($event_link)
-            ? '<a href="' . $event_link . '"'
-              . ' title="' . esc_html__('Click here to edit event.', 'event_espresso') . '">'
+            ? '<a href="'.$event_link.'"'
+              . ' title="'.esc_html__('Click here to edit event.', 'event_espresso').'">'
               . '<span id="checkin-event-name">'
               . $registration->event_name()
               . '</span>'
               . '</a>'
             : '';
         $this->_template_args['before_list_table'] = ! empty($reg_id) && ! empty($dtt_id)
-            ? '<h2>' . sprintf(
+            ? '<h2>'.sprintf(
                 esc_html__('Displaying check in records for %1$s for %2$s at the event, %3$s', 'event_espresso'),
                 $attendee_link,
                 $datetime_link,
                 $event_link
-            ) . '</h2>'
+            ).'</h2>'
             : '';
         $this->_template_args['list_table_hidden_fields'] = ! empty($reg_id)
-            ? '<input type="hidden" name="_REG_ID" value="' . $reg_id . '">' : '';
+            ? '<input type="hidden" name="_REG_ID" value="'.$reg_id.'">' : '';
         $this->_template_args['list_table_hidden_fields'] .= ! empty($dtt_id)
-            ? '<input type="hidden" name="DTT_ID" value="' . $dtt_id . '">' : '';
+            ? '<input type="hidden" name="DTT_ID" value="'.$dtt_id.'">' : '';
         $this->display_admin_list_table_page_with_no_sidebar();
     }
 
@@ -902,7 +902,7 @@ 
     public function toggle_checkin_status()
     {
         // first make sure we have the necessary data
-        if (! isset($this->_req_data['_regid'])) {
+        if ( ! isset($this->_req_data['_regid'])) {
             EE_Error::add_error(
                 esc_html__(
                     'There must be something broken with the html structure because the required data for toggling the Check-in status is not being sent via ajax',
@@ -924,7 +924,7 @@ 
         // beautiful! Made it this far so let's get the status.
         $new_status = new CheckinStatusDashicon($this->_toggle_checkin_status());
         // setup new class to return via ajax
-        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin ' . $new_status->cssClasses();
+        $this->_template_args['admin_page_content'] = 'clickable trigger-checkin '.$new_status->cssClasses();
         $this->_template_args['success'] = true;
         $this->_return_json();
     }
@@ -950,7 +950,7 @@ 
         );
         $new_status = false;
         // bulk action check in toggle
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             // cycle thru checkboxes
             while (list($REG_ID, $value) = each($this->_req_data['checkbox'])) {
                 $DTT_ID = isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : null;
@@ -1020,9 +1020,9 @@ 
             '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
         );
         $errors = 0;
-        if (! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
+        if ( ! empty($this->_req_data['checkbox']) && is_array($this->_req_data['checkbox'])) {
             while (list($CHK_ID, $value) = each($this->_req_data['checkbox'])) {
-                if (! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
+                if ( ! EEM_Checkin::instance()->delete_by_ID($CHK_ID)) {
                     $errors++;
                 }
             }
@@ -1068,8 +1068,8 @@ 
             'DTT_ID'  => isset($this->_req_data['DTT_ID']) ? $this->_req_data['DTT_ID'] : 0,
             '_REG_ID' => isset($this->_req_data['_REG_ID']) ? $this->_req_data['_REG_ID'] : 0,
         );
-        if (! empty($this->_req_data['CHK_ID'])) {
-            if (! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
+        if ( ! empty($this->_req_data['CHK_ID'])) {
+            if ( ! EEM_Checkin::instance()->delete_by_ID($this->_req_data['CHK_ID'])) {
                 EE_Error::add_error(
                     esc_html__('Something went wrong and this check-in record was not deleted', 'event_espresso'),
                     __FILE__,
@@ -1138,27 +1138,27 @@ 
                 'desc'  => $checked_never->legendLabel(),
             ),
             'approved_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_approved,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_approved, false, 'sentence'),
             ),
             'cancelled_status' => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_cancelled,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_cancelled,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_cancelled, false, 'sentence'),
             ),
             'declined_status'  => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_declined,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_declined,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_declined, false, 'sentence'),
             ),
             'not_approved'     => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_not_approved,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_not_approved,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_not_approved, false, 'sentence'),
             ),
             'pending_status'   => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_pending_payment,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_pending_payment,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_pending_payment, false, 'sentence'),
             ),
             'wait_list'        => array(
-                'class' => 'ee-status-legend ee-status-legend-' . EEM_Registration::status_id_wait_list,
+                'class' => 'ee-status-legend ee-status-legend-'.EEM_Registration::status_id_wait_list,
                 'desc'  => EEH_Template::pretty_status(EEM_Registration::status_id_wait_list, false, 'sentence'),
             ),
         );
@@ -1167,10 +1167,10 @@ 
         /** @var EE_Event $event */
         $event = EEM_Event::instance()->get_one_by_ID($event_id);
         $this->_template_args['before_list_table'] = $event instanceof EE_Event
-            ? '<h2>' . sprintf(
+            ? '<h2>'.sprintf(
                 esc_html__('Viewing Registrations for Event: %s', 'event_espresso'),
                 EEM_Event::instance()->get_one_by_ID($event_id)->get('EVT_name')
-            ) . '</h2>'
+            ).'</h2>'
             : '';
         // need to get the number of datetimes on the event and set default datetime_id if there is only one datetime on
         // the event.
@@ -1188,12 +1188,12 @@ 
             $this->_template_args['before_list_table'] .= ' &nbsp;<span class="drk-grey-text">';
             $this->_template_args['before_list_table'] .= '<span class="dashicons dashicons-calendar"></span>';
             $this->_template_args['before_list_table'] .= $datetime->name();
-            $this->_template_args['before_list_table'] .= ' ( ' . $datetime->date_and_time_range() . ' )';
+            $this->_template_args['before_list_table'] .= ' ( '.$datetime->date_and_time_range().' )';
             $this->_template_args['before_list_table'] .= '</span></h2>';
         }
         // if no datetime, then we're on the initial view, so let's give some helpful instructions on what the status
         // column represents
-        if (! $datetime instanceof EE_Datetime) {
+        if ( ! $datetime instanceof EE_Datetime) {
             $this->_template_args['before_list_table'] .= '<br><p class="description">'
                                                           . esc_html__(
                                                               'In this view, the check-in status represents the latest check-in record for the registration in that row.',