eventespresso / event-espresso-core

core/EE_Payment_Processor.core.php

Indentation +838 added lines, -838 removed lines

@@ -18,842 +18,842 @@
 class EE_Payment_Processor extends EE_Processor_Base implements ResettableInterface
 {
 
-    /**
-     * @var EE_Payment_Processor $_instance
-     * @access    private
-     */
-    private static $_instance;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @access    public
-     * @return EE_Payment_Processor instance
-     */
-    public static function instance()
-    {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Payment_Processor) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @return EE_Payment_Processor
-     */
-    public static function reset()
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     *private constructor to prevent direct creation
-     *
-     * @Constructor
-     * @access private
-     */
-    private function __construct()
-    {
-        do_action('AHEE__EE_Payment_Processor__construct');
-        add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
-    }
-
-
-    /**
-     * Using the selected gateway, processes the payment for that transaction, and updates the transaction
-     * appropriately. Saves the payment that is generated
-     *
-     * @param EE_Payment_Method    $payment_method
-     * @param EE_Transaction       $transaction
-     * @param float                $amount       if only part of the transaction is to be paid for, how much.
-     *                                           Leave null if payment is for the full amount owing
-     * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
-     *                                           Receive_form_submission() should have
-     *                                           already been called on the billing form
-     *                                           (ie, its inputs should have their normalized values set).
-     * @param string               $return_url   string used mostly by offsite gateways to specify
-     *                                           where to go AFTER the offsite gateway
-     * @param string               $method       like 'CART', indicates who the client who called this was
-     * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
-     * @param boolean              $update_txn   whether or not to call
-     *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param string               $cancel_url   URL to return to if off-site payments are cancelled
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_payment(
-        EE_Payment_Method $payment_method,
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_form = null,
-        $return_url = null,
-        $method = 'CART',
-        $by_admin = false,
-        $update_txn = true,
-        $cancel_url = ''
-    ) {
-        if ((float) $amount < 0) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
-                        'event_espresso'
-                    ),
-                    $amount,
-                    $transaction->ID()
-                )
-            );
-        }
-        // verify payment method
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        // verify transaction
-        EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $transaction->set_payment_method_ID($payment_method->ID());
-        // verify payment method type
-        if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-            $payment = $payment_method->type_obj()->process_payment(
-                $transaction,
-                min($amount, $transaction->remaining()), // make sure we don't overcharge
-                $billing_form,
-                $return_url,
-                add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
-                $method,
-                $by_admin
-            );
-            // check if payment method uses an off-site gateway
-            if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
-                // don't process payments for off-site gateways yet because no payment has occurred yet
-                $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            }
-            return $payment;
-        }
-        EE_Error::add_error(
-            sprintf(
-                __(
-                    'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
-                    'event_espresso'
-                ),
-                '<br/>',
-                EE_Registry::instance()->CFG->organization->get_pretty('email')
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return null;
-    }
-
-
-    /**
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment_Method  $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_ipn_url_for_payment_method($transaction, $payment_method)
-    {
-        /** @type \EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg instanceof EE_Registration) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
-                        'event_espresso'
-                    ),
-                    $transaction->ID()
-                )
-            );
-        }
-        $payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
-            $payment_method,
-            true
-        );
-        $url = add_query_arg(
-            array(
-                'e_reg_url_link'    => $primary_reg->reg_url_link(),
-                'ee_payment_method' => $payment_method->slug(),
-            ),
-            EE_Registry::instance()->CFG->core->txn_page_url()
-        );
-        return $url;
-    }
-
-
-    /**
-     * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
-     * we can easily find what registration the IPN is for and what payment method.
-     * However, if not, we'll give all payment methods a chance to claim it and process it.
-     * If a payment is found for the IPN info, it is saved.
-     *
-     * @param array              $_req_data            eg $_REQUEST
-     * @param EE_Transaction|int $transaction          optional (or a transactions id)
-     * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
-     * @param boolean            $update_txn           whether or not to call
-     *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @param bool               $separate_IPN_request whether the IPN uses a separate request ( true like PayPal )
-     *                                                 or is processed manually ( false like Mijireh )
-     * @throws EE_Error
-     * @throws Exception
-     * @return EE_Payment
-     * @throws \RuntimeException
-     * @throws \ReflectionException
-     * @throws \InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function process_ipn(
-        $_req_data,
-        $transaction = null,
-        $payment_method = null,
-        $update_txn = true,
-        $separate_IPN_request = true
-    ) {
-        EE_Registry::instance()->load_model('Change_Log');
-        $_req_data = $this->_remove_unusable_characters_from_array((array) $_req_data);
-        EE_Processor_Base::set_IPN($separate_IPN_request);
-        $obj_for_log = null;
-        if ($transaction instanceof EE_Transaction) {
-            $obj_for_log = $transaction;
-            if ($payment_method instanceof EE_Payment_Method) {
-                $obj_for_log = EEM_Payment::instance()->get_one(
-                    array(
-                        array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
-                        'order_by' => array('PAY_timestamp' => 'desc'),
-                    )
-                );
-            }
-        } elseif ($payment_method instanceof EE_Payment) {
-            $obj_for_log = $payment_method;
-        }
-        $log = EEM_Change_Log::instance()->log(
-            EEM_Change_Log::type_gateway,
-            array('IPN data received' => $_req_data),
-            $obj_for_log
-        );
-        try {
-            /**
-             * @var EE_Payment $payment
-             */
-            $payment = null;
-            if ($transaction && $payment_method) {
-                /** @type EE_Transaction $transaction */
-                $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-                /** @type EE_Payment_Method $payment_method */
-                $payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
-                if ($payment_method->type_obj() instanceof EE_PMT_Base) {
-                    try {
-                        $payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
-                        $log->set_object($payment);
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    }
-                } else {
-                    // not a payment
-                    EE_Error::add_error(
-                        sprintf(
-                            __(
-                                'A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.',
-                                'event_espresso'
-                            ),
-                            '<br/>',
-                            EE_Registry::instance()->CFG->organization->get_pretty('email')
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                // that's actually pretty ok. The IPN just wasn't able
-                // to identify which transaction or payment method this was for
-                // give all active payment methods a chance to claim it
-                $active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
-                foreach ($active_payment_methods as $active_payment_method) {
-                    try {
-                        $payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
-                        $payment_method = $active_payment_method;
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array('IPN data' => $_req_data),
-                            $payment
-                        );
-                        break;
-                    } catch (EventEspresso\core\exceptions\IpnException $e) {
-                        EEM_Change_Log::instance()->log(
-                            EEM_Change_Log::type_gateway,
-                            array(
-                                'message'     => 'IPN Exception: ' . $e->getMessage(),
-                                'current_url' => EEH_URL::current_url(),
-                                'payment'     => $e->getPaymentProperties(),
-                                'IPN_data'    => $e->getIpnData(),
-                            ),
-                            $obj_for_log
-                        );
-                        return $e->getPayment();
-                    } catch (EE_Error $e) {
-                        // that's fine- it apparently couldn't handle the IPN
-                    }
-                }
-            }
-            // EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
-            if ($payment instanceof EE_Payment) {
-                $payment->save();
-                //  update the TXN
-                $this->update_txn_based_on_payment(
-                    $transaction,
-                    $payment,
-                    $update_txn,
-                    $separate_IPN_request
-                );
-            } else {
-                // we couldn't find the payment for this IPN... let's try and log at least SOMETHING
-                if ($payment_method) {
-                    EEM_Change_Log::instance()->log(
-                        EEM_Change_Log::type_gateway,
-                        array('IPN data' => $_req_data),
-                        $payment_method
-                    );
-                } elseif ($transaction) {
-                    EEM_Change_Log::instance()->log(
-                        EEM_Change_Log::type_gateway,
-                        array('IPN data' => $_req_data),
-                        $transaction
-                    );
-                }
-            }
-            return $payment;
-        } catch (EE_Error $e) {
-            do_action(
-                'AHEE__log',
-                __FILE__,
-                __FUNCTION__,
-                sprintf(
-                    __(
-                        'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
-                        'event_espresso'
-                    ),
-                    print_r($transaction, true),
-                    print_r($_req_data, true),
-                    $e->getMessage()
-                )
-            );
-            throw $e;
-        }
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param  array $request_data
-     * @return array
-     */
-    protected function _remove_unusable_characters_from_array(array $request_data)
-    {
-        $return_data = array();
-        foreach ($request_data as $key => $value) {
-            $return_data[ $this->_remove_unusable_characters($key) ] = $this->_remove_unusable_characters(
-                $value
-            );
-        }
-        return $return_data;
-    }
-
-
-    /**
-     * Removes any non-printable illegal characters from the input,
-     * which might cause a raucous when trying to insert into the database
-     *
-     * @param string $request_data
-     * @return string
-     */
-    protected function _remove_unusable_characters($request_data)
-    {
-        return preg_replace('/[^[:print:]]/', '', $request_data);
-    }
-
-
-    /**
-     * Should be called just before displaying the payment attempt results to the user,
-     * when the payment attempt has finished. Some payment methods may have special
-     * logic to perform here. For example, if process_payment() happens on a special request
-     * and then the user is redirected to a page that displays the payment's status, this
-     * should be called while loading the page that displays the payment's status. If the user is
-     * sent to an offsite payment provider, this should be called upon returning from that offsite payment
-     * provider.
-     *
-     * @param EE_Transaction|int $transaction
-     * @param bool               $update_txn whether or not to call
-     *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
-     *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
-     */
-    public function finalize_payment_for($transaction, $update_txn = true)
-    {
-        /** @var $transaction EE_Transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        $last_payment_method = $transaction->payment_method();
-        if ($last_payment_method instanceof EE_Payment_Method) {
-            $payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
-            $this->update_txn_based_on_payment($transaction, $payment, $update_txn);
-            return $payment;
-        }
-        return null;
-    }
-
-
-    /**
-     * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @param EE_Payment        $payment_to_refund
-     * @param array             $refund_info
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_refund(
-        EE_Payment_Method $payment_method,
-        EE_Payment $payment_to_refund,
-        array $refund_info = array()
-    ) {
-        if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
-            $payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
-            $this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
-        }
-        return $payment_to_refund;
-    }
-
-
-    /**
-     * This should be called each time there may have been an update to a
-     * payment on a transaction (ie, we asked for a payment to process a
-     * payment for a transaction, or we told a payment method about an IPN, or
-     * we told a payment method to
-     * "finalize_payment_for" (a transaction), or we told a payment method to
-     * process a refund. This should handle firing the correct hooks to
-     * indicate
-     * what exactly happened and updating the transaction appropriately). This
-     * could be integrated directly into EE_Transaction upon save, but we want
-     * this logic to be separate from 'normal' plain-jane saving and updating
-     * of transactions and payments, and to be tied to payment processing.
-     * Note: this method DOES NOT save the payment passed into it. It is the responsibility
-     * of previous code to decide whether or not to save (because the payment passed into
-     * this method might be a temporary, never-to-be-saved payment from an offline gateway,
-     * in which case we only want that payment object for some temporary usage during this request,
-     * but we don't want it to be saved).
-     *
-     * @param EE_Transaction|int $transaction
-     * @param EE_Payment         $payment
-     * @param boolean            $update_txn
-     *                        whether or not to call
-     *                        EE_Transaction_Processor::
-     *                        update_transaction_and_registrations_after_checkout_or_payment()
-     *                        (you can save 1 DB query if you know you're going
-     *                        to save it later instead)
-     * @param bool               $IPN
-     *                        if processing IPNs or other similar payment
-     *                        related activities that occur in alternate
-     *                        requests than the main one that is processing the
-     *                        TXN, then set this to true to check whether the
-     *                        TXN is locked before updating
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
-    {
-        $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
-        /** @type EE_Transaction $transaction */
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        // can we freely update the TXN at this moment?
-        if ($IPN && $transaction->is_locked()) {
-            // don't update the transaction at this exact moment
-            // because the TXN is active in another request
-            EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                time(),
-                $transaction->ID(),
-                $payment->ID()
-            );
-        } else {
-            // verify payment and that it has been saved
-            if ($payment instanceof EE_Payment && $payment->ID()) {
-                if ($payment->payment_method() instanceof EE_Payment_Method
-                    && $payment->payment_method()->type_obj() instanceof EE_PMT_Base
-                ) {
-                    $payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
-                    // update TXN registrations with payment info
-                    $this->process_registration_payments($transaction, $payment);
-                }
-                $do_action = $payment->just_approved()
-                    ? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
-                    : $do_action;
-            } else {
-                // send out notifications
-                add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-                $do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
-            }
-            if ($payment instanceof EE_Payment && $payment->status() !== EEM_Payment::status_id_failed) {
-                /** @type EE_Transaction_Payments $transaction_payments */
-                $transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
-                // set new value for total paid
-                $transaction_payments->calculate_total_payments_and_update_status($transaction);
-                // call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
-                if ($update_txn) {
-                    $this->_post_payment_processing($transaction, $payment, $IPN);
-                }
-            }
-            // granular hook for others to use.
-            do_action($do_action, $transaction, $payment);
-            do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
-            // global hook for others to use.
-            do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
-        }
-    }
-
-
-    /**
-     * update registrations REG_paid field after successful payment and link registrations with payment
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment        $payment
-     * @param EE_Registration[] $registrations
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_payments(
-        EE_Transaction $transaction,
-        EE_Payment $payment,
-        array $registrations = array()
-    ) {
-        // only process if payment was successful
-        if ($payment->status() !== EEM_Payment::status_id_approved) {
-            return;
-        }
-        // EEM_Registration::instance()->show_next_x_db_queries();
-        if (empty($registrations)) {
-            // find registrations with monies owing that can receive a payment
-            $registrations = $transaction->registrations(
-                array(
-                    array(
-                        // only these reg statuses can receive payments
-                        'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
-                        'REG_final_price'  => array('!=', 0),
-                        'REG_final_price*' => array('!=', 'REG_paid', true),
-                    ),
-                )
-            );
-        }
-        // still nothing ??!??
-        if (empty($registrations)) {
-            return;
-        }
-        // todo: break out the following logic into a separate strategy class
-        // todo: named something like "Sequential_Reg_Payment_Strategy"
-        // todo: which would apply payments using the capitalist "first come first paid" approach
-        // todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
-        // todo: which would be the socialist "everybody gets a piece of pie" approach,
-        // todo: which would be better for deposits, where you want a bit of the payment applied to each registration
-        $refund = $payment->is_a_refund();
-        // how much is available to apply to registrations?
-        $available_payment_amount = abs($payment->amount());
-        foreach ($registrations as $registration) {
-            if ($registration instanceof EE_Registration) {
-                // nothing left?
-                if ($available_payment_amount <= 0) {
-                    break;
-                }
-                if ($refund) {
-                    $available_payment_amount = $this->process_registration_refund(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                } else {
-                    $available_payment_amount = $this->process_registration_payment(
-                        $registration,
-                        $payment,
-                        $available_payment_amount
-                    );
-                }
-            }
-        }
-        if ($available_payment_amount > 0
-            && apply_filters(
-                'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
-                false
-            )) {
-            EE_Error::add_attention(
-                sprintf(
-                    __(
-                        'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
-                        'event_espresso'
-                    ),
-                    EEH_Template::format_currency($available_payment_amount),
-                    implode(', ', array_keys($registrations)),
-                    '<br/>',
-                    EEH_Template::format_currency($payment->amount())
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_payment_amount
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_payment_amount = 0.00
-    ) {
-        $owing = $registration->final_price() - $registration->paid();
-        if ($owing > 0) {
-            // don't allow payment amount to exceed the available payment amount, OR the amount owing
-            $payment_amount = min($available_payment_amount, $owing);
-            // update $available_payment_amount
-            $available_payment_amount -= $payment_amount;
-            // calculate and set new REG_paid
-            $registration->set_paid($registration->paid() + $payment_amount);
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $payment_amount);
-        }
-        return $available_payment_amount;
-    }
-
-
-    /**
-     * update registration REG_paid field after successful payment and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $payment_amount
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _apply_registration_payment(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $payment_amount = 0.00
-    ) {
-        // find any existing reg payment records for this registration and payment
-        $existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
-            array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
-        );
-        // if existing registration payment exists
-        if ($existing_reg_payment instanceof EE_Registration_Payment) {
-            // then update that record
-            $existing_reg_payment->set_amount($payment_amount);
-            $existing_reg_payment->save();
-        } else {
-            // or add new relation between registration and payment and set amount
-            $registration->_add_relation_to(
-                $payment,
-                'Payment',
-                array('RPY_amount' => $payment_amount)
-            );
-            // make it stick
-            $registration->save();
-        }
-    }
-
-
-    /**
-     * update registration REG_paid field after refund and link registration with payment
-     *
-     * @param EE_Registration $registration
-     * @param EE_Payment      $payment
-     * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function process_registration_refund(
-        EE_Registration $registration,
-        EE_Payment $payment,
-        $available_refund_amount = 0.00
-    ) {
-        // EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
-        if ($registration->paid() > 0) {
-            // ensure $available_refund_amount is NOT negative
-            $available_refund_amount = (float) abs($available_refund_amount);
-            // don't allow refund amount to exceed the available payment amount, OR the amount paid
-            $refund_amount = min($available_refund_amount, (float) $registration->paid());
-            // update $available_payment_amount
-            $available_refund_amount -= $refund_amount;
-            // calculate and set new REG_paid
-            $registration->set_paid($registration->paid() - $refund_amount);
-            // convert payment amount back to a negative value for storage in the db
-            $refund_amount = (float) abs($refund_amount) * -1;
-            // now save it
-            $this->_apply_registration_payment($registration, $payment, $refund_amount);
-        }
-        return $available_refund_amount;
-    }
-
-
-    /**
-     * Process payments and transaction after payment process completed.
-     * ultimately this will send the TXN and payment details off so that notifications can be sent out.
-     * if this request happens to be processing an IPN,
-     * then we will also set the Payment Options Reg Step to completed,
-     * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
-     *
-     * @param EE_Transaction $transaction
-     * @param EE_Payment     $payment
-     * @param bool           $IPN
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
-    {
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // is the Payment Options Reg Step completed ?
-        $payment_options_step_completed = $transaction->reg_step_completed('payment_options');
-        // if the Payment Options Reg Step is completed...
-        $revisit = $payment_options_step_completed === true;
-        // then this is kinda sorta a revisit with regards to payments at least
-        $transaction_processor->set_revisit($revisit);
-        // if this is an IPN, let's consider the Payment Options Reg Step completed if not already
-        if ($IPN
-            && $payment_options_step_completed !== true
-            && ($payment->is_approved() || $payment->is_pending())
-        ) {
-            $payment_options_step_completed = $transaction->set_reg_step_completed(
-                'payment_options'
-            );
-        }
-        // maybe update status, but don't save transaction just yet
-        $transaction->update_status_based_on_total_paid(false);
-        // check if 'finalize_registration' step has been completed...
-        $finalized = $transaction->reg_step_completed('finalize_registration');
-        //  if this is an IPN and the final step has not been initiated
-        if ($IPN && $payment_options_step_completed && $finalized === false) {
-            // and if it hasn't already been set as being started...
-            $finalized = $transaction->set_reg_step_initiated('finalize_registration');
-        }
-        $transaction->save();
-        // because the above will return false if the final step was not fully completed, we need to check again...
-        if ($IPN && $finalized !== false) {
-            // and if we are all good to go, then send out notifications
-            add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
-            // ok, now process the transaction according to the payment
-            $transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
-                $transaction,
-                $payment
-            );
-        }
-        // DEBUG LOG
-        $payment_method = $payment->payment_method();
-        if ($payment_method instanceof EE_Payment_Method) {
-            $payment_method_type_obj = $payment_method->type_obj();
-            if ($payment_method_type_obj instanceof EE_PMT_Base) {
-                $gateway = $payment_method_type_obj->get_gateway();
-                if ($gateway instanceof EE_Gateway) {
-                    $gateway->log(
-                        array(
-                            'message'               => __('Post Payment Transaction Details', 'event_espresso'),
-                            'transaction'           => $transaction->model_field_array(),
-                            'finalized'             => $finalized,
-                            'IPN'                   => $IPN,
-                            'deliver_notifications' => has_filter(
-                                'FHEE__EED_Messages___maybe_registration__deliver_notifications'
-                            ),
-                        ),
-                        $payment
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Force posts to PayPal to use TLS v1.2. See:
-     * https://core.trac.wordpress.org/ticket/36320
-     * https://core.trac.wordpress.org/ticket/34924#comment:15
-     * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
-     * This will affect PayPal standard, pro, express, and Payflow.
-     *
-     * @param $handle
-     * @param $r
-     * @param $url
-     */
-    public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
-    {
-        if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
-            // Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
-            // instead of the constant because it might not be defined
-            curl_setopt($handle, CURLOPT_SSLVERSION, 6);
-        }
-    }
+	/**
+	 * @var EE_Payment_Processor $_instance
+	 * @access    private
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @access    public
+	 * @return EE_Payment_Processor instance
+	 */
+	public static function instance()
+	{
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Payment_Processor) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Payment_Processor
+	 */
+	public static function reset()
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 *
+	 * @Constructor
+	 * @access private
+	 */
+	private function __construct()
+	{
+		do_action('AHEE__EE_Payment_Processor__construct');
+		add_action('http_api_curl', array($this, '_curl_requests_to_paypal_use_tls'), 10, 3);
+	}
+
+
+	/**
+	 * Using the selected gateway, processes the payment for that transaction, and updates the transaction
+	 * appropriately. Saves the payment that is generated
+	 *
+	 * @param EE_Payment_Method    $payment_method
+	 * @param EE_Transaction       $transaction
+	 * @param float                $amount       if only part of the transaction is to be paid for, how much.
+	 *                                           Leave null if payment is for the full amount owing
+	 * @param EE_Billing_Info_Form $billing_form (or probably null, if it's an offline or offsite payment method).
+	 *                                           Receive_form_submission() should have
+	 *                                           already been called on the billing form
+	 *                                           (ie, its inputs should have their normalized values set).
+	 * @param string               $return_url   string used mostly by offsite gateways to specify
+	 *                                           where to go AFTER the offsite gateway
+	 * @param string               $method       like 'CART', indicates who the client who called this was
+	 * @param bool                 $by_admin     TRUE if payment is being attempted from the admin
+	 * @param boolean              $update_txn   whether or not to call
+	 *                                           EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param string               $cancel_url   URL to return to if off-site payments are cancelled
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_payment(
+		EE_Payment_Method $payment_method,
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_form = null,
+		$return_url = null,
+		$method = 'CART',
+		$by_admin = false,
+		$update_txn = true,
+		$cancel_url = ''
+	) {
+		if ((float) $amount < 0) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Attempting to make a payment for a negative amount of %1$d for transaction %2$d. That should be a refund',
+						'event_espresso'
+					),
+					$amount,
+					$transaction->ID()
+				)
+			);
+		}
+		// verify payment method
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		// verify transaction
+		EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$transaction->set_payment_method_ID($payment_method->ID());
+		// verify payment method type
+		if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+			$payment = $payment_method->type_obj()->process_payment(
+				$transaction,
+				min($amount, $transaction->remaining()), // make sure we don't overcharge
+				$billing_form,
+				$return_url,
+				add_query_arg(array('ee_cancel_payment' => true), $cancel_url),
+				$method,
+				$by_admin
+			);
+			// check if payment method uses an off-site gateway
+			if ($payment_method->type_obj()->payment_occurs() !== EE_PMT_Base::offsite) {
+				// don't process payments for off-site gateways yet because no payment has occurred yet
+				$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			}
+			return $payment;
+		}
+		EE_Error::add_error(
+			sprintf(
+				__(
+					'A valid payment method could not be determined due to a technical issue.%sPlease try again or contact %s for assistance.',
+					'event_espresso'
+				),
+				'<br/>',
+				EE_Registry::instance()->CFG->organization->get_pretty('email')
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return null;
+	}
+
+
+	/**
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment_Method  $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_ipn_url_for_payment_method($transaction, $payment_method)
+	{
+		/** @type \EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg instanceof EE_Registration) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'Cannot get IPN URL for transaction with ID %d because it has no primary registration',
+						'event_espresso'
+					),
+					$transaction->ID()
+				)
+			);
+		}
+		$payment_method = EEM_Payment_Method::instance()->ensure_is_obj(
+			$payment_method,
+			true
+		);
+		$url = add_query_arg(
+			array(
+				'e_reg_url_link'    => $primary_reg->reg_url_link(),
+				'ee_payment_method' => $payment_method->slug(),
+			),
+			EE_Registry::instance()->CFG->core->txn_page_url()
+		);
+		return $url;
+	}
+
+
+	/**
+	 * Process the IPN. Firstly, we'll hope we put the standard args into the IPN URL so
+	 * we can easily find what registration the IPN is for and what payment method.
+	 * However, if not, we'll give all payment methods a chance to claim it and process it.
+	 * If a payment is found for the IPN info, it is saved.
+	 *
+	 * @param array              $_req_data            eg $_REQUEST
+	 * @param EE_Transaction|int $transaction          optional (or a transactions id)
+	 * @param EE_Payment_Method  $payment_method       (or a slug or id of one)
+	 * @param boolean            $update_txn           whether or not to call
+	 *                                                 EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @param bool               $separate_IPN_request whether the IPN uses a separate request ( true like PayPal )
+	 *                                                 or is processed manually ( false like Mijireh )
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @return EE_Payment
+	 * @throws \RuntimeException
+	 * @throws \ReflectionException
+	 * @throws \InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function process_ipn(
+		$_req_data,
+		$transaction = null,
+		$payment_method = null,
+		$update_txn = true,
+		$separate_IPN_request = true
+	) {
+		EE_Registry::instance()->load_model('Change_Log');
+		$_req_data = $this->_remove_unusable_characters_from_array((array) $_req_data);
+		EE_Processor_Base::set_IPN($separate_IPN_request);
+		$obj_for_log = null;
+		if ($transaction instanceof EE_Transaction) {
+			$obj_for_log = $transaction;
+			if ($payment_method instanceof EE_Payment_Method) {
+				$obj_for_log = EEM_Payment::instance()->get_one(
+					array(
+						array('TXN_ID' => $transaction->ID(), 'PMD_ID' => $payment_method->ID()),
+						'order_by' => array('PAY_timestamp' => 'desc'),
+					)
+				);
+			}
+		} elseif ($payment_method instanceof EE_Payment) {
+			$obj_for_log = $payment_method;
+		}
+		$log = EEM_Change_Log::instance()->log(
+			EEM_Change_Log::type_gateway,
+			array('IPN data received' => $_req_data),
+			$obj_for_log
+		);
+		try {
+			/**
+			 * @var EE_Payment $payment
+			 */
+			$payment = null;
+			if ($transaction && $payment_method) {
+				/** @type EE_Transaction $transaction */
+				$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+				/** @type EE_Payment_Method $payment_method */
+				$payment_method = EEM_Payment_Method::instance()->ensure_is_obj($payment_method);
+				if ($payment_method->type_obj() instanceof EE_PMT_Base) {
+					try {
+						$payment = $payment_method->type_obj()->handle_ipn($_req_data, $transaction);
+						$log->set_object($payment);
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					}
+				} else {
+					// not a payment
+					EE_Error::add_error(
+						sprintf(
+							__(
+								'A valid payment method could not be determined due to a technical issue.%sPlease refresh your browser and try again or contact %s for assistance.',
+								'event_espresso'
+							),
+							'<br/>',
+							EE_Registry::instance()->CFG->organization->get_pretty('email')
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				// that's actually pretty ok. The IPN just wasn't able
+				// to identify which transaction or payment method this was for
+				// give all active payment methods a chance to claim it
+				$active_payment_methods = EEM_Payment_Method::instance()->get_all_active();
+				foreach ($active_payment_methods as $active_payment_method) {
+					try {
+						$payment = $active_payment_method->type_obj()->handle_unclaimed_ipn($_req_data);
+						$payment_method = $active_payment_method;
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array('IPN data' => $_req_data),
+							$payment
+						);
+						break;
+					} catch (EventEspresso\core\exceptions\IpnException $e) {
+						EEM_Change_Log::instance()->log(
+							EEM_Change_Log::type_gateway,
+							array(
+								'message'     => 'IPN Exception: ' . $e->getMessage(),
+								'current_url' => EEH_URL::current_url(),
+								'payment'     => $e->getPaymentProperties(),
+								'IPN_data'    => $e->getIpnData(),
+							),
+							$obj_for_log
+						);
+						return $e->getPayment();
+					} catch (EE_Error $e) {
+						// that's fine- it apparently couldn't handle the IPN
+					}
+				}
+			}
+			// EEM_Payment_Log::instance()->log("got to 7",$transaction,$payment_method);
+			if ($payment instanceof EE_Payment) {
+				$payment->save();
+				//  update the TXN
+				$this->update_txn_based_on_payment(
+					$transaction,
+					$payment,
+					$update_txn,
+					$separate_IPN_request
+				);
+			} else {
+				// we couldn't find the payment for this IPN... let's try and log at least SOMETHING
+				if ($payment_method) {
+					EEM_Change_Log::instance()->log(
+						EEM_Change_Log::type_gateway,
+						array('IPN data' => $_req_data),
+						$payment_method
+					);
+				} elseif ($transaction) {
+					EEM_Change_Log::instance()->log(
+						EEM_Change_Log::type_gateway,
+						array('IPN data' => $_req_data),
+						$transaction
+					);
+				}
+			}
+			return $payment;
+		} catch (EE_Error $e) {
+			do_action(
+				'AHEE__log',
+				__FILE__,
+				__FUNCTION__,
+				sprintf(
+					__(
+						'Error occurred while receiving IPN. Transaction: %1$s, req data: %2$s. The error was "%3$s"',
+						'event_espresso'
+					),
+					print_r($transaction, true),
+					print_r($_req_data, true),
+					$e->getMessage()
+				)
+			);
+			throw $e;
+		}
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param  array $request_data
+	 * @return array
+	 */
+	protected function _remove_unusable_characters_from_array(array $request_data)
+	{
+		$return_data = array();
+		foreach ($request_data as $key => $value) {
+			$return_data[ $this->_remove_unusable_characters($key) ] = $this->_remove_unusable_characters(
+				$value
+			);
+		}
+		return $return_data;
+	}
+
+
+	/**
+	 * Removes any non-printable illegal characters from the input,
+	 * which might cause a raucous when trying to insert into the database
+	 *
+	 * @param string $request_data
+	 * @return string
+	 */
+	protected function _remove_unusable_characters($request_data)
+	{
+		return preg_replace('/[^[:print:]]/', '', $request_data);
+	}
+
+
+	/**
+	 * Should be called just before displaying the payment attempt results to the user,
+	 * when the payment attempt has finished. Some payment methods may have special
+	 * logic to perform here. For example, if process_payment() happens on a special request
+	 * and then the user is redirected to a page that displays the payment's status, this
+	 * should be called while loading the page that displays the payment's status. If the user is
+	 * sent to an offsite payment provider, this should be called upon returning from that offsite payment
+	 * provider.
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param bool               $update_txn whether or not to call
+	 *                                       EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment()
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated 4.6.24 method is no longer used. Instead it is up to client code, like SPCO,
+	 *                                       to call handle_ipn() for offsite gateways that don't receive separate IPNs
+	 */
+	public function finalize_payment_for($transaction, $update_txn = true)
+	{
+		/** @var $transaction EE_Transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		$last_payment_method = $transaction->payment_method();
+		if ($last_payment_method instanceof EE_Payment_Method) {
+			$payment = $last_payment_method->type_obj()->finalize_payment_for($transaction);
+			$this->update_txn_based_on_payment($transaction, $payment, $update_txn);
+			return $payment;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Processes a direct refund request, saves the payment, and updates the transaction appropriately.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @param EE_Payment        $payment_to_refund
+	 * @param array             $refund_info
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_refund(
+		EE_Payment_Method $payment_method,
+		EE_Payment $payment_to_refund,
+		array $refund_info = array()
+	) {
+		if ($payment_method instanceof EE_Payment_Method && $payment_method->type_obj()->supports_sending_refunds()) {
+			$payment_method->type_obj()->process_refund($payment_to_refund, $refund_info);
+			$this->update_txn_based_on_payment($payment_to_refund->transaction(), $payment_to_refund);
+		}
+		return $payment_to_refund;
+	}
+
+
+	/**
+	 * This should be called each time there may have been an update to a
+	 * payment on a transaction (ie, we asked for a payment to process a
+	 * payment for a transaction, or we told a payment method about an IPN, or
+	 * we told a payment method to
+	 * "finalize_payment_for" (a transaction), or we told a payment method to
+	 * process a refund. This should handle firing the correct hooks to
+	 * indicate
+	 * what exactly happened and updating the transaction appropriately). This
+	 * could be integrated directly into EE_Transaction upon save, but we want
+	 * this logic to be separate from 'normal' plain-jane saving and updating
+	 * of transactions and payments, and to be tied to payment processing.
+	 * Note: this method DOES NOT save the payment passed into it. It is the responsibility
+	 * of previous code to decide whether or not to save (because the payment passed into
+	 * this method might be a temporary, never-to-be-saved payment from an offline gateway,
+	 * in which case we only want that payment object for some temporary usage during this request,
+	 * but we don't want it to be saved).
+	 *
+	 * @param EE_Transaction|int $transaction
+	 * @param EE_Payment         $payment
+	 * @param boolean            $update_txn
+	 *                        whether or not to call
+	 *                        EE_Transaction_Processor::
+	 *                        update_transaction_and_registrations_after_checkout_or_payment()
+	 *                        (you can save 1 DB query if you know you're going
+	 *                        to save it later instead)
+	 * @param bool               $IPN
+	 *                        if processing IPNs or other similar payment
+	 *                        related activities that occur in alternate
+	 *                        requests than the main one that is processing the
+	 *                        TXN, then set this to true to check whether the
+	 *                        TXN is locked before updating
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function update_txn_based_on_payment($transaction, $payment, $update_txn = true, $IPN = false)
+	{
+		$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__not_successful';
+		/** @type EE_Transaction $transaction */
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		// can we freely update the TXN at this moment?
+		if ($IPN && $transaction->is_locked()) {
+			// don't update the transaction at this exact moment
+			// because the TXN is active in another request
+			EE_Cron_Tasks::schedule_update_transaction_with_payment(
+				time(),
+				$transaction->ID(),
+				$payment->ID()
+			);
+		} else {
+			// verify payment and that it has been saved
+			if ($payment instanceof EE_Payment && $payment->ID()) {
+				if ($payment->payment_method() instanceof EE_Payment_Method
+					&& $payment->payment_method()->type_obj() instanceof EE_PMT_Base
+				) {
+					$payment->payment_method()->type_obj()->update_txn_based_on_payment($payment);
+					// update TXN registrations with payment info
+					$this->process_registration_payments($transaction, $payment);
+				}
+				$do_action = $payment->just_approved()
+					? 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__successful'
+					: $do_action;
+			} else {
+				// send out notifications
+				add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+				$do_action = 'AHEE__EE_Payment_Processor__update_txn_based_on_payment__no_payment_made';
+			}
+			if ($payment instanceof EE_Payment && $payment->status() !== EEM_Payment::status_id_failed) {
+				/** @type EE_Transaction_Payments $transaction_payments */
+				$transaction_payments = EE_Registry::instance()->load_class('Transaction_Payments');
+				// set new value for total paid
+				$transaction_payments->calculate_total_payments_and_update_status($transaction);
+				// call EE_Transaction_Processor::update_transaction_and_registrations_after_checkout_or_payment() ???
+				if ($update_txn) {
+					$this->_post_payment_processing($transaction, $payment, $IPN);
+				}
+			}
+			// granular hook for others to use.
+			do_action($do_action, $transaction, $payment);
+			do_action('AHEE_log', __CLASS__, __FUNCTION__, $do_action, '$do_action');
+			// global hook for others to use.
+			do_action('AHEE__EE_Payment_Processor__update_txn_based_on_payment', $transaction, $payment);
+		}
+	}
+
+
+	/**
+	 * update registrations REG_paid field after successful payment and link registrations with payment
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment        $payment
+	 * @param EE_Registration[] $registrations
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_payments(
+		EE_Transaction $transaction,
+		EE_Payment $payment,
+		array $registrations = array()
+	) {
+		// only process if payment was successful
+		if ($payment->status() !== EEM_Payment::status_id_approved) {
+			return;
+		}
+		// EEM_Registration::instance()->show_next_x_db_queries();
+		if (empty($registrations)) {
+			// find registrations with monies owing that can receive a payment
+			$registrations = $transaction->registrations(
+				array(
+					array(
+						// only these reg statuses can receive payments
+						'STS_ID'           => array('IN', EEM_Registration::reg_statuses_that_allow_payment()),
+						'REG_final_price'  => array('!=', 0),
+						'REG_final_price*' => array('!=', 'REG_paid', true),
+					),
+				)
+			);
+		}
+		// still nothing ??!??
+		if (empty($registrations)) {
+			return;
+		}
+		// todo: break out the following logic into a separate strategy class
+		// todo: named something like "Sequential_Reg_Payment_Strategy"
+		// todo: which would apply payments using the capitalist "first come first paid" approach
+		// todo: then have another strategy class like "Distributed_Reg_Payment_Strategy"
+		// todo: which would be the socialist "everybody gets a piece of pie" approach,
+		// todo: which would be better for deposits, where you want a bit of the payment applied to each registration
+		$refund = $payment->is_a_refund();
+		// how much is available to apply to registrations?
+		$available_payment_amount = abs($payment->amount());
+		foreach ($registrations as $registration) {
+			if ($registration instanceof EE_Registration) {
+				// nothing left?
+				if ($available_payment_amount <= 0) {
+					break;
+				}
+				if ($refund) {
+					$available_payment_amount = $this->process_registration_refund(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				} else {
+					$available_payment_amount = $this->process_registration_payment(
+						$registration,
+						$payment,
+						$available_payment_amount
+					);
+				}
+			}
+		}
+		if ($available_payment_amount > 0
+			&& apply_filters(
+				'FHEE__EE_Payment_Processor__process_registration_payments__display_notifications',
+				false
+			)) {
+			EE_Error::add_attention(
+				sprintf(
+					__(
+						'A remainder of %1$s exists after applying this payment to Registration(s) %2$s.%3$sPlease verify that the original payment amount of %4$s is correct. If so, you should edit this payment and select at least one additional registration in the "Registrations to Apply Payment to" section, so that the remainder of this payment can be applied to the additional registration(s).',
+						'event_espresso'
+					),
+					EEH_Template::format_currency($available_payment_amount),
+					implode(', ', array_keys($registrations)),
+					'<br/>',
+					EEH_Template::format_currency($payment->amount())
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_payment_amount
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_payment_amount = 0.00
+	) {
+		$owing = $registration->final_price() - $registration->paid();
+		if ($owing > 0) {
+			// don't allow payment amount to exceed the available payment amount, OR the amount owing
+			$payment_amount = min($available_payment_amount, $owing);
+			// update $available_payment_amount
+			$available_payment_amount -= $payment_amount;
+			// calculate and set new REG_paid
+			$registration->set_paid($registration->paid() + $payment_amount);
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $payment_amount);
+		}
+		return $available_payment_amount;
+	}
+
+
+	/**
+	 * update registration REG_paid field after successful payment and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $payment_amount
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _apply_registration_payment(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$payment_amount = 0.00
+	) {
+		// find any existing reg payment records for this registration and payment
+		$existing_reg_payment = EEM_Registration_Payment::instance()->get_one(
+			array(array('REG_ID' => $registration->ID(), 'PAY_ID' => $payment->ID()))
+		);
+		// if existing registration payment exists
+		if ($existing_reg_payment instanceof EE_Registration_Payment) {
+			// then update that record
+			$existing_reg_payment->set_amount($payment_amount);
+			$existing_reg_payment->save();
+		} else {
+			// or add new relation between registration and payment and set amount
+			$registration->_add_relation_to(
+				$payment,
+				'Payment',
+				array('RPY_amount' => $payment_amount)
+			);
+			// make it stick
+			$registration->save();
+		}
+	}
+
+
+	/**
+	 * update registration REG_paid field after refund and link registration with payment
+	 *
+	 * @param EE_Registration $registration
+	 * @param EE_Payment      $payment
+	 * @param float           $available_refund_amount - IMPORTANT !!! SEND AVAILABLE REFUND AMOUNT AS A POSITIVE NUMBER
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function process_registration_refund(
+		EE_Registration $registration,
+		EE_Payment $payment,
+		$available_refund_amount = 0.00
+	) {
+		// EEH_Debug_Tools::printr( $payment->amount(), '$payment->amount()', __FILE__, __LINE__ );
+		if ($registration->paid() > 0) {
+			// ensure $available_refund_amount is NOT negative
+			$available_refund_amount = (float) abs($available_refund_amount);
+			// don't allow refund amount to exceed the available payment amount, OR the amount paid
+			$refund_amount = min($available_refund_amount, (float) $registration->paid());
+			// update $available_payment_amount
+			$available_refund_amount -= $refund_amount;
+			// calculate and set new REG_paid
+			$registration->set_paid($registration->paid() - $refund_amount);
+			// convert payment amount back to a negative value for storage in the db
+			$refund_amount = (float) abs($refund_amount) * -1;
+			// now save it
+			$this->_apply_registration_payment($registration, $payment, $refund_amount);
+		}
+		return $available_refund_amount;
+	}
+
+
+	/**
+	 * Process payments and transaction after payment process completed.
+	 * ultimately this will send the TXN and payment details off so that notifications can be sent out.
+	 * if this request happens to be processing an IPN,
+	 * then we will also set the Payment Options Reg Step to completed,
+	 * and attempt to completely finalize the TXN if all of the other Reg Steps are completed as well.
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param EE_Payment     $payment
+	 * @param bool           $IPN
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _post_payment_processing(EE_Transaction $transaction, EE_Payment $payment, $IPN = false)
+	{
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// is the Payment Options Reg Step completed ?
+		$payment_options_step_completed = $transaction->reg_step_completed('payment_options');
+		// if the Payment Options Reg Step is completed...
+		$revisit = $payment_options_step_completed === true;
+		// then this is kinda sorta a revisit with regards to payments at least
+		$transaction_processor->set_revisit($revisit);
+		// if this is an IPN, let's consider the Payment Options Reg Step completed if not already
+		if ($IPN
+			&& $payment_options_step_completed !== true
+			&& ($payment->is_approved() || $payment->is_pending())
+		) {
+			$payment_options_step_completed = $transaction->set_reg_step_completed(
+				'payment_options'
+			);
+		}
+		// maybe update status, but don't save transaction just yet
+		$transaction->update_status_based_on_total_paid(false);
+		// check if 'finalize_registration' step has been completed...
+		$finalized = $transaction->reg_step_completed('finalize_registration');
+		//  if this is an IPN and the final step has not been initiated
+		if ($IPN && $payment_options_step_completed && $finalized === false) {
+			// and if it hasn't already been set as being started...
+			$finalized = $transaction->set_reg_step_initiated('finalize_registration');
+		}
+		$transaction->save();
+		// because the above will return false if the final step was not fully completed, we need to check again...
+		if ($IPN && $finalized !== false) {
+			// and if we are all good to go, then send out notifications
+			add_filter('FHEE__EED_Messages___maybe_registration__deliver_notifications', '__return_true');
+			// ok, now process the transaction according to the payment
+			$transaction_processor->update_transaction_and_registrations_after_checkout_or_payment(
+				$transaction,
+				$payment
+			);
+		}
+		// DEBUG LOG
+		$payment_method = $payment->payment_method();
+		if ($payment_method instanceof EE_Payment_Method) {
+			$payment_method_type_obj = $payment_method->type_obj();
+			if ($payment_method_type_obj instanceof EE_PMT_Base) {
+				$gateway = $payment_method_type_obj->get_gateway();
+				if ($gateway instanceof EE_Gateway) {
+					$gateway->log(
+						array(
+							'message'               => __('Post Payment Transaction Details', 'event_espresso'),
+							'transaction'           => $transaction->model_field_array(),
+							'finalized'             => $finalized,
+							'IPN'                   => $IPN,
+							'deliver_notifications' => has_filter(
+								'FHEE__EED_Messages___maybe_registration__deliver_notifications'
+							),
+						),
+						$payment
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Force posts to PayPal to use TLS v1.2. See:
+	 * https://core.trac.wordpress.org/ticket/36320
+	 * https://core.trac.wordpress.org/ticket/34924#comment:15
+	 * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
+	 * This will affect PayPal standard, pro, express, and Payflow.
+	 *
+	 * @param $handle
+	 * @param $r
+	 * @param $url
+	 */
+	public static function _curl_requests_to_paypal_use_tls($handle, $r, $url)
+	{
+		if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
+			// Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
+			// instead of the constant because it might not be defined
+			curl_setopt($handle, CURLOPT_SSLVERSION, 6);
+		}
+	}
 }

