eventespresso / event-espresso-core

core/business/EE_Transaction_Processor.class.php

Spacing +7 added lines, -7 removed lines

@@ -53,7 +53,7 @@ 
     public static function instance($registration_query_params = array())
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
+        if ( ! self::$_instance instanceof EE_Transaction_Processor) {
             self::$_instance = new self($registration_query_params);
         }
         return self::$_instance;
@@ -311,7 +311,7 @@ 
         // these reg statuses should not be considered in any calculations involving monies owing
         $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
             : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+        if ( ! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
             return false;
         }
         try {
@@ -365,7 +365,7 @@ 
     public function get_transaction_for_registration(EE_Registration $registration)
     {
         $transaction = $registration->transaction();
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
@@ -395,7 +395,7 @@ 
             $transaction->ID(),
             $registration->ticket_ID()
         );
-        if (! $ticket_line_item instanceof EE_Line_Item) {
+        if ( ! $ticket_line_item instanceof EE_Line_Item) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -479,7 +479,7 @@ 
         /** @type EE_Registration_Processor $registration_processor */
         $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
         // check that method exists
-        if (! method_exists($registration_processor, $method_name)) {
+        if ( ! method_exists($registration_processor, $method_name)) {
             throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
         }
         // make sure some query params are set for retrieving registrations
@@ -537,7 +537,7 @@ 
                         $transaction,
                         EEM_Payment_Method::scope_cart
                     );
-                    if (! empty($available_payment_methods)) {
+                    if ( ! empty($available_payment_methods)) {
                         $PMD_ID = 0;
                         foreach ($available_payment_methods as $available_payment_method) {
                             if (
@@ -548,7 +548,7 @@ 
                                 break;
                             }
                         }
-                        if (! $PMD_ID) {
+                        if ( ! $PMD_ID) {
                             $first_payment_method = reset($available_payment_methods);
                             if ($first_payment_method instanceof EE_Payment_Method) {
                                 $PMD_ID = $first_payment_method->ID();

Indentation +948 added lines, -948 removed lines

@@ -16,952 +16,952 @@
  */
 class EE_Transaction_Processor extends EE_Processor_Base
 {
-    /**
-     * @var EE_Registration_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * array of query WHERE params to use when retrieving cached registrations from a transaction
-     *
-     * @var array $registration_query_params
-     * @access private
-     */
-    private $_registration_query_params = array();
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_old_txn_status;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_new_txn_status;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @param array $registration_query_params
-     * @return EE_Transaction_Processor instance
-     */
-    public static function instance($registration_query_params = array())
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Processor) {
-            self::$_instance = new self($registration_query_params);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @param array $registration_query_params
-     */
-    private function __construct($registration_query_params = array())
-    {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-    }
-
-
-    /**
-     * @access private
-     * @param array $registration_query_params
-     */
-    private function _set_registration_query_params($registration_query_params)
-    {
-        $this->_registration_query_params = ! empty($registration_query_params) ? $registration_query_params
-            : array('order_by' => array('REG_count' => 'ASC'));
-    }
-
-
-    /**
-     * manually_update_registration_statuses
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param string         $new_reg_status
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function manually_update_registration_statuses(
-        EE_Transaction $transaction,
-        $new_reg_status = '',
-        $registration_query_params = array()
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'manually_update_registration_status',
-            $transaction,
-            $registration_query_params,
-            $new_reg_status
-        );
-        // send messages
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        $registration_processor->trigger_registration_update_notifications(
-            $transaction->primary_registration(),
-            array('manually_updated' => true)
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * toggle_registration_statuses_for_default_approved_events
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_registration_statuses_for_default_approved_events(
-        EE_Transaction $transaction,
-        $registration_query_params = array()
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'toggle_registration_status_for_default_approved_events',
-            $transaction,
-            $registration_query_params
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * toggle_registration_statuses_if_no_monies_owing
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_registration_statuses_if_no_monies_owing(
-        EE_Transaction $transaction,
-        $registration_query_params = array()
-    ) {
-        $status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
-            'toggle_registration_status_if_no_monies_owing',
-            $transaction,
-            $registration_query_params
-        );
-        do_action(
-            'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
-            $transaction,
-            $status_updates
-        );
-        return $status_updates;
-    }
-
-
-    /**
-     * update_transaction_and_registrations_after_checkout_or_payment
-     * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
-     *
-     * @param EE_Transaction     $transaction
-     * @param \EE_Payment | NULL $payment
-     * @param array              $registration_query_params    array of query WHERE params to use
-     *                                                         when retrieving cached registrations from a transaction
-     * @param bool               $trigger_notifications        whether or not to call
-     *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
-     * @return array
-     * @throws \EE_Error
-     */
-    public function update_transaction_and_registrations_after_checkout_or_payment(
-        EE_Transaction $transaction,
-        $payment = null,
-        $registration_query_params = array(),
-        $trigger_notifications = true
-    ) {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // get final reg step status
-        $finalized = $transaction->final_reg_step_completed();
-        // if the 'finalize_registration' step has been initiated (has a timestamp)
-        // but has not yet been fully completed (TRUE)
-        if (is_int($finalized) && $finalized !== false && $finalized !== true) {
-            $transaction->set_reg_step_completed('finalize_registration');
-            $finalized = true;
-        }
-        $transaction->save();
-        // array of details to aid in decision making by systems
-        $update_params = array(
-            'old_txn_status'  => $transaction->old_txn_status(),
-            'new_txn_status'  => $transaction->status_ID(),
-            'finalized'       => $finalized,
-            'revisit'         => $this->_revisit,
-            'payment_updates' => $payment instanceof EE_Payment ? true : false,
-            'last_payment'    => $payment,
-        );
-        // now update the registrations and add the results to our $update_params
-        $update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
-            'update_registration_after_checkout_or_payment',
-            $transaction,
-            $this->_registration_query_params,
-            $update_params
-        );
-        if ($trigger_notifications) {
-            // send messages
-            /** @type EE_Registration_Processor $registration_processor */
-            $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-            $registration_processor->trigger_registration_update_notifications(
-                $transaction->primary_registration(),
-                $update_params
-            );
-        }
-        do_action(
-            'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
-            $transaction,
-            $update_params
-        );
-        return $update_params;
-    }
-
-
-    /**
-     * update_transaction_after_registration_reopened
-     * readjusts TXN and Line Item totals after a registration is changed from
-     * cancelled or declined to another reg status such as pending payment or approved
-     *
-     * @param \EE_Registration $registration
-     * @param array            $closed_reg_statuses
-     * @param bool             $update_txn
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function update_transaction_after_reinstating_canceled_registration(
-        EE_Registration $registration,
-        $closed_reg_statuses = array(),
-        $update_txn = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        try {
-            $transaction = $this->get_transaction_for_registration($registration);
-            $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
-                $transaction,
-                $registration
-            );
-            // un-cancel the ticket
-            $success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
-                        'event_espresso'
-                    ),
-                    $registration->ID(),
-                    '<br />',
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if ($update_txn) {
-            return $transaction->save() ? $success : false;
-        }
-        return $success;
-    }
-
-
-    /**
-     * update_transaction_after_canceled_or_declined_registration
-     * readjusts TXN and Line Item totals after a registration is cancelled or declined
-     *
-     * @param \EE_Registration $registration
-     * @param array            $closed_reg_statuses
-     * @param bool             $update_txn
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function update_transaction_after_canceled_or_declined_registration(
-        EE_Registration $registration,
-        $closed_reg_statuses = array(),
-        $update_txn = true
-    ) {
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
-            return false;
-        }
-        try {
-            $transaction = $this->get_transaction_for_registration($registration);
-            if (
-                apply_filters(
-                    'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
-                    true,
-                    $registration,
-                    $transaction
-                )
-            ) {
-                $ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
-                    $transaction,
-                    $registration
-                );
-                EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
-            }
-        } catch (EE_Error $e) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s',
-                        'event_espresso'
-                    ),
-                    $registration->ID(),
-                    '<br />',
-                    $e->getMessage()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if ($update_txn) {
-            return $transaction->save() ? true : false;
-        }
-        return true;
-    }
-
-
-    /**
-     * get_transaction_for_registration
-     *
-     * @access    public
-     * @param    EE_Registration $registration
-     * @return    EE_Transaction
-     * @throws    EE_Error
-     */
-    public function get_transaction_for_registration(EE_Registration $registration)
-    {
-        $transaction = $registration->transaction();
-        if (! $transaction instanceof EE_Transaction) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
-                    $registration->ID()
-                )
-            );
-        }
-        return $transaction;
-    }
-
-
-    /**
-     * get_ticket_line_item_for_transaction_registration
-     *
-     * @access    public
-     * @param    EE_Transaction  $transaction
-     * @param    EE_Registration $registration
-     * @return    EE_Line_Item
-     * @throws    EE_Error
-     */
-    public function get_ticket_line_item_for_transaction_registration(
-        EE_Transaction $transaction,
-        EE_Registration $registration
-    ) {
-        EE_Registry::instance()->load_helper('Line_Item');
-        $ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
-            $transaction->ID(),
-            $registration->ticket_ID()
-        );
-        if (! $ticket_line_item instanceof EE_Line_Item) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
-                        'event_espresso'
-                    ),
-                    $transaction->ID(),
-                    $registration->ticket_ID()
-                )
-            );
-        }
-        return $ticket_line_item;
-    }
-
-
-    /**
-     * cancel_transaction_if_all_registrations_canceled
-     * cycles thru related registrations and checks their statuses
-     * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
-     *
-     * @access    public
-     * @param    EE_Transaction $transaction
-     * @param    string         $new_TXN_status
-     * @param    array          $registration_query_params - array of query WHERE params to use when
-     *                                                     retrieving cached registrations from a transaction
-     * @param    array          $closed_reg_statuses
-     * @param    bool           $update_txn
-     * @return    bool            true if TXN status was updated, false if not
-     */
-    public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
-        EE_Transaction $transaction,
-        $new_TXN_status = '',
-        $registration_query_params = array(),
-        $closed_reg_statuses = array(),
-        $update_txn = true
-    ) {
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // these reg statuses should not be considered in any calculations involving monies owing
-        $closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
-            : EEM_Registration::closed_reg_statuses();
-        // loop through cached registrations
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
-            if (
-                $registration instanceof EE_Registration
-                && ! in_array($registration->status_ID(), $closed_reg_statuses)
-            ) {
-                return false;
-            }
-        }
-        if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
-            $transaction->set_status($new_TXN_status);
-        }
-        if ($update_txn) {
-            return $transaction->save() ? true : false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _call_method_on_registrations_via_Registration_Processor
-     * cycles thru related registrations and calls the requested method on each
-     *
-     * @access private
-     * @param string         $method_name
-     * @param EE_Transaction $transaction
-     * @param array          $registration_query_params array of query WHERE params to use
-     *                                                  when retrieving cached registrations from a transaction
-     * @param string         $additional_param
-     * @throws \EE_Error
-     * @return boolean
-     */
-    private function _call_method_on_registrations_via_Registration_Processor(
-        $method_name,
-        EE_Transaction $transaction,
-        $registration_query_params = array(),
-        $additional_param = null
-    ) {
-        $response = false;
-        /** @type EE_Registration_Processor $registration_processor */
-        $registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
-        // check that method exists
-        if (! method_exists($registration_processor, $method_name)) {
-            throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
-        }
-        // make sure some query params are set for retrieving registrations
-        $this->_set_registration_query_params($registration_query_params);
-        // loop through cached registrations
-        foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
-            if ($registration instanceof EE_Registration) {
-                if ($additional_param) {
-                    $response = $registration_processor->{$method_name}($registration, $additional_param)
-                        ? true
-                        : $response;
-                } else {
-                    $response = $registration_processor->{$method_name}($registration)
-                        ? true
-                        : $response;
-                }
-            }
-        }
-        return $response;
-    }
-
-
-    /**
-     * set_transaction_payment_method_based_on_registration_statuses
-     * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
-     * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
-     * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
-     *        the first "default" Payment Method
-     *        the first active Payment Method
-     *    whichever is found first.
-     *
-     * @param  EE_Registration $edited_registration
-     * @return void
-     * @throws \EE_Error
-     */
-    public function set_transaction_payment_method_based_on_registration_statuses(
-        EE_Registration $edited_registration
-    ) {
-        if ($edited_registration instanceof EE_Registration) {
-            $transaction = $edited_registration->transaction();
-            if ($transaction instanceof EE_Transaction) {
-                $all_not_approved = true;
-                foreach ($transaction->registrations() as $registration) {
-                    if ($registration instanceof EE_Registration) {
-                        // if any REG != "Not Approved" then toggle to false
-                        $all_not_approved = $registration->is_not_approved() ? $all_not_approved : false;
-                    }
-                }
-                // if ALL Registrations are "Not Approved"
-                if ($all_not_approved) {
-                    $transaction->set_payment_method_ID(null);
-                    $transaction->save();
-                } else {
-                    $available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
-                        $transaction,
-                        EEM_Payment_Method::scope_cart
-                    );
-                    if (! empty($available_payment_methods)) {
-                        $PMD_ID = 0;
-                        foreach ($available_payment_methods as $available_payment_method) {
-                            if (
-                                $available_payment_method instanceof EE_Payment_Method
-                                && $available_payment_method->open_by_default()
-                            ) {
-                                $PMD_ID = $available_payment_method->ID();
-                                break;
-                            }
-                        }
-                        if (! $PMD_ID) {
-                            $first_payment_method = reset($available_payment_methods);
-                            if ($first_payment_method instanceof EE_Payment_Method) {
-                                $PMD_ID = $first_payment_method->ID();
-                            } else {
-                                EE_Error::add_error(
-                                    esc_html__(
-                                        'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.',
-                                        'event_espresso'
-                                    ),
-                                    __FILE__,
-                                    __LINE__,
-                                    __FUNCTION__
-                                );
-                            }
-                        }
-                        $transaction->set_payment_method_ID($PMD_ID);
-                        $transaction->save();
-                    } else {
-                        EE_Error::add_error(
-                            esc_html__(
-                                'Please activate at least one Payment Method in order for things to operate correctly.',
-                                'event_espresso'
-                            ),
-                            __FILE__,
-                            __LINE__,
-                            __FUNCTION__
-                        );
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /********************************** DEPRECATED METHODS **********************************/
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function new_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $new_txn_status
-     */
-    public function set_new_txn_status($new_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        $this->_new_txn_status = $new_txn_status;
-    }
-
-
-    /**
-     * reg_status_updated
-     *
-     * @deprecated 4.9.12
-     * @return bool
-     */
-    public function txn_status_updated()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
-    }
-
-
-    /**
-     * all_reg_steps_completed
-     * returns:
-     *    true if ALL reg steps have been marked as completed
-     *        or false if any step is not completed
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @return boolean
-     */
-    public function all_reg_steps_completed(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed();
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
-     *        or false if any other step is not completed
-     *        or false if ALL steps are completed including the exception you are testing !!!
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @param string         $exception
-     * @return boolean
-     */
-    public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed_except($exception);
-    }
-
-
-    /**
-     * all_reg_steps_completed_except
-     * returns:
-     *        true if ALL reg steps, except the final step, have been marked as completed
-     *        or false if any step is not completed
-     *    or false if ALL steps are completed including the final step !!!
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @return boolean
-     */
-    public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except_final_step(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->all_reg_steps_completed_except_final_step();
-    }
-
-
-    /**
-     * reg_step_completed
-     * returns:
-     *    true if a specific reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @param string         $reg_step_slug
-     * @return boolean | int
-     */
-    public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->reg_step_completed($reg_step_slug);
-    }
-
-
-    /**
-     * completed_final_reg_step
-     * returns:
-     *    true if the finalize_registration reg step has been marked as completed
-     *    a Unix timestamp if it has been initialized but not yet completed,
-     *    or false if it has not yet been initialized
-     *
-     * @deprecated 4.9.12
-     * @param EE_Transaction $transaction
-     * @return boolean | int
-     */
-    public function final_reg_step_completed(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::final_reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->final_reg_step_completed();
-    }
-
-
-    /**
-     * set_reg_step_initiated
-     * given a valid TXN_reg_step, this sets it's value to a unix timestamp
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_initiated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_initiated($reg_step_slug);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step, this sets the step as completed
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_completed($reg_step_slug);
-    }
-
-
-    /**
-     * set_reg_step_completed
-     * given a valid TXN_reg_step slug, this sets the step as NOT completed
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_reg_step_not_completed(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->set_reg_step_not_completed($reg_step_slug);
-    }
-
-
-    /**
-     * remove_reg_step
-     * given a valid TXN_reg_step slug, this will remove (unset)
-     * the reg step from the TXN reg step array
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param \EE_Transaction $transaction
-     * @param string          $reg_step_slug
-     * @return void
-     */
-    public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::remove_reg_step(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        $transaction->remove_reg_step($reg_step_slug);
-    }
-
-
-    /**
-     *    toggle_failed_transaction_status
-     * upgrades a TXNs status from failed to abandoned,
-     * meaning that contact information has been captured for at least one registrant
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param EE_Transaction $transaction
-     * @return    boolean
-     * @throws \EE_Error
-     */
-    public function toggle_failed_transaction_status(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::toggle_failed_transaction_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->toggle_failed_transaction_status();
-    }
-
-
-    /**
-     * toggle_abandoned_transaction_status
-     * upgrades a TXNs status from failed or abandoned to incomplete
-     *
-     * @deprecated 4.9.12
-     * @access     public
-     * @param  EE_Transaction $transaction
-     * @return boolean
-     */
-    public function toggle_abandoned_transaction_status(EE_Transaction $transaction)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::toggle_abandoned_transaction_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12',
-            '5.0.0'
-        );
-        return $transaction->toggle_abandoned_transaction_status();
-    }
+	/**
+	 * @var EE_Registration_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * array of query WHERE params to use when retrieving cached registrations from a transaction
+	 *
+	 * @var array $registration_query_params
+	 * @access private
+	 */
+	private $_registration_query_params = array();
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_new_txn_status;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @param array $registration_query_params
+	 * @return EE_Transaction_Processor instance
+	 */
+	public static function instance($registration_query_params = array())
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Transaction_Processor) {
+			self::$_instance = new self($registration_query_params);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @param array $registration_query_params
+	 */
+	private function __construct($registration_query_params = array())
+	{
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+	}
+
+
+	/**
+	 * @access private
+	 * @param array $registration_query_params
+	 */
+	private function _set_registration_query_params($registration_query_params)
+	{
+		$this->_registration_query_params = ! empty($registration_query_params) ? $registration_query_params
+			: array('order_by' => array('REG_count' => 'ASC'));
+	}
+
+
+	/**
+	 * manually_update_registration_statuses
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param string         $new_reg_status
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function manually_update_registration_statuses(
+		EE_Transaction $transaction,
+		$new_reg_status = '',
+		$registration_query_params = array()
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'manually_update_registration_status',
+			$transaction,
+			$registration_query_params,
+			$new_reg_status
+		);
+		// send messages
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		$registration_processor->trigger_registration_update_notifications(
+			$transaction->primary_registration(),
+			array('manually_updated' => true)
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * toggle_registration_statuses_for_default_approved_events
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_registration_statuses_for_default_approved_events(
+		EE_Transaction $transaction,
+		$registration_query_params = array()
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'toggle_registration_status_for_default_approved_events',
+			$transaction,
+			$registration_query_params
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * toggle_registration_statuses_if_no_monies_owing
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_registration_statuses_if_no_monies_owing(
+		EE_Transaction $transaction,
+		$registration_query_params = array()
+	) {
+		$status_updates = $this->_call_method_on_registrations_via_Registration_Processor(
+			'toggle_registration_status_if_no_monies_owing',
+			$transaction,
+			$registration_query_params
+		);
+		do_action(
+			'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing',
+			$transaction,
+			$status_updates
+		);
+		return $status_updates;
+	}
+
+
+	/**
+	 * update_transaction_and_registrations_after_checkout_or_payment
+	 * cycles thru related registrations and calls update_registration_after_checkout_or_payment() on each
+	 *
+	 * @param EE_Transaction     $transaction
+	 * @param \EE_Payment | NULL $payment
+	 * @param array              $registration_query_params    array of query WHERE params to use
+	 *                                                         when retrieving cached registrations from a transaction
+	 * @param bool               $trigger_notifications        whether or not to call
+	 *                                                         \EE_Registration_Processor::trigger_registration_update_notifications()
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_and_registrations_after_checkout_or_payment(
+		EE_Transaction $transaction,
+		$payment = null,
+		$registration_query_params = array(),
+		$trigger_notifications = true
+	) {
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// get final reg step status
+		$finalized = $transaction->final_reg_step_completed();
+		// if the 'finalize_registration' step has been initiated (has a timestamp)
+		// but has not yet been fully completed (TRUE)
+		if (is_int($finalized) && $finalized !== false && $finalized !== true) {
+			$transaction->set_reg_step_completed('finalize_registration');
+			$finalized = true;
+		}
+		$transaction->save();
+		// array of details to aid in decision making by systems
+		$update_params = array(
+			'old_txn_status'  => $transaction->old_txn_status(),
+			'new_txn_status'  => $transaction->status_ID(),
+			'finalized'       => $finalized,
+			'revisit'         => $this->_revisit,
+			'payment_updates' => $payment instanceof EE_Payment ? true : false,
+			'last_payment'    => $payment,
+		);
+		// now update the registrations and add the results to our $update_params
+		$update_params['status_updates'] = $this->_call_method_on_registrations_via_Registration_Processor(
+			'update_registration_after_checkout_or_payment',
+			$transaction,
+			$this->_registration_query_params,
+			$update_params
+		);
+		if ($trigger_notifications) {
+			// send messages
+			/** @type EE_Registration_Processor $registration_processor */
+			$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+			$registration_processor->trigger_registration_update_notifications(
+				$transaction->primary_registration(),
+				$update_params
+			);
+		}
+		do_action(
+			'AHEE__EE_Transaction_Processor__update_transaction_and_registrations_after_checkout_or_payment',
+			$transaction,
+			$update_params
+		);
+		return $update_params;
+	}
+
+
+	/**
+	 * update_transaction_after_registration_reopened
+	 * readjusts TXN and Line Item totals after a registration is changed from
+	 * cancelled or declined to another reg status such as pending payment or approved
+	 *
+	 * @param \EE_Registration $registration
+	 * @param array            $closed_reg_statuses
+	 * @param bool             $update_txn
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_after_reinstating_canceled_registration(
+		EE_Registration $registration,
+		$closed_reg_statuses = array(),
+		$update_txn = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		try {
+			$transaction = $this->get_transaction_for_registration($registration);
+			$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
+				$transaction,
+				$registration
+			);
+			// un-cancel the ticket
+			$success = EEH_Line_Item::reinstate_canceled_ticket_line_item($ticket_line_item);
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The Ticket Line Item for Registration %1$d could not be reinstated because :%2$s%3$s',
+						'event_espresso'
+					),
+					$registration->ID(),
+					'<br />',
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if ($update_txn) {
+			return $transaction->save() ? $success : false;
+		}
+		return $success;
+	}
+
+
+	/**
+	 * update_transaction_after_canceled_or_declined_registration
+	 * readjusts TXN and Line Item totals after a registration is cancelled or declined
+	 *
+	 * @param \EE_Registration $registration
+	 * @param array            $closed_reg_statuses
+	 * @param bool             $update_txn
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_after_canceled_or_declined_registration(
+		EE_Registration $registration,
+		$closed_reg_statuses = array(),
+		$update_txn = true
+	) {
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		if (! in_array($registration->status_ID(), $closed_reg_statuses, true)) {
+			return false;
+		}
+		try {
+			$transaction = $this->get_transaction_for_registration($registration);
+			if (
+				apply_filters(
+					'FHEE__EE_Transaction_Processor__update_transaction_after_canceled_or_declined_registration__cancel_ticket_line_item',
+					true,
+					$registration,
+					$transaction
+				)
+			) {
+				$ticket_line_item = $this->get_ticket_line_item_for_transaction_registration(
+					$transaction,
+					$registration
+				);
+				EEH_Line_Item::cancel_ticket_line_item($ticket_line_item);
+			}
+		} catch (EE_Error $e) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The Ticket Line Item for Registration %1$d could not be cancelled because :%2$s%3$s',
+						'event_espresso'
+					),
+					$registration->ID(),
+					'<br />',
+					$e->getMessage()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if ($update_txn) {
+			return $transaction->save() ? true : false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * get_transaction_for_registration
+	 *
+	 * @access    public
+	 * @param    EE_Registration $registration
+	 * @return    EE_Transaction
+	 * @throws    EE_Error
+	 */
+	public function get_transaction_for_registration(EE_Registration $registration)
+	{
+		$transaction = $registration->transaction();
+		if (! $transaction instanceof EE_Transaction) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('The Transaction for Registration %1$d was not found or is invalid.', 'event_espresso'),
+					$registration->ID()
+				)
+			);
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 * get_ticket_line_item_for_transaction_registration
+	 *
+	 * @access    public
+	 * @param    EE_Transaction  $transaction
+	 * @param    EE_Registration $registration
+	 * @return    EE_Line_Item
+	 * @throws    EE_Error
+	 */
+	public function get_ticket_line_item_for_transaction_registration(
+		EE_Transaction $transaction,
+		EE_Registration $registration
+	) {
+		EE_Registry::instance()->load_helper('Line_Item');
+		$ticket_line_item = EEM_Line_Item::instance()->get_ticket_line_item_for_transaction(
+			$transaction->ID(),
+			$registration->ticket_ID()
+		);
+		if (! $ticket_line_item instanceof EE_Line_Item) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The Line Item for Transaction %1$d and Ticket %2$d was not found or is invalid.',
+						'event_espresso'
+					),
+					$transaction->ID(),
+					$registration->ticket_ID()
+				)
+			);
+		}
+		return $ticket_line_item;
+	}
+
+
+	/**
+	 * cancel_transaction_if_all_registrations_canceled
+	 * cycles thru related registrations and checks their statuses
+	 * if ALL registrations are Cancelled or Declined, then this sets the TXN status to
+	 *
+	 * @access    public
+	 * @param    EE_Transaction $transaction
+	 * @param    string         $new_TXN_status
+	 * @param    array          $registration_query_params - array of query WHERE params to use when
+	 *                                                     retrieving cached registrations from a transaction
+	 * @param    array          $closed_reg_statuses
+	 * @param    bool           $update_txn
+	 * @return    bool            true if TXN status was updated, false if not
+	 */
+	public function toggle_transaction_status_if_all_registrations_canceled_or_declined(
+		EE_Transaction $transaction,
+		$new_TXN_status = '',
+		$registration_query_params = array(),
+		$closed_reg_statuses = array(),
+		$update_txn = true
+	) {
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// these reg statuses should not be considered in any calculations involving monies owing
+		$closed_reg_statuses = ! empty($closed_reg_statuses) ? $closed_reg_statuses
+			: EEM_Registration::closed_reg_statuses();
+		// loop through cached registrations
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if (
+				$registration instanceof EE_Registration
+				&& ! in_array($registration->status_ID(), $closed_reg_statuses)
+			) {
+				return false;
+			}
+		}
+		if (in_array($new_TXN_status, EEM_Transaction::txn_status_array())) {
+			$transaction->set_status($new_TXN_status);
+		}
+		if ($update_txn) {
+			return $transaction->save() ? true : false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _call_method_on_registrations_via_Registration_Processor
+	 * cycles thru related registrations and calls the requested method on each
+	 *
+	 * @access private
+	 * @param string         $method_name
+	 * @param EE_Transaction $transaction
+	 * @param array          $registration_query_params array of query WHERE params to use
+	 *                                                  when retrieving cached registrations from a transaction
+	 * @param string         $additional_param
+	 * @throws \EE_Error
+	 * @return boolean
+	 */
+	private function _call_method_on_registrations_via_Registration_Processor(
+		$method_name,
+		EE_Transaction $transaction,
+		$registration_query_params = array(),
+		$additional_param = null
+	) {
+		$response = false;
+		/** @type EE_Registration_Processor $registration_processor */
+		$registration_processor = EE_Registry::instance()->load_class('Registration_Processor');
+		// check that method exists
+		if (! method_exists($registration_processor, $method_name)) {
+			throw new EE_Error(esc_html__('Method does not exist.', 'event_espresso'));
+		}
+		// make sure some query params are set for retrieving registrations
+		$this->_set_registration_query_params($registration_query_params);
+		// loop through cached registrations
+		foreach ($transaction->registrations($this->_registration_query_params) as $registration) {
+			if ($registration instanceof EE_Registration) {
+				if ($additional_param) {
+					$response = $registration_processor->{$method_name}($registration, $additional_param)
+						? true
+						: $response;
+				} else {
+					$response = $registration_processor->{$method_name}($registration)
+						? true
+						: $response;
+				}
+			}
+		}
+		return $response;
+	}
+
+
+	/**
+	 * set_transaction_payment_method_based_on_registration_statuses
+	 * sets or unsets the PMD_ID field on the TXN based on the related REG statuses
+	 * basically if ALL Registrations are "Not Approved", then the EE_Transaction.PMD_ID is set to null,
+	 * but if any Registration has a different status, then EE_Transaction.PMD_ID is set to either:
+	 *        the first "default" Payment Method
+	 *        the first active Payment Method
+	 *    whichever is found first.
+	 *
+	 * @param  EE_Registration $edited_registration
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function set_transaction_payment_method_based_on_registration_statuses(
+		EE_Registration $edited_registration
+	) {
+		if ($edited_registration instanceof EE_Registration) {
+			$transaction = $edited_registration->transaction();
+			if ($transaction instanceof EE_Transaction) {
+				$all_not_approved = true;
+				foreach ($transaction->registrations() as $registration) {
+					if ($registration instanceof EE_Registration) {
+						// if any REG != "Not Approved" then toggle to false
+						$all_not_approved = $registration->is_not_approved() ? $all_not_approved : false;
+					}
+				}
+				// if ALL Registrations are "Not Approved"
+				if ($all_not_approved) {
+					$transaction->set_payment_method_ID(null);
+					$transaction->save();
+				} else {
+					$available_payment_methods = EEM_Payment_Method::instance()->get_all_for_transaction(
+						$transaction,
+						EEM_Payment_Method::scope_cart
+					);
+					if (! empty($available_payment_methods)) {
+						$PMD_ID = 0;
+						foreach ($available_payment_methods as $available_payment_method) {
+							if (
+								$available_payment_method instanceof EE_Payment_Method
+								&& $available_payment_method->open_by_default()
+							) {
+								$PMD_ID = $available_payment_method->ID();
+								break;
+							}
+						}
+						if (! $PMD_ID) {
+							$first_payment_method = reset($available_payment_methods);
+							if ($first_payment_method instanceof EE_Payment_Method) {
+								$PMD_ID = $first_payment_method->ID();
+							} else {
+								EE_Error::add_error(
+									esc_html__(
+										'A valid Payment Method could not be determined. Please ensure that at least one Payment Method is activated.',
+										'event_espresso'
+									),
+									__FILE__,
+									__LINE__,
+									__FUNCTION__
+								);
+							}
+						}
+						$transaction->set_payment_method_ID($PMD_ID);
+						$transaction->save();
+					} else {
+						EE_Error::add_error(
+							esc_html__(
+								'Please activate at least one Payment Method in order for things to operate correctly.',
+								'event_espresso'
+							),
+							__FILE__,
+							__LINE__,
+							__FUNCTION__
+						);
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/********************************** DEPRECATED METHODS **********************************/
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function new_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $new_txn_status
+	 */
+	public function set_new_txn_status($new_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		$this->_new_txn_status = $new_txn_status;
+	}
+
+
+	/**
+	 * reg_status_updated
+	 *
+	 * @deprecated 4.9.12
+	 * @return bool
+	 */
+	public function txn_status_updated()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
+	}
+
+
+	/**
+	 * all_reg_steps_completed
+	 * returns:
+	 *    true if ALL reg steps have been marked as completed
+	 *        or false if any step is not completed
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @return boolean
+	 */
+	public function all_reg_steps_completed(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed();
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except a particular step that you wish to skip over, have been marked as completed
+	 *        or false if any other step is not completed
+	 *        or false if ALL steps are completed including the exception you are testing !!!
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @param string         $exception
+	 * @return boolean
+	 */
+	public function all_reg_steps_completed_except(EE_Transaction $transaction, $exception = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed_except($exception);
+	}
+
+
+	/**
+	 * all_reg_steps_completed_except
+	 * returns:
+	 *        true if ALL reg steps, except the final step, have been marked as completed
+	 *        or false if any step is not completed
+	 *    or false if ALL steps are completed including the final step !!!
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @return boolean
+	 */
+	public function all_reg_steps_completed_except_final_step(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::all_reg_steps_completed_except_final_step(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->all_reg_steps_completed_except_final_step();
+	}
+
+
+	/**
+	 * reg_step_completed
+	 * returns:
+	 *    true if a specific reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @param string         $reg_step_slug
+	 * @return boolean | int
+	 */
+	public function reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->reg_step_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * completed_final_reg_step
+	 * returns:
+	 *    true if the finalize_registration reg step has been marked as completed
+	 *    a Unix timestamp if it has been initialized but not yet completed,
+	 *    or false if it has not yet been initialized
+	 *
+	 * @deprecated 4.9.12
+	 * @param EE_Transaction $transaction
+	 * @return boolean | int
+	 */
+	public function final_reg_step_completed(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::final_reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->final_reg_step_completed();
+	}
+
+
+	/**
+	 * set_reg_step_initiated
+	 * given a valid TXN_reg_step, this sets it's value to a unix timestamp
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_initiated(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_initiated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_initiated($reg_step_slug);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step, this sets the step as completed
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * set_reg_step_completed
+	 * given a valid TXN_reg_step slug, this sets the step as NOT completed
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function set_reg_step_not_completed(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_reg_step_not_completed(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->set_reg_step_not_completed($reg_step_slug);
+	}
+
+
+	/**
+	 * remove_reg_step
+	 * given a valid TXN_reg_step slug, this will remove (unset)
+	 * the reg step from the TXN reg step array
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param \EE_Transaction $transaction
+	 * @param string          $reg_step_slug
+	 * @return void
+	 */
+	public function remove_reg_step(EE_Transaction $transaction, $reg_step_slug)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::remove_reg_step(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		$transaction->remove_reg_step($reg_step_slug);
+	}
+
+
+	/**
+	 *    toggle_failed_transaction_status
+	 * upgrades a TXNs status from failed to abandoned,
+	 * meaning that contact information has been captured for at least one registrant
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param EE_Transaction $transaction
+	 * @return    boolean
+	 * @throws \EE_Error
+	 */
+	public function toggle_failed_transaction_status(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::toggle_failed_transaction_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->toggle_failed_transaction_status();
+	}
+
+
+	/**
+	 * toggle_abandoned_transaction_status
+	 * upgrades a TXNs status from failed or abandoned to incomplete
+	 *
+	 * @deprecated 4.9.12
+	 * @access     public
+	 * @param  EE_Transaction $transaction
+	 * @return boolean
+	 */
+	public function toggle_abandoned_transaction_status(EE_Transaction $transaction)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::toggle_abandoned_transaction_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12',
+			'5.0.0'
+		);
+		return $transaction->toggle_abandoned_transaction_status();
+	}
 }

