eventespresso / event-espresso-core

core/EE_Cron_Tasks.core.php

Indentation +601 added lines, -601 removed lines

@@ -17,607 +17,607 @@
 class EE_Cron_Tasks extends EE_Base
 {
 
-    /**
-     * WordPress doesn't allow duplicate crons within 10 minutes of the original,
-     * so we'll set our retry time for just over 10 minutes to avoid that
-     */
-    const reschedule_timeout = 605;
-
-
-    /**
-     * @var EE_Cron_Tasks
-     */
-    private static $_instance;
-
-
-    /**
-     * @return EE_Cron_Tasks
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function instance()
-    {
-        if (! self::$_instance instanceof EE_Cron_Tasks) {
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * @access private
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function __construct()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // verify that WP Cron is enabled
-        if (
-            defined('DISABLE_WP_CRON')
-            && DISABLE_WP_CRON
-            && is_admin()
-            && ! get_option('ee_disabled_wp_cron_check')
-        ) {
-            /**
-             * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
-             * config is loaded.
-             * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
-             * wanting to not have this functionality can just register its own action at a priority after this one to
-             * reverse any changes.
-             */
-            add_action(
-                'AHEE__EE_System__load_core_configuration__complete',
-                function ()
-                {
-                    EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
-                    EE_Registry::instance()->NET_CFG->update_config(true, false);
-                    add_option('ee_disabled_wp_cron_check', 1, '', false);
-                }
-            );
-        }
-        // UPDATE TRANSACTION WITH PAYMENT
-        add_action(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-            array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
-            10,
-            2
-        );
-        // ABANDONED / EXPIRED TRANSACTION CHECK
-        add_action(
-            'AHEE__EE_Cron_Tasks__expired_transaction_check',
-            array('EE_Cron_Tasks', 'expired_transaction_check'),
-            10,
-            1
-        );
-        // CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
-        add_action(
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-            array('EE_Cron_Tasks', 'clean_out_junk_transactions')
-        );
-        // logging
-        add_action(
-            'AHEE__EE_System__load_core_configuration__complete',
-            array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
-        );
-        EE_Registry::instance()->load_lib('Messages_Scheduler');
-        //clean out old gateway logs
-        add_action(
-            'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
-            array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
-        );
-    }
-
-
-    /**
-     * @access protected
-     * @return void
-     */
-    public static function log_scheduled_ee_crons()
-    {
-        $ee_crons = array(
-            'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
-            'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-        );
-        $crons    = (array) get_option('cron');
-        if (! is_array($crons)) {
-            return;
-        }
-        foreach ($crons as $timestamp => $cron) {
-            /** @var array[] $cron */
-            foreach ($ee_crons as $ee_cron) {
-                if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
-                    do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
-                    foreach ($cron[ $ee_cron ] as $ee_cron_details) {
-                        if (! empty($ee_cron_details['args'])) {
-                            do_action(
-                                'AHEE_log',
-                                __CLASS__,
-                                __FUNCTION__,
-                                print_r($ee_cron_details['args'], true),
-                                "{$ee_cron} args"
-                            );
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * reschedule_cron_for_transactions_if_maintenance_mode
-     * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
-     *
-     * @param string $cron_task
-     * @param array  $TXN_IDs
-     * @return bool
-     * @throws DomainException
-     */
-    public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
-    {
-        if (! method_exists('EE_Cron_Tasks', $cron_task)) {
-            throw new DomainException(
-                sprintf(
-                    __('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
-                    $cron_task
-                )
-            );
-        }
-        // reschedule the cron if we can't hit the db right now
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-            foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
-                // ensure $additional_vars is an array
-                $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
-                // reset cron job for the TXN
-                call_user_func_array(
-                    array('EE_Cron_Tasks', $cron_task),
-                    array_merge(
-                        array(
-                            time() + (10 * MINUTE_IN_SECONDS),
-                            $TXN_ID,
-                        ),
-                        $additional_vars
-                    )
-                );
-            }
-            return true;
-        }
-        return false;
-    }
-
-
-
-
-    /****************  UPDATE TRANSACTION WITH PAYMENT ****************/
-
-
-
-    /**
-     * array of TXN IDs and the payment
-     *
-     * @var array
-     */
-    protected static $_update_transactions_with_payment = array();
-
-
-    /**
-     * schedule_update_transaction_with_payment
-     * sets a wp_schedule_single_event() for updating any TXNs that may
-     * require updating due to recently received payments
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function schedule_update_transaction_with_payment(
-        $timestamp,
-        $TXN_ID,
-        $PAY_ID
-    ) {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        // validate $TXN_ID and $timestamp
-        $TXN_ID    = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
-                array($TXN_ID, $PAY_ID)
-            );
-        }
-    }
-
-
-    /**
-     * setup_update_for_transaction_with_payment
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
-     * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
-     * The passed TXN_ID and associated payment gets added to an array, and then
-     * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
-     * 'shutdown' which will actually handle the processing of any
-     * transactions requiring updating, because doing so now would be too early
-     * and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     * @param int $PAY_ID
-     */
-    public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
-        if (absint($TXN_ID)) {
-            self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'update_transaction_with_payment'),
-                5
-            );
-        }
-    }
-
-
-    /**
-     * update_transaction_with_payment
-     * loops through the self::$_abandoned_transactions array
-     * and attempts to finalize any TXNs that have not been completed
-     * but have had their sessions expired, most likely due to a user not
-     * returning from an off-site payment gateway
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function update_transaction_with_payment()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (
-            // are there any TXNs that need cleaning up ?
-            empty(self::$_update_transactions_with_payment)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_update_transaction_with_payment',
-                self::$_update_transactions_with_payment
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Payment_Processor $payment_processor */
-        $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-        // set revisit flag for payment processor
-        $payment_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
-            // reschedule the cron if we can't hit the db right now
-            if (! EE_Maintenance_Mode::instance()->models_can_query()) {
-                // reset cron job for updating the TXN
-                EE_Cron_Tasks::schedule_update_transaction_with_payment(
-                    time() + EE_Cron_Tasks::reschedule_timeout,
-                    $TXN_ID,
-                    $PAY_ID
-                );
-                continue;
-            }
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            $payment     = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
-            // verify transaction
-            if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
-                // now try to update the TXN with any payments
-                $payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
-            }
-            unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
-        }
-    }
-
-
-
-    /************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
-
-
-
-    /*****************  EXPIRED TRANSACTION CHECK *****************/
-
-
-
-    /**
-     * array of TXN IDs
-     *
-     * @var array
-     */
-    protected static $_expired_transactions = array();
-
-
-
-    /**
-     * schedule_expired_transaction_check
-     * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
-     *
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_expired_transaction_check(
-        $timestamp,
-        $TXN_ID
-    ) {
-        // validate $TXN_ID and $timestamp
-        $TXN_ID    = absint($TXN_ID);
-        $timestamp = absint($timestamp);
-        if ($TXN_ID && $timestamp) {
-            wp_schedule_single_event(
-                $timestamp,
-                'AHEE__EE_Cron_Tasks__expired_transaction_check',
-                array($TXN_ID)
-            );
-        }
-    }
-
-
-
-    /**
-     * expired_transaction_check
-     * this is the callback for the action hook:
-     * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
-     * which is utilized by wp_schedule_single_event()
-     * in \EED_Single_Page_Checkout::_initialize_transaction().
-     * The passed TXN_ID gets added to an array, and then the
-     * process_expired_transactions() function is hooked into
-     * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
-     * processing of any failed transactions, because doing so now would be
-     * too early and the required resources may not be available
-     *
-     * @param int $TXN_ID
-     */
-    public static function expired_transaction_check($TXN_ID = 0)
-    {
-        if (absint($TXN_ID)) {
-            self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
-            add_action(
-                'shutdown',
-                array('EE_Cron_Tasks', 'process_expired_transactions'),
-                5
-            );
-        }
-    }
-
-
-
-    /**
-     * process_expired_transactions
-     * loops through the self::$_expired_transactions array and processes any failed TXNs
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws DomainException
-     * @throws RuntimeException
-     */
-    public static function process_expired_transactions()
-    {
-        if (
-            // are there any TXNs that need cleaning up ?
-            empty(self::$_expired_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_expired_transactions
-            )
-        ) {
-            return;
-        }
-        /** @type EE_Transaction_Processor $transaction_processor */
-        $transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
-        // set revisit flag for txn processor
-        $transaction_processor->set_revisit();
-        // load EEM_Transaction
-        EE_Registry::instance()->load_model('Transaction');
-        foreach (self::$_expired_transactions as $TXN_ID) {
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
-            // verify transaction and whether it is failed or not
-            if ($transaction instanceof EE_Transaction) {
-                switch ($transaction->status_ID()) {
-                    // Completed TXNs
-                    case EEM_Transaction::complete_status_code :
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
-                            $transaction
-                        );
-                        break;
-                    // Overpaid TXNs
-                    case EEM_Transaction::overpaid_status_code :
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
-                            $transaction
-                        );
-                        break;
-                    // Incomplete TXNs
-                    case EEM_Transaction::incomplete_status_code :
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
-                            $transaction
-                        );
-                        // todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
-                        break;
-                    // Abandoned TXNs
-                    case EEM_Transaction::abandoned_status_code :
-                        // run hook before updating transaction, primarily so
-                        // EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
-                            $transaction
-                        );
-                        // don't finalize the TXN if it has already been completed
-                        if ($transaction->all_reg_steps_completed() !== true) {
-                            /** @type EE_Payment_Processor $payment_processor */
-                            $payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
-                            // let's simulate an IPN here which will trigger any notifications that need to go out
-                            $payment_processor->update_txn_based_on_payment(
-                                $transaction,
-                                $transaction->last_payment(),
-                                true,
-                                true
-                            );
-                        }
-                        break;
-                    // Failed TXNs
-                    case EEM_Transaction::failed_status_code :
-                        do_action(
-                            'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
-                            $transaction
-                        );
-                        // todo : perform garbage collection here and remove clean_out_junk_transactions()
-                        //$registrations = $transaction->registrations();
-                        //if ( ! empty( $registrations ) ) {
-                        //	foreach ( $registrations as $registration ) {
-                        //		if ( $registration instanceof EE_Registration ) {
-                        //$delete_registration = true;
-                        //if ( $registration->attendee() instanceof EE_Attendee ) {
-                        //	$delete_registration = false;
-                        //}
-                        //if ( $delete_registration ) {
-                        //	$registration->delete_permanently();
-                        //	$registration->delete_related_permanently();
-                        //}
-                        //		}
-                        //	}
-                        //}
-                        break;
-                }
-            }
-            unset(self::$_expired_transactions[ $TXN_ID ]);
-        }
-    }
-
-
-
-    /*************  END OF EXPIRED TRANSACTION CHECK  *************/
-
-
-
-    /************* START CLEAN UP BOT TRANSACTIONS **********************/
-
-
-
-    /**
-     * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
-     * which is setup during activation to run on an hourly cron
-     *
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws DomainException
-     */
-    public static function clean_out_junk_transactions()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            EED_Ticket_Sales_Monitor::reset_reservation_counts();
-            EEM_Transaction::instance('')->delete_junk_transactions();
-            EEM_Registration::instance('')->delete_registrations_with_no_transaction();
-            EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
-        }
-    }
-
-
-
-    /**
-     * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function clean_out_old_gateway_logs()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $time_diff_for_comparison = apply_filters(
-                'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
-                '-1 week'
-            );
-            EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
-        }
-    }
-
-
-    /*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
-
-
-
-    /**
-     * @var array
-     */
-    protected static $_abandoned_transactions = array();
-
-
-    /**
-     * @deprecated
-     * @param int $timestamp
-     * @param int $TXN_ID
-     */
-    public static function schedule_finalize_abandoned_transactions_check($timestamp, $TXN_ID)
-    {
-        EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @param int $TXN_ID
-     */
-    public static function check_for_abandoned_transactions($TXN_ID = 0)
-    {
-        EE_Cron_Tasks::expired_transaction_check($TXN_ID);
-    }
-
-
-    /**
-     * @deprecated
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     */
-    public static function finalize_abandoned_transactions()
-    {
-        do_action('AHEE_log', __CLASS__, __FUNCTION__);
-        if (
-            // are there any TXNs that need cleaning up ?
-            empty(self::$_abandoned_transactions)
-            // reschedule the cron if we can't hit the db right now
-            || EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
-                'schedule_expired_transaction_check',
-                self::$_abandoned_transactions
-            )
-        ) {
-            return;
-        }
-        // combine our arrays of transaction IDs
-        self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
-        // and deal with abandoned transactions here now...
-        EE_Cron_Tasks::process_expired_transactions();
-    }
-
-
-
-    /*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
+	/**
+	 * WordPress doesn't allow duplicate crons within 10 minutes of the original,
+	 * so we'll set our retry time for just over 10 minutes to avoid that
+	 */
+	const reschedule_timeout = 605;
+
+
+	/**
+	 * @var EE_Cron_Tasks
+	 */
+	private static $_instance;
+
+
+	/**
+	 * @return EE_Cron_Tasks
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function instance()
+	{
+		if (! self::$_instance instanceof EE_Cron_Tasks) {
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * @access private
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function __construct()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// verify that WP Cron is enabled
+		if (
+			defined('DISABLE_WP_CRON')
+			&& DISABLE_WP_CRON
+			&& is_admin()
+			&& ! get_option('ee_disabled_wp_cron_check')
+		) {
+			/**
+			 * This needs to be delayed until after the config is loaded because EE_Cron_Tasks is constructed before
+			 * config is loaded.
+			 * This is intentionally using a anonymous function so that its not easily de-registered.  Client code
+			 * wanting to not have this functionality can just register its own action at a priority after this one to
+			 * reverse any changes.
+			 */
+			add_action(
+				'AHEE__EE_System__load_core_configuration__complete',
+				function ()
+				{
+					EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
+					EE_Registry::instance()->NET_CFG->update_config(true, false);
+					add_option('ee_disabled_wp_cron_check', 1, '', false);
+				}
+			);
+		}
+		// UPDATE TRANSACTION WITH PAYMENT
+		add_action(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+			array('EE_Cron_Tasks', 'setup_update_for_transaction_with_payment'),
+			10,
+			2
+		);
+		// ABANDONED / EXPIRED TRANSACTION CHECK
+		add_action(
+			'AHEE__EE_Cron_Tasks__expired_transaction_check',
+			array('EE_Cron_Tasks', 'expired_transaction_check'),
+			10,
+			1
+		);
+		// CLEAN OUT JUNK TRANSACTIONS AND RELATED DATA
+		add_action(
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+			array('EE_Cron_Tasks', 'clean_out_junk_transactions')
+		);
+		// logging
+		add_action(
+			'AHEE__EE_System__load_core_configuration__complete',
+			array('EE_Cron_Tasks', 'log_scheduled_ee_crons')
+		);
+		EE_Registry::instance()->load_lib('Messages_Scheduler');
+		//clean out old gateway logs
+		add_action(
+			'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
+			array('EE_Cron_Tasks', 'clean_out_old_gateway_logs')
+		);
+	}
+
+
+	/**
+	 * @access protected
+	 * @return void
+	 */
+	public static function log_scheduled_ee_crons()
+	{
+		$ee_crons = array(
+			'AHEE__EE_Cron_Tasks__update_transaction_with_payment',
+			'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+		);
+		$crons    = (array) get_option('cron');
+		if (! is_array($crons)) {
+			return;
+		}
+		foreach ($crons as $timestamp => $cron) {
+			/** @var array[] $cron */
+			foreach ($ee_crons as $ee_cron) {
+				if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
+					do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
+					foreach ($cron[ $ee_cron ] as $ee_cron_details) {
+						if (! empty($ee_cron_details['args'])) {
+							do_action(
+								'AHEE_log',
+								__CLASS__,
+								__FUNCTION__,
+								print_r($ee_cron_details['args'], true),
+								"{$ee_cron} args"
+							);
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * reschedule_cron_for_transactions_if_maintenance_mode
+	 * if Maintenance Mode is active, this will reschedule a cron to run again in 10 minutes
+	 *
+	 * @param string $cron_task
+	 * @param array  $TXN_IDs
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
+	{
+		if (! method_exists('EE_Cron_Tasks', $cron_task)) {
+			throw new DomainException(
+				sprintf(
+					__('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
+					$cron_task
+				)
+			);
+		}
+		// reschedule the cron if we can't hit the db right now
+		if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+			foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
+				// ensure $additional_vars is an array
+				$additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
+				// reset cron job for the TXN
+				call_user_func_array(
+					array('EE_Cron_Tasks', $cron_task),
+					array_merge(
+						array(
+							time() + (10 * MINUTE_IN_SECONDS),
+							$TXN_ID,
+						),
+						$additional_vars
+					)
+				);
+			}
+			return true;
+		}
+		return false;
+	}
+
+
+
+
+	/****************  UPDATE TRANSACTION WITH PAYMENT ****************/
+
+
+
+	/**
+	 * array of TXN IDs and the payment
+	 *
+	 * @var array
+	 */
+	protected static $_update_transactions_with_payment = array();
+
+
+	/**
+	 * schedule_update_transaction_with_payment
+	 * sets a wp_schedule_single_event() for updating any TXNs that may
+	 * require updating due to recently received payments
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function schedule_update_transaction_with_payment(
+		$timestamp,
+		$TXN_ID,
+		$PAY_ID
+	) {
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		// validate $TXN_ID and $timestamp
+		$TXN_ID    = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__update_transaction_with_payment_2',
+				array($TXN_ID, $PAY_ID)
+			);
+		}
+	}
+
+
+	/**
+	 * setup_update_for_transaction_with_payment
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__update_transaction_with_payment'
+	 * which is setup by EE_Cron_Tasks::schedule_update_transaction_with_payment().
+	 * The passed TXN_ID and associated payment gets added to an array, and then
+	 * the EE_Cron_Tasks::update_transaction_with_payment() function is hooked into
+	 * 'shutdown' which will actually handle the processing of any
+	 * transactions requiring updating, because doing so now would be too early
+	 * and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 * @param int $PAY_ID
+	 */
+	public static function setup_update_for_transaction_with_payment($TXN_ID = 0, $PAY_ID = 0)
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
+		if (absint($TXN_ID)) {
+			self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'update_transaction_with_payment'),
+				5
+			);
+		}
+	}
+
+
+	/**
+	 * update_transaction_with_payment
+	 * loops through the self::$_abandoned_transactions array
+	 * and attempts to finalize any TXNs that have not been completed
+	 * but have had their sessions expired, most likely due to a user not
+	 * returning from an off-site payment gateway
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function update_transaction_with_payment()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (
+			// are there any TXNs that need cleaning up ?
+			empty(self::$_update_transactions_with_payment)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_update_transaction_with_payment',
+				self::$_update_transactions_with_payment
+			)
+		) {
+			return;
+		}
+		/** @type EE_Payment_Processor $payment_processor */
+		$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+		// set revisit flag for payment processor
+		$payment_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
+			// reschedule the cron if we can't hit the db right now
+			if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+				// reset cron job for updating the TXN
+				EE_Cron_Tasks::schedule_update_transaction_with_payment(
+					time() + EE_Cron_Tasks::reschedule_timeout,
+					$TXN_ID,
+					$PAY_ID
+				);
+				continue;
+			}
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			$payment     = EEM_Payment::instance()->get_one_by_ID($PAY_ID);
+			// verify transaction
+			if ($transaction instanceof EE_Transaction && $payment instanceof EE_Payment) {
+				// now try to update the TXN with any payments
+				$payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
+			}
+			unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
+		}
+	}
+
+
+
+	/************  END OF UPDATE TRANSACTION WITH PAYMENT  ************/
+
+
+
+	/*****************  EXPIRED TRANSACTION CHECK *****************/
+
+
+
+	/**
+	 * array of TXN IDs
+	 *
+	 * @var array
+	 */
+	protected static $_expired_transactions = array();
+
+
+
+	/**
+	 * schedule_expired_transaction_check
+	 * sets a wp_schedule_single_event() for following up on TXNs after their session has expired
+	 *
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_expired_transaction_check(
+		$timestamp,
+		$TXN_ID
+	) {
+		// validate $TXN_ID and $timestamp
+		$TXN_ID    = absint($TXN_ID);
+		$timestamp = absint($timestamp);
+		if ($TXN_ID && $timestamp) {
+			wp_schedule_single_event(
+				$timestamp,
+				'AHEE__EE_Cron_Tasks__expired_transaction_check',
+				array($TXN_ID)
+			);
+		}
+	}
+
+
+
+	/**
+	 * expired_transaction_check
+	 * this is the callback for the action hook:
+	 * 'AHEE__EE_Cron_Tasks__transaction_session_expiration_check'
+	 * which is utilized by wp_schedule_single_event()
+	 * in \EED_Single_Page_Checkout::_initialize_transaction().
+	 * The passed TXN_ID gets added to an array, and then the
+	 * process_expired_transactions() function is hooked into
+	 * 'AHEE__EE_System__core_loaded_and_ready' which will actually handle the
+	 * processing of any failed transactions, because doing so now would be
+	 * too early and the required resources may not be available
+	 *
+	 * @param int $TXN_ID
+	 */
+	public static function expired_transaction_check($TXN_ID = 0)
+	{
+		if (absint($TXN_ID)) {
+			self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
+			add_action(
+				'shutdown',
+				array('EE_Cron_Tasks', 'process_expired_transactions'),
+				5
+			);
+		}
+	}
+
+
+
+	/**
+	 * process_expired_transactions
+	 * loops through the self::$_expired_transactions array and processes any failed TXNs
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws DomainException
+	 * @throws RuntimeException
+	 */
+	public static function process_expired_transactions()
+	{
+		if (
+			// are there any TXNs that need cleaning up ?
+			empty(self::$_expired_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_expired_transactions
+			)
+		) {
+			return;
+		}
+		/** @type EE_Transaction_Processor $transaction_processor */
+		$transaction_processor = EE_Registry::instance()->load_class('Transaction_Processor');
+		// set revisit flag for txn processor
+		$transaction_processor->set_revisit();
+		// load EEM_Transaction
+		EE_Registry::instance()->load_model('Transaction');
+		foreach (self::$_expired_transactions as $TXN_ID) {
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($TXN_ID);
+			// verify transaction and whether it is failed or not
+			if ($transaction instanceof EE_Transaction) {
+				switch ($transaction->status_ID()) {
+					// Completed TXNs
+					case EEM_Transaction::complete_status_code :
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__completed_transaction',
+							$transaction
+						);
+						break;
+					// Overpaid TXNs
+					case EEM_Transaction::overpaid_status_code :
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__overpaid_transaction',
+							$transaction
+						);
+						break;
+					// Incomplete TXNs
+					case EEM_Transaction::incomplete_status_code :
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__incomplete_transaction',
+							$transaction
+						);
+						// todo : move business logic into EE_Transaction_Processor for finalizing abandoned transactions
+						break;
+					// Abandoned TXNs
+					case EEM_Transaction::abandoned_status_code :
+						// run hook before updating transaction, primarily so
+						// EED_Ticket_Sales_Monitor::process_abandoned_transactions() can release reserved tickets
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__abandoned_transaction',
+							$transaction
+						);
+						// don't finalize the TXN if it has already been completed
+						if ($transaction->all_reg_steps_completed() !== true) {
+							/** @type EE_Payment_Processor $payment_processor */
+							$payment_processor = EE_Registry::instance()->load_core('Payment_Processor');
+							// let's simulate an IPN here which will trigger any notifications that need to go out
+							$payment_processor->update_txn_based_on_payment(
+								$transaction,
+								$transaction->last_payment(),
+								true,
+								true
+							);
+						}
+						break;
+					// Failed TXNs
+					case EEM_Transaction::failed_status_code :
+						do_action(
+							'AHEE__EE_Cron_Tasks__process_expired_transactions__failed_transaction',
+							$transaction
+						);
+						// todo : perform garbage collection here and remove clean_out_junk_transactions()
+						//$registrations = $transaction->registrations();
+						//if ( ! empty( $registrations ) ) {
+						//	foreach ( $registrations as $registration ) {
+						//		if ( $registration instanceof EE_Registration ) {
+						//$delete_registration = true;
+						//if ( $registration->attendee() instanceof EE_Attendee ) {
+						//	$delete_registration = false;
+						//}
+						//if ( $delete_registration ) {
+						//	$registration->delete_permanently();
+						//	$registration->delete_related_permanently();
+						//}
+						//		}
+						//	}
+						//}
+						break;
+				}
+			}
+			unset(self::$_expired_transactions[ $TXN_ID ]);
+		}
+	}
+
+
+
+	/*************  END OF EXPIRED TRANSACTION CHECK  *************/
+
+
+
+	/************* START CLEAN UP BOT TRANSACTIONS **********************/
+
+
+
+	/**
+	 * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
+	 * which is setup during activation to run on an hourly cron
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws DomainException
+	 */
+	public static function clean_out_junk_transactions()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			EED_Ticket_Sales_Monitor::reset_reservation_counts();
+			EEM_Transaction::instance('')->delete_junk_transactions();
+			EEM_Registration::instance('')->delete_registrations_with_no_transaction();
+			EEM_Line_Item::instance('')->delete_line_items_with_no_transaction();
+		}
+	}
+
+
+
+	/**
+	 * Deletes old gateway logs. After about a week we usually don't need them for debugging. But folks can filter that.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function clean_out_old_gateway_logs()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$time_diff_for_comparison = apply_filters(
+				'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
+				'-1 week'
+			);
+			EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
+		}
+	}
+
+
+	/*****************  FINALIZE ABANDONED TRANSACTIONS *****************/
+
+
+
+	/**
+	 * @var array
+	 */
+	protected static $_abandoned_transactions = array();
+
+
+	/**
+	 * @deprecated
+	 * @param int $timestamp
+	 * @param int $TXN_ID
+	 */
+	public static function schedule_finalize_abandoned_transactions_check($timestamp, $TXN_ID)
+	{
+		EE_Cron_Tasks::schedule_expired_transaction_check($timestamp, $TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @param int $TXN_ID
+	 */
+	public static function check_for_abandoned_transactions($TXN_ID = 0)
+	{
+		EE_Cron_Tasks::expired_transaction_check($TXN_ID);
+	}
+
+
+	/**
+	 * @deprecated
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 */
+	public static function finalize_abandoned_transactions()
+	{
+		do_action('AHEE_log', __CLASS__, __FUNCTION__);
+		if (
+			// are there any TXNs that need cleaning up ?
+			empty(self::$_abandoned_transactions)
+			// reschedule the cron if we can't hit the db right now
+			|| EE_Cron_Tasks::reschedule_cron_for_transactions_if_maintenance_mode(
+				'schedule_expired_transaction_check',
+				self::$_abandoned_transactions
+			)
+		) {
+			return;
+		}
+		// combine our arrays of transaction IDs
+		self::$_expired_transactions = self::$_abandoned_transactions + self::$_expired_transactions;
+		// and deal with abandoned transactions here now...
+		EE_Cron_Tasks::process_expired_transactions();
+	}
+
+
+
+	/*************  END OF FINALIZE ABANDONED TRANSACTIONS  *************/
 }
 // End of file EE_Cron_Tasks.core.php
 // Location: /EE_Cron_Tasks.core.php

Spacing +14 added lines, -14 removed lines

@@ -40,7 +40,7 @@ 
      */
     public static function instance()
     {
-        if (! self::$_instance instanceof EE_Cron_Tasks) {
+        if ( ! self::$_instance instanceof EE_Cron_Tasks) {
             self::$_instance = new self();
         }
         return self::$_instance;
@@ -74,7 +74,7 @@ 
              */
             add_action(
                 'AHEE__EE_System__load_core_configuration__complete',
-                function ()
+                function()
                 {
                     EE_Registry::instance()->NET_CFG->core->do_messages_on_same_request = true;
                     EE_Registry::instance()->NET_CFG->update_config(true, false);
@@ -126,17 +126,17 @@ 
             'AHEE__EE_Cron_Tasks__finalize_abandoned_transactions',
             'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
         );
-        $crons    = (array) get_option('cron');
-        if (! is_array($crons)) {
+        $crons = (array) get_option('cron');
+        if ( ! is_array($crons)) {
             return;
         }
         foreach ($crons as $timestamp => $cron) {
             /** @var array[] $cron */
             foreach ($ee_crons as $ee_cron) {
-                if (isset($cron[ $ee_cron ]) && is_array($cron[ $ee_cron ])) {
+                if (isset($cron[$ee_cron]) && is_array($cron[$ee_cron])) {
                     do_action('AHEE_log', __CLASS__, __FUNCTION__, $ee_cron, 'scheduled EE cron');
-                    foreach ($cron[ $ee_cron ] as $ee_cron_details) {
-                        if (! empty($ee_cron_details['args'])) {
+                    foreach ($cron[$ee_cron] as $ee_cron_details) {
+                        if ( ! empty($ee_cron_details['args'])) {
                             do_action(
                                 'AHEE_log',
                                 __CLASS__,
@@ -164,7 +164,7 @@ 
      */
     public static function reschedule_cron_for_transactions_if_maintenance_mode($cron_task, array $TXN_IDs)
     {
-        if (! method_exists('EE_Cron_Tasks', $cron_task)) {
+        if ( ! method_exists('EE_Cron_Tasks', $cron_task)) {
             throw new DomainException(
                 sprintf(
                     __('"%1$s" is not valid method on EE_Cron_Tasks.', 'event_espresso'),
@@ -173,7 +173,7 @@ 
             );
         }
         // reschedule the cron if we can't hit the db right now
-        if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+        if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
             foreach ($TXN_IDs as $TXN_ID => $additional_vars) {
                 // ensure $additional_vars is an array
                 $additional_vars = is_array($additional_vars) ? $additional_vars : array($additional_vars);
@@ -255,7 +255,7 @@ 
     {
         do_action('AHEE_log', __CLASS__, __FUNCTION__, $TXN_ID, '$TXN_ID');
         if (absint($TXN_ID)) {
-            self::$_update_transactions_with_payment[ $TXN_ID ] = $PAY_ID;
+            self::$_update_transactions_with_payment[$TXN_ID] = $PAY_ID;
             add_action(
                 'shutdown',
                 array('EE_Cron_Tasks', 'update_transaction_with_payment'),
@@ -302,7 +302,7 @@ 
         EE_Registry::instance()->load_model('Transaction');
         foreach (self::$_update_transactions_with_payment as $TXN_ID => $PAY_ID) {
             // reschedule the cron if we can't hit the db right now
-            if (! EE_Maintenance_Mode::instance()->models_can_query()) {
+            if ( ! EE_Maintenance_Mode::instance()->models_can_query()) {
                 // reset cron job for updating the TXN
                 EE_Cron_Tasks::schedule_update_transaction_with_payment(
                     time() + EE_Cron_Tasks::reschedule_timeout,
@@ -318,7 +318,7 @@ 
                 // now try to update the TXN with any payments
                 $payment_processor->update_txn_based_on_payment($transaction, $payment, true, true);
             }
-            unset(self::$_update_transactions_with_payment[ $TXN_ID ]);
+            unset(self::$_update_transactions_with_payment[$TXN_ID]);
         }
     }
 
@@ -383,7 +383,7 @@ 
     public static function expired_transaction_check($TXN_ID = 0)
     {
         if (absint($TXN_ID)) {
-            self::$_expired_transactions[ $TXN_ID ] = $TXN_ID;
+            self::$_expired_transactions[$TXN_ID] = $TXN_ID;
             add_action(
                 'shutdown',
                 array('EE_Cron_Tasks', 'process_expired_transactions'),
@@ -498,7 +498,7 @@ 
                         break;
                 }
             }
-            unset(self::$_expired_transactions[ $TXN_ID ]);
+            unset(self::$_expired_transactions[$TXN_ID]);
         }
     }
 

core/db_models/EEM_Transaction.model.php

Indentation +401 added lines, -401 removed lines

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

core/domain/entities/contexts/RequestTypeContext.php

Spacing +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
     public function __construct($slug, $description)
     {
         parent::__construct($slug, $description);
-        if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
+        if ( ! in_array($this->slug(), $this->validRequestTypes(), true)) {
             throw new InvalidArgumentException(
                 sprintf(
                     esc_html__(

Indentation +133 added lines, -133 removed lines

@@ -20,139 +20,139 @@
 class RequestTypeContext extends Context
 {
 
-    /**
-     * indicates that the current request involves some form of activation
-     */
-    const ACTIVATION = 'activation-request';
-
-    /**
-     * indicates that the current request is for the admin but is not being made via AJAX
-     */
-    const ADMIN = 'non-ajax-admin-request';
-
-    /**
-     * indicates that the current request is for the admin AND is being made via AJAX
-     */
-    const AJAX_ADMIN = 'admin-ajax-request';
-
-    /**
-     * indicates that the current request is for the frontend AND is being made via AJAX
-     */
-    const AJAX_FRONT = 'frontend-ajax-request';
-
-    /**
-     * indicates that the current request is being made via AJAX, but is NOT for EE
-     */
-    const AJAX_OTHER = 'other-ajax-request';
-
-    /**
-     * indicates that the current request is for the EE REST API
-     */
-    const API = 'rest-api';
-
-    /**
-     * indicates that the current request is from the command line
-     */
-    const CLI = 'command-line';
-
-    /**
-     * indicates that the current request is for a WP_Cron
-     */
-    const CRON = 'wp-cron';
-
-    /**
-     * indicates that the current request is for a feed (ie: RSS)
-     */
-    const FEED = 'feed-request';
-
-    /**
-     * indicates that the current request is for the frontend but is not being made via AJAX
-     */
-    const FRONTEND = 'non-ajax-frontend-request';
-
-    /**
-     * indicates that the current request is for content that is to be displayed within an iframe
-     */
-    const IFRAME = 'iframe-request';
-
-    /**
-     * @var boolean $is_activation
-     */
-    private $is_activation = false;
-
-    /**
-     * @var array $valid_request_types
-     */
-    private $valid_request_types = array();
-
-
-    /**
-     * RequestTypeContext constructor.
-     *
-     * @param string $slug
-     * @param string $description
-     * @throws InvalidArgumentException
-     */
-    public function __construct($slug, $description)
-    {
-        parent::__construct($slug, $description);
-        if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    esc_html__(
-                        'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    var_export($this->validRequestTypes(), true)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public function validRequestTypes()
-    {
-        if (empty($this->valid_request_types)) {
-            $this->valid_request_types = apply_filters(
-                'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
-                array(
-                    RequestTypeContext::ACTIVATION,
-                    RequestTypeContext::ADMIN,
-                    RequestTypeContext::AJAX_ADMIN,
-                    RequestTypeContext::AJAX_FRONT,
-                    RequestTypeContext::AJAX_OTHER,
-                    RequestTypeContext::API,
-                    RequestTypeContext::CLI,
-                    RequestTypeContext::CRON,
-                    RequestTypeContext::FEED,
-                    RequestTypeContext::FRONTEND,
-                    RequestTypeContext::IFRAME,
-                )
-            );
-        }
-        return $this->valid_request_types;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->is_activation;
-    }
-
-
-    /**
-     * @param bool $is_activation
-     */
-    public function setIsActivation($is_activation)
-    {
-        $this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * indicates that the current request involves some form of activation
+	 */
+	const ACTIVATION = 'activation-request';
+
+	/**
+	 * indicates that the current request is for the admin but is not being made via AJAX
+	 */
+	const ADMIN = 'non-ajax-admin-request';
+
+	/**
+	 * indicates that the current request is for the admin AND is being made via AJAX
+	 */
+	const AJAX_ADMIN = 'admin-ajax-request';
+
+	/**
+	 * indicates that the current request is for the frontend AND is being made via AJAX
+	 */
+	const AJAX_FRONT = 'frontend-ajax-request';
+
+	/**
+	 * indicates that the current request is being made via AJAX, but is NOT for EE
+	 */
+	const AJAX_OTHER = 'other-ajax-request';
+
+	/**
+	 * indicates that the current request is for the EE REST API
+	 */
+	const API = 'rest-api';
+
+	/**
+	 * indicates that the current request is from the command line
+	 */
+	const CLI = 'command-line';
+
+	/**
+	 * indicates that the current request is for a WP_Cron
+	 */
+	const CRON = 'wp-cron';
+
+	/**
+	 * indicates that the current request is for a feed (ie: RSS)
+	 */
+	const FEED = 'feed-request';
+
+	/**
+	 * indicates that the current request is for the frontend but is not being made via AJAX
+	 */
+	const FRONTEND = 'non-ajax-frontend-request';
+
+	/**
+	 * indicates that the current request is for content that is to be displayed within an iframe
+	 */
+	const IFRAME = 'iframe-request';
+
+	/**
+	 * @var boolean $is_activation
+	 */
+	private $is_activation = false;
+
+	/**
+	 * @var array $valid_request_types
+	 */
+	private $valid_request_types = array();
+
+
+	/**
+	 * RequestTypeContext constructor.
+	 *
+	 * @param string $slug
+	 * @param string $description
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($slug, $description)
+	{
+		parent::__construct($slug, $description);
+		if (! in_array($this->slug(), $this->validRequestTypes(), true)) {
+			throw new InvalidArgumentException(
+				sprintf(
+					esc_html__(
+						'The RequestTypeContext slug must be one of the following values: %1$s %2$s',
+						'event_espresso'
+					),
+					var_export($this->validRequestTypes(), true)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function validRequestTypes()
+	{
+		if (empty($this->valid_request_types)) {
+			$this->valid_request_types = apply_filters(
+				'FHEE__EventEspresso_core_domain_entities_contexts_RequestTypeContext__validRequestTypes',
+				array(
+					RequestTypeContext::ACTIVATION,
+					RequestTypeContext::ADMIN,
+					RequestTypeContext::AJAX_ADMIN,
+					RequestTypeContext::AJAX_FRONT,
+					RequestTypeContext::AJAX_OTHER,
+					RequestTypeContext::API,
+					RequestTypeContext::CLI,
+					RequestTypeContext::CRON,
+					RequestTypeContext::FEED,
+					RequestTypeContext::FRONTEND,
+					RequestTypeContext::IFRAME,
+				)
+			);
+		}
+		return $this->valid_request_types;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->is_activation;
+	}
+
+
+	/**
+	 * @param bool $is_activation
+	 */
+	public function setIsActivation($is_activation)
+	{
+		$this->is_activation = filter_var($is_activation, FILTER_VALIDATE_BOOLEAN);
+	}
 
 
 

core/domain/Domain.php

Indentation +12 added lines, -12 removed lines

@@ -16,18 +16,18 @@
 class Domain extends DomainBase
 {
 
-    /**
-     * URL path component used to denote an API request
-     */
-    const API_NAMESPACE = 'ee/v';
+	/**
+	 * URL path component used to denote an API request
+	 */
+	const API_NAMESPACE = 'ee/v';
 
-    /**
-     * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
-     * Page ui.
-     */
-    const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN
-        = 'manual_registration_status_change_from_registration_admin';
+	/**
+	 * Slug used for the context where a registration status is changed from a manual trigger in the Registration Admin
+	 * Page ui.
+	 */
+	const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN
+		= 'manual_registration_status_change_from_registration_admin';
 
-    const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
-        = 'manual_registration_status_change_from_registration_admin_and_notify';
+	const CONTEXT_REGISTRATION_STATUS_CHANGE_REGISTRATION_ADMIN_NOTIFY
+		= 'manual_registration_status_change_from_registration_admin_and_notify';
 }

core/EE_Psr4AutoloaderInit.core.php

Indentation +13 added lines, -13 removed lines

@@ -31,20 +31,20 @@
 	 * @return \EventEspresso\core\Psr4Autoloader
 	 */
 	public function initializeAutoloader() {
-        static $initialized = false;
-        if ( ! $initialized) {
-            // instantiate PSR4 autoloader
+		static $initialized = false;
+		if ( ! $initialized) {
+			// instantiate PSR4 autoloader
 			espresso_load_required( 'Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php' );
-            EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
-            // register the autoloader
-            EE_Psr4AutoloaderInit::$psr4_loader->register();
-            // register the base directories for the namespace prefix
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
-            $initialized = true;
-        }
-    }
+			EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
+			// register the autoloader
+			EE_Psr4AutoloaderInit::$psr4_loader->register();
+			// register the base directories for the namespace prefix
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
+			$initialized = true;
+		}
+	}
 
 
 

Spacing +2 added lines, -2 removed lines

@@ -34,13 +34,13 @@
         static $initialized = false;
         if ( ! $initialized) {
             // instantiate PSR4 autoloader
-			espresso_load_required( 'Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php' );
+			espresso_load_required('Psr4Autoloader', EE_CORE.'Psr4Autoloader.php');
             EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
             // register the autoloader
             EE_Psr4AutoloaderInit::$psr4_loader->register();
             // register the base directories for the namespace prefix
             EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
+            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES.'batch');
             EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
             $initialized = true;
         }

core/services/container/DependencyInjector.php

Spacing +1 added lines, -1 removed lines

@@ -182,7 +182,7 @@
                 is_string($param_name) && isset($ingredients[$param_name])
             ) {
                 // attempt to inject the dependency
-                $resolved_parameters[$index] = $ingredients[ $param_name ];
+                $resolved_parameters[$index] = $ingredients[$param_name];
             } else if (
                 // param is specified in the list of ingredients for this Recipe
                 isset($ingredients[$param_class])

Indentation +220 added lines, -220 removed lines

@@ -8,7 +8,7 @@ 
 use UnexpectedValueException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -26,225 +26,225 @@ 
 class DependencyInjector implements InjectorInterface
 {
 
-    /**
-     * @var CoffeePotInterface $coffee_pot
-     */
-    private $coffee_pot;
-
-    /**
-     * @var EEH_Array $array_helper
-     */
-    private $array_helper;
-
-    /**
-     * @var ReflectionClass[] $reflectors
-     */
-    private $reflectors;
-
-    /**
-     * @var ReflectionMethod[] $constructors
-     */
-    private $constructors;
-
-    /**
-     * @var ReflectionParameter[] $parameters
-     */
-    private $parameters;
-
-
-
-    /**
-     * DependencyInjector constructor
-     *
-     * @param CoffeePotInterface $coffee_pot
-     * @param EEH_Array         $array_helper
-     */
-    public function __construct(CoffeePotInterface $coffee_pot, EEH_Array $array_helper)
-    {
-        $this->coffee_pot = $coffee_pot;
-        $this->array_helper = $array_helper;
-    }
-
-
-
-    /**
-     * getReflectionClass
-     * checks if a ReflectionClass object has already been generated for a class
-     * and returns that instead of creating a new one
-     *
-     * @param string $class_name
-     * @return ReflectionClass
-     */
-    public function getReflectionClass($class_name)
-    {
-        if (
-            ! isset($this->reflectors[$class_name])
-            || ! $this->reflectors[$class_name] instanceof ReflectionClass
-        ) {
-            $this->reflectors[$class_name] = new ReflectionClass($class_name);
-        }
-        return $this->reflectors[$class_name];
-    }
-
-
-
-    /**
-     * getConstructor
-     * checks if a ReflectionMethod object has already been generated for the class constructor
-     * and returns that instead of creating a new one
-     *
-     * @param ReflectionClass $reflector
-     * @return ReflectionMethod
-     */
-    protected function getConstructor(ReflectionClass $reflector)
-    {
-        if (
-            ! isset($this->constructors[$reflector->getName()])
-            || ! $this->constructors[$reflector->getName()] instanceof ReflectionMethod
-        ) {
-            $this->constructors[$reflector->getName()] = $reflector->getConstructor();
-        }
-        return $this->constructors[$reflector->getName()];
-    }
-
-
-
-    /**
-     * getParameters
-     * checks if an array of ReflectionParameter objects has already been generated for the class constructor
-     * and returns that instead of creating a new one
-     *
-     * @param ReflectionMethod $constructor
-     * @return ReflectionParameter[]
-     */
-    protected function getParameters(ReflectionMethod $constructor)
-    {
-        if ( ! isset($this->parameters[$constructor->class])) {
-            $this->parameters[$constructor->class] = $constructor->getParameters();
-        }
-        return $this->parameters[$constructor->class];
-    }
-
-
-
-    /**
-     * resolveDependencies
-     * examines the constructor for the requested class to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     * PLZ NOTE: this is achieved by type hinting the constructor params
-     * For example:
-     *        if attempting to load a class "Foo" with the following constructor:
-     *        __construct( Bar $bar_class, Fighter $grohl_class )
-     *        then $bar_class and $grohl_class will be added to the $arguments array,
-     *        but only IF they are NOT already present in the incoming arguments array,
-     *        and the correct classes can be loaded
-     *
-     * @param RecipeInterface  $recipe
-     * @param ReflectionClass $reflector
-     * @param array            $arguments
-     * @return array
-     * @throws UnexpectedValueException
-     */
-    public function resolveDependencies(RecipeInterface $recipe, ReflectionClass $reflector, $arguments = array())
-    {
-        // if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : array($arguments);
-        $resolved_parameters = array();
-        // let's examine the constructor
-        // let's examine the constructor
-        $constructor = $this->getConstructor($reflector);
-        // whu? huh? nothing?
-        if ( ! $constructor) {
-            return $arguments;
-        }
-        // get constructor parameters
-        $params = $this->getParameters($constructor);
-        if (empty($params)) {
-            return $resolved_parameters;
-        }
-        $ingredients = $recipe->ingredients();
-        // and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
-        $argument_keys = array_keys($arguments);
-        // now loop thru all of the constructors expected parameters
-        foreach ($params as $index => $param) {
-            if ( ! $param instanceof ReflectionParameter) {
-                continue;
-            }
-            // is this a dependency for a specific class ?
-            $param_class = $param->getClass() ? $param->getClass()->name : '';
-            $param_name = $param->getName() ? $param->getName() : '';
-            if (
-                // param is not a class but is specified in the list of ingredients for this Recipe
-                is_string($param_name) && isset($ingredients[$param_name])
-            ) {
-                // attempt to inject the dependency
-                $resolved_parameters[$index] = $ingredients[ $param_name ];
-            } else if (
-                // param is specified in the list of ingredients for this Recipe
-                isset($ingredients[$param_class])
-            ) {
-                // attempt to inject the dependency
-                $resolved_parameters[$index] = $this->injectDependency($reflector, $ingredients[$param_class]);
-            } else if (
-                // param is not even a class
-                empty($param_class)
-                // and something already exists in the incoming arguments for this param
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-            ) {
-                // add parameter from incoming arguments
-                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
-            } else if (
-                // parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
-                ! empty($param_class)
-                && isset($argument_keys[$index], $arguments[$argument_keys[$index]])
-                && $arguments[$argument_keys[$index]] instanceof $param_class
-            ) {
-                // add parameter from incoming arguments
-                $resolved_parameters[$index] = $arguments[$argument_keys[$index]];
-            } else if (
-                // parameter is type hinted as a class, and should be injected
-                ! empty($param_class)
-            ) {
-                // attempt to inject the dependency
-                $resolved_parameters[$index] = $this->injectDependency($reflector, $param_class);
-            } else if ($param->isOptional()) {
-                $resolved_parameters[$index] = $param->getDefaultValue();
-            } else {
-                $resolved_parameters[$index] = null;
-            }
-        }
-        return $resolved_parameters;
-    }
-
-
-
-    /**
-     * @param ReflectionClass $reflector
-     * @param string          $param_class
-     * @return mixed
-     * @throws UnexpectedValueException
-     */
-    private function injectDependency(ReflectionClass $reflector, $param_class)
-    {
-        $dependency = $this->coffee_pot->brew($param_class);
-        if ( ! $dependency instanceof $param_class) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
-                        'event_espresso'
-                    ),
-                    $param_class,
-                    $reflector->getName()
-                )
-            );
-        }
-        return $dependency;
-    }
+	/**
+	 * @var CoffeePotInterface $coffee_pot
+	 */
+	private $coffee_pot;
+
+	/**
+	 * @var EEH_Array $array_helper
+	 */
+	private $array_helper;
+
+	/**
+	 * @var ReflectionClass[] $reflectors
+	 */
+	private $reflectors;
+
+	/**
+	 * @var ReflectionMethod[] $constructors
+	 */
+	private $constructors;
+
+	/**
+	 * @var ReflectionParameter[] $parameters
+	 */
+	private $parameters;
+
+
+
+	/**
+	 * DependencyInjector constructor
+	 *
+	 * @param CoffeePotInterface $coffee_pot
+	 * @param EEH_Array         $array_helper
+	 */
+	public function __construct(CoffeePotInterface $coffee_pot, EEH_Array $array_helper)
+	{
+		$this->coffee_pot = $coffee_pot;
+		$this->array_helper = $array_helper;
+	}
+
+
+
+	/**
+	 * getReflectionClass
+	 * checks if a ReflectionClass object has already been generated for a class
+	 * and returns that instead of creating a new one
+	 *
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 */
+	public function getReflectionClass($class_name)
+	{
+		if (
+			! isset($this->reflectors[$class_name])
+			|| ! $this->reflectors[$class_name] instanceof ReflectionClass
+		) {
+			$this->reflectors[$class_name] = new ReflectionClass($class_name);
+		}
+		return $this->reflectors[$class_name];
+	}
+
+
+
+	/**
+	 * getConstructor
+	 * checks if a ReflectionMethod object has already been generated for the class constructor
+	 * and returns that instead of creating a new one
+	 *
+	 * @param ReflectionClass $reflector
+	 * @return ReflectionMethod
+	 */
+	protected function getConstructor(ReflectionClass $reflector)
+	{
+		if (
+			! isset($this->constructors[$reflector->getName()])
+			|| ! $this->constructors[$reflector->getName()] instanceof ReflectionMethod
+		) {
+			$this->constructors[$reflector->getName()] = $reflector->getConstructor();
+		}
+		return $this->constructors[$reflector->getName()];
+	}
+
+
+
+	/**
+	 * getParameters
+	 * checks if an array of ReflectionParameter objects has already been generated for the class constructor
+	 * and returns that instead of creating a new one
+	 *
+	 * @param ReflectionMethod $constructor
+	 * @return ReflectionParameter[]
+	 */
+	protected function getParameters(ReflectionMethod $constructor)
+	{
+		if ( ! isset($this->parameters[$constructor->class])) {
+			$this->parameters[$constructor->class] = $constructor->getParameters();
+		}
+		return $this->parameters[$constructor->class];
+	}
+
+
+
+	/**
+	 * resolveDependencies
+	 * examines the constructor for the requested class to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 * PLZ NOTE: this is achieved by type hinting the constructor params
+	 * For example:
+	 *        if attempting to load a class "Foo" with the following constructor:
+	 *        __construct( Bar $bar_class, Fighter $grohl_class )
+	 *        then $bar_class and $grohl_class will be added to the $arguments array,
+	 *        but only IF they are NOT already present in the incoming arguments array,
+	 *        and the correct classes can be loaded
+	 *
+	 * @param RecipeInterface  $recipe
+	 * @param ReflectionClass $reflector
+	 * @param array            $arguments
+	 * @return array
+	 * @throws UnexpectedValueException
+	 */
+	public function resolveDependencies(RecipeInterface $recipe, ReflectionClass $reflector, $arguments = array())
+	{
+		// if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->array_helper->is_array_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: array($arguments);
+		$resolved_parameters = array();
+		// let's examine the constructor
+		// let's examine the constructor
+		$constructor = $this->getConstructor($reflector);
+		// whu? huh? nothing?
+		if ( ! $constructor) {
+			return $arguments;
+		}
+		// get constructor parameters
+		$params = $this->getParameters($constructor);
+		if (empty($params)) {
+			return $resolved_parameters;
+		}
+		$ingredients = $recipe->ingredients();
+		// and the keys for the incoming arguments array so that we can compare existing arguments with what is expected
+		$argument_keys = array_keys($arguments);
+		// now loop thru all of the constructors expected parameters
+		foreach ($params as $index => $param) {
+			if ( ! $param instanceof ReflectionParameter) {
+				continue;
+			}
+			// is this a dependency for a specific class ?
+			$param_class = $param->getClass() ? $param->getClass()->name : '';
+			$param_name = $param->getName() ? $param->getName() : '';
+			if (
+				// param is not a class but is specified in the list of ingredients for this Recipe
+				is_string($param_name) && isset($ingredients[$param_name])
+			) {
+				// attempt to inject the dependency
+				$resolved_parameters[$index] = $ingredients[ $param_name ];
+			} else if (
+				// param is specified in the list of ingredients for this Recipe
+				isset($ingredients[$param_class])
+			) {
+				// attempt to inject the dependency
+				$resolved_parameters[$index] = $this->injectDependency($reflector, $ingredients[$param_class]);
+			} else if (
+				// param is not even a class
+				empty($param_class)
+				// and something already exists in the incoming arguments for this param
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+			) {
+				// add parameter from incoming arguments
+				$resolved_parameters[$index] = $arguments[$argument_keys[$index]];
+			} else if (
+				// parameter is type hinted as a class, exists as an incoming argument, AND it's the correct class
+				! empty($param_class)
+				&& isset($argument_keys[$index], $arguments[$argument_keys[$index]])
+				&& $arguments[$argument_keys[$index]] instanceof $param_class
+			) {
+				// add parameter from incoming arguments
+				$resolved_parameters[$index] = $arguments[$argument_keys[$index]];
+			} else if (
+				// parameter is type hinted as a class, and should be injected
+				! empty($param_class)
+			) {
+				// attempt to inject the dependency
+				$resolved_parameters[$index] = $this->injectDependency($reflector, $param_class);
+			} else if ($param->isOptional()) {
+				$resolved_parameters[$index] = $param->getDefaultValue();
+			} else {
+				$resolved_parameters[$index] = null;
+			}
+		}
+		return $resolved_parameters;
+	}
+
+
+
+	/**
+	 * @param ReflectionClass $reflector
+	 * @param string          $param_class
+	 * @return mixed
+	 * @throws UnexpectedValueException
+	 */
+	private function injectDependency(ReflectionClass $reflector, $param_class)
+	{
+		$dependency = $this->coffee_pot->brew($param_class);
+		if ( ! $dependency instanceof $param_class) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Could not resolve dependency for "%1$s" for the "%2$s" class constructor.',
+						'event_espresso'
+					),
+					$param_class,
+					$reflector->getName()
+				)
+			);
+		}
+		return $dependency;
+	}
 
 }
 // End of file DependencyInjector.php

core/services/container/Recipe.php

Indentation +321 added lines, -321 removed lines

@@ -8,7 +8,7 @@ 
 use RuntimeException;
 
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,326 +24,326 @@ 
 class Recipe implements RecipeInterface
 {
 
-    /**
-     * A default Recipe to use if none is specified for a class
-     */
-    const DEFAULT_ID = '*';
-
-    /**
-     * Identifier for the entity class to be constructed.
-     * Typically a Fully Qualified Class Name
-     *
-     * @var string $identifier
-     */
-    private $identifier;
-
-    /**
-     * Fully Qualified Class Name
-     *
-     * @var string $fqcn
-     */
-    private $fqcn;
-
-    /**
-     * a dependency class map array
-     * If a Recipe is for a single class (or group of classes that shares the EXACT SAME constructor arguments),
-     * and that class type hints for an interface, then this property allows you to configure what dependencies
-     * get used when instantiating the class.
-     * For example:
-     *  There's a class called Coffee, and one of its constructor arguments is BeanInterface
-     *  There are two implementations of BeanInterface: HonduranBean, and KenyanBean
-     *  We want one Coffee object to use HonduranBean for its BeanInterface,
-     *  and the 2nd Coffee object to use KenyanBean for its BeanInterface.
-     *  To do this, we need to create two Recipes:
-     *      one with an identifier of 'HonduranCoffee' using the following ingredients :
-     *          array('BeanInterface' => 'HonduranBean')
-     *      and the other with an identifier of 'KenyanCoffee' using the following ingredients :
-     *          array('BeanInterface' => 'KenyanBean')
-     *  Then, whenever the CoffeeShop brews an instance of HonduranCoffee,
-     *  an instance of HonduranBean will get injected for the BeanInterface dependency,
-     *  and whenever the CoffeeShop brews an instance of KenyanCoffee,
-     *  an instance of KenyanBean will get injected for the BeanInterface dependency
-     *
-     * @var array $ingredients
-     */
-    private $ingredients = array();
-
-    /**
-     * one of the class constants from CoffeeShop:
-     *  CoffeeMaker::BREW_NEW - creates a new instance
-     *  CoffeeMaker::BREW_SHARED - creates a shared instance
-     *  CoffeeMaker::BREW_LOAD_ONLY - loads but does not instantiate
-     *
-     * @var string $type
-     */
-    private $type;
-
-    /**
-     * class name aliases - typically a Fully Qualified Interface that the class implements
-     * identifiers passed to the CoffeeShop will be run through the filters to find the correct class name
-     *
-     * @var array $filters
-     */
-    private $filters = array();
-
-    /**
-     * array of full server filepaths to files that may contain the class
-     *
-     * @var array $paths
-     */
-    private $paths = array();
-
-
-
-    /**
-     * Recipe constructor.
-     *
-     * @param string $identifier    class identifier, can be an alias, or FQCN, or whatever
-     * @param string $fqcn          \Fully\Qualified\ClassName, optional if $identifier is FQCN
-     * @param array  $ingredients   array of dependencies that can not be resolved automatically,
-     *                              used for resolving concrete classes for type hinted interfaces
-     *                              for the dependencies of THIS class
-     * @param string $type          recipe type: one of the class constants on
-     *                              \EventEspresso\core\services\container\CoffeeMaker
-     * @param array  $filters       array of class aliases, or class interfaces
-     *                              this works somewhat opposite to the $ingredients array above,
-     *                              in that this array specifies interfaces or aliases
-     *                              that this Recipe can be used for when resolving OTHER class's dependencies
-     * @param array  $paths         if class can not be loaded via PSR-4 autoloading,
-     *                              then supply a filepath, or array of filepaths, so that it can be included
-     * @throws InvalidIdentifierException
-     * @throws RuntimeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-	    $identifier,
-        $fqcn = '',
-        array $filters = array(),
-        array $ingredients = array(),
-	    $type = CoffeeMaker::BREW_NEW,
-        array $paths = array()
-    )
-    {
-        $this->setIdentifier($identifier);
-        $this->setFilters($filters);
-        $this->setIngredients($ingredients);
-        $this->setType($type);
-        $this->setPaths($paths);
-        $this->setFqcn($fqcn);
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function fqcn()
-    {
-        return $this->fqcn;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function filters()
-    {
-        return $this->filters;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function ingredients()
-    {
-        return $this->ingredients;
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-
-    /**
-     * @return array
-     */
-    public function paths()
-    {
-        return $this->paths;
-    }
-
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the Recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     * @throws InvalidIdentifierException
-     */
-    public function setIdentifier($identifier)
-    {
-        if ( ! is_string($identifier) || empty($identifier)) {
-            throw new InvalidIdentifierException(
-                is_object($identifier) ? get_class($identifier) : gettype($identifier),
-                __('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
-            );
-        }
-        $this->identifier = $identifier;
-    }
-
-
-
-    /**
-     * Ensures incoming string is a valid Fully Qualified Class Name,
-     * except if this is the default wildcard Recipe ( * ),
-     * or it's NOT an actual FQCN because the Recipe is using filepaths
-     * for classes that are not PSR-4 compatible
-     * PLZ NOTE:
-     *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
-     *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
-     *
-     * @param string $fqcn
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidInterfaceException
-     */
-    public function setFqcn($fqcn)
-    {
-	    $fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
-        if ( ! is_string($fqcn)) {
-            throw new InvalidDataTypeException(
-                '$fqcn',
-                is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
-                __('string (Fully\Qualified\ClassName)', 'event_espresso')
-            );
-        }
-        $fqcn = ltrim($fqcn, '\\');
-        if (
-            $fqcn !== Recipe::DEFAULT_ID
-            && ! empty($fqcn)
-            && empty($this->paths)
-            && ! (class_exists($fqcn) || interface_exists($fqcn))
-        ) {
-            throw new InvalidClassException($fqcn);
-        }
-        $this->fqcn = $fqcn;
-    }
-
-
-
-    /**
-     * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
-     *                              example:
-     *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
-     * @throws InvalidDataTypeException
-     */
-    public function setIngredients(array $ingredients)
-    {
-        if (empty($ingredients)) {
-            return;
-        }
-        if ( ! is_array($ingredients)) {
-            throw new InvalidDataTypeException(
-                '$ingredients',
-                is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
-                __('array of class dependencies', 'event_espresso')
-            );
-        }
-        $this->ingredients = array_merge($this->ingredients, $ingredients);
-    }
-
-
-    /**
-     * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
-     * @throws InvalidIdentifierException
-     */
-    public function setType($type = CoffeeMaker::BREW_NEW)
-    {
-        $this->type = CoffeeMaker::validateType($type);
-    }
-
-
-
-    /**
-     * @param array $filters    an array of filters where keys are the aliases and values are the FQCNs
-     *                          example:
-     *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
-     * @throws InvalidDataTypeException
-     */
-    public function setFilters(array $filters)
-    {
-        if (empty($filters)) {
-            return;
-        }
-        if ( ! is_array($filters)) {
-            throw new InvalidDataTypeException(
-                '$filters',
-                is_object($filters) ? get_class($filters) : gettype($filters),
-                __('array of class aliases', 'event_espresso')
-            );
-        }
-        $this->filters = array_merge($this->filters, $filters);
-    }
-
-
-
-    /**
-     * Ensures incoming paths is a valid filepath, or array of valid filepaths,
-     * and merges them in with any existing filepaths
-     * PLZ NOTE:
-     *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
-     *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
-     *
-     * @param string|array $paths
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     */
-    public function setPaths($paths = array())
-    {
-        if (empty($paths)) {
-            return;
-        }
-        if ( ! (is_string($paths) || is_array($paths))) {
-            throw new InvalidDataTypeException(
-                '$path',
-                is_object($paths) ? get_class($paths) : gettype($paths),
-                __('string or array of strings (full server filepath(s))', 'event_espresso')
-            );
-        }
-        $paths = (array)$paths;
-        foreach ($paths as $path) {
-            if (strpos($path, '*') === false && ! is_readable($path)) {
-                throw new RuntimeException(
-                    sprintf(
-                        __('The following filepath is not readable: "%1$s"', 'event_espresso'),
-                        $path
-                    )
-                );
-            }
-        }
-        $this->paths = array_merge($this->paths, $paths);
-    }
+	/**
+	 * A default Recipe to use if none is specified for a class
+	 */
+	const DEFAULT_ID = '*';
+
+	/**
+	 * Identifier for the entity class to be constructed.
+	 * Typically a Fully Qualified Class Name
+	 *
+	 * @var string $identifier
+	 */
+	private $identifier;
+
+	/**
+	 * Fully Qualified Class Name
+	 *
+	 * @var string $fqcn
+	 */
+	private $fqcn;
+
+	/**
+	 * a dependency class map array
+	 * If a Recipe is for a single class (or group of classes that shares the EXACT SAME constructor arguments),
+	 * and that class type hints for an interface, then this property allows you to configure what dependencies
+	 * get used when instantiating the class.
+	 * For example:
+	 *  There's a class called Coffee, and one of its constructor arguments is BeanInterface
+	 *  There are two implementations of BeanInterface: HonduranBean, and KenyanBean
+	 *  We want one Coffee object to use HonduranBean for its BeanInterface,
+	 *  and the 2nd Coffee object to use KenyanBean for its BeanInterface.
+	 *  To do this, we need to create two Recipes:
+	 *      one with an identifier of 'HonduranCoffee' using the following ingredients :
+	 *          array('BeanInterface' => 'HonduranBean')
+	 *      and the other with an identifier of 'KenyanCoffee' using the following ingredients :
+	 *          array('BeanInterface' => 'KenyanBean')
+	 *  Then, whenever the CoffeeShop brews an instance of HonduranCoffee,
+	 *  an instance of HonduranBean will get injected for the BeanInterface dependency,
+	 *  and whenever the CoffeeShop brews an instance of KenyanCoffee,
+	 *  an instance of KenyanBean will get injected for the BeanInterface dependency
+	 *
+	 * @var array $ingredients
+	 */
+	private $ingredients = array();
+
+	/**
+	 * one of the class constants from CoffeeShop:
+	 *  CoffeeMaker::BREW_NEW - creates a new instance
+	 *  CoffeeMaker::BREW_SHARED - creates a shared instance
+	 *  CoffeeMaker::BREW_LOAD_ONLY - loads but does not instantiate
+	 *
+	 * @var string $type
+	 */
+	private $type;
+
+	/**
+	 * class name aliases - typically a Fully Qualified Interface that the class implements
+	 * identifiers passed to the CoffeeShop will be run through the filters to find the correct class name
+	 *
+	 * @var array $filters
+	 */
+	private $filters = array();
+
+	/**
+	 * array of full server filepaths to files that may contain the class
+	 *
+	 * @var array $paths
+	 */
+	private $paths = array();
+
+
+
+	/**
+	 * Recipe constructor.
+	 *
+	 * @param string $identifier    class identifier, can be an alias, or FQCN, or whatever
+	 * @param string $fqcn          \Fully\Qualified\ClassName, optional if $identifier is FQCN
+	 * @param array  $ingredients   array of dependencies that can not be resolved automatically,
+	 *                              used for resolving concrete classes for type hinted interfaces
+	 *                              for the dependencies of THIS class
+	 * @param string $type          recipe type: one of the class constants on
+	 *                              \EventEspresso\core\services\container\CoffeeMaker
+	 * @param array  $filters       array of class aliases, or class interfaces
+	 *                              this works somewhat opposite to the $ingredients array above,
+	 *                              in that this array specifies interfaces or aliases
+	 *                              that this Recipe can be used for when resolving OTHER class's dependencies
+	 * @param array  $paths         if class can not be loaded via PSR-4 autoloading,
+	 *                              then supply a filepath, or array of filepaths, so that it can be included
+	 * @throws InvalidIdentifierException
+	 * @throws RuntimeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		$identifier,
+		$fqcn = '',
+		array $filters = array(),
+		array $ingredients = array(),
+		$type = CoffeeMaker::BREW_NEW,
+		array $paths = array()
+	)
+	{
+		$this->setIdentifier($identifier);
+		$this->setFilters($filters);
+		$this->setIngredients($ingredients);
+		$this->setType($type);
+		$this->setPaths($paths);
+		$this->setFqcn($fqcn);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function fqcn()
+	{
+		return $this->fqcn;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function filters()
+	{
+		return $this->filters;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function ingredients()
+	{
+		return $this->ingredients;
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	public function paths()
+	{
+		return $this->paths;
+	}
+
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the Recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @throws InvalidIdentifierException
+	 */
+	public function setIdentifier($identifier)
+	{
+		if ( ! is_string($identifier) || empty($identifier)) {
+			throw new InvalidIdentifierException(
+				is_object($identifier) ? get_class($identifier) : gettype($identifier),
+				__('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
+			);
+		}
+		$this->identifier = $identifier;
+	}
+
+
+
+	/**
+	 * Ensures incoming string is a valid Fully Qualified Class Name,
+	 * except if this is the default wildcard Recipe ( * ),
+	 * or it's NOT an actual FQCN because the Recipe is using filepaths
+	 * for classes that are not PSR-4 compatible
+	 * PLZ NOTE:
+	 *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
+	 *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
+	 *
+	 * @param string $fqcn
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidInterfaceException
+	 */
+	public function setFqcn($fqcn)
+	{
+		$fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
+		if ( ! is_string($fqcn)) {
+			throw new InvalidDataTypeException(
+				'$fqcn',
+				is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
+				__('string (Fully\Qualified\ClassName)', 'event_espresso')
+			);
+		}
+		$fqcn = ltrim($fqcn, '\\');
+		if (
+			$fqcn !== Recipe::DEFAULT_ID
+			&& ! empty($fqcn)
+			&& empty($this->paths)
+			&& ! (class_exists($fqcn) || interface_exists($fqcn))
+		) {
+			throw new InvalidClassException($fqcn);
+		}
+		$this->fqcn = $fqcn;
+	}
+
+
+
+	/**
+	 * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
+	 *                              example:
+	 *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
+	 * @throws InvalidDataTypeException
+	 */
+	public function setIngredients(array $ingredients)
+	{
+		if (empty($ingredients)) {
+			return;
+		}
+		if ( ! is_array($ingredients)) {
+			throw new InvalidDataTypeException(
+				'$ingredients',
+				is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
+				__('array of class dependencies', 'event_espresso')
+			);
+		}
+		$this->ingredients = array_merge($this->ingredients, $ingredients);
+	}
+
+
+	/**
+	 * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
+	 * @throws InvalidIdentifierException
+	 */
+	public function setType($type = CoffeeMaker::BREW_NEW)
+	{
+		$this->type = CoffeeMaker::validateType($type);
+	}
+
+
+
+	/**
+	 * @param array $filters    an array of filters where keys are the aliases and values are the FQCNs
+	 *                          example:
+	 *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFilters(array $filters)
+	{
+		if (empty($filters)) {
+			return;
+		}
+		if ( ! is_array($filters)) {
+			throw new InvalidDataTypeException(
+				'$filters',
+				is_object($filters) ? get_class($filters) : gettype($filters),
+				__('array of class aliases', 'event_espresso')
+			);
+		}
+		$this->filters = array_merge($this->filters, $filters);
+	}
+
+
+
+	/**
+	 * Ensures incoming paths is a valid filepath, or array of valid filepaths,
+	 * and merges them in with any existing filepaths
+	 * PLZ NOTE:
+	 *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
+	 *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
+	 *
+	 * @param string|array $paths
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 */
+	public function setPaths($paths = array())
+	{
+		if (empty($paths)) {
+			return;
+		}
+		if ( ! (is_string($paths) || is_array($paths))) {
+			throw new InvalidDataTypeException(
+				'$path',
+				is_object($paths) ? get_class($paths) : gettype($paths),
+				__('string or array of strings (full server filepath(s))', 'event_espresso')
+			);
+		}
+		$paths = (array)$paths;
+		foreach ($paths as $path) {
+			if (strpos($path, '*') === false && ! is_readable($path)) {
+				throw new RuntimeException(
+					sprintf(
+						__('The following filepath is not readable: "%1$s"', 'event_espresso'),
+						$path
+					)
+				);
+			}
+		}
+		$this->paths = array_merge($this->paths, $paths);
+	}
 
 
 

Spacing +1 added lines, -1 removed lines

@@ -331,7 +331,7 @@
                 __('string or array of strings (full server filepath(s))', 'event_espresso')
             );
         }
-        $paths = (array)$paths;
+        $paths = (array) $paths;
         foreach ($paths as $path) {
             if (strpos($path, '*') === false && ! is_readable($path)) {
                 throw new RuntimeException(

core/interfaces/EEI_Request_Stack_Core_App.interface.php

Indentation +8 added lines, -8 removed lines

@@ -9,14 +9,14 @@
 interface EEI_Request_Stack_Core_App
 {
 
-    /**
-     * gives the core app a chance to handle the response after the request stack has fully processed
-     *
-     * @deprecated 4.9.53
-     * @param EE_Request $request
-     * @param EE_Response   $response
-     */
-    public function handle_response(EE_Request $request, EE_Response $response);
+	/**
+	 * gives the core app a chance to handle the response after the request stack has fully processed
+	 *
+	 * @deprecated 4.9.53
+	 * @param EE_Request $request
+	 * @param EE_Response   $response
+	 */
+	public function handle_response(EE_Request $request, EE_Response $response);
 
 }
 // End of file EEI_Request_Stack_Core_App.interface.php

core/interfaces/EEI_Request_Decorator.interface.php

Indentation +18 added lines, -18 removed lines

@@ -9,24 +9,24 @@
 interface EEI_Request_Decorator
 {
 
-    /**
-     * converts a Request to a Response
-     * can perform their logic either before or after the core application has run like so:
-     *    public function handle_request( EE_Request $request, EE_Response $response ) {
-     *        $this->request = $request;
-     *        $this->response = $response;
-     *      // logic performed BEFORE core app has run
-     *      $this->process_request_stack( $this->request, $this->response );
-     *      // logic performed AFTER core app has run
-     *      return $response;
-     *    }
-     *
-     * @deprecated 4.9.53
-     * @param    EE_Request $request
-     * @param    EE_Response   $response
-     * @return    EE_Response
-     */
-    public function handle_request(EE_Request $request, EE_Response $response);
+	/**
+	 * converts a Request to a Response
+	 * can perform their logic either before or after the core application has run like so:
+	 *    public function handle_request( EE_Request $request, EE_Response $response ) {
+	 *        $this->request = $request;
+	 *        $this->response = $response;
+	 *      // logic performed BEFORE core app has run
+	 *      $this->process_request_stack( $this->request, $this->response );
+	 *      // logic performed AFTER core app has run
+	 *      return $response;
+	 *    }
+	 *
+	 * @deprecated 4.9.53
+	 * @param    EE_Request $request
+	 * @param    EE_Response   $response
+	 * @return    EE_Response
+	 */
+	public function handle_request(EE_Request $request, EE_Response $response);
 
 
 }