core/EE_Deprecated.core.php

Indentation +1121 added lines, -1121 removed lines

@@ -37,31 +37,31 @@ 
  * @param string $action_or_filter
  */
 function deprecated_espresso_action_or_filter_doing_it_wrong(
-    $deprecated_filter,
-    $replacement,
-    $replacement_location,
-    $version_deprecated,
-    $version_applies,
-    $action_or_filter = 'action'
+	$deprecated_filter,
+	$replacement,
+	$replacement_location,
+	$version_deprecated,
+	$version_applies,
+	$action_or_filter = 'action'
 ) {
-    $action_or_filter = $action_or_filter === 'action'
-        ? esc_html__('action', 'event_espresso')
-        : esc_html__('filter', 'event_espresso');
-    EE_Error::doing_it_wrong(
-        $deprecated_filter,
-        sprintf(
-            __(
-                'This %1$s is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new %1$s: %4$s"%2$s" found in "%3$s"',
-                'event_espresso'
-            ),
-            $action_or_filter,
-            $replacement,
-            $replacement_location,
-            '<br />'
-        ),
-        $version_deprecated,
-        $version_applies
-    );
+	$action_or_filter = $action_or_filter === 'action'
+		? esc_html__('action', 'event_espresso')
+		: esc_html__('filter', 'event_espresso');
+	EE_Error::doing_it_wrong(
+		$deprecated_filter,
+		sprintf(
+			__(
+				'This %1$s is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new %1$s: %4$s"%2$s" found in "%3$s"',
+				'event_espresso'
+			),
+			$action_or_filter,
+			$replacement,
+			$replacement_location,
+			'<br />'
+		),
+		$version_deprecated,
+		$version_applies
+	);
 }
 
 /**
@@ -73,90 +73,90 @@ 
  */
 function ee_deprecated__registration_checkout__button_text($submit_button_text, EE_Checkout $checkout)
 {
-    // list of old filters
-    $deprecated_filters = array(
-        'update_registration_details' => true,
-        'process_payment'             => true,
-        'finalize_registration'       => true,
-        'and_proceed_to_payment'      => true,
-        'proceed_to'                  => true,
-    );
-    // loop thru and call doing_it_wrong() or remove any that aren't being used
-    foreach ($deprecated_filters as $deprecated_filter => $on) {
-        // was this filter called ?
-        if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) {
-            // only display doing_it_wrong() notice to Event Admins during non-AJAX requests
-            if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_read_ee',
-                    'hide_doing_it_wrong_for_deprecated_SPCO_filter'
-                ) && ! defined('DOING_AJAX')) {
-                EE_Error::doing_it_wrong(
-                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
-                    sprintf(
-                        __(
-                            'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"',
-                            'event_espresso'
-                        ),
-                        'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
-                        '<br />',
-                        'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-                        '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
-                    ),
-                    '4.6.10'
-                );
-            }
-        } else {
-            unset($deprecated_filters[ $deprecated_filter ]);
-        }
-    }
-    if (! empty($deprecated_filters)) {
-
-        if ($checkout->current_step->slug(
-            ) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details',
-                $submit_button_text
-            );
-        } elseif ($checkout->current_step->slug(
-            ) == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment',
-                $submit_button_text
-            );
-        } elseif ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug(
-            ) == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration',
-                $submit_button_text
-            );
-        }
-        if ($checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($checkout->payment_required() && $checkout->next_step->slug(
-                ) == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) {
-                $submit_button_text .= apply_filters(
-                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment',
-                    $submit_button_text
-                );
-            }
-            if ($checkout->next_step->slug(
-                ) != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) {
-                $submit_button_text = apply_filters(
-                                          'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to',
-                                          $submit_button_text
-                                      ) . $checkout->next_step->name();
-            }
-        }
-
-    }
-    return $submit_button_text;
+	// list of old filters
+	$deprecated_filters = array(
+		'update_registration_details' => true,
+		'process_payment'             => true,
+		'finalize_registration'       => true,
+		'and_proceed_to_payment'      => true,
+		'proceed_to'                  => true,
+	);
+	// loop thru and call doing_it_wrong() or remove any that aren't being used
+	foreach ($deprecated_filters as $deprecated_filter => $on) {
+		// was this filter called ?
+		if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) {
+			// only display doing_it_wrong() notice to Event Admins during non-AJAX requests
+			if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_read_ee',
+					'hide_doing_it_wrong_for_deprecated_SPCO_filter'
+				) && ! defined('DOING_AJAX')) {
+				EE_Error::doing_it_wrong(
+					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+					sprintf(
+						__(
+							'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"',
+							'event_espresso'
+						),
+						'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+						'<br />',
+						'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+						'/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
+					),
+					'4.6.10'
+				);
+			}
+		} else {
+			unset($deprecated_filters[ $deprecated_filter ]);
+		}
+	}
+	if (! empty($deprecated_filters)) {
+
+		if ($checkout->current_step->slug(
+			) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details',
+				$submit_button_text
+			);
+		} elseif ($checkout->current_step->slug(
+			) == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment',
+				$submit_button_text
+			);
+		} elseif ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug(
+			) == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration',
+				$submit_button_text
+			);
+		}
+		if ($checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($checkout->payment_required() && $checkout->next_step->slug(
+				) == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) {
+				$submit_button_text .= apply_filters(
+					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment',
+					$submit_button_text
+				);
+			}
+			if ($checkout->next_step->slug(
+				) != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) {
+				$submit_button_text = apply_filters(
+										  'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to',
+										  $submit_button_text
+									  ) . $checkout->next_step->name();
+			}
+		}
+
+	}
+	return $submit_button_text;
 
 }
 
 add_filter(
-    'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-    'ee_deprecated__registration_checkout__button_text',
-    10,
-    2
+	'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+	'ee_deprecated__registration_checkout__button_text',
+	10,
+	2
 );
 
 