core/business/EE_Transaction_Payments.class.php

Spacing +12 added lines, -12 removed lines

@@ -42,7 +42,7 @@ 
     public static function instance()
     {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Payments) {
+        if ( ! self::$_instance instanceof EE_Transaction_Payments) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -61,7 +61,7 @@ 
     public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
     {
         $total_line_item = $transaction->total_line_item();
-        if (! $total_line_item instanceof EE_Line_Item) {
+        if ( ! $total_line_item instanceof EE_Line_Item) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
@@ -100,7 +100,7 @@ 
     public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
     {
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,
@@ -115,7 +115,7 @@ 
         if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
             $transaction->set_paid($total_paid);
             // maybe update status, and make sure to save transaction if not done already
-            if (! $transaction->update_status_based_on_total_paid($update_txn)) {
+            if ( ! $transaction->update_status_based_on_total_paid($update_txn)) {
                 if ($update_txn) {
                     return $transaction->save() ? true : false;
                 }
@@ -144,7 +144,7 @@ 
         $payment_status = EEM_Payment::status_id_approved
     ) {
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,
@@ -177,7 +177,7 @@ 
     public function delete_payment_and_update_transaction(EE_Payment $payment)
     {
         // verify payment
-        if (! $payment instanceof EE_Payment) {
+        if ( ! $payment instanceof EE_Payment) {
             EE_Error::add_error(
                 esc_html__('A valid Payment object was not received.', 'event_espresso'),
                 __FILE__,
@@ -186,10 +186,10 @@ 
             );
             return false;
         }
-        if (! $this->delete_registration_payments_and_update_registrations($payment)) {
+        if ( ! $this->delete_registration_payments_and_update_registrations($payment)) {
             return false;
         }
-        if (! $payment->delete()) {
+        if ( ! $payment->delete()) {
             EE_Error::add_error(
                 esc_html__('The payment could not be deleted.', 'event_espresso'),
                 __FILE__,
@@ -213,7 +213,7 @@ 
 
         // if this fails, that just means that the transaction didn't get its status changed and/or updated.
         // however the payment was still deleted.
-        if (! $this->calculate_total_payments_and_update_status($transaction)) {
+        if ( ! $this->calculate_total_payments_and_update_status($transaction)) {
             EE_Error::add_attention(
                 esc_html__(
                     'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
@@ -255,7 +255,7 @@ 
         $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
             : array(array('PAY_ID' => $payment->ID()));
         $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
-        if (! empty($registration_payments)) {
+        if ( ! empty($registration_payments)) {
             foreach ($registration_payments as $registration_payment) {
                 if ($registration_payment instanceof EE_Registration_Payment) {
                     $amount_paid = $registration_payment->amount();
@@ -321,7 +321,7 @@ 
     public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
     {
         EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
+            __CLASS__.'::'.__FUNCTION__,
             sprintf(
                 esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
                 'EE_Transaction::update_status_based_on_total_paid()'
@@ -330,7 +330,7 @@ 
             '5.0.0'
         );
         // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
                 __FILE__,

Indentation +420 added lines, -420 removed lines

@@ -14,424 +14,424 @@
  */
 class EE_Transaction_Payments
 {
-    /**
-     * @var EE_Transaction_Payments $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_old_txn_status;
-
-    /**
-     * @deprecated
-     * @var string
-     */
-    protected $_new_txn_status;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Transaction_Payments instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Transaction_Payments) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * recalculate_transaction_total
-     *
-     * @access private
-     * @param EE_Transaction $transaction
-     * @param bool           $update_txn
-     * @return bool true if TXN total was updated, false if not
-     * @throws \EE_Error
-     */
-    public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
-    {
-        $total_line_item = $transaction->total_line_item();
-        if (! $total_line_item instanceof EE_Line_Item) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
-                    $transaction->ID()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $new_total = $total_line_item->recalculate_total_including_taxes();
-        $transaction->set_total($new_total);
-        if ($update_txn) {
-            return $transaction->save() ? true : false;
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the provided EE_Transaction with all the applicable payments
-     * returns a boolean for whether the TXN was saved to the db
-     * (meaning a status change occurred)
-     * or not saved (which could **still** mean that
-     * the TXN status changed, but just was not yet saved).
-     * So if passing a value of false for the $update_txn param,
-     * then client code needs to take responsibility for saving the TXN
-     * regardless of what happens within EE_Transaction_Payments;
-     *
-     * @param            EE_Transaction /int $transaction_obj_or_id EE_Transaction or its ID
-     * @param    boolean $update_txn whether to save the TXN
-     * @return    boolean        whether the TXN was saved
-     * @throws \EE_Error
-     */
-    public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
-    {
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // calculate total paid
-        $total_paid = $this->recalculate_total_payments_for_transaction($transaction);
-        // if total paid has changed
-        if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
-            $transaction->set_paid($total_paid);
-            // maybe update status, and make sure to save transaction if not done already
-            if (! $transaction->update_status_based_on_total_paid($update_txn)) {
-                if ($update_txn) {
-                    return $transaction->save() ? true : false;
-                }
-            } else {
-                // the status got updated and was saved by
-                // update_transaction_status_based_on_total_paid()
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * recalculate_total_payments_for_transaction
-     *
-     * @access public
-     * @param EE_Transaction $transaction
-     * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
-     *                                       By default, searches for approved payments
-     * @return float|false   float on success, false on fail
-     * @throws \EE_Error
-     */
-    public function recalculate_total_payments_for_transaction(
-        EE_Transaction $transaction,
-        $payment_status = EEM_Payment::status_id_approved
-    ) {
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // ensure Payment model is loaded
-        EE_Registry::instance()->load_model('Payment');
-        // calls EEM_Base::sum()
-        return EEM_Payment::instance()->sum(
-            // query params
-            array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
-            // field to sum
-            'PAY_amount'
-        );
-    }
-
-
-    /**
-     * delete_payment_and_update_transaction
-     * Before deleting the selected payment, we fetch it's transaction,
-     * then delete the payment, and update the transactions' amount paid.
-     *
-     * @param EE_Payment $payment
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function delete_payment_and_update_transaction(EE_Payment $payment)
-    {
-        // verify payment
-        if (! $payment instanceof EE_Payment) {
-            EE_Error::add_error(
-                esc_html__('A valid Payment object was not received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        if (! $this->delete_registration_payments_and_update_registrations($payment)) {
-            return false;
-        }
-        if (! $payment->delete()) {
-            EE_Error::add_error(
-                esc_html__('The payment could not be deleted.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-
-        $transaction = $payment->transaction();
-        $TXN_status = $transaction->status_ID();
-        if (
-            $TXN_status === EEM_Transaction::abandoned_status_code
-            || $TXN_status === EEM_Transaction::failed_status_code
-            || $payment->amount() === 0
-        ) {
-            EE_Error::add_success(esc_html__('The Payment was successfully deleted.', 'event_espresso'));
-            return true;
-        }
-
-
-        // if this fails, that just means that the transaction didn't get its status changed and/or updated.
-        // however the payment was still deleted.
-        if (! $this->calculate_total_payments_and_update_status($transaction)) {
-            EE_Error::add_attention(
-                esc_html__(
-                    'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return true;
-        }
-
-        EE_Error::add_success(
-            esc_html__(
-                'The Payment was successfully deleted, and the Transaction has been updated accordingly.',
-                'event_espresso'
-            )
-        );
-        return true;
-    }
-
-
-    /**
-     * delete_registration_payments_and_update_registrations
-     *
-     * removes all registration payment records associated with a payment
-     * and subtracts their amounts from the corresponding registrations REG_paid field
-     *
-     * @param EE_Payment $payment
-     * @param array      $reg_payment_query_params
-     * @return bool
-     * @throws \EE_Error
-     */
-    public function delete_registration_payments_and_update_registrations(
-        EE_Payment $payment,
-        $reg_payment_query_params = array()
-    ) {
-        $save_payment = false;
-        $reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
-            : array(array('PAY_ID' => $payment->ID()));
-        $registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
-        if (! empty($registration_payments)) {
-            foreach ($registration_payments as $registration_payment) {
-                if ($registration_payment instanceof EE_Registration_Payment) {
-                    $amount_paid = $registration_payment->amount();
-                    $registration = $registration_payment->registration();
-                    if ($registration instanceof EE_Registration) {
-                        $registration->set_paid($registration->paid() - $amount_paid);
-                        if ($registration->save() !== false) {
-                            $registration_payment->delete_permanently();
-                            $save_payment = true;
-                        }
-                    } else {
-                        EE_Error::add_error(
-                            sprintf(
-                                esc_html__(
-                                    'An invalid Registration object was associated with Registration Payment ID# %1$d.',
-                                    'event_espresso'
-                                ),
-                                $registration_payment->ID()
-                            ),
-                            __FILE__,
-                            __FUNCTION__,
-                            __LINE__
-                        );
-                        return false;
-                    }
-                } else {
-                    EE_Error::add_error(
-                        sprintf(
-                            esc_html__(
-                                'An invalid Registration Payment object was associated with payment ID# %1$d.',
-                                'event_espresso'
-                            ),
-                            $payment->ID()
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                    return false;
-                }
-            }
-        }
-        if ($save_payment) {
-            $payment->save();
-        }
-        return true;
-    }
-
-
-
-    /********************************** DEPRECATED METHODS **********************************/
-
-
-    /**
-     * possibly toggles TXN status
-     *
-     * @deprecated 4.9.1
-     * @param EE_Transaction $transaction
-     * @param    boolean     $update_txn whether to save the TXN
-     * @return    boolean        whether the TXN was saved
-     * @throws \EE_Error
-     */
-    public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
-    {
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            sprintf(
-                esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
-                'EE_Transaction::update_status_based_on_total_paid()'
-            ),
-            '4.9.1',
-            '5.0.0'
-        );
-        // verify transaction
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        // set transaction status based on comparison of TXN_paid vs TXN_total
-        return $transaction->update_status_based_on_total_paid($update_txn);
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function old_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_old_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $old_txn_status
-     */
-    public function set_old_txn_status($old_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        // only set the first time
-        if ($this->_old_txn_status === null) {
-            $this->_old_txn_status = $old_txn_status;
-        }
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return string
-     */
-    public function new_txn_status()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @param string $new_txn_status
-     */
-    public function set_new_txn_status($new_txn_status)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        $this->_new_txn_status = $new_txn_status;
-    }
-
-
-    /**
-     * @deprecated 4.9.12
-     * @return bool
-     */
-    public function txn_status_updated()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
-                'event_espresso'
-            ),
-            '4.9.12'
-        );
-        return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
-    }
+	/**
+	 * @var EE_Transaction_Payments $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_old_txn_status;
+
+	/**
+	 * @deprecated
+	 * @var string
+	 */
+	protected $_new_txn_status;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Transaction_Payments instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Transaction_Payments) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * recalculate_transaction_total
+	 *
+	 * @access private
+	 * @param EE_Transaction $transaction
+	 * @param bool           $update_txn
+	 * @return bool true if TXN total was updated, false if not
+	 * @throws \EE_Error
+	 */
+	public function recalculate_transaction_total(EE_Transaction $transaction, $update_txn = true)
+	{
+		$total_line_item = $transaction->total_line_item();
+		if (! $total_line_item instanceof EE_Line_Item) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__('The Total Line Item for Transaction %1$d\'s was not found or is invalid.', 'event_espresso'),
+					$transaction->ID()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$new_total = $total_line_item->recalculate_total_including_taxes();
+		$transaction->set_total($new_total);
+		if ($update_txn) {
+			return $transaction->save() ? true : false;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the provided EE_Transaction with all the applicable payments
+	 * returns a boolean for whether the TXN was saved to the db
+	 * (meaning a status change occurred)
+	 * or not saved (which could **still** mean that
+	 * the TXN status changed, but just was not yet saved).
+	 * So if passing a value of false for the $update_txn param,
+	 * then client code needs to take responsibility for saving the TXN
+	 * regardless of what happens within EE_Transaction_Payments;
+	 *
+	 * @param            EE_Transaction /int $transaction_obj_or_id EE_Transaction or its ID
+	 * @param    boolean $update_txn whether to save the TXN
+	 * @return    boolean        whether the TXN was saved
+	 * @throws \EE_Error
+	 */
+	public function calculate_total_payments_and_update_status(EE_Transaction $transaction, $update_txn = true)
+	{
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// calculate total paid
+		$total_paid = $this->recalculate_total_payments_for_transaction($transaction);
+		// if total paid has changed
+		if ($total_paid !== false && (float) $total_paid !== $transaction->paid()) {
+			$transaction->set_paid($total_paid);
+			// maybe update status, and make sure to save transaction if not done already
+			if (! $transaction->update_status_based_on_total_paid($update_txn)) {
+				if ($update_txn) {
+					return $transaction->save() ? true : false;
+				}
+			} else {
+				// the status got updated and was saved by
+				// update_transaction_status_based_on_total_paid()
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * recalculate_total_payments_for_transaction
+	 *
+	 * @access public
+	 * @param EE_Transaction $transaction
+	 * @param string         $payment_status One of EEM_Payment's statuses, like 'PAP' (Approved).
+	 *                                       By default, searches for approved payments
+	 * @return float|false   float on success, false on fail
+	 * @throws \EE_Error
+	 */
+	public function recalculate_total_payments_for_transaction(
+		EE_Transaction $transaction,
+		$payment_status = EEM_Payment::status_id_approved
+	) {
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// ensure Payment model is loaded
+		EE_Registry::instance()->load_model('Payment');
+		// calls EEM_Base::sum()
+		return EEM_Payment::instance()->sum(
+			// query params
+			array(array('TXN_ID' => $transaction->ID(), 'STS_ID' => $payment_status)),
+			// field to sum
+			'PAY_amount'
+		);
+	}
+
+
+	/**
+	 * delete_payment_and_update_transaction
+	 * Before deleting the selected payment, we fetch it's transaction,
+	 * then delete the payment, and update the transactions' amount paid.
+	 *
+	 * @param EE_Payment $payment
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function delete_payment_and_update_transaction(EE_Payment $payment)
+	{
+		// verify payment
+		if (! $payment instanceof EE_Payment) {
+			EE_Error::add_error(
+				esc_html__('A valid Payment object was not received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		if (! $this->delete_registration_payments_and_update_registrations($payment)) {
+			return false;
+		}
+		if (! $payment->delete()) {
+			EE_Error::add_error(
+				esc_html__('The payment could not be deleted.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+
+		$transaction = $payment->transaction();
+		$TXN_status = $transaction->status_ID();
+		if (
+			$TXN_status === EEM_Transaction::abandoned_status_code
+			|| $TXN_status === EEM_Transaction::failed_status_code
+			|| $payment->amount() === 0
+		) {
+			EE_Error::add_success(esc_html__('The Payment was successfully deleted.', 'event_espresso'));
+			return true;
+		}
+
+
+		// if this fails, that just means that the transaction didn't get its status changed and/or updated.
+		// however the payment was still deleted.
+		if (! $this->calculate_total_payments_and_update_status($transaction)) {
+			EE_Error::add_attention(
+				esc_html__(
+					'It appears that the Payment was deleted but no change was recorded for the Transaction for an unknown reason. Please verify that all data for this Transaction looks correct..',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return true;
+		}
+
+		EE_Error::add_success(
+			esc_html__(
+				'The Payment was successfully deleted, and the Transaction has been updated accordingly.',
+				'event_espresso'
+			)
+		);
+		return true;
+	}
+
+
+	/**
+	 * delete_registration_payments_and_update_registrations
+	 *
+	 * removes all registration payment records associated with a payment
+	 * and subtracts their amounts from the corresponding registrations REG_paid field
+	 *
+	 * @param EE_Payment $payment
+	 * @param array      $reg_payment_query_params
+	 * @return bool
+	 * @throws \EE_Error
+	 */
+	public function delete_registration_payments_and_update_registrations(
+		EE_Payment $payment,
+		$reg_payment_query_params = array()
+	) {
+		$save_payment = false;
+		$reg_payment_query_params = ! empty($reg_payment_query_params) ? $reg_payment_query_params
+			: array(array('PAY_ID' => $payment->ID()));
+		$registration_payments = EEM_Registration_Payment::instance()->get_all($reg_payment_query_params);
+		if (! empty($registration_payments)) {
+			foreach ($registration_payments as $registration_payment) {
+				if ($registration_payment instanceof EE_Registration_Payment) {
+					$amount_paid = $registration_payment->amount();
+					$registration = $registration_payment->registration();
+					if ($registration instanceof EE_Registration) {
+						$registration->set_paid($registration->paid() - $amount_paid);
+						if ($registration->save() !== false) {
+							$registration_payment->delete_permanently();
+							$save_payment = true;
+						}
+					} else {
+						EE_Error::add_error(
+							sprintf(
+								esc_html__(
+									'An invalid Registration object was associated with Registration Payment ID# %1$d.',
+									'event_espresso'
+								),
+								$registration_payment->ID()
+							),
+							__FILE__,
+							__FUNCTION__,
+							__LINE__
+						);
+						return false;
+					}
+				} else {
+					EE_Error::add_error(
+						sprintf(
+							esc_html__(
+								'An invalid Registration Payment object was associated with payment ID# %1$d.',
+								'event_espresso'
+							),
+							$payment->ID()
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+					return false;
+				}
+			}
+		}
+		if ($save_payment) {
+			$payment->save();
+		}
+		return true;
+	}
+
+
+
+	/********************************** DEPRECATED METHODS **********************************/
+
+
+	/**
+	 * possibly toggles TXN status
+	 *
+	 * @deprecated 4.9.1
+	 * @param EE_Transaction $transaction
+	 * @param    boolean     $update_txn whether to save the TXN
+	 * @return    boolean        whether the TXN was saved
+	 * @throws \EE_Error
+	 */
+	public function update_transaction_status_based_on_total_paid(EE_Transaction $transaction, $update_txn = true)
+	{
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			sprintf(
+				esc_html__('This method is deprecated. Please use "%s" instead', 'event_espresso'),
+				'EE_Transaction::update_status_based_on_total_paid()'
+			),
+			'4.9.1',
+			'5.0.0'
+		);
+		// verify transaction
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__('Please provide a valid EE_Transaction object.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		// set transaction status based on comparison of TXN_paid vs TXN_total
+		return $transaction->update_status_based_on_total_paid($update_txn);
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function old_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_old_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $old_txn_status
+	 */
+	public function set_old_txn_status($old_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::set_old_txn_status(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		// only set the first time
+		if ($this->_old_txn_status === null) {
+			$this->_old_txn_status = $old_txn_status;
+		}
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return string
+	 */
+	public function new_txn_status()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::status_ID() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @param string $new_txn_status
+	 */
+	public function set_new_txn_status($new_txn_status)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been removed. Please just use \EE_Transaction::set_status() instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		$this->_new_txn_status = $new_txn_status;
+	}
+
+
+	/**
+	 * @deprecated 4.9.12
+	 * @return bool
+	 */
+	public function txn_status_updated()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'This logic has been moved into \EE_Transaction::txn_status_updated(), please use that method instead.',
+				'event_espresso'
+			),
+			'4.9.12'
+		);
+		return $this->_new_txn_status !== $this->_old_txn_status && $this->_old_txn_status !== null ? true : false;
+	}
 }

core/domain/services/admin/registrations/list_table/page_header/TicketFilterHeader.php

Spacing +3 added lines, -3 removed lines

@@ -59,9 +59,9 @@ 
         if ($TKT_ID) {
             $ticket = $this->ticket_model->get_one_by_ID($TKT_ID);
             if ($ticket instanceof EE_Ticket) {
-                $ticket_details = '<span class="ee-ticket-name">' . $ticket->name() . '</span> ';
+                $ticket_details = '<span class="ee-ticket-name">'.$ticket->name().'</span> ';
                 $ticket_details .= ! $ticket->is_free()
-                    ? '<span class="ee-ticket-price">' . $ticket->pretty_price() . '</span>'
+                    ? '<span class="ee-ticket-price">'.$ticket->pretty_price().'</span>'
                     : '<span class="reg-overview-free-event-spn">'
                       . esc_html__('free', 'event_espresso')
                       . '</span>';
@@ -78,7 +78,7 @@ 
                 $text .= '&nbsp; &nbsp; ';
                 $text .= '<span class="drk-grey-text" style="font-size:.9em;">';
                 $text .= '<span class="dashicons dashicons-tickets-alt"></span>';
-                $text .= $ticket_details . '</span></h3>';
+                $text .= $ticket_details.'</span></h3>';
             }
         }
         return $text;

Indentation +56 added lines, -56 removed lines

@@ -22,64 +22,64 @@
  */
 class TicketFilterHeader extends AdminPageHeaderDecorator
 {
-    /**
-     * @var EEM_Ticket $ticket_model
-     */
-    private $ticket_model;
+	/**
+	 * @var EEM_Ticket $ticket_model
+	 */
+	private $ticket_model;
 
 
-    /**
-     * TicketFilterHeader constructor.
-     *
-     * @param RequestInterface $request
-     * @param EEM_Ticket       $ticket_model
-     */
-    public function __construct(RequestInterface $request, EEM_Ticket $ticket_model)
-    {
-        parent::__construct($request);
-        $this->ticket_model = $ticket_model;
-    }
+	/**
+	 * TicketFilterHeader constructor.
+	 *
+	 * @param RequestInterface $request
+	 * @param EEM_Ticket       $ticket_model
+	 */
+	public function __construct(RequestInterface $request, EEM_Ticket $ticket_model)
+	{
+		parent::__construct($request);
+		$this->ticket_model = $ticket_model;
+	}
 
 
-    /**
-     * @param string $text
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @since 4.10.2.p
-     */
-    public function getHeaderText($text = '')
-    {
-        $TKT_ID = $this->request->getRequestParam('TKT_ID');
-        $TKT_ID = $this->request->getRequestParam('ticket_id', $TKT_ID, 'int');
-        if ($TKT_ID) {
-            $ticket = $this->ticket_model->get_one_by_ID($TKT_ID);
-            if ($ticket instanceof EE_Ticket) {
-                $ticket_details = '<span class="ee-ticket-name">' . $ticket->name() . '</span> ';
-                $ticket_details .= ! $ticket->is_free()
-                    ? '<span class="ee-ticket-price">' . $ticket->pretty_price() . '</span>'
-                    : '<span class="reg-overview-free-event-spn">'
-                      . esc_html__('free', 'event_espresso')
-                      . '</span>';
-                // remove the closing h3 heading tag if it exists
-                $text = str_replace(
-                    '</h3>',
-                    '',
-                    $text
-                );
-                if (empty($text)) {
-                    $text = '<h3 style="line-height:1.5em;">';
-                    $text .= esc_html__('Viewing registrations for ticket:', 'event_espresso');
-                }
-                $text .= '&nbsp; &nbsp; ';
-                $text .= '<span class="drk-grey-text" style="font-size:.9em;">';
-                $text .= '<span class="dashicons dashicons-tickets-alt"></span>';
-                $text .= $ticket_details . '</span></h3>';
-            }
-        }
-        return $text;
-    }
+	/**
+	 * @param string $text
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @since 4.10.2.p
+	 */
+	public function getHeaderText($text = '')
+	{
+		$TKT_ID = $this->request->getRequestParam('TKT_ID');
+		$TKT_ID = $this->request->getRequestParam('ticket_id', $TKT_ID, 'int');
+		if ($TKT_ID) {
+			$ticket = $this->ticket_model->get_one_by_ID($TKT_ID);
+			if ($ticket instanceof EE_Ticket) {
+				$ticket_details = '<span class="ee-ticket-name">' . $ticket->name() . '</span> ';
+				$ticket_details .= ! $ticket->is_free()
+					? '<span class="ee-ticket-price">' . $ticket->pretty_price() . '</span>'
+					: '<span class="reg-overview-free-event-spn">'
+					  . esc_html__('free', 'event_espresso')
+					  . '</span>';
+				// remove the closing h3 heading tag if it exists
+				$text = str_replace(
+					'</h3>',
+					'',
+					$text
+				);
+				if (empty($text)) {
+					$text = '<h3 style="line-height:1.5em;">';
+					$text .= esc_html__('Viewing registrations for ticket:', 'event_espresso');
+				}
+				$text .= '&nbsp; &nbsp; ';
+				$text .= '<span class="drk-grey-text" style="font-size:.9em;">';
+				$text .= '<span class="dashicons dashicons-tickets-alt"></span>';
+				$text .= $ticket_details . '</span></h3>';
+			}
+		}
+		return $text;
+	}
 }

core/domain/services/admin/ajax/ThankYouPageIpnMonitor.php

Spacing +25 added lines, -25 removed lines

@@ -67,12 +67,12 @@ 
     public function heartbeatResponse($response = array(), $data = array())
     {
         // does this heartbeat contain our data ?
-        if (! isset($data[ $this->heartbeat ])) {
+        if ( ! isset($data[$this->heartbeat])) {
             return $response;
         }
         // check for reg_url_link in the incoming heartbeat data
-        if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
-            $response[ $this->heartbeat ] = array(
+        if ( ! isset($data[$this->heartbeat]['e_reg_url_link'])) {
+            $response[$this->heartbeat] = array(
                 'errors' => ! empty($notices['errors'])
                     ? $notices['errors']
                     : esc_html__(
@@ -85,22 +85,22 @@ 
         // kk heartbeat has our data
         $response = $this->initializeThankYouPageAndTransaction($response, $data);
         // if something went wrong...
-        if (isset($response[ $this->heartbeat ]['errors'])) {
+        if (isset($response[$this->heartbeat]['errors'])) {
             return $response;
         }
         // grab transient of Transaction's status
-        $txn_status = isset($data[ $this->heartbeat ]['txn_status'])
-            ? $data[ $this->heartbeat ]['txn_status']
+        $txn_status = isset($data[$this->heartbeat]['txn_status'])
+            ? $data[$this->heartbeat]['txn_status']
             : null;
         $response = $this->getTransactionDetails($txn_status, $response, $data);
         // no payment data yet?
-        if (isset($response[ $this->heartbeat ]['still_waiting'])) {
+        if (isset($response[$this->heartbeat]['still_waiting'])) {
             return $response;
         }
         // TXN is happening so let's get the payments now
         // if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
-        $since = isset($data[ $this->heartbeat ]['get_payments_since'])
-            ? $data[ $this->heartbeat ]['get_payments_since']
+        $since = isset($data[$this->heartbeat]['get_payments_since'])
+            ? $data[$this->heartbeat]['get_payments_since']
             : 0;
         return $this->paymentDetails($response, $since);
     }
@@ -117,18 +117,18 @@ 
      */
     private function initializeThankYouPageAndTransaction($response, $data)
     {
-        require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
+        require_once EE_MODULES.'thank_you_page/EED_Thank_You_Page.module.php';
         // set_definitions, instantiate the thank you page class, and get the ball rolling
         EED_Thank_You_Page::set_definitions();
         $this->thank_you_page = EED_Thank_You_Page::instance();
-        $this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
+        $this->thank_you_page->set_reg_url_link($data[$this->heartbeat]['e_reg_url_link']);
         $this->thank_you_page->init();
         // get TXN
         $transaction = $this->thank_you_page->get_txn();
         // no TXN? then get out
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             $notices = EE_Error::get_notices();
-            $response[ $this->heartbeat ] = array(
+            $response[$this->heartbeat] = array(
                 'errors' => ! empty($notices['errors'])
                     ? $notices['errors']
                     : sprintf(
@@ -173,12 +173,12 @@ 
                 case EEM_Transaction::failed_status_code:
                 default:
                     // keep on waiting...
-                    return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+                    return $this->updateServerWaitTime($data[$this->heartbeat]);
             }
             // or is the TXN still failed (never been updated) ???
         } elseif ($this->transaction->failed()) {
             // keep on waiting...
-            return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+            return $this->updateServerWaitTime($data[$this->heartbeat]);
         }
         return $response;
     }
@@ -196,11 +196,11 @@ 
      */
     private function setTransactionDetails($response, $status_only = false)
     {
-        if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
-            $response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
+        if ( ! $status_only && ! isset($response[$this->heartbeat]['transaction_details'])) {
+            $response[$this->heartbeat]['transaction_details'] = $this->thank_you_page->get_transaction_details();
         }
-        if (! isset($response[ $this->heartbeat ]['txn_status'])) {
-            $response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
+        if ( ! isset($response[$this->heartbeat]['txn_status'])) {
+            $response[$this->heartbeat]['txn_status'] = $this->transaction->status_ID();
         }
         return $response;
     }
@@ -221,19 +221,19 @@ 
         // then check for payments
         $payments = $this->thank_you_page->get_txn_payments($since);
         // has a payment been processed ?
-        if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
+        if ( ! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
             if ($since) {
-                $response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
+                $response[$this->heartbeat]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
                 $response = $this->setTransactionDetails($response);
             } else {
-                $response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
+                $response[$this->heartbeat]['payment_details'] = $this->thank_you_page->get_payment_details(
                     $payments
                 );
             }
             // reset time to check for payments
-            $response[ $this->heartbeat ]['get_payments_since'] = time();
+            $response[$this->heartbeat]['get_payments_since'] = time();
         } else {
-            $response[ $this->heartbeat ]['get_payments_since'] = $since;
+            $response[$this->heartbeat]['get_payments_since'] = $since;
         }
         return $response;
     }
@@ -251,7 +251,7 @@ 
      */
     private function updateServerWaitTime($thank_you_page_data)
     {
-        $response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
+        $response[$this->heartbeat]['still_waiting'] = isset($thank_you_page_data['initial_access'])
             ? time() - $thank_you_page_data['initial_access']
             : 0;
         $response = $this->setTransactionDetails($response, true);

Indentation +219 added lines, -219 removed lines

@@ -21,239 +21,239 @@
  */
 class ThankYouPageIpnMonitor
 {
-    /**
-     * @var string $heartbeat
-     */
-    private $heartbeat;
+	/**
+	 * @var string $heartbeat
+	 */
+	private $heartbeat;
 
-    /**
-     * @var EED_Thank_You_Page $thank_you_page
-     */
-    private $thank_you_page;
+	/**
+	 * @var EED_Thank_You_Page $thank_you_page
+	 */
+	private $thank_you_page;
 
-    /**
-     * @var EE_Transaction $transaction
-     */
-    private $transaction;
+	/**
+	 * @var EE_Transaction $transaction
+	 */
+	private $transaction;
 
 
-    /**
-     * EventEditorHeartbeat constructor.
-     */
-    public function __construct()
-    {
-        $this->heartbeat = WordpressHeartbeat::RESPONSE_KEY_THANK_YOU_PAGE;
-        add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 3);
-        add_filter('heartbeat_nopriv_received', array($this, 'heartbeatResponse'), 10, 3);
-    }
+	/**
+	 * EventEditorHeartbeat constructor.
+	 */
+	public function __construct()
+	{
+		$this->heartbeat = WordpressHeartbeat::RESPONSE_KEY_THANK_YOU_PAGE;
+		add_filter('heartbeat_received', array($this, 'heartbeatResponse'), 10, 3);
+		add_filter('heartbeat_nopriv_received', array($this, 'heartbeatResponse'), 10, 3);
+	}
 
 
-    /**
-     * thank_you_page_IPN_monitor
-     * this basically just pulls the TXN based on the reg_url_link sent from the server,
-     * then checks that the TXN status is not failed, and that no other errors have been generated.
-     * it also calculates the IPN wait time since the Thank You page was first loaded
-     *
-     * @param array $response
-     * @param array $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function heartbeatResponse($response = array(), $data = array())
-    {
-        // does this heartbeat contain our data ?
-        if (! isset($data[ $this->heartbeat ])) {
-            return $response;
-        }
-        // check for reg_url_link in the incoming heartbeat data
-        if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
-            $response[ $this->heartbeat ] = array(
-                'errors' => ! empty($notices['errors'])
-                    ? $notices['errors']
-                    : esc_html__(
-                        'No transaction information could be retrieved because the registration URL link is missing or invalid.',
-                        'event_espresso'
-                    ),
-            );
-            return $response;
-        }
-        // kk heartbeat has our data
-        $response = $this->initializeThankYouPageAndTransaction($response, $data);
-        // if something went wrong...
-        if (isset($response[ $this->heartbeat ]['errors'])) {
-            return $response;
-        }
-        // grab transient of Transaction's status
-        $txn_status = isset($data[ $this->heartbeat ]['txn_status'])
-            ? $data[ $this->heartbeat ]['txn_status']
-            : null;
-        $response = $this->getTransactionDetails($txn_status, $response, $data);
-        // no payment data yet?
-        if (isset($response[ $this->heartbeat ]['still_waiting'])) {
-            return $response;
-        }
-        // TXN is happening so let's get the payments now
-        // if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
-        $since = isset($data[ $this->heartbeat ]['get_payments_since'])
-            ? $data[ $this->heartbeat ]['get_payments_since']
-            : 0;
-        return $this->paymentDetails($response, $since);
-    }
+	/**
+	 * thank_you_page_IPN_monitor
+	 * this basically just pulls the TXN based on the reg_url_link sent from the server,
+	 * then checks that the TXN status is not failed, and that no other errors have been generated.
+	 * it also calculates the IPN wait time since the Thank You page was first loaded
+	 *
+	 * @param array $response
+	 * @param array $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function heartbeatResponse($response = array(), $data = array())
+	{
+		// does this heartbeat contain our data ?
+		if (! isset($data[ $this->heartbeat ])) {
+			return $response;
+		}
+		// check for reg_url_link in the incoming heartbeat data
+		if (! isset($data[ $this->heartbeat ]['e_reg_url_link'])) {
+			$response[ $this->heartbeat ] = array(
+				'errors' => ! empty($notices['errors'])
+					? $notices['errors']
+					: esc_html__(
+						'No transaction information could be retrieved because the registration URL link is missing or invalid.',
+						'event_espresso'
+					),
+			);
+			return $response;
+		}
+		// kk heartbeat has our data
+		$response = $this->initializeThankYouPageAndTransaction($response, $data);
+		// if something went wrong...
+		if (isset($response[ $this->heartbeat ]['errors'])) {
+			return $response;
+		}
+		// grab transient of Transaction's status
+		$txn_status = isset($data[ $this->heartbeat ]['txn_status'])
+			? $data[ $this->heartbeat ]['txn_status']
+			: null;
+		$response = $this->getTransactionDetails($txn_status, $response, $data);
+		// no payment data yet?
+		if (isset($response[ $this->heartbeat ]['still_waiting'])) {
+			return $response;
+		}
+		// TXN is happening so let's get the payments now
+		// if we've already gotten payments then the heartbeat data will contain the timestamp of the last time we checked
+		$since = isset($data[ $this->heartbeat ]['get_payments_since'])
+			? $data[ $this->heartbeat ]['get_payments_since']
+			: 0;
+		return $this->paymentDetails($response, $since);
+	}
 
 
-    /**
-     * @param array $response
-     * @param array $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function initializeThankYouPageAndTransaction($response, $data)
-    {
-        require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
-        // set_definitions, instantiate the thank you page class, and get the ball rolling
-        EED_Thank_You_Page::set_definitions();
-        $this->thank_you_page = EED_Thank_You_Page::instance();
-        $this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
-        $this->thank_you_page->init();
-        // get TXN
-        $transaction = $this->thank_you_page->get_txn();
-        // no TXN? then get out
-        if (! $transaction instanceof EE_Transaction) {
-            $notices = EE_Error::get_notices();
-            $response[ $this->heartbeat ] = array(
-                'errors' => ! empty($notices['errors'])
-                    ? $notices['errors']
-                    : sprintf(
-                        esc_html__(
-                            'The information for your transaction could not be retrieved from the server or the transaction data received was invalid because of a technical reason. (%s)',
-                            'event_espresso'
-                        ),
-                        __LINE__
-                    ),
-            );
-            return $response;
-        }
-        $this->transaction = $transaction;
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param array $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function initializeThankYouPageAndTransaction($response, $data)
+	{
+		require_once EE_MODULES . 'thank_you_page/EED_Thank_You_Page.module.php';
+		// set_definitions, instantiate the thank you page class, and get the ball rolling
+		EED_Thank_You_Page::set_definitions();
+		$this->thank_you_page = EED_Thank_You_Page::instance();
+		$this->thank_you_page->set_reg_url_link($data[ $this->heartbeat ]['e_reg_url_link']);
+		$this->thank_you_page->init();
+		// get TXN
+		$transaction = $this->thank_you_page->get_txn();
+		// no TXN? then get out
+		if (! $transaction instanceof EE_Transaction) {
+			$notices = EE_Error::get_notices();
+			$response[ $this->heartbeat ] = array(
+				'errors' => ! empty($notices['errors'])
+					? $notices['errors']
+					: sprintf(
+						esc_html__(
+							'The information for your transaction could not be retrieved from the server or the transaction data received was invalid because of a technical reason. (%s)',
+							'event_espresso'
+						),
+						__LINE__
+					),
+			);
+			return $response;
+		}
+		$this->transaction = $transaction;
+		return $response;
+	}
 
 
-    /**
-     * @param string $txn_status
-     * @param array  $response
-     * @param array  $data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function getTransactionDetails($txn_status, $response, $data)
-    {
-        // has the TXN status changed since we last checked (or empty because this is the first time running through this code)?
-        if ($txn_status !== $this->transaction->status_ID()) {
-            // switch between two possible basic outcomes
-            switch ($this->transaction->status_ID()) {
-                // TXN has been updated in some way
-                case EEM_Transaction::overpaid_status_code:
-                case EEM_Transaction::complete_status_code:
-                case EEM_Transaction::incomplete_status_code:
-                    // send updated TXN results back to client,
-                    return $this->setTransactionDetails($response);
-                // or we have a bad TXN, or really slow IPN, so calculate the wait time and send that back...
-                case EEM_Transaction::failed_status_code:
-                default:
-                    // keep on waiting...
-                    return $this->updateServerWaitTime($data[ $this->heartbeat ]);
-            }
-            // or is the TXN still failed (never been updated) ???
-        } elseif ($this->transaction->failed()) {
-            // keep on waiting...
-            return $this->updateServerWaitTime($data[ $this->heartbeat ]);
-        }
-        return $response;
-    }
+	/**
+	 * @param string $txn_status
+	 * @param array  $response
+	 * @param array  $data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function getTransactionDetails($txn_status, $response, $data)
+	{
+		// has the TXN status changed since we last checked (or empty because this is the first time running through this code)?
+		if ($txn_status !== $this->transaction->status_ID()) {
+			// switch between two possible basic outcomes
+			switch ($this->transaction->status_ID()) {
+				// TXN has been updated in some way
+				case EEM_Transaction::overpaid_status_code:
+				case EEM_Transaction::complete_status_code:
+				case EEM_Transaction::incomplete_status_code:
+					// send updated TXN results back to client,
+					return $this->setTransactionDetails($response);
+				// or we have a bad TXN, or really slow IPN, so calculate the wait time and send that back...
+				case EEM_Transaction::failed_status_code:
+				default:
+					// keep on waiting...
+					return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+			}
+			// or is the TXN still failed (never been updated) ???
+		} elseif ($this->transaction->failed()) {
+			// keep on waiting...
+			return $this->updateServerWaitTime($data[ $this->heartbeat ]);
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $response
-     * @param boolean $status_only
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function setTransactionDetails($response, $status_only = false)
-    {
-        if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
-            $response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
-        }
-        if (! isset($response[ $this->heartbeat ]['txn_status'])) {
-            $response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
-        }
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param boolean $status_only
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function setTransactionDetails($response, $status_only = false)
+	{
+		if (! $status_only && ! isset($response[ $this->heartbeat ]['transaction_details'])) {
+			$response[ $this->heartbeat ]['transaction_details'] = $this->thank_you_page->get_transaction_details();
+		}
+		if (! isset($response[ $this->heartbeat ]['txn_status'])) {
+			$response[ $this->heartbeat ]['txn_status'] = $this->transaction->status_ID();
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $response
-     * @param int $since
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function paymentDetails($response, $since)
-    {
-        // then check for payments
-        $payments = $this->thank_you_page->get_txn_payments($since);
-        // has a payment been processed ?
-        if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
-            if ($since) {
-                $response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
-                $response = $this->setTransactionDetails($response);
-            } else {
-                $response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
-                    $payments
-                );
-            }
-            // reset time to check for payments
-            $response[ $this->heartbeat ]['get_payments_since'] = time();
-        } else {
-            $response[ $this->heartbeat ]['get_payments_since'] = $since;
-        }
-        return $response;
-    }
+	/**
+	 * @param array $response
+	 * @param int $since
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function paymentDetails($response, $since)
+	{
+		// then check for payments
+		$payments = $this->thank_you_page->get_txn_payments($since);
+		// has a payment been processed ?
+		if (! empty($payments) || $this->thank_you_page->isOfflinePaymentMethod()) {
+			if ($since) {
+				$response[ $this->heartbeat ]['new_payments'] = $this->thank_you_page->get_new_payments($payments);
+				$response = $this->setTransactionDetails($response);
+			} else {
+				$response[ $this->heartbeat ]['payment_details'] = $this->thank_you_page->get_payment_details(
+					$payments
+				);
+			}
+			// reset time to check for payments
+			$response[ $this->heartbeat ]['get_payments_since'] = time();
+		} else {
+			$response[ $this->heartbeat ]['get_payments_since'] = $since;
+		}
+		return $response;
+	}
 
 
-    /**
-     * @param array $thank_you_page_data    thank you page portion of the incoming JSON array
-     *                                      from the WP heartbeat data
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function updateServerWaitTime($thank_you_page_data)
-    {
-        $response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
-            ? time() - $thank_you_page_data['initial_access']
-            : 0;
-        $response = $this->setTransactionDetails($response, true);
-        return $response;
-    }
+	/**
+	 * @param array $thank_you_page_data    thank you page portion of the incoming JSON array
+	 *                                      from the WP heartbeat data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function updateServerWaitTime($thank_you_page_data)
+	{
+		$response[ $this->heartbeat ]['still_waiting'] = isset($thank_you_page_data['initial_access'])
+			? time() - $thank_you_page_data['initial_access']
+			: 0;
+		$response = $this->setTransactionDetails($response, true);
+		return $response;
+	}
 }

core/domain/services/ticket/CancelTicketLineItemService.php

Spacing +2 added lines, -2 removed lines

@@ -88,7 +88,7 @@ 
             );
             $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new \RuntimeException(
                 sprintf(
                     esc_html__('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
@@ -125,7 +125,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 +106 added lines, -106 removed lines

@@ -18,114 +18,114 @@
  */
 class CancelTicketLineItemService extends DomainService
 {
-    /**
-     * @param \EE_Registration $registration
-     * @param int              $quantity
-     * @return bool|int
-     */
-    public function forRegistration(\EE_Registration $registration, $quantity = 1)
-    {
-        return $this->cancel(
-            $registration->transaction(),
-            $registration->ticket(),
-            $quantity,
-            $registration->ticket_line_item()
-        );
-    }
+	/**
+	 * @param \EE_Registration $registration
+	 * @param int              $quantity
+	 * @return bool|int
+	 */
+	public function forRegistration(\EE_Registration $registration, $quantity = 1)
+	{
+		return $this->cancel(
+			$registration->transaction(),
+			$registration->ticket(),
+			$quantity,
+			$registration->ticket_line_item()
+		);
+	}
 
 
-    /**
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     * @param int             $quantity
-     * @param \EE_Line_Item   $ticket_line_item
-     * @return bool|int
-     */
-    public function cancel(
-        \EE_Transaction $transaction,
-        \EE_Ticket $ticket,
-        $quantity = 1,
-        \EE_Line_Item $ticket_line_item = null
-    ) {
-        $ticket_line_item = $ticket_line_item instanceof \EE_Line_Item
-            ? $ticket_line_item
-            : $this->getTicketLineItem($transaction, $ticket);
-        // first we need to decrement the ticket quantity
-        \EEH_Line_Item::decrement_quantity($ticket_line_item, $quantity);
-        // no tickets left for this line item ?
-        if ((int) $ticket_line_item->quantity() === 0) {
-            // then just set this line item as cancelled, save, and get out
-            $ticket_line_item->set_type(\EEM_Line_Item::type_cancellation);
-            $success = $ticket_line_item->save();
-        } else {
-            // otherwise create a new cancelled line item, so that we have a record of the cancellation
-            $items_subtotal = \EEH_Line_Item::get_pre_tax_subtotal(
-                \EEH_Line_Item::get_event_line_item_for_ticket(
-                    $transaction->total_line_item(),
-                    $ticket
-                )
-            );
-            $cancelled_line_item = \EE_Line_Item::new_instance(
-                array(
-                    'LIN_name'       => $ticket_line_item->name(),
-                    'LIN_desc'       => sprintf(
-                        esc_html__('%1$s Cancelled: %2$s', 'event_espresso'),
-                        $ticket_line_item->desc(),
-                        date('Y-m-d h:i a')
-                    ),
-                    'LIN_unit_price' => (float) $ticket_line_item->unit_price(),
-                    'LIN_quantity'   => $quantity,
-                    'LIN_percent'    => null,
-                    'LIN_is_taxable' => false,
-                    'LIN_order'      => $items_subtotal instanceof \EE_Line_Item
-                        ? count($items_subtotal->children())
-                        : 0,
-                    'LIN_total'      => (float) $ticket_line_item->unit_price(),
-                    'LIN_type'       => \EEM_Line_Item::type_cancellation,
-                )
-            );
-            $success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
-        }
-        if (! $success) {
-            throw new \RuntimeException(
-                sprintf(
-                    esc_html__('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
-                    $ticket_line_item->ID()
-                )
-            );
-        }
-        return $success;
-    }
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 * @param int             $quantity
+	 * @param \EE_Line_Item   $ticket_line_item
+	 * @return bool|int
+	 */
+	public function cancel(
+		\EE_Transaction $transaction,
+		\EE_Ticket $ticket,
+		$quantity = 1,
+		\EE_Line_Item $ticket_line_item = null
+	) {
+		$ticket_line_item = $ticket_line_item instanceof \EE_Line_Item
+			? $ticket_line_item
+			: $this->getTicketLineItem($transaction, $ticket);
+		// first we need to decrement the ticket quantity
+		\EEH_Line_Item::decrement_quantity($ticket_line_item, $quantity);
+		// no tickets left for this line item ?
+		if ((int) $ticket_line_item->quantity() === 0) {
+			// then just set this line item as cancelled, save, and get out
+			$ticket_line_item->set_type(\EEM_Line_Item::type_cancellation);
+			$success = $ticket_line_item->save();
+		} else {
+			// otherwise create a new cancelled line item, so that we have a record of the cancellation
+			$items_subtotal = \EEH_Line_Item::get_pre_tax_subtotal(
+				\EEH_Line_Item::get_event_line_item_for_ticket(
+					$transaction->total_line_item(),
+					$ticket
+				)
+			);
+			$cancelled_line_item = \EE_Line_Item::new_instance(
+				array(
+					'LIN_name'       => $ticket_line_item->name(),
+					'LIN_desc'       => sprintf(
+						esc_html__('%1$s Cancelled: %2$s', 'event_espresso'),
+						$ticket_line_item->desc(),
+						date('Y-m-d h:i a')
+					),
+					'LIN_unit_price' => (float) $ticket_line_item->unit_price(),
+					'LIN_quantity'   => $quantity,
+					'LIN_percent'    => null,
+					'LIN_is_taxable' => false,
+					'LIN_order'      => $items_subtotal instanceof \EE_Line_Item
+						? count($items_subtotal->children())
+						: 0,
+					'LIN_total'      => (float) $ticket_line_item->unit_price(),
+					'LIN_type'       => \EEM_Line_Item::type_cancellation,
+				)
+			);
+			$success = \EEH_Line_Item::add_item($transaction->total_line_item(), $cancelled_line_item);
+		}
+		if (! $success) {
+			throw new \RuntimeException(
+				sprintf(
+					esc_html__('An error occurred while attempting to cancel ticket line item %1$s', 'event_espresso'),
+					$ticket_line_item->ID()
+				)
+			);
+		}
+		return $success;
+	}
 
 
-    /**
-     * @param \EE_Transaction $transaction
-     * @param \EE_Ticket      $ticket
-     * @return \EE_Line_Item
-     * @throws EntityNotFoundException
-     * @throws \EE_Error
-     */
-    protected static function getTicketLineItem(\EE_Transaction $transaction, \EE_Ticket $ticket)
-    {
-        $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;
-    }
+	/**
+	 * @param \EE_Transaction $transaction
+	 * @param \EE_Ticket      $ticket
+	 * @return \EE_Line_Item
+	 * @throws EntityNotFoundException
+	 * @throws \EE_Error
+	 */
+	protected static function getTicketLineItem(\EE_Transaction $transaction, \EE_Ticket $ticket)
+	{
+		$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;
+	}
 }

core/domain/services/validation/email/strategies/InternationalDNS.php

Spacing +2 added lines, -2 removed lines

@@ -30,7 +30,7 @@ 
             $email_address,
             $this->getAtIndex($email_address)
         );
-        if (! checkdnsrr($domain, 'MX')) {
+        if ( ! checkdnsrr($domain, 'MX')) {
             // domain not found in MX records
             throw new EmailValidationException(
                 esc_html__(
@@ -41,7 +41,7 @@ 
                 )
             );
         }
-        if (! checkdnsrr($domain, 'A')) {
+        if ( ! checkdnsrr($domain, 'A')) {
             // domain not found in A records
             throw new EmailValidationException(
                 esc_html__(

Indentation +39 added lines, -39 removed lines

@@ -14,43 +14,43 @@
  */
 class InternationalDNS extends International
 {
-    /**
-     * Validates the email in teh same way as the parent, but also
-     * verifies the domain exists.
-     *
-     * @param string $email_address
-     * @return bool
-     * @throws EmailValidationException
-     */
-    public function validate($email_address)
-    {
-        parent::validate($email_address);
-        $domain = $this->getDomainPartOfEmail(
-            $email_address,
-            $this->getAtIndex($email_address)
-        );
-        if (! checkdnsrr($domain, 'MX')) {
-            // domain not found in MX records
-            throw new EmailValidationException(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                )
-            );
-        }
-        if (! checkdnsrr($domain, 'A')) {
-            // domain not found in A records
-            throw new EmailValidationException(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                )
-            );
-        }
-        return true;
-    }
+	/**
+	 * Validates the email in teh same way as the parent, but also
+	 * verifies the domain exists.
+	 *
+	 * @param string $email_address
+	 * @return bool
+	 * @throws EmailValidationException
+	 */
+	public function validate($email_address)
+	{
+		parent::validate($email_address);
+		$domain = $this->getDomainPartOfEmail(
+			$email_address,
+			$this->getAtIndex($email_address)
+		);
+		if (! checkdnsrr($domain, 'MX')) {
+			// domain not found in MX records
+			throw new EmailValidationException(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'Although the email address provided is formatted correctly, a valid "MX record" could not be located for that address and domain. Please enter a valid email address.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				)
+			);
+		}
+		if (! checkdnsrr($domain, 'A')) {
+			// domain not found in A records
+			throw new EmailValidationException(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'Although the email address provided is formatted correctly, a valid "A record" could not be located for that address and domain. Please enter a valid email address.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				)
+			);
+		}
+		return true;
+	}
 }

core/EE_Module_Request_Router.core.php

Spacing +10 added lines, -10 removed lines

@@ -60,7 +60,7 @@ 
         // assume this if first route being called
         $previous_route = false;
         // but is it really ???
-        if (! empty(self::$_previous_routes)) {
+        if ( ! empty(self::$_previous_routes)) {
             // get last run route
             $previous_routes = array_values(self::$_previous_routes);
             $previous_route = array_pop($previous_routes);
@@ -71,7 +71,7 @@ 
             $current_route = $this->get_forward($previous_route);
             try {
                 // check for recursive forwarding
-                if (isset(self::$_previous_routes[ $current_route ])) {
+                if (isset(self::$_previous_routes[$current_route])) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -144,38 +144,38 @@ 
             return false;
         }
         // verify that result is an array
-        if (! is_array($module_method)) {
+        if ( ! is_array($module_method)) {
             $msg = sprintf(esc_html__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // grab module name
         $module_name = $module_method[0];
         // verify that a class method was registered properly
-        if (! isset($module_method[1])) {
+        if ( ! isset($module_method[1])) {
             $msg = sprintf(
                 esc_html__('A class method for the %s  route has not been properly registered.', 'event_espresso'),
                 $current_route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // grab method
         $method = $module_method[1];
         // verify that class exists
-        if (! class_exists($module_name)) {
+        if ( ! class_exists($module_name)) {
             $msg = sprintf(esc_html__('The requested %s class could not be found.', 'event_espresso'), $module_name);
             EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // verify that method exists
-        if (! method_exists($module_name, $method)) {
+        if ( ! method_exists($module_name, $method)) {
             $msg = sprintf(
                 esc_html__('The class method %s for the %s route is in invalid.', 'event_espresso'),
                 $method,
                 $current_route
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // instantiate module and call route method
@@ -209,7 +209,7 @@ 
         // instantiate module class
         $module = new $module_name();
         // ensure that class is actually a module
-        if (! $module instanceof EED_Module) {
+        if ( ! $module instanceof EED_Module) {
             EE_Error::add_error(
                 sprintf(esc_html__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
                 __FILE__,

Indentation +234 added lines, -234 removed lines

@@ -15,254 +15,254 @@
  */
 final class EE_Module_Request_Router implements InterminableInterface
 {
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
 
-    /**
-     * @var array $_previous_routes
-     */
-    private static $_previous_routes = array();
+	/**
+	 * @var array $_previous_routes
+	 */
+	private static $_previous_routes = array();
 
-    /**
-     * @var WP_Query $WP_Query
-     */
-    public $WP_Query;
+	/**
+	 * @var WP_Query $WP_Query
+	 */
+	public $WP_Query;
 
 
-    /**
-     * EE_Module_Request_Router constructor.
-     *
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * EE_Module_Request_Router constructor.
+	 *
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
 
 
-    /**
-     * on the first call  to this method, it checks the Request for a "route"
-     * on subsequent calls to this method,
-     * instead of checking the Request for a route, it checks the previous routes array,
-     * and checks if the last called route has any forwarding routes registered for it
-     *
-     * @param WP_Query $WP_Query
-     * @return NULL|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_route(WP_Query $WP_Query)
-    {
-        $this->WP_Query = $WP_Query;
-        // assume this if first route being called
-        $previous_route = false;
-        // but is it really ???
-        if (! empty(self::$_previous_routes)) {
-            // get last run route
-            $previous_routes = array_values(self::$_previous_routes);
-            $previous_route = array_pop($previous_routes);
-        }
-        //  has another route already been run ?
-        if ($previous_route) {
-            // check if  forwarding has been set
-            $current_route = $this->get_forward($previous_route);
-            try {
-                // check for recursive forwarding
-                if (isset(self::$_previous_routes[ $current_route ])) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                                'An error occurred. The %s route has already been called, and therefore can not be forwarded to, because an infinite loop would be created and break the interweb.',
-                                'event_espresso'
-                            ),
-                            $current_route
-                        )
-                    );
-                }
-            } catch (EE_Error $e) {
-                $e->get_error();
-                return null;
-            }
-        } else {
-            // first route called
-            $current_route = null;
-            // grab all routes
-            $routes = EE_Config::get_routes();
-            foreach ($routes as $key => $route) {
-                // first determine if route key uses w?ldc*rds
-                $uses_wildcards = strpos($key, '?') !== false
-                                  || strpos($key, '*') !== false;
-                // check request for module route
-                $route_found = $uses_wildcards
-                    ? $this->request->matches($key)
-                    : $this->request->requestParamIsSet($key);
-                if ($route_found) {
-                    $current_route = $uses_wildcards
-                        ? $this->request->getMatch($key)
-                        : $this->request->getRequestParam($key);
-                    $current_route = sanitize_text_field($current_route);
-                    if ($current_route) {
-                        $current_route = array($key, $current_route);
-                        break;
-                    }
-                }
-            }
-        }
-        // sorry, but I can't read what you route !
-        if (empty($current_route)) {
-            return null;
-        }
-        // add route to previous routes array
-        self::$_previous_routes[] = $current_route;
-        return $current_route;
-    }
+	/**
+	 * on the first call  to this method, it checks the Request for a "route"
+	 * on subsequent calls to this method,
+	 * instead of checking the Request for a route, it checks the previous routes array,
+	 * and checks if the last called route has any forwarding routes registered for it
+	 *
+	 * @param WP_Query $WP_Query
+	 * @return NULL|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_route(WP_Query $WP_Query)
+	{
+		$this->WP_Query = $WP_Query;
+		// assume this if first route being called
+		$previous_route = false;
+		// but is it really ???
+		if (! empty(self::$_previous_routes)) {
+			// get last run route
+			$previous_routes = array_values(self::$_previous_routes);
+			$previous_route = array_pop($previous_routes);
+		}
+		//  has another route already been run ?
+		if ($previous_route) {
+			// check if  forwarding has been set
+			$current_route = $this->get_forward($previous_route);
+			try {
+				// check for recursive forwarding
+				if (isset(self::$_previous_routes[ $current_route ])) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+								'An error occurred. The %s route has already been called, and therefore can not be forwarded to, because an infinite loop would be created and break the interweb.',
+								'event_espresso'
+							),
+							$current_route
+						)
+					);
+				}
+			} catch (EE_Error $e) {
+				$e->get_error();
+				return null;
+			}
+		} else {
+			// first route called
+			$current_route = null;
+			// grab all routes
+			$routes = EE_Config::get_routes();
+			foreach ($routes as $key => $route) {
+				// first determine if route key uses w?ldc*rds
+				$uses_wildcards = strpos($key, '?') !== false
+								  || strpos($key, '*') !== false;
+				// check request for module route
+				$route_found = $uses_wildcards
+					? $this->request->matches($key)
+					: $this->request->requestParamIsSet($key);
+				if ($route_found) {
+					$current_route = $uses_wildcards
+						? $this->request->getMatch($key)
+						: $this->request->getRequestParam($key);
+					$current_route = sanitize_text_field($current_route);
+					if ($current_route) {
+						$current_route = array($key, $current_route);
+						break;
+					}
+				}
+			}
+		}
+		// sorry, but I can't read what you route !
+		if (empty($current_route)) {
+			return null;
+		}
+		// add route to previous routes array
+		self::$_previous_routes[] = $current_route;
+		return $current_route;
+	}
 
 
-    /**
-     * this method simply takes a valid route, and resolves what module class method the route points to
-     *
-     * @param string $key
-     * @param string $current_route
-     * @return EED_Module|object|boolean|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function resolve_route($key, $current_route)
-    {
-        // get module method that route has been mapped to
-        $module_method = EE_Config::get_route($current_route, $key);
-        // verify result was returned
-        if (empty($module_method)) {
-            $msg = sprintf(
-                esc_html__('The requested route %s could not be mapped to any registered modules.', 'event_espresso'),
-                $current_route
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // verify that result is an array
-        if (! is_array($module_method)) {
-            $msg = sprintf(esc_html__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // grab module name
-        $module_name = $module_method[0];
-        // verify that a class method was registered properly
-        if (! isset($module_method[1])) {
-            $msg = sprintf(
-                esc_html__('A class method for the %s  route has not been properly registered.', 'event_espresso'),
-                $current_route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // grab method
-        $method = $module_method[1];
-        // verify that class exists
-        if (! class_exists($module_name)) {
-            $msg = sprintf(esc_html__('The requested %s class could not be found.', 'event_espresso'), $module_name);
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // verify that method exists
-        if (! method_exists($module_name, $method)) {
-            $msg = sprintf(
-                esc_html__('The class method %s for the %s route is in invalid.', 'event_espresso'),
-                $method,
-                $current_route
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // instantiate module and call route method
-        return $this->_module_router($module_name, $method);
-    }
+	/**
+	 * this method simply takes a valid route, and resolves what module class method the route points to
+	 *
+	 * @param string $key
+	 * @param string $current_route
+	 * @return EED_Module|object|boolean|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function resolve_route($key, $current_route)
+	{
+		// get module method that route has been mapped to
+		$module_method = EE_Config::get_route($current_route, $key);
+		// verify result was returned
+		if (empty($module_method)) {
+			$msg = sprintf(
+				esc_html__('The requested route %s could not be mapped to any registered modules.', 'event_espresso'),
+				$current_route
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// verify that result is an array
+		if (! is_array($module_method)) {
+			$msg = sprintf(esc_html__('The %s  route has not been properly registered.', 'event_espresso'), $current_route);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// grab module name
+		$module_name = $module_method[0];
+		// verify that a class method was registered properly
+		if (! isset($module_method[1])) {
+			$msg = sprintf(
+				esc_html__('A class method for the %s  route has not been properly registered.', 'event_espresso'),
+				$current_route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// grab method
+		$method = $module_method[1];
+		// verify that class exists
+		if (! class_exists($module_name)) {
+			$msg = sprintf(esc_html__('The requested %s class could not be found.', 'event_espresso'), $module_name);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// verify that method exists
+		if (! method_exists($module_name, $method)) {
+			$msg = sprintf(
+				esc_html__('The class method %s for the %s route is in invalid.', 'event_espresso'),
+				$method,
+				$current_route
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// instantiate module and call route method
+		return $this->_module_router($module_name, $method);
+	}
 
 
-    /**
-     * this method instantiates modules and calls the method that was defined when the route was registered
-     *
-     * @param string $module_name
-     * @return EED_Module|object|null
-     */
-    public static function module_factory($module_name)
-    {
-        if ($module_name === 'EED_Module') {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'EED_Module is an abstract parent class an can not be instantiated. Please provide a proper module name.',
-                        'event_espresso'
-                    ),
-                    $module_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        // instantiate module class
-        $module = new $module_name();
-        // ensure that class is actually a module
-        if (! $module instanceof EED_Module) {
-            EE_Error::add_error(
-                sprintf(esc_html__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return null;
-        }
-        return $module;
-    }
+	/**
+	 * this method instantiates modules and calls the method that was defined when the route was registered
+	 *
+	 * @param string $module_name
+	 * @return EED_Module|object|null
+	 */
+	public static function module_factory($module_name)
+	{
+		if ($module_name === 'EED_Module') {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'EED_Module is an abstract parent class an can not be instantiated. Please provide a proper module name.',
+						'event_espresso'
+					),
+					$module_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		// instantiate module class
+		$module = new $module_name();
+		// ensure that class is actually a module
+		if (! $module instanceof EED_Module) {
+			EE_Error::add_error(
+				sprintf(esc_html__('The requested %s module is not of the class EED_Module.', 'event_espresso'), $module_name),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return null;
+		}
+		return $module;
+	}
 
 
-    /**
-     * this method instantiates modules and calls the method that was defined when the route was registered
-     *
-     * @param string $module_name
-     * @param string $method
-     * @return EED_Module|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _module_router($module_name, $method)
-    {
-        // instantiate module class
-        $module = EE_Module_Request_Router::module_factory($module_name);
-        if ($module instanceof EED_Module) {
-            // and call whatever action the route was for
-            try {
-                $module->{$method}($this->WP_Query);
-            } catch (EE_Error $e) {
-                $e->get_error();
-                return null;
-            }
-        }
-        return $module;
-    }
+	/**
+	 * this method instantiates modules and calls the method that was defined when the route was registered
+	 *
+	 * @param string $module_name
+	 * @param string $method
+	 * @return EED_Module|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _module_router($module_name, $method)
+	{
+		// instantiate module class
+		$module = EE_Module_Request_Router::module_factory($module_name);
+		if ($module instanceof EED_Module) {
+			// and call whatever action the route was for
+			try {
+				$module->{$method}($this->WP_Query);
+			} catch (EE_Error $e) {
+				$e->get_error();
+				return null;
+			}
+		}
+		return $module;
+	}
 
 
-    /**
-     * @param $current_route
-     * @return string
-     */
-    public function get_forward($current_route)
-    {
-        return EE_Config::get_forward($current_route);
-    }
+	/**
+	 * @param $current_route
+	 * @return string
+	 */
+	public function get_forward($current_route)
+	{
+		return EE_Config::get_forward($current_route);
+	}
 
 
-    /**
-     * @param $current_route
-     * @return string
-     */
-    public function get_view($current_route)
-    {
-        return EE_Config::get_view($current_route);
-    }
+	/**
+	 * @param $current_route
+	 * @return string
+	 */
+	public function get_view($current_route)
+	{
+		return EE_Config::get_view($current_route);
+	}
 }

core/data_migration_scripts/EE_Data_Migration_Class_Base.core.php

Spacing +4 added lines, -4 removed lines

@@ -185,7 +185,7 @@ 
      */
     public function add_error($error, $force = false)
     {
-        if (! defined('EE_DMS_ERROR_LIMIT')) {
+        if ( ! defined('EE_DMS_ERROR_LIMIT')) {
             $limit = 50;
         } else {
             $limit = EE_DMS_ERROR_LIMIT;
@@ -201,7 +201,7 @@ 
                 $this->_errors[] = "Limit reached; removed first half of errors to save space";
                 $this->_errors[] = $error;
             } else {
-                $this->_errors[ $limit ] = 'More, but limit reached...';
+                $this->_errors[$limit] = 'More, but limit reached...';
             }
         } else {
             $this->_errors[] = $error;
@@ -345,7 +345,7 @@ 
         $new_columns_and_values_for_string = array();
         $count = 0;
         foreach ($new_row_as_array as $column => $value) {
-            $new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
+            $new_columns_and_values_for_string[] = " $column => $value (".$data_types[$count++].")";
         }
         return sprintf(
             esc_html__(
@@ -376,7 +376,7 @@ 
         foreach ($array_of_data as $name => $value) {
             $unserialized_data = @unserialize($value);
             if ($unserialized_data === false) {
-                $fields_to_include[ $name ] = $value;
+                $fields_to_include[$name] = $value;
             }
         }
         return wp_json_encode($fields_to_include);

Indentation +404 added lines, -404 removed lines

@@ -16,408 +16,408 @@
  */
 abstract class EE_Data_Migration_Class_Base
 {
-    /**
-     * @var $records_to_migrate int count of all that have been migrated
-     */
-    protected $_records_to_migrate = 0;
-
-    /**
-     *
-     * @var $records_migrated int
-     */
-    protected $_records_migrated = 0;
-
-    /**
-     * Whether this migration script is done or not. This COULD be deduced by
-     * _records_to_migrate and _records_migrated, but that might nto be accurate
-     *
-     * @var string one of EE_Data_migration_Manager::status_* constants
-     */
-    protected $_status = null;
-
-    /**
-     * internationalized name of this class. Convention is to NOT restate that
-     * this class if a migration script or a migration script stage
-     *
-     * @var string (i18ned)
-     */
-    protected $_pretty_name = null;
-
-    /**
-     * @var array
-     */
-    protected $_errors = array();
-
-    /**
-     * @var \EventEspresso\core\services\database\TableManager $table_manager
-     */
-    protected $_table_manager;
-
-    /**
-     * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     * Just initializes the status of the migration
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_table_manager = $table_manager;
-        $this->_table_analysis = $table_analysis;
-        $this->set_status(EE_Data_Migration_Manager::status_continue);
-    }
-
-
-    /**
-     * Just gets the pretty name for this migration script or stage
-     *
-     * @throws EE_Error
-     * @return string
-     */
-    public function pretty_name()
-    {
-        if ($this->_pretty_name === null) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_pretty_name;
-    }
-
-    /**
-     *
-     * @return int
-     */
-    public function count_records_to_migrate()
-    {
-        if ($this->_records_to_migrate == null) {
-            $this->_records_to_migrate = $this->_count_records_to_migrate();
-        }
-        return $this->_records_to_migrate;
-    }
-
-    /**
-     * Counts records already migrated. This should only be implemented by EE_Data_Migration_Script_base and
-     * EE_Data_migration_Script_Stage
-     *
-     * @return int
-     */
-    abstract public function count_records_migrated();
-
-    /**
-     * Counts the records to migrate; the public version may cache it
-     *
-     * @return int
-     */
-    abstract protected function _count_records_to_migrate();
-
-    /**
-     * Returns a string indicating the migration script's status.
-     *
-     * @return string one of EE_Data_Migration_Manager::status_* constants
-     * @throws EE_Error
-     */
-    public function get_status()
-    {
-        if ($this->_status === null) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.",
-                        "event_espresso"
-                    ),
-                    get_class($this)
-                )
-            );
-        }
-        return $this->_status;
-    }
-
-    /**
-     *
-     * @param string $status
-     * @return void
-     */
-    protected function set_status($status)
-    {
-        $this->_status = $status;
-    }
-
-    /**
-     * @return array of strings
-     */
-    abstract public function get_errors();
-
-    /**
-     * Returns the last error that occurred. If none occurred, returns null
-     *
-     * @return string
-     */
-    public function get_last_error()
-    {
-        $errors = $this->get_errors();
-        if ($errors) {
-            return end($errors);
-        } else {
-            return null;
-        }
-    }
-
-    /**
-     * Adds an error to the array of errors on this class.
-     *
-     * @param string  $error a string describing the error that will be useful for debugging. Consider including all
-     *                       the data that led to the error, and a stack trace etc.
-     * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are
-     *                       already at their limit, we will purposefully forget the first half
-     */
-    public function add_error($error, $force = false)
-    {
-        if (! defined('EE_DMS_ERROR_LIMIT')) {
-            $limit = 50;
-        } else {
-            $limit = EE_DMS_ERROR_LIMIT;
-        }
-        // make sure errors is an array, see ticket #8261
-        if (is_string($this->_errors)) {
-            $this->_errors = array($this->_errors);
-        }
-        if (count($this->_errors) >= $limit) {
-            if ($force) {
-                // get rid of the first half of the errors and any above the limit
-                $this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2);
-                $this->_errors[] = "Limit reached; removed first half of errors to save space";
-                $this->_errors[] = $error;
-            } else {
-                $this->_errors[ $limit ] = 'More, but limit reached...';
-            }
-        } else {
-            $this->_errors[] = $error;
-        }
-    }
-
-    /**
-     * Indicates there was a fatal error and the migration cannot possibly continue
-     *
-     * @return boolean
-     */
-    public function is_broken()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error;
-    }
-
-    /**
-     * @deprecated since 4.6.12
-     */
-    public function is_borked()
-    {
-        EE_Error::doing_it_wrong(
-            'is_borked',
-            esc_html__(
-                'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
-                'event_espresso'
-            ),
-            '4.6.12'
-        );
-        return $this->is_broken();
-    }
-
-    /**
-     * Sets the status to as having a fatal error
-     */
-    public function set_broken()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_fatal_error;
-    }
-
-    /**
-     *
-     * @deprecated since 4.6.12
-     */
-    public function set_borked()
-    {
-        EE_Error::doing_it_wrong(
-            'is_borked',
-            esc_html__(
-                'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
-                'event_espresso'
-            ),
-            '4.6.12'
-        );
-        return $this->set_broken();
-    }
-
-    /**
-     * Checks if this thing believes it is completed
-     *
-     * @return boolean
-     */
-    public function is_completed()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_completed;
-    }
-
-    /**
-     * Checks if the current script has more to do or not (ie, if it's status is CONTINUE)
-     *
-     * @return boolean
-     */
-    public function has_more_to_do()
-    {
-        return $this->get_status() == EE_Data_Migration_Manager::status_continue;
-    }
-
-    /**
-     * Marks that we believe this migration thing is completed
-     */
-    public function set_completed()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_completed;
-    }
-
-    /**
-     * Marks that we think this migration class can continue to migrate
-     */
-    public function reattempt()
-    {
-        $this->_status = EE_Data_Migration_Manager::status_continue;
-        $this->add_error(esc_html__('Reattempt migration', 'event_espresso'), true);
-    }
-
-    /**
-     * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
-     * properties to the DB. However, we don't want to use __sleep() because its quite
-     * possible that this class is defined when it goes to sleep, but NOT available when it
-     * awakes (eg, this class is part of an addon that is deactivated at some point).
-     */
-    public function properties_as_array()
-    {
-        $properties = get_object_vars($this);
-        $properties['class'] = get_class($this);
-        unset($properties['_migration_script']);
-        unset($properties['_table_manager']);
-        unset($properties['_table_analysis']);
-        return $properties;
-    }
-
-    /**
-     * Sets all of the properties of this script stage to match what's in the array, which is assumed
-     * to have been made from the properties_as_array() function.
-     *
-     * @param array $array_of_properties like what's produced from properties_as_array() method
-     */
-    abstract public function instantiate_from_array_of_properties($array_of_properties);
-
-    /**
-     * Convenience method for showing a database insertion error
-     *
-     * @param string $old_table
-     * @param array  $old_row_as_array
-     * @param string $new_table
-     * @param array  $new_row_as_array columns=>values like used in wpdb->insert
-     * @param array  $data_types       numerically indexed
-     * @return string
-     */
-    protected function _create_error_message_for_db_insertion(
-        $old_table,
-        $old_row_as_array,
-        $new_table,
-        $new_row_as_array,
-        $data_types
-    ) {
-        global $wpdb;
-        $old_columns_and_values_for_string = array();
-        foreach ($old_row_as_array as $column => $value) {
-            $old_columns_and_values_for_string[] = "$column => $value";
-        }
-        $new_columns_and_values_for_string = array();
-        $count = 0;
-        foreach ($new_row_as_array as $column => $value) {
-            $new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
-        }
-        return sprintf(
-            esc_html__(
-                'Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4$s.',
-                'event_espresso'
-            ),
-            implode(", ", $new_columns_and_values_for_string),
-            $new_table,
-            implode(", ", $old_columns_and_values_for_string),
-            $old_table,
-            '<br/>',
-            $wpdb->last_error
-        );
-    }
-
-
-    /**
-     * Same as json_encode, just avoids putting
-     * serialized arrays into the http build query, as that would
-     *
-     * @param array $array_of_data
-     * @return string
-     */
-    protected function _json_encode($array_of_data)
-    {
-        // we'd rather NOT serialize the transaction details
-        $fields_to_include = array();
-        foreach ($array_of_data as $name => $value) {
-            $unserialized_data = @unserialize($value);
-            if ($unserialized_data === false) {
-                $fields_to_include[ $name ] = $value;
-            }
-        }
-        return wp_json_encode($fields_to_include);
-    }
-
-    /**
-     * Gets the table manager (or throws an exception if it cannot be retrieved)
-     *
-     * @return TableManager
-     * @throws EE_Error
-     */
-    protected function _get_table_manager()
-    {
-        if ($this->_table_manager instanceof TableManager) {
-            return $this->_table_manager;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Table manager on migration class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-    /**
-     * 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;
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * @var $records_to_migrate int count of all that have been migrated
+	 */
+	protected $_records_to_migrate = 0;
+
+	/**
+	 *
+	 * @var $records_migrated int
+	 */
+	protected $_records_migrated = 0;
+
+	/**
+	 * Whether this migration script is done or not. This COULD be deduced by
+	 * _records_to_migrate and _records_migrated, but that might nto be accurate
+	 *
+	 * @var string one of EE_Data_migration_Manager::status_* constants
+	 */
+	protected $_status = null;
+
+	/**
+	 * internationalized name of this class. Convention is to NOT restate that
+	 * this class if a migration script or a migration script stage
+	 *
+	 * @var string (i18ned)
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_errors = array();
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableManager $table_manager
+	 */
+	protected $_table_manager;
+
+	/**
+	 * @var \EventEspresso\core\services\database\TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 * Just initializes the status of the migration
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_table_manager = $table_manager;
+		$this->_table_analysis = $table_analysis;
+		$this->set_status(EE_Data_Migration_Manager::status_continue);
+	}
+
+
+	/**
+	 * Just gets the pretty name for this migration script or stage
+	 *
+	 * @throws EE_Error
+	 * @return string
+	 */
+	public function pretty_name()
+	{
+		if ($this->_pretty_name === null) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Please give a pretty name to the migration script stage %s by assigning the property _pretty_name in the constructor",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_pretty_name;
+	}
+
+	/**
+	 *
+	 * @return int
+	 */
+	public function count_records_to_migrate()
+	{
+		if ($this->_records_to_migrate == null) {
+			$this->_records_to_migrate = $this->_count_records_to_migrate();
+		}
+		return $this->_records_to_migrate;
+	}
+
+	/**
+	 * Counts records already migrated. This should only be implemented by EE_Data_Migration_Script_base and
+	 * EE_Data_migration_Script_Stage
+	 *
+	 * @return int
+	 */
+	abstract public function count_records_migrated();
+
+	/**
+	 * Counts the records to migrate; the public version may cache it
+	 *
+	 * @return int
+	 */
+	abstract protected function _count_records_to_migrate();
+
+	/**
+	 * Returns a string indicating the migration script's status.
+	 *
+	 * @return string one of EE_Data_Migration_Manager::status_* constants
+	 * @throws EE_Error
+	 */
+	public function get_status()
+	{
+		if ($this->_status === null) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Trying to get status of Migration class %s, but it has not been initialized yet. It should be set in the constructor.",
+						"event_espresso"
+					),
+					get_class($this)
+				)
+			);
+		}
+		return $this->_status;
+	}
+
+	/**
+	 *
+	 * @param string $status
+	 * @return void
+	 */
+	protected function set_status($status)
+	{
+		$this->_status = $status;
+	}
+
+	/**
+	 * @return array of strings
+	 */
+	abstract public function get_errors();
+
+	/**
+	 * Returns the last error that occurred. If none occurred, returns null
+	 *
+	 * @return string
+	 */
+	public function get_last_error()
+	{
+		$errors = $this->get_errors();
+		if ($errors) {
+			return end($errors);
+		} else {
+			return null;
+		}
+	}
+
+	/**
+	 * Adds an error to the array of errors on this class.
+	 *
+	 * @param string  $error a string describing the error that will be useful for debugging. Consider including all
+	 *                       the data that led to the error, and a stack trace etc.
+	 * @param boolean $force force the error to be added (because otherwise we have a limit). If forcing and errors are
+	 *                       already at their limit, we will purposefully forget the first half
+	 */
+	public function add_error($error, $force = false)
+	{
+		if (! defined('EE_DMS_ERROR_LIMIT')) {
+			$limit = 50;
+		} else {
+			$limit = EE_DMS_ERROR_LIMIT;
+		}
+		// make sure errors is an array, see ticket #8261
+		if (is_string($this->_errors)) {
+			$this->_errors = array($this->_errors);
+		}
+		if (count($this->_errors) >= $limit) {
+			if ($force) {
+				// get rid of the first half of the errors and any above the limit
+				$this->_errors = array_slice($this->_errors, $limit / 2, $limit / 2);
+				$this->_errors[] = "Limit reached; removed first half of errors to save space";
+				$this->_errors[] = $error;
+			} else {
+				$this->_errors[ $limit ] = 'More, but limit reached...';
+			}
+		} else {
+			$this->_errors[] = $error;
+		}
+	}
+
+	/**
+	 * Indicates there was a fatal error and the migration cannot possibly continue
+	 *
+	 * @return boolean
+	 */
+	public function is_broken()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_fatal_error;
+	}
+
+	/**
+	 * @deprecated since 4.6.12
+	 */
+	public function is_borked()
+	{
+		EE_Error::doing_it_wrong(
+			'is_borked',
+			esc_html__(
+				'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
+				'event_espresso'
+			),
+			'4.6.12'
+		);
+		return $this->is_broken();
+	}
+
+	/**
+	 * Sets the status to as having a fatal error
+	 */
+	public function set_broken()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_fatal_error;
+	}
+
+	/**
+	 *
+	 * @deprecated since 4.6.12
+	 */
+	public function set_borked()
+	{
+		EE_Error::doing_it_wrong(
+			'is_borked',
+			esc_html__(
+				'The cheeky "is_borked" method had been replaced with the more proper "is_broken"',
+				'event_espresso'
+			),
+			'4.6.12'
+		);
+		return $this->set_broken();
+	}
+
+	/**
+	 * Checks if this thing believes it is completed
+	 *
+	 * @return boolean
+	 */
+	public function is_completed()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_completed;
+	}
+
+	/**
+	 * Checks if the current script has more to do or not (ie, if it's status is CONTINUE)
+	 *
+	 * @return boolean
+	 */
+	public function has_more_to_do()
+	{
+		return $this->get_status() == EE_Data_Migration_Manager::status_continue;
+	}
+
+	/**
+	 * Marks that we believe this migration thing is completed
+	 */
+	public function set_completed()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_completed;
+	}
+
+	/**
+	 * Marks that we think this migration class can continue to migrate
+	 */
+	public function reattempt()
+	{
+		$this->_status = EE_Data_Migration_Manager::status_continue;
+		$this->add_error(esc_html__('Reattempt migration', 'event_espresso'), true);
+	}
+
+	/**
+	 * A lot like "__sleep()" magic method in purpose, this is meant for persisting this class'
+	 * properties to the DB. However, we don't want to use __sleep() because its quite
+	 * possible that this class is defined when it goes to sleep, but NOT available when it
+	 * awakes (eg, this class is part of an addon that is deactivated at some point).
+	 */
+	public function properties_as_array()
+	{
+		$properties = get_object_vars($this);
+		$properties['class'] = get_class($this);
+		unset($properties['_migration_script']);
+		unset($properties['_table_manager']);
+		unset($properties['_table_analysis']);
+		return $properties;
+	}
+
+	/**
+	 * Sets all of the properties of this script stage to match what's in the array, which is assumed
+	 * to have been made from the properties_as_array() function.
+	 *
+	 * @param array $array_of_properties like what's produced from properties_as_array() method
+	 */
+	abstract public function instantiate_from_array_of_properties($array_of_properties);
+
+	/**
+	 * Convenience method for showing a database insertion error
+	 *
+	 * @param string $old_table
+	 * @param array  $old_row_as_array
+	 * @param string $new_table
+	 * @param array  $new_row_as_array columns=>values like used in wpdb->insert
+	 * @param array  $data_types       numerically indexed
+	 * @return string
+	 */
+	protected function _create_error_message_for_db_insertion(
+		$old_table,
+		$old_row_as_array,
+		$new_table,
+		$new_row_as_array,
+		$data_types
+	) {
+		global $wpdb;
+		$old_columns_and_values_for_string = array();
+		foreach ($old_row_as_array as $column => $value) {
+			$old_columns_and_values_for_string[] = "$column => $value";
+		}
+		$new_columns_and_values_for_string = array();
+		$count = 0;
+		foreach ($new_row_as_array as $column => $value) {
+			$new_columns_and_values_for_string[] = " $column => $value (" . $data_types[ $count++ ] . ")";
+		}
+		return sprintf(
+			esc_html__(
+				'Received error "%6$s" inserting row %5$s %1$s %5$s into table %2$s.%5$s Data used was %5$s %3$s %5$s from table %4$s.',
+				'event_espresso'
+			),
+			implode(", ", $new_columns_and_values_for_string),
+			$new_table,
+			implode(", ", $old_columns_and_values_for_string),
+			$old_table,
+			'<br/>',
+			$wpdb->last_error
+		);
+	}
+
+
+	/**
+	 * Same as json_encode, just avoids putting
+	 * serialized arrays into the http build query, as that would
+	 *
+	 * @param array $array_of_data
+	 * @return string
+	 */
+	protected function _json_encode($array_of_data)
+	{
+		// we'd rather NOT serialize the transaction details
+		$fields_to_include = array();
+		foreach ($array_of_data as $name => $value) {
+			$unserialized_data = @unserialize($value);
+			if ($unserialized_data === false) {
+				$fields_to_include[ $name ] = $value;
+			}
+		}
+		return wp_json_encode($fields_to_include);
+	}
+
+	/**
+	 * Gets the table manager (or throws an exception if it cannot be retrieved)
+	 *
+	 * @return TableManager
+	 * @throws EE_Error
+	 */
+	protected function _get_table_manager()
+	{
+		if ($this->_table_manager instanceof TableManager) {
+			return $this->_table_manager;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Table manager on migration class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+	/**
+	 * 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;
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Table analysis class on migration class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }

core/data_migration_scripts/EE_DMS_Core_4_6_0.dms.php

Spacing +17 added lines, -17 removed lines

@@ -13,12 +13,12 @@ 
 // unfortunately, this needs to be done upon INCLUSION of this file,
 // instead of construction, because it only gets constructed on first page load
 // (all other times it gets resurrected from a wordpress option)
-$stages = glob(EE_CORE . 'data_migration_scripts/4_6_0_stages/*');
+$stages = glob(EE_CORE.'data_migration_scripts/4_6_0_stages/*');
 $class_to_filepath = array();
 foreach ($stages as $filepath) {
     $matches = array();
     preg_match('~4_6_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+    $class_to_filepath[$matches[1]] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_6_0__autoloaded_stages', $class_to_filepath);
@@ -72,10 +72,10 @@ 
         if (version_compare($version_string, '4.6.0.decaf', '<') && version_compare($version_string, '4.5.0.decaf', '>=')) {
 //          echo "$version_string can be migrated from";
             return true;
-        } elseif (! $version_string) {
+        } elseif ( ! $version_string) {
 //          echo "no version string provided: $version_string";
             // no version string provided... this must be pre 4.3
-            return false;// changed mind. dont want people thinking they should migrate yet because they cant
+            return false; // changed mind. dont want people thinking they should migrate yet because they cant
         } else {
 //          echo "$version_string doesnt apply";
             return false;
@@ -90,7 +90,7 @@ 
     public function schema_changes_before_migration()
     {
         // relies on 4.1's EEH_Activation::create_table
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+        require_once(EE_HELPERS.'EEH_Activation.helper.php');
         $table_name = 'esp_answer';
         $sql = "ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
@@ -537,7 +537,7 @@ 
     public function add_default_admin_only_payments()
     {
         global $wpdb;
-        $table_name = $wpdb->prefix . "esp_payment_method";
+        $table_name = $wpdb->prefix."esp_payment_method";
         $user_id = EEH_Activation::get_default_creator_id();
         if ($this->_get_table_analysis()->tableExists($table_name)) {
             $SQL = "SELECT COUNT( * ) FROM $table_name";
@@ -565,7 +565,7 @@ 
                 $slug = sanitize_key($nicename);
                 // check that such a payment method exists
                 $exists = $wpdb->get_var($wpdb->prepare("SELECT count(*) FROM $table_name WHERE PMD_slug = %s", $slug));
-                if (! $exists) {
+                if ( ! $exists) {
                     $values = array(
                         'PMD_type'       => 'Admin_Only',
                         'PMD_name'       => $nicename,
@@ -579,16 +579,16 @@ 
                         $table_name,
                         $values,
                         array(
-                            '%s',// PMD_type
-                            '%s',// PMD_name
-                            '%s',// PMD_admin_name
-                            '%s',// PMD_admin_desc
-                            '%s',// PMD_slug
-                            '%d',// PMD_wp_user
-                            '%s',// PMD_scope
+                            '%s', // PMD_type
+                            '%s', // PMD_name
+                            '%s', // PMD_admin_name
+                            '%s', // PMD_admin_desc
+                            '%s', // PMD_slug
+                            '%d', // PMD_wp_user
+                            '%s', // PMD_scope
                         )
                     );
-                    if (! $success) {
+                    if ( ! $success) {
                         $this->add_error(sprintf(esc_html__(
                             "Could not insert new admin-only payment method with values %s during migration",
                             "event_espresso"
@@ -610,11 +610,11 @@ 
     public function insert_default_currencies()
     {
         global $wpdb;
-        $currency_table = $wpdb->prefix . "esp_currency";
+        $currency_table = $wpdb->prefix."esp_currency";
         if ($this->_get_table_analysis()->tableExists($currency_table)) {
             $SQL = "SELECT COUNT('CUR_code') FROM $currency_table";
             $countries = $wpdb->get_var($SQL);
-            if (! $countries) {
+            if ( ! $countries) {
                 $SQL = "INSERT INTO $currency_table
 				( CUR_code, CUR_single, CUR_plural, CUR_sign, CUR_dec_plc, CUR_active) VALUES
 				( 'EUR',  'Euro',  'Euros',  '€',  2,1),

Indentation +259 added lines, -259 removed lines

@@ -10,9 +10,9 @@ 
 $stages = glob(EE_CORE . 'data_migration_scripts/4_6_0_stages/*');
 $class_to_filepath = array();
 foreach ($stages as $filepath) {
-    $matches = array();
-    preg_match('~4_6_0_stages/(.*).dmsstage.php~', $filepath, $matches);
-    $class_to_filepath[ $matches[1] ] = $filepath;
+	$matches = array();
+	preg_match('~4_6_0_stages/(.*).dmsstage.php~', $filepath, $matches);
+	$class_to_filepath[ $matches[1] ] = $filepath;
 }
 // give addons a chance to autoload their stages too
 $class_to_filepath = apply_filters('FHEE__EE_DMS_4_6_0__autoloaded_stages', $class_to_filepath);
@@ -33,69 +33,69 @@ 
  */
 class EE_DMS_Core_4_6_0 extends EE_Data_Migration_Script_Base
 {
-    /**
-     * return EE_DMS_Core_4_6_0
-     *
-     * @param TableManager  $table_manager
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
-    {
-        $this->_pretty_name = esc_html__("Data Update to Event Espresso 4.6.0", "event_espresso");
-        $this->_priority = 10;
-        $this->_migration_stages = array(
-            new EE_DMS_4_6_0_gateways(),
-            new EE_DMS_4_6_0_question_types(),
-            new EE_DMS_4_6_0_country_system_question(),
-            new EE_DMS_4_6_0_state_system_question(),
-            new EE_DMS_4_6_0_billing_info(),
-            new EE_DMS_4_6_0_transactions(),
-            new EE_DMS_4_6_0_payments(),
-            new EE_DMS_4_6_0_invoice_settings(),
-        );
-        parent::__construct($table_manager, $table_analysis);
-    }
+	/**
+	 * return EE_DMS_Core_4_6_0
+	 *
+	 * @param TableManager  $table_manager
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableManager $table_manager = null, TableAnalysis $table_analysis = null)
+	{
+		$this->_pretty_name = esc_html__("Data Update to Event Espresso 4.6.0", "event_espresso");
+		$this->_priority = 10;
+		$this->_migration_stages = array(
+			new EE_DMS_4_6_0_gateways(),
+			new EE_DMS_4_6_0_question_types(),
+			new EE_DMS_4_6_0_country_system_question(),
+			new EE_DMS_4_6_0_state_system_question(),
+			new EE_DMS_4_6_0_billing_info(),
+			new EE_DMS_4_6_0_transactions(),
+			new EE_DMS_4_6_0_payments(),
+			new EE_DMS_4_6_0_invoice_settings(),
+		);
+		parent::__construct($table_manager, $table_analysis);
+	}
 
 
 
-    /**
-     * @param array $version_array
-     * @return bool
-     */
-    public function can_migrate_from_version($version_array)
-    {
-        $version_string = $version_array['Core'];
-        if (version_compare($version_string, '4.6.0.decaf', '<') && version_compare($version_string, '4.5.0.decaf', '>=')) {
+	/**
+	 * @param array $version_array
+	 * @return bool
+	 */
+	public function can_migrate_from_version($version_array)
+	{
+		$version_string = $version_array['Core'];
+		if (version_compare($version_string, '4.6.0.decaf', '<') && version_compare($version_string, '4.5.0.decaf', '>=')) {
 //          echo "$version_string can be migrated from";
-            return true;
-        } elseif (! $version_string) {
+			return true;
+		} elseif (! $version_string) {
 //          echo "no version string provided: $version_string";
-            // no version string provided... this must be pre 4.3
-            return false;// changed mind. dont want people thinking they should migrate yet because they cant
-        } else {
+			// no version string provided... this must be pre 4.3
+			return false;// changed mind. dont want people thinking they should migrate yet because they cant
+		} else {
 //          echo "$version_string doesnt apply";
-            return false;
-        }
-    }
+			return false;
+		}
+	}
 
 
 
-    /**
-     * @return bool
-     */
-    public function schema_changes_before_migration()
-    {
-        // relies on 4.1's EEH_Activation::create_table
-        require_once(EE_HELPERS . 'EEH_Activation.helper.php');
-        $table_name = 'esp_answer';
-        $sql = "ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+	/**
+	 * @return bool
+	 */
+	public function schema_changes_before_migration()
+	{
+		// relies on 4.1's EEH_Activation::create_table
+		require_once(EE_HELPERS . 'EEH_Activation.helper.php');
+		$table_name = 'esp_answer';
+		$sql = "ANS_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					ANS_value text NOT NULL,
 					PRIMARY KEY  (ANS_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_attendee_meta';
-        $sql = "ATTM_ID int(10) unsigned NOT	NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_attendee_meta';
+		$sql = "ATTM_ID int(10) unsigned NOT	NULL AUTO_INCREMENT,
 						ATT_ID bigint(20) unsigned NOT NULL,
 						ATT_fname varchar(45) NOT NULL,
 						ATT_lname varchar(45) NOT	NULL,
@@ -111,9 +111,9 @@ 
 								KEY ATT_fname (ATT_fname),
 								KEY ATT_lname (ATT_lname),
 								KEY ATT_email (ATT_email(191))";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_country';
-        $sql = "CNT_ISO varchar(2) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_country';
+		$sql = "CNT_ISO varchar(2) COLLATE utf8_bin NOT NULL,
 					  CNT_ISO3 varchar(3) COLLATE utf8_bin NOT NULL,
 					  RGN_ID tinyint(3) unsigned DEFAULT NULL,
 					  CNT_name varchar(45) COLLATE utf8_bin NOT NULL,
@@ -129,24 +129,24 @@ 
 					  CNT_is_EU tinyint(1) DEFAULT '0',
 					  CNT_active tinyint(1) DEFAULT '0',
 					  PRIMARY KEY  (CNT_ISO)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency';
-        $sql = "CUR_code varchar(6) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency';
+		$sql = "CUR_code varchar(6) COLLATE utf8_bin NOT NULL,
 				CUR_single varchar(45) COLLATE utf8_bin DEFAULT 'dollar',
 				CUR_plural varchar(45) COLLATE utf8_bin DEFAULT 'dollars',
 				CUR_sign varchar(45) COLLATE utf8_bin DEFAULT '$',
 				CUR_dec_plc varchar(1) COLLATE utf8_bin NOT NULL DEFAULT '2',
 				CUR_active tinyint(1) DEFAULT '0',
 				PRIMARY KEY  (CUR_code)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_currency_payment_method';
-        $sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_currency_payment_method';
+		$sql = "CPM_ID int(11) NOT NULL AUTO_INCREMENT,
 				CUR_code varchar(6) COLLATE utf8_bin NOT NULL,
 				PMD_ID int(11) NOT NULL,
 				PRIMARY KEY  (CPM_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_datetime';
-        $sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_datetime';
+		$sql = "DTT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 				  EVT_ID bigint(20) unsigned NOT NULL,
 				  DTT_name varchar(255) NOT NULL DEFAULT '',
 				  DTT_description text NOT NULL,
@@ -161,9 +161,9 @@ 
 						PRIMARY KEY  (DTT_ID),
 						KEY EVT_ID (EVT_ID),
 						KEY DTT_is_primary (DTT_is_primary)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_meta';
-        $sql = "
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_meta';
+		$sql = "
 			EVTM_ID int(10) NOT NULL AUTO_INCREMENT,
 			EVT_ID bigint(20) unsigned NOT NULL,
 			EVT_display_desc tinyint(1) unsigned NOT NULL DEFAULT 1,
@@ -178,31 +178,31 @@ 
 			EVT_external_URL varchar(200) NULL,
 			EVT_donations tinyint(1) NULL,
 			PRIMARY KEY  (EVTM_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_question_group';
-        $sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_question_group';
+		$sql = "EQG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					EVT_ID bigint(20) unsigned NOT NULL,
 					QSG_ID int(10) unsigned NOT NULL,
 					EQG_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EQG_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_venue';
-        $sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_venue';
+		$sql = "EVV_ID int(11) NOT NULL AUTO_INCREMENT,
 				EVT_ID bigint(20) unsigned NOT NULL,
 				VNU_ID bigint(20) unsigned NOT NULL,
 				EVV_primary tinyint(1) unsigned NOT NULL DEFAULT 0,
 				PRIMARY KEY  (EVV_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_extra_meta';
-        $sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_extra_meta';
+		$sql = "EXM_ID int(11) NOT NULL AUTO_INCREMENT,
 				OBJ_ID int(11) DEFAULT NULL,
 				EXM_type varchar(45) DEFAULT NULL,
 				EXM_key varchar(45) DEFAULT NULL,
 				EXM_value text,
 				PRIMARY KEY  (EXM_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_line_item';
-        $sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_line_item';
+		$sql = "LIN_ID int(11) NOT NULL AUTO_INCREMENT,
 				LIN_code varchar(245) NOT NULL DEFAULT '',
 				TXN_ID int(11) DEFAULT NULL,
 				LIN_name varchar(245) NOT NULL DEFAULT '',
@@ -218,9 +218,9 @@ 
 				OBJ_ID int(11) DEFAULT NULL,
 				OBJ_type varchar(45)DEFAULT NULL,
 				PRIMARY KEY  (LIN_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_log';
-        $sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_log';
+		$sql = "LOG_ID int(11) NOT NULL AUTO_INCREMENT,
 				LOG_time datetime DEFAULT NULL,
 				OBJ_ID varchar(45) DEFAULT NULL,
 				OBJ_type varchar(45) DEFAULT NULL,
@@ -228,19 +228,19 @@ 
 				LOG_message text,
 				LOG_wp_user int(11) DEFAULT NULL,
 				PRIMARY KEY  (LOG_ID)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_message_template';
-        $sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_message_template';
+		$sql = "MTP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					GRP_ID int(10) unsigned NOT NULL,
 					MTP_context varchar(50) NOT NULL,
 					MTP_template_field varchar(30) NOT NULL,
 					MTP_content text NOT NULL,
 					PRIMARY KEY  (MTP_ID),
 					KEY GRP_ID (GRP_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $this->_get_table_manager()->dropIndex('esp_message_template_group', 'EVT_ID');
-        $table_name = 'esp_message_template_group';
-        $sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_get_table_manager()->dropIndex('esp_message_template_group', 'EVT_ID');
+		$table_name = 'esp_message_template_group';
+		$sql = "GRP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					MTP_user_id int(10) NOT NULL DEFAULT '1',
 					MTP_name varchar(245) NOT NULL DEFAULT '',
 					MTP_description varchar(245) NOT NULL DEFAULT '',
@@ -252,17 +252,17 @@ 
 					MTP_is_active tinyint(1) NOT NULL DEFAULT '1',
 					PRIMARY KEY  (GRP_ID),
 					KEY MTP_user_id (MTP_user_id)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_event_message_template';
-        $sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_event_message_template';
+		$sql = "EMT_ID bigint(20) unsigned NOT NULL AUTO_INCREMENT,
 					EVT_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 					GRP_ID int(10) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (EMT_ID),
 					KEY EVT_ID (EVT_ID),
 					KEY GRP_ID (GRP_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_payment';
-        $sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_payment';
+		$sql = "PAY_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					TXN_ID int(10) unsigned DEFAULT NULL,
 					STS_ID varchar(3) COLLATE utf8_bin DEFAULT NULL,
 					PAY_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
@@ -279,9 +279,9 @@ 
 					PRIMARY KEY  (PAY_ID),
 					KEY TXN_ID (TXN_ID),
 					KEY PAY_timestamp (PAY_timestamp)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_payment_method';
-        $sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_payment_method';
+		$sql = "PMD_ID int(11) NOT NULL AUTO_INCREMENT,
 				PMD_type varchar(124) DEFAULT NULL,
 				PMD_name varchar(255) DEFAULT NULL,
 				PMD_desc text,
@@ -296,28 +296,28 @@ 
 				PMD_scope varchar(255) NULL DEFAULT 'frontend',
 				PRIMARY KEY  (PMD_ID),
 				UNIQUE KEY PMD_slug_UNIQUE (PMD_slug)";
-        $this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket_price";
-        $sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_is_new_in_this_version($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket_price";
+		$sql = "TKP_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TKT_ID int(10) unsigned NOT NULL,
 					  PRC_ID int(10) unsigned NOT NULL,
 					  PRIMARY KEY  (TKP_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_datetime_ticket";
-        $sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_datetime_ticket";
+		$sql = "DTK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  DTT_ID int(10) unsigned NOT NULL,
 					  TKT_ID int(10) unsigned NOT NULL,
 					  PRIMARY KEY  (DTK_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_ticket_template";
-        $sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_ticket_template";
+		$sql = "TTM_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TTM_name varchar(45) NOT NULL,
 					  TTM_description text,
 					  TTM_file varchar(45),
 					  PRIMARY KEY  (TTM_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question';
-        $sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question';
+		$sql = 'QST_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QST_display_text text NOT NULL,
 					QST_admin_label varchar(255) NOT NULL,
 					QST_system varchar(25) DEFAULT NULL,
@@ -329,25 +329,25 @@ 
 					QST_wp_user bigint(20) unsigned NULL,
 					QST_deleted tinyint(1) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QST_ID)';
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_group_question';
-        $sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_group_question';
+		$sql = "QGQ_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QSG_ID int(10) unsigned NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					QGQ_order int(10) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QGQ_ID) ";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_question_option';
-        $sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_question_option';
+		$sql = "QSO_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QSO_value varchar(255) NOT NULL,
 					QSO_desc text NOT NULL,
 					QST_ID int(10) unsigned NOT NULL,
 					QSO_order int(10) unsigned NOT NULL DEFAULT 0,
 					QSO_deleted tinyint(1) unsigned NOT NULL DEFAULT 0,
 					PRIMARY KEY  (QSO_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_registration';
-        $sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_registration';
+		$sql = "REG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  EVT_ID bigint(20) unsigned NOT NULL,
 					  ATT_ID bigint(20) unsigned NOT NULL,
 					  TXN_ID int(10) unsigned NOT NULL,
@@ -370,25 +370,25 @@ 
 					  KEY STS_ID (STS_ID),
 					  KEY REG_url_link (REG_url_link),
 					  KEY REG_code (REG_code)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = 'esp_checkin';
-        $sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = 'esp_checkin';
+		$sql = "CHK_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					REG_ID int(10) unsigned NOT NULL,
 					DTT_ID int(10) unsigned NOT NULL,
 					CHK_in tinyint(1) unsigned NOT NULL DEFAULT 1,
 					CHK_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
 					PRIMARY KEY  (CHK_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_state';
-        $sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_state';
+		$sql = "STA_ID smallint(5) unsigned NOT NULL AUTO_INCREMENT,
 					  CNT_ISO varchar(2) COLLATE utf8_bin NOT NULL,
 					  STA_abbrev varchar(24) COLLATE utf8_bin NOT NULL,
 					  STA_name varchar(100) COLLATE utf8_bin NOT NULL,
 					  STA_active tinyint(1) DEFAULT '1',
 					  PRIMARY KEY  (STA_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_status';
-        $sql = "STS_ID varchar(3) COLLATE utf8_bin NOT NULL,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_status';
+		$sql = "STS_ID varchar(3) COLLATE utf8_bin NOT NULL,
 					  STS_code varchar(45) COLLATE utf8_bin NOT NULL,
 					  STS_type set('event','registration','transaction','payment','email') COLLATE utf8_bin NOT NULL,
 					  STS_can_edit tinyint(1) NOT NULL DEFAULT 0,
@@ -396,9 +396,9 @@ 
 					  STS_open tinyint(1) NOT NULL DEFAULT 1,
 					  UNIQUE KEY STS_ID_UNIQUE (STS_ID),
 					  KEY STS_type (STS_type)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_transaction';
-        $sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_transaction';
+		$sql = "TXN_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TXN_timestamp datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
 					  TXN_total decimal(10,3) DEFAULT '0.00',
 					  TXN_paid decimal(10,3) NOT NULL DEFAULT '0.00',
@@ -410,9 +410,9 @@ 
 					  PRIMARY KEY  (TXN_ID),
 					  KEY TXN_timestamp (TXN_timestamp),
 					  KEY STS_ID (STS_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = 'esp_venue_meta';
-        $sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = 'esp_venue_meta';
+		$sql = "VNUM_ID int(11) NOT NULL AUTO_INCREMENT,
 			VNU_ID bigint(20) unsigned NOT NULL DEFAULT 0,
 			VNU_address varchar(255) DEFAULT NULL,
 			VNU_address2 varchar(255) DEFAULT NULL,
@@ -430,10 +430,10 @@ 
 			PRIMARY KEY  (VNUM_ID),
 			KEY STA_ID (STA_ID),
 			KEY CNT_ISO (CNT_ISO)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        // modified tables
-        $table_name = "esp_price";
-        $sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		// modified tables
+		$table_name = "esp_price";
+		$sql = "PRC_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  PRT_ID tinyint(3) unsigned NOT NULL,
 					  PRC_amount decimal(10,3) NOT NULL DEFAULT '0.00',
 					  PRC_name varchar(245) NOT NULL,
@@ -445,9 +445,9 @@ 
 					  PRC_wp_user bigint(20) unsigned NULL,
 					  PRC_parent int(10) unsigned DEFAULT 0,
 					  PRIMARY KEY  (PRC_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $table_name = "esp_price_type";
-        $sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$table_name = "esp_price_type";
+		$sql = "PRT_ID tinyint(3) unsigned NOT NULL AUTO_INCREMENT,
 				  PRT_name varchar(45) NOT NULL,
 				  PBT_ID tinyint(3) unsigned NOT NULL DEFAULT '1',
 				  PRT_is_percent tinyint(1) NOT NULL DEFAULT '0',
@@ -456,9 +456,9 @@ 
 				  PRT_deleted tinyint(1) NOT NULL DEFAULT '0',
 				  UNIQUE KEY PRT_name_UNIQUE (PRT_name),
 				  PRIMARY KEY  (PRT_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
-        $table_name = "esp_ticket";
-        $sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB ');
+		$table_name = "esp_ticket";
+		$sql = "TKT_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					  TTM_ID int(10) unsigned NOT NULL,
 					  TKT_name varchar(245) NOT NULL DEFAULT '',
 					  TKT_description text NOT NULL,
@@ -479,10 +479,10 @@ 
 					  TKT_parent int(10) unsigned DEFAULT '0',
 					  TKT_deleted tinyint(1) NOT NULL DEFAULT '0',
 					  PRIMARY KEY  (TKT_ID)";
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        $this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_identifier_UNIQUE');
-        $table_name = 'esp_question_group';
-        $sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		$this->_get_table_manager()->dropIndex('esp_question_group', 'QSG_identifier_UNIQUE');
+		$table_name = 'esp_question_group';
+		$sql = 'QSG_ID int(10) unsigned NOT NULL AUTO_INCREMENT,
 					QSG_name varchar(255) NOT NULL,
 					QSG_identifier varchar(100) NOT NULL,
 					QSG_desc text NULL,
@@ -494,124 +494,124 @@ 
 					QSG_wp_user bigint(20) unsigned NULL,
 					PRIMARY KEY  (QSG_ID),
 					UNIQUE KEY QSG_identifier_UNIQUE (QSG_identifier ASC)';
-        $this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
-        /** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
-        $script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
-        // (because many need to convert old string states to foreign keys into the states table)
-        $script_4_1_defaults->insert_default_states();
-        $script_4_1_defaults->insert_default_countries();
-        /** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
-        $script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
-        $script_4_5_defaults->insert_default_price_types();
-        $script_4_5_defaults->insert_default_prices();
-        $script_4_5_defaults->insert_default_tickets();
-        // setting up the config wp option pretty well counts as a 'schema change', or at least should happen here
-        EE_Config::instance()->update_espresso_config(false, true);
-        $this->add_default_admin_only_payments();
-        $this->insert_default_currencies();
-        return true;
-    }
+		$this->_table_should_exist_previously($table_name, $sql, 'ENGINE=InnoDB');
+		/** @var EE_DMS_Core_4_1_0 $script_4_1_defaults */
+		$script_4_1_defaults = EE_Registry::instance()->load_dms('Core_4_1_0');
+		// (because many need to convert old string states to foreign keys into the states table)
+		$script_4_1_defaults->insert_default_states();
+		$script_4_1_defaults->insert_default_countries();
+		/** @var EE_DMS_Core_4_5_0 $script_4_5_defaults */
+		$script_4_5_defaults = EE_Registry::instance()->load_dms('Core_4_5_0');
+		$script_4_5_defaults->insert_default_price_types();
+		$script_4_5_defaults->insert_default_prices();
+		$script_4_5_defaults->insert_default_tickets();
+		// setting up the config wp option pretty well counts as a 'schema change', or at least should happen here
+		EE_Config::instance()->update_espresso_config(false, true);
+		$this->add_default_admin_only_payments();
+		$this->insert_default_currencies();
+		return true;
+	}
 
 
 
-    /**
-     * @return boolean
-     */
-    public function schema_changes_after_migration()
-    {
-        return true;
-    }
+	/**
+	 * @return boolean
+	 */
+	public function schema_changes_after_migration()
+	{
+		return true;
+	}
 
 
 
-    public function migration_page_hooks()
-    {
-    }
+	public function migration_page_hooks()
+	{
+	}
 
 
 
-    public function add_default_admin_only_payments()
-    {
-        global $wpdb;
-        $table_name = $wpdb->prefix . "esp_payment_method";
-        $user_id = EEH_Activation::get_default_creator_id();
-        if ($this->_get_table_analysis()->tableExists($table_name)) {
-            $SQL = "SELECT COUNT( * ) FROM $table_name";
-            $existing_payment_methods = $wpdb->get_var($SQL);
-            $default_admin_only_payment_methods = apply_filters(
-                'FHEE__EEH_Activation__add_default_admin_only_payments__default_admin_only_payment_methods',
-                array(
-                    (string) esc_html__("Bank", 'event_espresso')        => esc_html__("Bank Draft", 'event_espresso'),
-                    (string) esc_html__("Cash", 'event_espresso')        => esc_html__("Cash Delivered Physically", 'event_espresso'),
-                    (string) esc_html__("Check", 'event_espresso')       => esc_html__("Paper Check", 'event_espresso'),
-                    (string) esc_html__("Credit Card", 'event_espresso') => esc_html__("Offline Credit Card Payment", 'event_espresso'),
-                    (string) esc_html__("Debit Card", 'event_espresso')  => esc_html__("Offline Debit Payment", 'event_espresso'),
-                    (string) esc_html__("Invoice", 'event_espresso')     => esc_html__(
-                        "Invoice received with monies included",
-                        'event_espresso'
-                    ),
-                    (string) esc_html__("Money Order", 'event_espresso') => '',
-                    (string) esc_html__("Paypal", 'event_espresso')      => esc_html__("Paypal eCheck, Invoice, etc", 'event_espresso'),
-                    (string) esc_html__('Other', 'event_espresso')       => esc_html__('Other method of payment', 'event_espresso'),
-                )
-            );
-            // make sure we hae payment method records for the following
-            // so admins can record payments for them from the admin page
-            foreach ($default_admin_only_payment_methods as $nicename => $description) {
-                $slug = sanitize_key($nicename);
-                // check that such a payment method exists
-                $exists = $wpdb->get_var($wpdb->prepare("SELECT count(*) FROM $table_name WHERE PMD_slug = %s", $slug));
-                if (! $exists) {
-                    $values = array(
-                        'PMD_type'       => 'Admin_Only',
-                        'PMD_name'       => $nicename,
-                        'PMD_admin_name' => $nicename,
-                        'PMD_admin_desc' => $description,
-                        'PMD_slug'       => $slug,
-                        'PMD_wp_user'    => $user_id,
-                        'PMD_scope'      => serialize(array('ADMIN')),
-                    );
-                    $success = $wpdb->insert(
-                        $table_name,
-                        $values,
-                        array(
-                            '%s',// PMD_type
-                            '%s',// PMD_name
-                            '%s',// PMD_admin_name
-                            '%s',// PMD_admin_desc
-                            '%s',// PMD_slug
-                            '%d',// PMD_wp_user
-                            '%s',// PMD_scope
-                        )
-                    );
-                    if (! $success) {
-                        $this->add_error(sprintf(esc_html__(
-                            "Could not insert new admin-only payment method with values %s during migration",
-                            "event_espresso"
-                        ), $this->_json_encode($values)));
-                    }
-                }
-            }
-        }
-    }
+	public function add_default_admin_only_payments()
+	{
+		global $wpdb;
+		$table_name = $wpdb->prefix . "esp_payment_method";
+		$user_id = EEH_Activation::get_default_creator_id();
+		if ($this->_get_table_analysis()->tableExists($table_name)) {
+			$SQL = "SELECT COUNT( * ) FROM $table_name";
+			$existing_payment_methods = $wpdb->get_var($SQL);
+			$default_admin_only_payment_methods = apply_filters(
+				'FHEE__EEH_Activation__add_default_admin_only_payments__default_admin_only_payment_methods',
+				array(
+					(string) esc_html__("Bank", 'event_espresso')        => esc_html__("Bank Draft", 'event_espresso'),
+					(string) esc_html__("Cash", 'event_espresso')        => esc_html__("Cash Delivered Physically", 'event_espresso'),
+					(string) esc_html__("Check", 'event_espresso')       => esc_html__("Paper Check", 'event_espresso'),
+					(string) esc_html__("Credit Card", 'event_espresso') => esc_html__("Offline Credit Card Payment", 'event_espresso'),
+					(string) esc_html__("Debit Card", 'event_espresso')  => esc_html__("Offline Debit Payment", 'event_espresso'),
+					(string) esc_html__("Invoice", 'event_espresso')     => esc_html__(
+						"Invoice received with monies included",
+						'event_espresso'
+					),
+					(string) esc_html__("Money Order", 'event_espresso') => '',
+					(string) esc_html__("Paypal", 'event_espresso')      => esc_html__("Paypal eCheck, Invoice, etc", 'event_espresso'),
+					(string) esc_html__('Other', 'event_espresso')       => esc_html__('Other method of payment', 'event_espresso'),
+				)
+			);
+			// make sure we hae payment method records for the following
+			// so admins can record payments for them from the admin page
+			foreach ($default_admin_only_payment_methods as $nicename => $description) {
+				$slug = sanitize_key($nicename);
+				// check that such a payment method exists
+				$exists = $wpdb->get_var($wpdb->prepare("SELECT count(*) FROM $table_name WHERE PMD_slug = %s", $slug));
+				if (! $exists) {
+					$values = array(
+						'PMD_type'       => 'Admin_Only',
+						'PMD_name'       => $nicename,
+						'PMD_admin_name' => $nicename,
+						'PMD_admin_desc' => $description,
+						'PMD_slug'       => $slug,
+						'PMD_wp_user'    => $user_id,
+						'PMD_scope'      => serialize(array('ADMIN')),
+					);
+					$success = $wpdb->insert(
+						$table_name,
+						$values,
+						array(
+							'%s',// PMD_type
+							'%s',// PMD_name
+							'%s',// PMD_admin_name
+							'%s',// PMD_admin_desc
+							'%s',// PMD_slug
+							'%d',// PMD_wp_user
+							'%s',// PMD_scope
+						)
+					);
+					if (! $success) {
+						$this->add_error(sprintf(esc_html__(
+							"Could not insert new admin-only payment method with values %s during migration",
+							"event_espresso"
+						), $this->_json_encode($values)));
+					}
+				}
+			}
+		}
+	}
 
 
 
-    /**
-     * insert_default_countries
-     *
-     * @static
-     * @return void
-     */
-    public function insert_default_currencies()
-    {
-        global $wpdb;
-        $currency_table = $wpdb->prefix . "esp_currency";
-        if ($this->_get_table_analysis()->tableExists($currency_table)) {
-            $SQL = "SELECT COUNT('CUR_code') FROM $currency_table";
-            $countries = $wpdb->get_var($SQL);
-            if (! $countries) {
-                $SQL = "INSERT INTO $currency_table
+	/**
+	 * insert_default_countries
+	 *
+	 * @static
+	 * @return void
+	 */
+	public function insert_default_currencies()
+	{
+		global $wpdb;
+		$currency_table = $wpdb->prefix . "esp_currency";
+		if ($this->_get_table_analysis()->tableExists($currency_table)) {
+			$SQL = "SELECT COUNT('CUR_code') FROM $currency_table";
+			$countries = $wpdb->get_var($SQL);
+			if (! $countries) {
+				$SQL = "INSERT INTO $currency_table
 				( CUR_code, CUR_single, CUR_plural, CUR_sign, CUR_dec_plc, CUR_active) VALUES
 				( 'EUR',  'Euro',  'Euros',  '€',  2,1),
 				( 'AED',  'Dirham',  'Dirhams', 'د.إ',2,1),
@@ -765,8 +765,8 @@ 
 				( 'ZAR',  'Rand',  'Rands',  'R',  2,1),
 				( 'ZMK',  'Kwacha',  'Kwachas',  '',  2,1),
 				( 'ZWD', 'Dollar', 'Dollars', 'Z$', 2,1);";
-                $wpdb->query($SQL);
-            }
-        }
-    }
+				$wpdb->query($SQL);
+			}
+		}
+	}
 }