@@ -168,54 +168,54 @@ 
  */
 function ee_deprecated_finalize_transaction(EE_Checkout $checkout, $status_updates)
 {
-    $action_ref = null;
-    $action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction')
-        ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
-    $action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction')
-        ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
-    if ($action_ref) {
-
-        EE_Error::doing_it_wrong(
-            $action_ref,
-            sprintf(
-                __(
-                    'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"',
-                    'event_espresso'
-                ),
-                '<br />',
-                '/core/business/EE_Transaction_Processor.class.php',
-                'AHEE__EE_Transaction_Processor__finalize',
-                'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
-                'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
-                'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing'
-            ),
-            '4.6.0'
-        );
-        switch ($action_ref) {
-            case 'AHEE__EE_Transaction__finalize__new_transaction' :
-                do_action(
-                    'AHEE__EE_Transaction__finalize__new_transaction',
-                    $checkout->transaction,
-                    $checkout->admin_request
-                );
-                break;
-            case 'AHEE__EE_Transaction__finalize__all_transaction' :
-                do_action(
-                    'AHEE__EE_Transaction__finalize__new_transaction',
-                    $checkout->transaction,
-                    array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates),
-                    $checkout->admin_request
-                );
-                break;
-        }
-    }
+	$action_ref = null;
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction')
+		? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction')
+		? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
+	if ($action_ref) {
+
+		EE_Error::doing_it_wrong(
+			$action_ref,
+			sprintf(
+				__(
+					'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"',
+					'event_espresso'
+				),
+				'<br />',
+				'/core/business/EE_Transaction_Processor.class.php',
+				'AHEE__EE_Transaction_Processor__finalize',
+				'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
+				'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
+				'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing'
+			),
+			'4.6.0'
+		);
+		switch ($action_ref) {
+			case 'AHEE__EE_Transaction__finalize__new_transaction' :
+				do_action(
+					'AHEE__EE_Transaction__finalize__new_transaction',
+					$checkout->transaction,
+					$checkout->admin_request
+				);
+				break;
+			case 'AHEE__EE_Transaction__finalize__all_transaction' :
+				do_action(
+					'AHEE__EE_Transaction__finalize__new_transaction',
+					$checkout->transaction,
+					array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates),
+					$checkout->admin_request
+				);
+				break;
+		}
+	}
 }
 
 add_action(
-    'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
-    'ee_deprecated_finalize_transaction',
-    10,
-    2
+	'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
+	'ee_deprecated_finalize_transaction',
+	10,
+	2
 );
 /**
  * ee_deprecated_finalize_registration
@@ -224,35 +224,35 @@ 
  */
 function ee_deprecated_finalize_registration(EE_Registration $registration)
 {
-    $action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg')
-        ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : null;
-    if ($action_ref) {
-        EE_Error::doing_it_wrong(
-            $action_ref,
-            sprintf(
-                __(
-                    'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"',
-                    'event_espresso'
-                ),
-                '<br />',
-                '/core/business/EE_Registration_Processor.class.php',
-                'AHEE__EE_Registration_Processor__trigger_registration_update_notifications'
-            ),
-            '4.6.0'
-        );
-        do_action(
-            'AHEE__EE_Registration__finalize__update_and_new_reg',
-            $registration,
-            (is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX))
-        );
-    }
+	$action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg')
+		? 'AHEE__EE_Registration__finalize__update_and_new_reg' : null;
+	if ($action_ref) {
+		EE_Error::doing_it_wrong(
+			$action_ref,
+			sprintf(
+				__(
+					'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"',
+					'event_espresso'
+				),
+				'<br />',
+				'/core/business/EE_Registration_Processor.class.php',
+				'AHEE__EE_Registration_Processor__trigger_registration_update_notifications'
+			),
+			'4.6.0'
+		);
+		do_action(
+			'AHEE__EE_Registration__finalize__update_and_new_reg',
+			$registration,
+			(is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX))
+		);
+	}
 }
 
 add_action(
-    'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-    'ee_deprecated_finalize_registration',
-    10,
-    1
+	'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+	'ee_deprecated_finalize_registration',
+	10,
+	1
 );
 
 
@@ -262,44 +262,44 @@ 
  */
 function ee_deprecated_hooks()
 {
-    /**
-     * @var          $hooks       array where keys are hook names, and their values are array{
-     * @type string  $version     when deprecated
-     * @type string  $alternative saying what to use instead
-     * @type boolean $still_works whether or not the hook still works
-     *        }
-     */
-    $hooks = array(
-        'AHEE__EE_System___do_setup_validations' => array(
-            'version'     => '4.6.0',
-            'alternative' => __(
-                'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)',
-                'event_espresso'
-            ),
-            'still_works' => false,
-        ),
-    );
-    foreach ($hooks as $name => $deprecation_info) {
-        if (has_action($name)) {
-            EE_Error::doing_it_wrong(
-                $name,
-                sprintf(
-                    __('This filter is deprecated. %1$s%2$s', 'event_espresso'),
-                    $deprecation_info['still_works'] ? __(
-                        'It *may* work as an attempt to build in backwards compatibility.',
-                        'event_espresso'
-                    ) : __('It has been completely removed.', 'event_espresso'),
-                    isset($deprecation_info['alternative'])
-                        ? $deprecation_info['alternative']
-                        : __(
-                        'Please read the current EE4 documentation further or contact Support.',
-                        'event_espresso'
-                    )
-                ),
-                isset($deprecation_info['version']) ? $deprecation_info['version'] : __('recently', 'event_espresso')
-            );
-        }
-    }
+	/**
+	 * @var          $hooks       array where keys are hook names, and their values are array{
+	 * @type string  $version     when deprecated
+	 * @type string  $alternative saying what to use instead
+	 * @type boolean $still_works whether or not the hook still works
+	 *        }
+	 */
+	$hooks = array(
+		'AHEE__EE_System___do_setup_validations' => array(
+			'version'     => '4.6.0',
+			'alternative' => __(
+				'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)',
+				'event_espresso'
+			),
+			'still_works' => false,
+		),
+	);
+	foreach ($hooks as $name => $deprecation_info) {
+		if (has_action($name)) {
+			EE_Error::doing_it_wrong(
+				$name,
+				sprintf(
+					__('This filter is deprecated. %1$s%2$s', 'event_espresso'),
+					$deprecation_info['still_works'] ? __(
+						'It *may* work as an attempt to build in backwards compatibility.',
+						'event_espresso'
+					) : __('It has been completely removed.', 'event_espresso'),
+					isset($deprecation_info['alternative'])
+						? $deprecation_info['alternative']
+						: __(
+						'Please read the current EE4 documentation further or contact Support.',
+						'event_espresso'
+					)
+				),
+				isset($deprecation_info['version']) ? $deprecation_info['version'] : __('recently', 'event_espresso')
+			);
+		}
+	}
 }
 
 add_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks');
@@ -314,34 +314,34 @@ 
  */
 function ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
 {
-    $in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns')
-              || has_action(
-                  'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save'
-              );
-    if ($in_use) {
-        $msg = __(
-            'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.'
-            . 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,'
-            . 'use FHEE__EE_Form_Section_Proper__receive_form_submission__req_data to customize the submission data, or AHEE__EE_Form_Section_Proper__receive_form_submission__end '
-            . 'to add other actions after a form submission has been received.',
-            'event_espresso'
-        );
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            $msg,
-            '4.8.32.rc.000'
-        );
-        // it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed
-        if (is_admin() && ! defined('DOING_AJAX')) {
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-    return $in_use;
+	$in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns')
+			  || has_action(
+				  'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save'
+			  );
+	if ($in_use) {
+		$msg = __(
+			'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.'
+			. 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,'
+			. 'use FHEE__EE_Form_Section_Proper__receive_form_submission__req_data to customize the submission data, or AHEE__EE_Form_Section_Proper__receive_form_submission__end '
+			. 'to add other actions after a form submission has been received.',
+			'event_espresso'
+		);
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			$msg,
+			'4.8.32.rc.000'
+		);
+		// it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed
+		if (is_admin() && ! defined('DOING_AJAX')) {
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+	return $in_use;
 }
 
 add_action(
-    'AHEE__Registrations_Admin_Page___registration_details_metabox__start',
-    'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks'
+	'AHEE__Registrations_Admin_Page___registration_details_metabox__start',
+	'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks'
 );
 
 /**
@@ -353,77 +353,77 @@ 
  */
 function ee_deprecated_update_attendee_registration_form_old($admin_page)
 {
-    // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-        || ! $admin_page instanceof EE_Admin_Page) {
-        return;
-    }
-    $req_data = $admin_page->get_request_data();
-    $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false;
-    $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false;
-    $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
-    if (! $REG_ID || ! $qstns) {
-        EE_Error::add_error(
-            __('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-    $success = true;
-
-    // allow others to get in on this awesome fun   :D
-    do_action(
-        'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save',
-        $REG_ID,
-        $qstns
-    );
-    // loop thru questions... FINALLY!!!
-
-    foreach ($qstns as $QST_ID => $qstn) {
-        // if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
-        if (! is_array($qstn)) {
-            $success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn);
-            continue;
-        }
-
-
-        foreach ($qstn as $ANS_ID => $ANS_value) {
-            // get answer
-            $query_params = array(
-                0 => array(
-                    'ANS_ID' => $ANS_ID,
-                    'REG_ID' => $REG_ID,
-                    'QST_ID' => $QST_ID,
-                ),
-            );
-            $answer = EEM_Answer::instance()->get_one($query_params);
-            // this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
-            if (! $answer instanceof EE_Answer) {
-                $set_values = array(
-                    'QST_ID'    => $QST_ID,
-                    'REG_ID'    => $REG_ID,
-                    'ANS_value' => $qstn,
-                );
-                $success = EEM_Answer::instance()->insert($set_values);
-                continue 2;
-            }
-
-            $answer->set('ANS_value', $ANS_value);
-            $success = $answer->save();
-        }
-    }
-    $what = __('Registration Form', 'event_espresso');
-    $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default');
-    $admin_page->redirect_after_action($success, $what, __('updated', 'event_espresso'), $route);
-    exit;
+	// check if the old hooks are in use. If not, do the default
+	if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
+		return;
+	}
+	$req_data = $admin_page->get_request_data();
+	$qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false;
+	$REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false;
+	$qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
+	if (! $REG_ID || ! $qstns) {
+		EE_Error::add_error(
+			__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+	$success = true;
+
+	// allow others to get in on this awesome fun   :D
+	do_action(
+		'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save',
+		$REG_ID,
+		$qstns
+	);
+	// loop thru questions... FINALLY!!!
+
+	foreach ($qstns as $QST_ID => $qstn) {
+		// if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
+		if (! is_array($qstn)) {
+			$success = $this->_save_new_answer($REG_ID, $QST_ID, $qstn);
+			continue;
+		}
+
+
+		foreach ($qstn as $ANS_ID => $ANS_value) {
+			// get answer
+			$query_params = array(
+				0 => array(
+					'ANS_ID' => $ANS_ID,
+					'REG_ID' => $REG_ID,
+					'QST_ID' => $QST_ID,
+				),
+			);
+			$answer = EEM_Answer::instance()->get_one($query_params);
+			// this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
+			if (! $answer instanceof EE_Answer) {
+				$set_values = array(
+					'QST_ID'    => $QST_ID,
+					'REG_ID'    => $REG_ID,
+					'ANS_value' => $qstn,
+				);
+				$success = EEM_Answer::instance()->insert($set_values);
+				continue 2;
+			}
+
+			$answer->set('ANS_value', $ANS_value);
+			$success = $answer->save();
+		}
+	}
+	$what = __('Registration Form', 'event_espresso');
+	$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default');
+	$admin_page->redirect_after_action($success, $what, __('updated', 'event_espresso'), $route);
+	exit;
 }
 
 add_action(
-    'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start',
-    'ee_deprecated_update_attendee_registration_form_old',
-    10,
-    1
+	'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start',
+	'ee_deprecated_update_attendee_registration_form_old',
+	10,
+	1
 );
 /**
  * Render the registration admin page's custom questions area in the old fashion
@@ -439,50 +439,50 @@ 
  */
 function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration)
 {
-    // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-        || ! $admin_page instanceof EE_Admin_Page) {
-        return $do_default_action;
-    }
-    add_filter(
-        'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-        array($admin_page, 'form_before_question_group'),
-        10,
-        1
-    );
-    add_filter(
-        'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-        array($admin_page, 'form_after_question_group'),
-        10,
-        1
-    );
-    add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1);
-    add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1);
-
-    $question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options(
-        $registration,
-        $registration->get(
-            'EVT_ID'
-        )
-    );
-
-    EE_Registry::instance()->load_helper('Form_Fields');
-    $template_args = array(
-        'att_questions'             => EEH_Form_Fields::generate_question_groups_html($question_groups),
-        'reg_questions_form_action' => 'edit_registration',
-        'REG_ID'                    => $registration->ID(),
-    );
-    $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-    echo EEH_Template::display_template($template_path, $template_args, true);
-    // indicate that we should not do the default admin page code
-    return false;
+	// check if the old hooks are in use. If not, do the default
+	if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
+		return $do_default_action;
+	}
+	add_filter(
+		'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+		array($admin_page, 'form_before_question_group'),
+		10,
+		1
+	);
+	add_filter(
+		'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+		array($admin_page, 'form_after_question_group'),
+		10,
+		1
+	);
+	add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1);
+	add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1);
+
+	$question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options(
+		$registration,
+		$registration->get(
+			'EVT_ID'
+		)
+	);
+
+	EE_Registry::instance()->load_helper('Form_Fields');
+	$template_args = array(
+		'att_questions'             => EEH_Form_Fields::generate_question_groups_html($question_groups),
+		'reg_questions_form_action' => 'edit_registration',
+		'REG_ID'                    => $registration->ID(),
+	);
+	$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+	echo EEH_Template::display_template($template_path, $template_args, true);
+	// indicate that we should not do the default admin page code
+	return false;
 }
 
 add_action(
-    'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
-    'ee_deprecated_reg_questions_meta_box_old',
-    10,
-    3
+	'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
+	'ee_deprecated_reg_questions_meta_box_old',
+	10,
+	3
 );
 
 
@@ -499,42 +499,42 @@ 
 class EE_Message_Template_Defaults extends EE_Base
 {
 
-    /**
-     * EE_Message_Template_Defaults constructor.
-     *
-     * @param EE_messages $messages
-     * @param             $messenger_name
-     * @param             $message_type_name
-     * @param int         $GRP_ID
-     * @return EE_Messages_Template_Defaults
-     */
-    public function __construct(
-        EE_messages $messages,
-        $messenger_name,
-        $message_type_name,
-        $GRP_ID = 0
-    ) {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            __(
-                'The class EE_Message_Template_Defaults has been deprecated and replaced by EE_Messages_Template_Defaults.',
-                'event_espresso'
-            ),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $message_resource_manager->get_messenger($messenger_name);
-        $message_type = $message_resource_manager->get_message_type($message_type_name);
-        return EE_Registry::instance()->load_lib(
-            'Messages_Template_Defaults',
-            array(
-                $GRP_ID,
-                $messenger,
-                $message_type,
-            )
-        );
-    }
+	/**
+	 * EE_Message_Template_Defaults constructor.
+	 *
+	 * @param EE_messages $messages
+	 * @param             $messenger_name
+	 * @param             $message_type_name
+	 * @param int         $GRP_ID
+	 * @return EE_Messages_Template_Defaults
+	 */
+	public function __construct(
+		EE_messages $messages,
+		$messenger_name,
+		$message_type_name,
+		$GRP_ID = 0
+	) {
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			__(
+				'The class EE_Message_Template_Defaults has been deprecated and replaced by EE_Messages_Template_Defaults.',
+				'event_espresso'
+			),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $message_resource_manager->get_messenger($messenger_name);
+		$message_type = $message_resource_manager->get_message_type($message_type_name);
+		return EE_Registry::instance()->load_lib(
+			'Messages_Template_Defaults',
+			array(
+				$GRP_ID,
+				$messenger,
+				$message_type,
+			)
+		);
+	}
 }
 
 
@@ -552,525 +552,525 @@ 
 class EE_messages
 {
 
-    /** @type EE_messenger[] */
-    protected $_active_messengers = array();
-
-    /** @type array */
-    protected $_active_message_types = array();
-
-    /** @type EE_message_type[] */
-    protected $_installed_message_types = array();
-
-    /** @type EE_messenger */
-    protected $_messenger;
-
-    /** @type EE_message_type */
-    protected $_message_type;
-
-    /** @type array */
-    protected $_contexts = array();
-
-    /** @type EE_Message_Resource_Manager $_message_resource_manager */
-    protected $_message_resource_manager;
-
-
-    /**
-     * EE_messages constructor.
-     *
-     * @deprecated 4.9.0
-     */
-    public function __construct()
-    {
-    }
-
-
-    /**
-     * @param string $method
-     */
-    public function _class_is_deprecated($method)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_messages::' . $method,
-            __('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
-            '4.9.0',
-            '4.10.0.p'
-        );
-        // Please use EE_Message_Resource_Manager instead
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger_name
-     * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
-     */
-    public function ensure_messenger_is_active($messenger_name)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $message_type message type name
-     * @param        $messenger
-     * @return bool true if it got activated (or was active) and false if not.
-     * @throws \EE_Error
-     */
-    public function ensure_message_type_is_active($message_type, $messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger_name
-     * @param array  $mts_to_activate             (optional) An array of message types to activate with this messenger.
-     *                                             If included we do NOT setup the default message types (assuming they
-     *                                             are already setup.)
-     * @return boolean an array of generated templates or false if nothing generated/activated.
-     */
-    public function activate_messenger($messenger_name, $mts_to_activate = array())
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param EE_messenger    $messenger    messenger used in trigger
-     * @param EE_message_type $message_type message type used in trigger
-     *
-     * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
-     */
-    public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger
-     * @return EE_messenger | null
-     */
-    public function get_messenger_if_active($messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_messenger($messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param EE_Message $message
-     * @return array  An array with 'messenger' and 'message_type' as the index and the corresponding valid object if
-     *                  available.
-     *                  Eg. Valid Messenger and Message Type:
-     *                  array(
-     *                  'messenger' => new EE_Email_messenger(),
-     *                  'message_type' => new EE_Registration_Approved_message_type()
-     *                  )
-     *                  Valid Messenger and Invalid Message Type:
-     *                  array(
-     *                  'messenger' => new EE_Email_messenger(),
-     *                  'message_type' => null
-     *                  )
-     */
-    public function validate_for_use(EE_Message $message)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return array(
-            'messenger'    => $message->messenger_object(),
-            'message_type' => $message->message_type_object(),
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $type                 What type of message are we sending (corresponds to message types)
-     * @param  mixed  $vars                 Data being sent for parsing in the message
-     * @param  string $sending_messenger    if included then we ONLY use the specified messenger for delivery.
-     *                                      Otherwise we cycle through all active messengers.
-     * @param string  $generating_messenger if included then this messenger is used for generating the message
-     *                                      templates (but not for sending).
-     * @param string  $context              If included then only a message type for a specific context will be
-     *                                      generated.
-     * @param bool    $send                 Default TRUE.  If false, then this will just return the generated
-     *                                      EE_messages objects which might be used by the trigger to setup a batch
-     *                                      message (typically html messenger uses it).
-     * @return bool
-     */
-    public function send_message(
-        $type,
-        $vars,
-        $sending_messenger = '',
-        $generating_messenger = '',
-        $context = '',
-        $send = true
-    ) {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        /** @type EE_Messages_Processor $processor */
-        $processor = EE_Registry::instance()->load_lib('Messages_Processor');
-        $error = false;
-        // try to intelligently determine what method we'll call based on the incoming data.
-        // if generating and sending are different then generate and send immediately.
-        if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
-            // in the legacy system, when generating and sending were different, that means all the
-            // vars are already in the request object.  So let's just use that.
-            try {
-                /** @type EE_Message_To_Generate_From_Request $mtg */
-                $mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
-                $processor->generate_and_send_now($mtg);
-            } catch (EE_Error $e) {
-                $error_msg = __(
-                    'Please note that a system message failed to send due to a technical issue.',
-                    'event_espresso'
-                );
-                // add specific message for developers if WP_DEBUG in on
-                $error_msg .= '||' . $e->getMessage();
-                EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-                $error = true;
-            }
-        } else {
-            $processor->generate_for_all_active_messengers($type, $vars, $send);
-            // let's find out if there were any errors and how many successfully were queued.
-            $count_errors = $processor->get_queue()->count_STS_in_queue(
-                array(EEM_Message::status_failed, EEM_Message::status_debug_only)
-            );
-            $count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete);
-            $count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry);
-            $count_errors = $count_errors + $count_retry;
-            if ($count_errors > 0) {
-                $error = true;
-                if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) {
-                    $message = sprintf(
-                        __(
-                            'There were %d errors and %d messages successfully queued for generation and sending',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } elseif ($count_errors > 1 && $count_queued === 1) {
-                    $message = sprintf(
-                        __(
-                            'There were %d errors and %d message successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } elseif ($count_errors === 1 && $count_queued > 1) {
-                    $message = sprintf(
-                        __(
-                            'There was %d error and %d messages successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } else {
-                    $message = sprintf(
-                        __(
-                            'There was %d message that failed to be queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors
-                    );
-                }
-                EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__);
-            } else {
-                if ($count_queued === 1) {
-                    $message = sprintf(
-                        __(
-                            '%d message successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_queued
-                    );
-                } else {
-                    $message = sprintf(
-                        __(
-                            '%d messages were successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_queued
-                    );
-                }
-                EE_Error::add_success($message);
-            }
-        }
-        // if no error then return the generated message(s).
-        if (! $error && ! $send) {
-            $generated_queue = $processor->generate_queue(false);
-            // get message and return.
-            $generated_queue->get_message_repository()->rewind();
-            $messages = array();
-            while ($generated_queue->get_message_repository()->valid()) {
-                $message = $generated_queue->get_message_repository()->current();
-                if ($message instanceof EE_Message) {
-                    // set properties that might be expected by add-ons (backward compat)
-                    $message->content = $message->content();
-                    $message->template_pack = $message->get_template_pack();
-                    $message->template_variation = $message->get_template_pack_variation();
-                    $messages[] = $message;
-                }
-                $generated_queue->get_message_repository()->next();
-            }
-            return $messages;
-        }
-        return $error ? false
-            : true; // yeah backwards eh?  Really what we're returning is if there is a total success for all the messages or not.  We'll modify this once we get message recording in place.
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $type      This should correspond with a valid message type
-     * @param  string $context   This should correspond with a valid context for the message type
-     * @param  string $messenger This should correspond with a valid messenger.
-     * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
-     *                           preview
-     * @return string          The body of the message.
-     */
-    public function preview_message($type, $context, $messenger, $send = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return EED_Messages::preview_message($type, $context, $messenger, $send);
-    }
-
-
-    /**
-     * @since      4.5.0
-     * @deprecated 4.9.0   Moved to EED_Messages Module
-     * @param string   $messenger    a string matching a valid active messenger in the system
-     * @param string   $message_type Although it seems contrary to the name of the method, a message type name is still
-     *                               required to send along the message type to the messenger because this is used for
-     *                               determining what specific variations might be loaded for the generated message.
-     * @param stdClass $message      a stdClass object in the format expected by the messenger.
-     *
-     * @return bool          success or fail.
-     */
-    public function send_message_with_messenger_only($messenger, $message_type, $message)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        // setup for sending to new method.
-        /** @type EE_Messages_Queue $queue */
-        $queue = EE_Registry::instance()->load_lib('Messages_Queue');
-        // make sure we have a proper message object
-        if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
-            $msg = EE_Message_Factory::create(
-                array(
-                    'MSG_messenger'    => $messenger,
-                    'MSG_message_type' => $message_type,
-                    'MSG_content'      => $message->content,
-                    'MSG_subject'      => $message->subject,
-                )
-            );
-        } else {
-            $msg = $message;
-        }
-        if (! $msg instanceof EE_Message) {
-            return false;
-        }
-        // make sure any content in a content property (if not empty) is set on the MSG_content.
-        if (! empty($msg->content)) {
-            $msg->set('MSG_content', $msg->content);
-        }
-        $queue->add($msg);
-        return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param         $messenger
-     * @param  string $message_type message type that the templates are being created for
-     * @param int     $GRP_ID
-     * @param bool    $is_global
-     * @return array|object if creation is successful then we return an array of info, otherwise an error_object is
-     *                      returned.
-     * @throws \EE_Error
-     */
-    public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $messenger_name    name of EE_messenger
-     * @param  string $message_type_name name of EE_message_type
-     * @return array
-     */
-    public function get_fields($messenger_name, $message_type_name)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_fields($messenger_name, $message_type_name);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @access     public
-     * @param string $type                we can indicate just returning installed message types
-     *                                    or messengers (or both) via this parameter.
-     * @param bool   $skip_cache          if true then we skip the cache and retrieve via files.
-     * @return array                    multidimensional array of messenger and message_type objects
-     *                                    (messengers index, and message_type index);
-     */
-    public function get_installed($type = 'all', $skip_cache = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        if ($skip_cache) {
-            $this->_message_resource_manager->reset_active_messengers_and_message_types();
-        }
-        switch ($type) {
-            case 'messengers' :
-                return array(
-                    'messenger' => $this->_message_resource_manager->installed_messengers(),
-                );
-                break;
-            case 'message_types' :
-                return array(
-                    'message_type' => $this->_message_resource_manager->installed_message_types(),
-                );
-                break;
-            case 'all' :
-            default :
-                return array(
-                    'messenger'    => $this->_message_resource_manager->installed_messengers(),
-                    'message_type' => $this->_message_resource_manager->installed_message_types(),
-                );
-                break;
-        }
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return \EE_messenger[]
-     */
-    public function get_active_messengers()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->active_messengers();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array array of message_type references (string)
-     */
-    public function get_active_message_types()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->list_of_active_message_types();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return EE_message_type[]
-     */
-    public function get_active_message_type_objects()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_type_objects();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @since      4.5.0
-     * @param string $messenger The messenger being checked
-     * @return EE_message_type[]    (or empty array if none present)
-     */
-    public function get_active_message_types_per_messenger($messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger    The string should correspond to the messenger (message types are
-     * @param string $message_type The string should correspond to a message type.
-     * @return EE_message_type|null
-     */
-    public function get_active_message_type($messenger, $message_type)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array|\EE_message_type[]
-     */
-    public function get_installed_message_types()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->installed_message_types();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array
-     */
-    public function get_installed_messengers()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->installed_messengers();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param   bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by
-     *                           message type.
-     * @return array
-     */
-    public function get_all_contexts($slugs_only = true)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_all_contexts($slugs_only);
-    }
+	/** @type EE_messenger[] */
+	protected $_active_messengers = array();
+
+	/** @type array */
+	protected $_active_message_types = array();
+
+	/** @type EE_message_type[] */
+	protected $_installed_message_types = array();
+
+	/** @type EE_messenger */
+	protected $_messenger;
+
+	/** @type EE_message_type */
+	protected $_message_type;
+
+	/** @type array */
+	protected $_contexts = array();
+
+	/** @type EE_Message_Resource_Manager $_message_resource_manager */
+	protected $_message_resource_manager;
+
+
+	/**
+	 * EE_messages constructor.
+	 *
+	 * @deprecated 4.9.0
+	 */
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 * @param string $method
+	 */
+	public function _class_is_deprecated($method)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_messages::' . $method,
+			__('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
+			'4.9.0',
+			'4.10.0.p'
+		);
+		// Please use EE_Message_Resource_Manager instead
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger_name
+	 * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
+	 */
+	public function ensure_messenger_is_active($messenger_name)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $message_type message type name
+	 * @param        $messenger
+	 * @return bool true if it got activated (or was active) and false if not.
+	 * @throws \EE_Error
+	 */
+	public function ensure_message_type_is_active($message_type, $messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger_name
+	 * @param array  $mts_to_activate             (optional) An array of message types to activate with this messenger.
+	 *                                             If included we do NOT setup the default message types (assuming they
+	 *                                             are already setup.)
+	 * @return boolean an array of generated templates or false if nothing generated/activated.
+	 */
+	public function activate_messenger($messenger_name, $mts_to_activate = array())
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param EE_messenger    $messenger    messenger used in trigger
+	 * @param EE_message_type $message_type message type used in trigger
+	 *
+	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
+	 */
+	public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger
+	 * @return EE_messenger | null
+	 */
+	public function get_messenger_if_active($messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_messenger($messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param EE_Message $message
+	 * @return array  An array with 'messenger' and 'message_type' as the index and the corresponding valid object if
+	 *                  available.
+	 *                  Eg. Valid Messenger and Message Type:
+	 *                  array(
+	 *                  'messenger' => new EE_Email_messenger(),
+	 *                  'message_type' => new EE_Registration_Approved_message_type()
+	 *                  )
+	 *                  Valid Messenger and Invalid Message Type:
+	 *                  array(
+	 *                  'messenger' => new EE_Email_messenger(),
+	 *                  'message_type' => null
+	 *                  )
+	 */
+	public function validate_for_use(EE_Message $message)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return array(
+			'messenger'    => $message->messenger_object(),
+			'message_type' => $message->message_type_object(),
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $type                 What type of message are we sending (corresponds to message types)
+	 * @param  mixed  $vars                 Data being sent for parsing in the message
+	 * @param  string $sending_messenger    if included then we ONLY use the specified messenger for delivery.
+	 *                                      Otherwise we cycle through all active messengers.
+	 * @param string  $generating_messenger if included then this messenger is used for generating the message
+	 *                                      templates (but not for sending).
+	 * @param string  $context              If included then only a message type for a specific context will be
+	 *                                      generated.
+	 * @param bool    $send                 Default TRUE.  If false, then this will just return the generated
+	 *                                      EE_messages objects which might be used by the trigger to setup a batch
+	 *                                      message (typically html messenger uses it).
+	 * @return bool
+	 */
+	public function send_message(
+		$type,
+		$vars,
+		$sending_messenger = '',
+		$generating_messenger = '',
+		$context = '',
+		$send = true
+	) {
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		/** @type EE_Messages_Processor $processor */
+		$processor = EE_Registry::instance()->load_lib('Messages_Processor');
+		$error = false;
+		// try to intelligently determine what method we'll call based on the incoming data.
+		// if generating and sending are different then generate and send immediately.
+		if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
+			// in the legacy system, when generating and sending were different, that means all the
+			// vars are already in the request object.  So let's just use that.
+			try {
+				/** @type EE_Message_To_Generate_From_Request $mtg */
+				$mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+				$processor->generate_and_send_now($mtg);
+			} catch (EE_Error $e) {
+				$error_msg = __(
+					'Please note that a system message failed to send due to a technical issue.',
+					'event_espresso'
+				);
+				// add specific message for developers if WP_DEBUG in on
+				$error_msg .= '||' . $e->getMessage();
+				EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+				$error = true;
+			}
+		} else {
+			$processor->generate_for_all_active_messengers($type, $vars, $send);
+			// let's find out if there were any errors and how many successfully were queued.
+			$count_errors = $processor->get_queue()->count_STS_in_queue(
+				array(EEM_Message::status_failed, EEM_Message::status_debug_only)
+			);
+			$count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete);
+			$count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry);
+			$count_errors = $count_errors + $count_retry;
+			if ($count_errors > 0) {
+				$error = true;
+				if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) {
+					$message = sprintf(
+						__(
+							'There were %d errors and %d messages successfully queued for generation and sending',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} elseif ($count_errors > 1 && $count_queued === 1) {
+					$message = sprintf(
+						__(
+							'There were %d errors and %d message successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} elseif ($count_errors === 1 && $count_queued > 1) {
+					$message = sprintf(
+						__(
+							'There was %d error and %d messages successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} else {
+					$message = sprintf(
+						__(
+							'There was %d message that failed to be queued for generation.',
+							'event_espresso'
+						),
+						$count_errors
+					);
+				}
+				EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__);
+			} else {
+				if ($count_queued === 1) {
+					$message = sprintf(
+						__(
+							'%d message successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_queued
+					);
+				} else {
+					$message = sprintf(
+						__(
+							'%d messages were successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_queued
+					);
+				}
+				EE_Error::add_success($message);
+			}
+		}
+		// if no error then return the generated message(s).
+		if (! $error && ! $send) {
+			$generated_queue = $processor->generate_queue(false);
+			// get message and return.
+			$generated_queue->get_message_repository()->rewind();
+			$messages = array();
+			while ($generated_queue->get_message_repository()->valid()) {
+				$message = $generated_queue->get_message_repository()->current();
+				if ($message instanceof EE_Message) {
+					// set properties that might be expected by add-ons (backward compat)
+					$message->content = $message->content();
+					$message->template_pack = $message->get_template_pack();
+					$message->template_variation = $message->get_template_pack_variation();
+					$messages[] = $message;
+				}
+				$generated_queue->get_message_repository()->next();
+			}
+			return $messages;
+		}
+		return $error ? false
+			: true; // yeah backwards eh?  Really what we're returning is if there is a total success for all the messages or not.  We'll modify this once we get message recording in place.
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $type      This should correspond with a valid message type
+	 * @param  string $context   This should correspond with a valid context for the message type
+	 * @param  string $messenger This should correspond with a valid messenger.
+	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
+	 *                           preview
+	 * @return string          The body of the message.
+	 */
+	public function preview_message($type, $context, $messenger, $send = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return EED_Messages::preview_message($type, $context, $messenger, $send);
+	}
+
+
+	/**
+	 * @since      4.5.0
+	 * @deprecated 4.9.0   Moved to EED_Messages Module
+	 * @param string   $messenger    a string matching a valid active messenger in the system
+	 * @param string   $message_type Although it seems contrary to the name of the method, a message type name is still
+	 *                               required to send along the message type to the messenger because this is used for
+	 *                               determining what specific variations might be loaded for the generated message.
+	 * @param stdClass $message      a stdClass object in the format expected by the messenger.
+	 *
+	 * @return bool          success or fail.
+	 */
+	public function send_message_with_messenger_only($messenger, $message_type, $message)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		// setup for sending to new method.
+		/** @type EE_Messages_Queue $queue */
+		$queue = EE_Registry::instance()->load_lib('Messages_Queue');
+		// make sure we have a proper message object
+		if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
+			$msg = EE_Message_Factory::create(
+				array(
+					'MSG_messenger'    => $messenger,
+					'MSG_message_type' => $message_type,
+					'MSG_content'      => $message->content,
+					'MSG_subject'      => $message->subject,
+				)
+			);
+		} else {
+			$msg = $message;
+		}
+		if (! $msg instanceof EE_Message) {
+			return false;
+		}
+		// make sure any content in a content property (if not empty) is set on the MSG_content.
+		if (! empty($msg->content)) {
+			$msg->set('MSG_content', $msg->content);
+		}
+		$queue->add($msg);
+		return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param         $messenger
+	 * @param  string $message_type message type that the templates are being created for
+	 * @param int     $GRP_ID
+	 * @param bool    $is_global
+	 * @return array|object if creation is successful then we return an array of info, otherwise an error_object is
+	 *                      returned.
+	 * @throws \EE_Error
+	 */
+	public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $messenger_name    name of EE_messenger
+	 * @param  string $message_type_name name of EE_message_type
+	 * @return array
+	 */
+	public function get_fields($messenger_name, $message_type_name)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_fields($messenger_name, $message_type_name);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @access     public
+	 * @param string $type                we can indicate just returning installed message types
+	 *                                    or messengers (or both) via this parameter.
+	 * @param bool   $skip_cache          if true then we skip the cache and retrieve via files.
+	 * @return array                    multidimensional array of messenger and message_type objects
+	 *                                    (messengers index, and message_type index);
+	 */
+	public function get_installed($type = 'all', $skip_cache = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		if ($skip_cache) {
+			$this->_message_resource_manager->reset_active_messengers_and_message_types();
+		}
+		switch ($type) {
+			case 'messengers' :
+				return array(
+					'messenger' => $this->_message_resource_manager->installed_messengers(),
+				);
+				break;
+			case 'message_types' :
+				return array(
+					'message_type' => $this->_message_resource_manager->installed_message_types(),
+				);
+				break;
+			case 'all' :
+			default :
+				return array(
+					'messenger'    => $this->_message_resource_manager->installed_messengers(),
+					'message_type' => $this->_message_resource_manager->installed_message_types(),
+				);
+				break;
+		}
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return \EE_messenger[]
+	 */
+	public function get_active_messengers()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->active_messengers();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array array of message_type references (string)
+	 */
+	public function get_active_message_types()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->list_of_active_message_types();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return EE_message_type[]
+	 */
+	public function get_active_message_type_objects()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_type_objects();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @since      4.5.0
+	 * @param string $messenger The messenger being checked
+	 * @return EE_message_type[]    (or empty array if none present)
+	 */
+	public function get_active_message_types_per_messenger($messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger    The string should correspond to the messenger (message types are
+	 * @param string $message_type The string should correspond to a message type.
+	 * @return EE_message_type|null
+	 */
+	public function get_active_message_type($messenger, $message_type)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array|\EE_message_type[]
+	 */
+	public function get_installed_message_types()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->installed_message_types();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array
+	 */
+	public function get_installed_messengers()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->installed_messengers();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param   bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by
+	 *                           message type.
+	 * @return array
+	 */
+	public function get_all_contexts($slugs_only = true)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_all_contexts($slugs_only);
+	}
 
 
 }
@@ -1129,88 +1129,88 @@ 
 
 
 add_filter(
-    'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-    function ($event_list_iframe_css) {
-        if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
-            return $event_list_iframe_css;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE__EventsArchiveIframe__event_list_iframe__css',
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-            '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
-            '4.9.14',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE__EventsArchiveIframe__event_list_iframe__css',
-            $event_list_iframe_css
-        );
-    }
+	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+	function ($event_list_iframe_css) {
+		if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
+			return $event_list_iframe_css;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE__EventsArchiveIframe__event_list_iframe__css',
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+			'\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
+			'4.9.14',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE__EventsArchiveIframe__event_list_iframe__css',
+			$event_list_iframe_css
+		);
+	}
 );
 add_filter(
-    'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-    function ($event_list_iframe_js) {
-        if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
-            return $event_list_iframe_js;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-            '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
-            '4.9.14',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            $event_list_iframe_js
-        );
-    }
+	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+	function ($event_list_iframe_js) {
+		if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
+			return $event_list_iframe_js;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+			'\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
+			'4.9.14',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			$event_list_iframe_js
+		);
+	}
 );
 add_action(
-    'AHEE__EE_Capabilities__addCaps__complete',
-    function ($capabilities_map) {
-        if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
-            return;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'AHEE__EE_Capabilities__init_role_caps__complete',
-            'AHEE__EE_Capabilities__addCaps__complete',
-            '\EE_Capabilities::addCaps()',
-            '4.9.42',
-            '5.0.0'
-        );
-        do_action(
-            'AHEE__EE_Capabilities__init_role_caps__complete',
-            $capabilities_map
-        );
-    }
+	'AHEE__EE_Capabilities__addCaps__complete',
+	function ($capabilities_map) {
+		if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
+			return;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'AHEE__EE_Capabilities__init_role_caps__complete',
+			'AHEE__EE_Capabilities__addCaps__complete',
+			'\EE_Capabilities::addCaps()',
+			'4.9.42',
+			'5.0.0'
+		);
+		do_action(
+			'AHEE__EE_Capabilities__init_role_caps__complete',
+			$capabilities_map
+		);
+	}
 );
 
 add_filter(
-    'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-    function ($existing_attendee, $registration, $attendee_data) {
-        if (! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) {
-            return $existing_attendee;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
-            'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-            '\EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler::findExistingAttendee()',
-            '4.9.34',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
-            $existing_attendee,
-            $registration,
-            $attendee_data
-        );
-    },
-    10,
-    3
+	'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
+	function ($existing_attendee, $registration, $attendee_data) {
+		if (! has_filter('FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee')) {
+			return $existing_attendee;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
+			'FHEE_EventEspresso_core_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
+			'\EventEspresso\core\services\commands\attendee\CreateAttendeeCommandHandler::findExistingAttendee()',
+			'4.9.34',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
+			$existing_attendee,
+			$registration,
+			$attendee_data
+		);
+	},
+	10,
+	3
 );
 
 /**
@@ -1221,88 +1221,88 @@ 
 class EE_Event_List_Query extends WP_Query
 {
 
-    private $title;
-
-    private $css_class;
-
-    private $category_slug;
-
-    /**
-     * EE_Event_List_Query constructor.
-     *
-     * @param array $args
-     */
-    public function __construct($args = array())
-    {
-        \EE_Error::doing_it_wrong(
-            __METHOD__,
-            __(
-                'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
-                'event_espresso'
-            ),
-            '4.9.27',
-            '5.0.0'
-        );
-        $this->title = isset($args['title']) ? $args['title'] : '';
-        $this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
-        $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
-        $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        $args = array_merge(
-            $args,
-            array(
-                'post_type'              => 'espresso_events',
-                'posts_per_page'         => $limit,
-                'update_post_term_cache' => false,
-                'update_post_meta_cache' => false,
-                'paged'                  => $paged,
-                'offset'                 => ($paged - 1) * $limit,
-            )
-        );
-        // run the query
-        parent::__construct($args);
-    }
-
-
-    /**
-     * event_list_title
-     *
-     * @param string $event_list_title
-     * @return string
-     */
-    public function event_list_title($event_list_title = '')
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-    /**
-     * event_list_css
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css($event_list_css = '')
-    {
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->css_class)
-            ? $this->css_class
-            : '';
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->category_slug)
-            ? $this->category_slug
-            : '';
-        return $event_list_css;
-    }
+	private $title;
+
+	private $css_class;
+
+	private $category_slug;
+
+	/**
+	 * EE_Event_List_Query constructor.
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = array())
+	{
+		\EE_Error::doing_it_wrong(
+			__METHOD__,
+			__(
+				'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
+				'event_espresso'
+			),
+			'4.9.27',
+			'5.0.0'
+		);
+		$this->title = isset($args['title']) ? $args['title'] : '';
+		$this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
+		$this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
+		$limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		$args = array_merge(
+			$args,
+			array(
+				'post_type'              => 'espresso_events',
+				'posts_per_page'         => $limit,
+				'update_post_term_cache' => false,
+				'update_post_meta_cache' => false,
+				'paged'                  => $paged,
+				'offset'                 => ($paged - 1) * $limit,
+			)
+		);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+	/**
+	 * event_list_title
+	 *
+	 * @param string $event_list_title
+	 * @return string
+	 */
+	public function event_list_title($event_list_title = '')
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+	/**
+	 * event_list_css
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css($event_list_css = '')
+	{
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->css_class)
+			? $this->css_class
+			: '';
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->category_slug)
+			? $this->category_slug
+			: '';
+		return $event_list_css;
+	}
 
 }
 
@@ -1319,66 +1319,66 @@ 
 {
 
 
-    /**
-     *    class constructor
-     *
-     * @deprecated 4.9.59.p
-     */
-    public function __construct()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __CLASS__,
-                'EventEspresso\core\services\licensing\LicenseServices'
-            ),
-            '4.9.59.p'
-        );
-    }
-
-
-    /**
-     * The purpose of this function is to display information about Event Espresso data collection
-     * and a optin selection for extra data collecting by users.
-     *
-     * @param bool $extra
-     * @return string html.
-     * @deprecated 4.9.59.p
-     */
-    public static function espresso_data_collection_optin_text($extra = true)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __METHOD__,
-                'EventEspresso\core\domain\services\Stats::optinText'
-            ),
-            '4.9.59.p'
-        );
-        Stats::optinText($extra);
-    }
-
-    /**
-     * This is a handy helper method for retrieving whether there is an update available for the given plugin.
-     *
-     * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
-     *                          identify plugins. Defaults to core update
-     * @return boolean           True if update available, false if not.
-     * @deprecated 4.9.59.p
-     */
-    public static function is_update_available($basename = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __METHOD__,
-                'EventEspresso\core\services\licensing\LicenseService::isUpdateAvailable'
-            ),
-            '4.9.59.p'
-        );
-        return LicenseService::isUpdateAvailable($basename);
-    }
+	/**
+	 *    class constructor
+	 *
+	 * @deprecated 4.9.59.p
+	 */
+	public function __construct()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__CLASS__,
+				'EventEspresso\core\services\licensing\LicenseServices'
+			),
+			'4.9.59.p'
+		);
+	}
+
+
+	/**
+	 * The purpose of this function is to display information about Event Espresso data collection
+	 * and a optin selection for extra data collecting by users.
+	 *
+	 * @param bool $extra
+	 * @return string html.
+	 * @deprecated 4.9.59.p
+	 */
+	public static function espresso_data_collection_optin_text($extra = true)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__METHOD__,
+				'EventEspresso\core\domain\services\Stats::optinText'
+			),
+			'4.9.59.p'
+		);
+		Stats::optinText($extra);
+	}
+
+	/**
+	 * This is a handy helper method for retrieving whether there is an update available for the given plugin.
+	 *
+	 * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
+	 *                          identify plugins. Defaults to core update
+	 * @return boolean           True if update available, false if not.
+	 * @deprecated 4.9.59.p
+	 */
+	public static function is_update_available($basename = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__METHOD__,
+				'EventEspresso\core\services\licensing\LicenseService::isUpdateAvailable'
+			),
+			'4.9.59.p'
+		);
+		return LicenseService::isUpdateAvailable($basename);
+	}
 }
\ No newline at end of file

espresso.php

Indentation +80 added lines, -80 removed lines

@@ -38,103 +38,103 @@
  * @since           4.0
  */
 if (function_exists('espresso_version')) {
-    if (! function_exists('espresso_duplicate_plugin_error')) {
-        /**
-         *    espresso_duplicate_plugin_error
-         *    displays if more than one version of EE is activated at the same time
-         */
-        function espresso_duplicate_plugin_error()
-        {
-            ?>
+	if (! function_exists('espresso_duplicate_plugin_error')) {
+		/**
+		 *    espresso_duplicate_plugin_error
+		 *    displays if more than one version of EE is activated at the same time
+		 */
+		function espresso_duplicate_plugin_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    echo esc_html__(
-                        'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
-                        'event_espresso'
-                    ); ?>
+					echo esc_html__(
+						'Can not run multiple versions of Event Espresso! One version has been automatically deactivated. Please verify that you have the correct version you want still active.',
+						'event_espresso'
+					); ?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
-    }
-    add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
+	}
+	add_action('admin_notices', 'espresso_duplicate_plugin_error', 1);
 } else {
-    define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
-    if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
-        /**
-         * espresso_minimum_php_version_error
-         *
-         * @return void
-         */
-        function espresso_minimum_php_version_error()
-        {
-            ?>
+	define('EE_MIN_PHP_VER_REQUIRED', '5.4.0');
+	if (! version_compare(PHP_VERSION, EE_MIN_PHP_VER_REQUIRED, '>=')) {
+		/**
+		 * espresso_minimum_php_version_error
+		 *
+		 * @return void
+		 */
+		function espresso_minimum_php_version_error()
+		{
+			?>
             <div class="error">
                 <p>
                     <?php
-                    printf(
-                        esc_html__(
-                            'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                            'event_espresso'
-                        ),
-                        EE_MIN_PHP_VER_REQUIRED,
-                        PHP_VERSION,
-                        '<br/>',
-                        '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                    );
-                    ?>
+					printf(
+						esc_html__(
+							'We\'re sorry, but Event Espresso requires PHP version %1$s or greater in order to operate. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+							'event_espresso'
+						),
+						EE_MIN_PHP_VER_REQUIRED,
+						PHP_VERSION,
+						'<br/>',
+						'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+					);
+					?>
                 </p>
             </div>
             <?php
-            espresso_deactivate_plugin(plugin_basename(__FILE__));
-        }
+			espresso_deactivate_plugin(plugin_basename(__FILE__));
+		}
 
-        add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
-    } else {
-        define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
-        /**
-         * espresso_version
-         * Returns the plugin version
-         *
-         * @return string
-         */
-        function espresso_version()
-        {
-            return apply_filters('FHEE__espresso__espresso_version', '4.9.66.rc.001');
-        }
+		add_action('admin_notices', 'espresso_minimum_php_version_error', 1);
+	} else {
+		define('EVENT_ESPRESSO_MAIN_FILE', __FILE__);
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version()
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '4.9.66.rc.001');
+		}
 
-        /**
-         * espresso_plugin_activation
-         * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
-         */
-        function espresso_plugin_activation()
-        {
-            update_option('ee_espresso_activation', true);
-        }
+		/**
+		 * espresso_plugin_activation
+		 * adds a wp-option to indicate that EE has been activated via the WP admin plugins page
+		 */
+		function espresso_plugin_activation()
+		{
+			update_option('ee_espresso_activation', true);
+		}
 
-        register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
+		register_activation_hook(EVENT_ESPRESSO_MAIN_FILE, 'espresso_plugin_activation');
 
-        require_once __DIR__ . '/core/bootstrap_espresso.php';
-        bootstrap_espresso();
-    }
+		require_once __DIR__ . '/core/bootstrap_espresso.php';
+		bootstrap_espresso();
+	}
 }
 if (! function_exists('espresso_deactivate_plugin')) {
-    /**
-     *    deactivate_plugin
-     * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
-     *
-     * @access public
-     * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
-     * @return    void
-     */
-    function espresso_deactivate_plugin($plugin_basename = '')
-    {
-        if (! function_exists('deactivate_plugins')) {
-            require_once ABSPATH . 'wp-admin/includes/plugin.php';
-        }
-        unset($_GET['activate'], $_REQUEST['activate']);
-        deactivate_plugins($plugin_basename);
-    }
+	/**
+	 *    deactivate_plugin
+	 * usage:  espresso_deactivate_plugin( plugin_basename( __FILE__ ));
+	 *
+	 * @access public
+	 * @param string $plugin_basename - the results of plugin_basename( __FILE__ ) for the plugin's main file
+	 * @return    void
+	 */
+	function espresso_deactivate_plugin($plugin_basename = '')
+	{
+		if (! function_exists('deactivate_plugins')) {
+			require_once ABSPATH . 'wp-admin/includes/plugin.php';
+		}
+		unset($_GET['activate'], $_REQUEST['activate']);
+		deactivate_plugins($plugin_basename);
+	}
 }