eventespresso / event-espresso-core

core/domain/services/cron/jobs/GarbageCollection.php

Indentation +46 added lines, -46 removed lines

@@ -18,54 +18,54 @@
 
 class GarbageCollection extends CronJob
 {
-    public function setHooks(): void
-    {
-        add_action(
-            'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
-            [$this, 'cleanUpJunkTransactions']
-        );
-        add_action(
-            'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
-            [$this, 'cleanUpOldGatewayLogs']
-        );
-    }
+	public function setHooks(): void
+	{
+		add_action(
+			'AHEE__EE_Cron_Tasks__clean_up_junk_transactions',
+			[$this, 'cleanUpJunkTransactions']
+		);
+		add_action(
+			'AHEE_EE_Cron_Tasks__clean_out_old_gateway_logs',
+			[$this, 'cleanUpOldGatewayLogs']
+		);
+	}
 
 
-    /**
-     * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
-     * which is set up during activation to run on an hourly cron
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws ReflectionException
-     */
-    public function cleanUpJunkTransactions(): void
-    {
-        if (DbStatus::isOnline()) {
-            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();
-        }
-    }
+	/**
+	 * callback for 'AHEE__EE_Cron_Tasks__clean_up_junk_transactions'
+	 * which is set up during activation to run on an hourly cron
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws ReflectionException
+	 */
+	public function cleanUpJunkTransactions(): void
+	{
+		if (DbStatus::isOnline()) {
+			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 ReflectionException
-     * @throws Exception
-     */
-    public function cleanUpOldGatewayLogs(): void
-    {
-        if (DbStatus::isOnline()) {
-            $reg_config               = $this->loader->getShared(EE_Registration_Config::class);
-            $time_diff_for_comparison = apply_filters(
-                'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
-                '-' . $reg_config->gateway_log_lifespan
-            );
-            EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
-        }
-    }
+	/**
+	 * 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 ReflectionException
+	 * @throws Exception
+	 */
+	public function cleanUpOldGatewayLogs(): void
+	{
+		if (DbStatus::isOnline()) {
+			$reg_config               = $this->loader->getShared(EE_Registration_Config::class);
+			$time_diff_for_comparison = apply_filters(
+				'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
+				'-' . $reg_config->gateway_log_lifespan
+			);
+			EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -63,7 +63,7 @@
             $reg_config               = $this->loader->getShared(EE_Registration_Config::class);
             $time_diff_for_comparison = apply_filters(
                 'FHEE__EE_Cron_Tasks__clean_out_old_gateway_logs__time_diff_for_comparison',
-                '-' . $reg_config->gateway_log_lifespan
+                '-'.$reg_config->gateway_log_lifespan
             );
             EEM_Change_Log::instance()->delete_gateway_logs_older_than(new DateTime($time_diff_for_comparison));
         }

espresso.php

Indentation +107 added lines, -107 removed lines

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

core/libraries/payment_methods/EE_PMT_Base.lib.php

Indentation +931 added lines, -931 removed lines

@@ -16,935 +16,935 @@
  */
 abstract class EE_PMT_Base
 {
-    const onsite  = 'on-site';
-
-    const offsite = 'off-site';
-
-    const offline = 'off-line';
-
-    protected ?EE_Payment_Method $_pm_instance = null;
-
-    protected ?EE_Gateway $_gateway = null;
-
-    protected ?EE_Payment_Method_Form $_settings_form = null;
-
-    protected ?EE_Form_Section_Proper $_billing_form = null;
-
-    protected bool $_cache_billing_form = true;
-
-    protected ?bool $_has_billing_form;
-
-    protected bool $_requires_https = false;
-
-    /**
-     * String of the absolute path to the folder containing this file, with a trailing slash.
-     * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
-     *
-     * @var string|null
-     */
-    protected $_file_folder = null;
-
-    /**
-     * String to the absolute URL to this file (useful for getting its web-accessible resources
-     * like images, js, or css)
-     *
-     * @var string|null
-     */
-    protected $_file_url = null;
-
-    /**
-     * Pretty name for the payment method
-     *
-     * @var string|null
-     */
-    protected $_pretty_name = null;
-
-    /**
-     * @var string|null
-     */
-    protected $_default_button_url = null;
-
-    /**
-     * @var string|null
-     */
-    protected $_default_description = null;
-
-    /**
-     * @var string|null
-     */
-    protected $_template_path = null;
-
-
-    /**
-     * @param EE_Payment_Method|null $pm_instance
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function __construct($pm_instance = null)
-    {
-        if ($pm_instance instanceof EE_Payment_Method) {
-            $this->set_instance($pm_instance);
-        }
-        if ($this->_gateway) {
-            $this->_gateway->set_payment_model(EEM_Payment::instance());
-            $this->_gateway->set_payment_log(EEM_Change_Log::instance());
-            $this->_gateway->set_template_helper(new EEH_Template());
-            $this->_gateway->set_line_item_helper(new EEH_Line_Item());
-            $this->_gateway->set_money_helper(new EEH_Money());
-            $this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
-            $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
-            do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
-        }
-        if (! isset($this->_has_billing_form)) {
-            // by default, On Site gateways have a billing form
-            if ($this->payment_occurs() == EE_PMT_Base::onsite) {
-                $this->set_has_billing_form(true);
-            } else {
-                $this->set_has_billing_form(false);
-            }
-        }
-
-        if (! $this->_pretty_name) {
-            throw new EE_Error(
-                esc_html__(
-                    'You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized',
-                    'event_espresso'
-                )
-            );
-        }
-        // if the child didn't specify a default button, use the credit card one
-        if ($this->_default_button_url === null) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods/pay-by-credit-card.png';
-        }
-    }
-
-
-    /**
-     * @param bool|int|string $has_billing_form
-     */
-    public function set_has_billing_form($has_billing_form)
-    {
-        $this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * sets the file_folder property
-     */
-    protected function _set_file_folder()
-    {
-        $reflector          = new ReflectionClass(get_class($this));
-        $fn                 = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . '/';
-    }
-
-
-    /**
-     * sets the file URL with a trailing slash for this PMT
-     */
-    protected function _set_file_url()
-    {
-        $plugins_dir_fixed = str_replace('\\', '/', WP_PLUGIN_DIR);
-        $file_folder_fixed = str_replace('\\', '/', $this->file_folder());
-        $file_path         = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
-        $this->_file_url   = set_url_scheme($file_path);
-    }
-
-
-    /**
-     * Gets the default description on all payment methods of this type
-     *
-     * @return string
-     */
-    public function default_description(): ?string
-    {
-        return $this->_default_description;
-    }
-
-
-    /**
-     * Returns the folder containing the PMT child class, with a trailing slash
-     *
-     * @return string
-     */
-    public function file_folder(): ?string
-    {
-        if (! $this->_file_folder) {
-            $this->_set_file_folder();
-        }
-        return $this->_file_folder;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function file_url(): ?string
-    {
-        if (! $this->_file_url) {
-            $this->_set_file_url();
-        }
-        return $this->_file_url;
-    }
-
-
-    /**
-     * Sets the payment method instance this payment method type is for.
-     * Its important teh payment method instance is set before
-     *
-     * @param EE_Payment_Method $payment_method_instance
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_instance(EE_Payment_Method $payment_method_instance)
-    {
-        $this->_pm_instance = $payment_method_instance;
-        // if they have already requested the settings form, make sure its
-        // data matches this model object
-        if ($this->_settings_form) {
-            $this->settings_form()->populate_model_obj($payment_method_instance);
-        }
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->set_settings($payment_method_instance->settings_array());
-        }
-    }
-
-
-    /**
-     * Gets teh form for displaying to admins where they set up the payment method
-     *
-     * @return EE_Payment_Method_Form
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function settings_form(): EE_Payment_Method_Form
-    {
-        if (! $this->_settings_form) {
-            $this->_settings_form = $this->generate_new_settings_form();
-            $this->_settings_form->set_payment_method_type($this);
-            // if we have already assigned a model object to this pmt, make
-            // sure it's reflected in the form we just generated
-            if ($this->_pm_instance) {
-                $this->_settings_form->populate_model_obj($this->_pm_instance);
-            }
-        }
-        return $this->_settings_form;
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     *
-     * @return EE_Payment_Method_Form
-     */
-    abstract public function generate_new_settings_form();
-
-
-    /**
-     * Sets the form for settings. This may be useful if we have already received
-     * a form submission and have form data it in, and want to use it anytime we're showing
-     * this payment method type's settings form later in the request
-     *
-     * @param EE_Payment_Method_Form $form
-     */
-    public function set_settings_form(EE_Payment_Method_Form $form)
-    {
-        $this->_settings_form = $form;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function has_billing_form(): bool
-    {
-        return $this->_has_billing_form;
-    }
-
-
-    /**
-     * Gets the form for displaying to attendees where they can enter their billing info
-     * which will be sent to teh gateway (can be null)
-     *
-     * @param EE_Transaction|null $transaction
-     * @param array               $extra_args
-     * @return EE_Billing_Attendee_Info_Form|EE_Billing_Info_Form|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function billing_form(EE_Transaction $transaction = null, array $extra_args = [])
-    {
-        // has billing form already been regenerated ? or overwrite cache?
-        if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
-            $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
-        }
-        // if we know who the attendee is, and this is a billing form
-        // that uses attendee info, populate it
-        if (
-            apply_filters(
-                'FHEE__populate_billing_form_fields_from_attendee',
-                (
-                    $this->_billing_form instanceof EE_Billing_Attendee_Info_Form
-                    && $transaction instanceof EE_Transaction
-                    && $transaction->primary_registration() instanceof EE_Registration
-                    && $transaction->primary_registration()->attendee() instanceof EE_Attendee
-                ),
-                $this->_billing_form,
-                $transaction
-            )
-        ) {
-            $this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
-        }
-        return $this->_billing_form;
-    }
-
-
-    /**
-     * Creates the billing form for this payment method type
-     *
-     * @param EE_Transaction|null $transaction
-     * @return EE_Billing_Info_Form|null
-     */
-    abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
-
-
-    /**
-     * applies debug data to the form
-     *
-     * @param EE_Billing_Info_Form $billing_form
-     * @return EE_Billing_Info_Form|null
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        return $billing_form;
-    }
-
-
-    /**
-     * Sets the billing form for this payment method type. You may want to use this
-     * if you have form
-     *
-     * @param EE_Billing_Info_Form $form
-     */
-    public function set_billing_form(EE_Billing_Info_Form $form)
-    {
-        $this->_billing_form = $form;
-    }
-
-
-    /**
-     * Returns whether this payment method requires HTTPS to be used
-     *
-     * @return boolean
-     */
-    public function requires_https(): bool
-    {
-        return $this->_requires_https;
-    }
-
-
-    /**
-     * @param EE_Transaction            $transaction
-     * @param float|null                $amount
-     * @param EE_Billing_Info_Form|null $billing_info
-     * @param string|null               $return_url
-     * @param string                    $fail_url
-     * @param string                    $method
-     * @param bool                      $by_admin
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function process_payment(
-        EE_Transaction $transaction,
-        $amount = null,
-        $billing_info = null,
-        $return_url = null,
-        $fail_url = '',
-        $method = EEM_Payment_Method::scope_cart,
-        $by_admin = false
-    ) {
-        $amount = $amount ?: $transaction->remaining();
-        $method = EEM_Payment_Method::instance()->is_valid_scope($method) ? $method : EEM_Payment_Method::scope_cart;
-
-
-        // @todo: add surcharge for the payment method, if any
-        if (! $this->_gateway instanceof EE_Gateway) {
-            // no gateway provided, must be an offline gateway
-            // create a payment object anyways, but don't save it
-            // but if there is billing info, clean it and save it first
-            if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
-                $this->_save_billing_info_to_attendee($billing_info, $transaction);
-            }
-            return EE_Payment::new_instance(
-                [
-                    'STS_ID'        => EEM_Payment::status_id_pending,
-                    'TXN_ID'        => $transaction->ID(),
-                    'PMD_ID'        => $transaction->payment_method_ID(),
-                    'PAY_amount'    => 0.00,
-                    'PAY_timestamp' => time(),
-                ]
-            );
-        }
-
-        $payment = $this->getLastPayment($transaction, $amount, $method);
-        $payment = $this->validatePayment($transaction, $payment, $amount, $method);
-
-        $max_payment_attempts   = apply_filters(
-            'FHEE__EE_PMT_Base__process_payment__max_payment_attempts',
-            5,
-            $transaction
-        );
-        $previous_payment_count = $this->getPreviousPaymentCount($transaction, $amount, $method);
-        // only pass payment to gateway if we haven't exceeded the max attempts
-        $payment = $previous_payment_count < $max_payment_attempts
-            ? $this->passPaymentToGateway($payment, $transaction, $billing_info, $return_url, $fail_url)
-            : $payment;
-
-        // if there is billing info, clean it and save it
-        if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
-            $this->_save_billing_info_to_attendee($billing_info, $transaction);
-        }
-
-        return $payment;
-    }
-
-
-    /**
-     * Checks for any existing payments that are in a failed state for the same TXN, amount, and method
-     *
-     * @param EE_Transaction $transaction
-     * @param float          $amount
-     * @param string         $method
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.28.p
-     */
-    private function getLastPayment(EE_Transaction $transaction, float $amount, string $method): ?EE_Payment
-    {
-        return EEM_Payment::instance()->get_one(
-            [
-                [
-                    'STS_ID'     => EEM_Payment::status_id_failed,
-                    'TXN_ID'     => $transaction->ID(),
-                    'PMD_ID'     => $this->_pm_instance->ID(),
-                    'PAY_source' => $method,
-                    'PAY_amount' => $amount,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * IF the last payment was not a failed payment
-     * (which indicates a payment in progress that has yet to be updated),
-     * then create a new payment, otherwise just return the existing payment,
-     * but save it to ensure it has an ID
-     *
-     * @param EE_Transaction  $transaction
-     * @param EE_Payment|null $payment
-     * @param float           $amount
-     * @param string          $method
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.28.p
-     */
-    private function validatePayment(
-        EE_Transaction $transaction,
-        ?EE_Payment $payment,
-        float $amount,
-        string $method
-    ): EE_Payment {
-        if (! $payment instanceof EE_Payment || ! $payment->is_failed()) {
-            $payment = EE_Payment::new_instance(
-                [
-                    'PAY_amount'           => $amount,
-                    'PAY_details'          => null,
-                    'PAY_extra_accntng'    => null,
-                    'PAY_gateway_response' => null,
-                    'PAY_po_number'        => null,
-                    'PAY_source'           => $method,
-                    'PAY_timestamp'        => time(),
-                    'PAY_txn_id_chq_nmbr'  => null,
-                    'PMD_ID'               => $this->_pm_instance->ID(),
-                    'STS_ID'               => EEM_Payment::status_id_failed,
-                    'TXN_ID'               => $transaction->ID(),
-                ]
-            );
-        }
-        // make sure the payment has been saved to show we started it,
-        // and so it has an ID should the gateway try to log it
-        $payment->save();
-
-        return $payment;
-    }
-
-
-    /**
-     * Checks for any existing payments that are in a failed state for the same TXN, amount, and method
-     *
-     * @param EE_Transaction $transaction
-     * @param float          $amount
-     * @param string         $method
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.28.p
-     */
-    private function getPreviousPaymentCount(EE_Transaction $transaction, float $amount, string $method): int
-    {
-        return EEM_Payment::instance()->count(
-            [
-                [
-                    'STS_ID'     => [
-                        'IN',
-                        [
-                            EEM_Payment::status_id_pending,
-                            EEM_Payment::status_id_cancelled,
-                            EEM_Payment::status_id_declined,
-                            EEM_Payment::status_id_failed,
-                        ],
-                    ],
-                    'TXN_ID'     => $transaction->ID(),
-                    'PMD_ID'     => $this->_pm_instance->ID(),
-                    'PAY_source' => $method,
-                    'PAY_amount' => $amount,
-                ],
-                'order_by' => ['PAY_timestamp' => 'DESC'],
-            ]
-        );
-    }
-
-
-    /**
-     * @param EE_Payment                $payment
-     * @param EE_Transaction            $transaction
-     * @param EE_Billing_Info_Form|null $billing_info
-     * @param string|null               $return_url
-     * @param string|null               $fail_url
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.28.p
-     */
-    private function passPaymentToGateway(
-        EE_Payment $payment,
-        EE_Transaction $transaction,
-        ?EE_Billing_Info_Form $billing_info,
-        ?string $return_url = null,
-        ?string $fail_url = ''
-    ): EE_Payment {
-        $billing_values = $this->_get_billing_values_from_form($billing_info);
-        if ($this->_gateway instanceof EE_Offsite_Gateway) {
-            $payment = $this->_gateway->set_redirection_info(
-                $payment,
-                $billing_values,
-                $return_url,
-                EE_Config::instance()->core->txn_page_url(
-                    [
-                        'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
-                        'ee_payment_method' => $this->_pm_instance->slug(),
-                    ]
-                ),
-                $fail_url
-            );
-            $payment->save();
-        } elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
-            $payment = $this->_gateway->do_direct_payment($payment, $billing_values);
-            $payment->save();
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
-                        'event_espresso'
-                    ),
-                    get_class($this),
-                    gettype($this->_gateway)
-                )
-            );
-        }
-        return $payment;
-    }
-
-
-    /**
-     * Gets the values we want to pass onto the gateway. Normally these
-     * are just the 'pretty' values, but there may be times the data may need
-     * a  little massaging. Proper subsections will become arrays of inputs
-     *
-     * @param EE_Billing_Info_Form|null $billing_form
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        return $billing_form instanceof EE_Form_Section_Proper
-            ? $billing_form->input_pretty_values(true)
-            : [];
-    }
-
-
-    /**
-     * Handles an instant payment notification when the transaction is known (by default).
-     *
-     * @param array          $req_data
-     * @param EE_Transaction $transaction
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function handle_ipn(array $req_data, EE_Transaction $transaction): EE_Payment
-    {
-        $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (! $this->_gateway instanceof EE_Offsite_Gateway) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
-                    print_r($this->_gateway, true)
-                )
-            );
-        }
-        return $this->_gateway->handle_payment_update($req_data, $transaction);
-    }
-
-
-    /**
-     * Saves the billing info onto the attendee of the primary registrant on this transaction, and
-     * cleans it first.
-     *
-     * @param EE_Billing_Attendee_Info_Form $billing_form
-     * @param EE_Transaction|null           $transaction
-     * @return boolean success
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _save_billing_info_to_attendee(
-        EE_Billing_Attendee_Info_Form $billing_form,
-        ?EE_Transaction $transaction
-    ): bool {
-        if (! $transaction instanceof EE_Transaction) {
-            EE_Error::add_error(
-                esc_html__("Cannot save billing info because no transaction was specified", "event_espresso"),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg) {
-            EE_Error::add_error(
-                esc_html__(
-                    "Cannot save billing info because the transaction has no primary registration",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $attendee = $primary_reg->attendee();
-        if (! $attendee) {
-            EE_Error::add_error(
-                esc_html__(
-                    "Cannot save billing info because the transaction's primary registration has no attendee!",
-                    "event_espresso"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
-    }
-
-
-    /**
-     * Gets the payment this IPN is for. Children may often want to
-     * override this to inspect the request
-     *
-     * @param EE_Transaction $transaction
-     * @param array          $req_data
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function find_payment_for_ipn(EE_Transaction $transaction, array $req_data = []): EE_Payment
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * In case generic code cannot provide the payment processor with a specific payment method
-     * and transaction, it will try calling this method on each activate payment method.
-     * If the payment method is able to identify the request as being for it, it should fetch
-     * the payment it's for and return it. If not, it should throw an EE_Error to indicate it cannot
-     * handle the IPN
-     *
-     * @param array $req_data
-     * @return EE_Payment only if this payment method can find the info its needs from $req_data
-     * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
-     * @throws EE_Error
-     */
-    public function handle_unclaimed_ipn(array $req_data = []): EE_Payment
-    {
-        throw new EE_Error(
-            sprintf(
-                esc_html__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * Logic to be accomplished when the payment attempt is complete.
-     * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
-     * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
-     * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
-     * of the payment). Fed a transaction because it's always assumed to be the last payment that
-     * we're dealing with. Returns that last payment (if there is one)
-     *
-     * @param EE_Transaction $transaction
-     * @return EE_Payment|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function finalize_payment_for(EE_Transaction $transaction): ?EE_Payment
-    {
-        return $transaction->last_payment();
-    }
-
-
-    /**
-     * Whether this payment method's gateway supports sending refund requests
-     *
-     * @return boolean
-     */
-    public function supports_sending_refunds(): bool
-    {
-        return $this->_gateway instanceof EE_Gateway && $this->_gateway->supports_sending_refunds();
-    }
-
-
-    /**
-     * @param EE_Payment $payment
-     * @param array      $refund_info
-     * @return EE_Payment
-     * @throws EE_Error
-     */
-    public function process_refund(EE_Payment $payment, array $refund_info = []): EE_Payment
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            return $this->_gateway->do_direct_refund($payment, $refund_info);
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Returns one the class's constants onsite,offsite, or offline, depending on this
-     * payment method's gateway.
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function payment_occurs(): string
-    {
-        if (! $this->_gateway) {
-            return EE_PMT_Base::offline;
-        }
-        if ($this->_gateway instanceof EE_Onsite_Gateway) {
-            return EE_PMT_Base::onsite;
-        }
-        if ($this->_gateway instanceof EE_Offsite_Gateway) {
-            return EE_PMT_Base::offsite;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    "Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
-                    "event_espresso"
-                ),
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * For adding any html output ab ove the payment overview.
-     * Many gateways won't want ot display anything, so this function just returns an empty string.
-     * Other gateways may want to override this, such as offline gateways.
-     *
-     * @param EE_Payment $payment
-     * @return string
-     */
-    public function payment_overview_content(EE_Payment $payment)
-    {
-        return EEH_Template::display_template(
-            EE_LIBRARIES . 'payment_methods/templates/payment_details_content.template.php',
-            ['payment_method' => $this->_pm_instance, 'payment' => $payment],
-            true
-        );
-    }
-
-
-    /**
-     * @return array where keys are the help tab name,
-     * values are: array {
-     * @type string $title         i18n name for the help tab
-     * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
-     * @type array  $template_args any arguments you want passed to the template file while rendering.
-     *                             Keys will be variable names and values with be their values.
-     */
-    public function help_tabs_config()
-    {
-        return [];
-    }
-
-
-    /**
-     * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
-     * the payment method's table's PMT_type column)
-     *
-     * @return string
-     */
-    public function system_name()
-    {
-        $classname = get_class($this);
-        return str_replace("EE_PMT_", '', $classname);
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
-     * this method.
-     *
-     * @return string|null
-     */
-    public function defaultFrontendName()
-    {
-        return $this->pretty_name();
-    }
-
-
-    /**
-     * A pretty i18n version of the PMT name
-     *
-     * @return string|null
-     */
-    public function pretty_name(): ?string
-    {
-        return $this->_pretty_name;
-    }
-
-
-    /**
-     * Gets the default absolute URL to the payment method type's button
-     *
-     * @return string|null
-     */
-    public function default_button_url(): ?string
-    {
-        return $this->_default_button_url;
-    }
-
-
-    /**
-     * Gets the gateway used by this payment method (if any)
-     *
-     * @return EE_Gateway
-     */
-    public function get_gateway(): ?EE_Gateway
-    {
-        return $this->_gateway;
-    }
-
-
-    /**
-     * @return string html for the link to a help tab
-     */
-    public function get_help_tab_link(): string
-    {
-        return EEH_Template::get_help_tab_link(
-            $this->get_help_tab_name(),
-            'espresso_payment_settings',
-            'default'
-        );
-    }
-
-
-    /**
-     * Returns the name of the help tab for this PMT
-     *
-     * @return string
-     */
-    public function get_help_tab_name(): string
-    {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
-    }
-
-
-    /**
-     * The name of the wp capability that should be associated with the usage of
-     * this PMT by an admin
-     *
-     * @return string
-     */
-    public function cap_name(): string
-    {
-        return 'ee_payment_method_' . strtolower($this->system_name());
-    }
-
-
-    /**
-     * Called by client code to tell the gateway that if it wants to change
-     * the transaction or line items or registrations related to teh payment it already
-     * processed (we think, but possibly not) that now's the time to do it.
-     * It is expected that gateways will store any info they need for this on the PAY_details,
-     * or maybe an extra meta value
-     *
-     * @param EE_Payment $payment
-     * @return void
-     */
-    public function update_txn_based_on_payment($payment)
-    {
-        if ($this->_gateway instanceof EE_Gateway) {
-            $this->_gateway->update_txn_based_on_payment($payment);
-        }
-    }
-
-
-    /**
-     * Returns a string of HTML describing this payment method type for an admin,
-     * primarily intended for them to read before activating it.
-     * The easiest way to set this is to create a folder 'templates' alongside
-     * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
-     * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
-     * then you'd create a file named "templates" in the same folder as it, and name the file
-     * "foo_bar_intro.template.php", and its content will be returned by this method
-     *
-     * @return string
-     */
-    public function introductory_html(): string
-    {
-        return EEH_Template::locate_template(
-            $this->file_folder() . 'templates/' . strtolower($this->system_name()) . '_intro.template.php',
-            ['pmt_obj' => $this, 'pm_instance' => $this->_pm_instance]
-        );
-    }
+	const onsite  = 'on-site';
+
+	const offsite = 'off-site';
+
+	const offline = 'off-line';
+
+	protected ?EE_Payment_Method $_pm_instance = null;
+
+	protected ?EE_Gateway $_gateway = null;
+
+	protected ?EE_Payment_Method_Form $_settings_form = null;
+
+	protected ?EE_Form_Section_Proper $_billing_form = null;
+
+	protected bool $_cache_billing_form = true;
+
+	protected ?bool $_has_billing_form;
+
+	protected bool $_requires_https = false;
+
+	/**
+	 * String of the absolute path to the folder containing this file, with a trailing slash.
+	 * eg '/public_html/wp-site/wp-content/plugins/event-espresso/payment_methods/Invoice/'
+	 *
+	 * @var string|null
+	 */
+	protected $_file_folder = null;
+
+	/**
+	 * String to the absolute URL to this file (useful for getting its web-accessible resources
+	 * like images, js, or css)
+	 *
+	 * @var string|null
+	 */
+	protected $_file_url = null;
+
+	/**
+	 * Pretty name for the payment method
+	 *
+	 * @var string|null
+	 */
+	protected $_pretty_name = null;
+
+	/**
+	 * @var string|null
+	 */
+	protected $_default_button_url = null;
+
+	/**
+	 * @var string|null
+	 */
+	protected $_default_description = null;
+
+	/**
+	 * @var string|null
+	 */
+	protected $_template_path = null;
+
+
+	/**
+	 * @param EE_Payment_Method|null $pm_instance
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function __construct($pm_instance = null)
+	{
+		if ($pm_instance instanceof EE_Payment_Method) {
+			$this->set_instance($pm_instance);
+		}
+		if ($this->_gateway) {
+			$this->_gateway->set_payment_model(EEM_Payment::instance());
+			$this->_gateway->set_payment_log(EEM_Change_Log::instance());
+			$this->_gateway->set_template_helper(new EEH_Template());
+			$this->_gateway->set_line_item_helper(new EEH_Line_Item());
+			$this->_gateway->set_money_helper(new EEH_Money());
+			$this->_gateway->set_gateway_data_formatter(new GatewayDataFormatter());
+			$this->_gateway->set_unsupported_character_remover(new AsciiOnly());
+			do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
+		}
+		if (! isset($this->_has_billing_form)) {
+			// by default, On Site gateways have a billing form
+			if ($this->payment_occurs() == EE_PMT_Base::onsite) {
+				$this->set_has_billing_form(true);
+			} else {
+				$this->set_has_billing_form(false);
+			}
+		}
+
+		if (! $this->_pretty_name) {
+			throw new EE_Error(
+				esc_html__(
+					'You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized',
+					'event_espresso'
+				)
+			);
+		}
+		// if the child didn't specify a default button, use the credit card one
+		if ($this->_default_button_url === null) {
+			$this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods/pay-by-credit-card.png';
+		}
+	}
+
+
+	/**
+	 * @param bool|int|string $has_billing_form
+	 */
+	public function set_has_billing_form($has_billing_form)
+	{
+		$this->_has_billing_form = filter_var($has_billing_form, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * sets the file_folder property
+	 */
+	protected function _set_file_folder()
+	{
+		$reflector          = new ReflectionClass(get_class($this));
+		$fn                 = $reflector->getFileName();
+		$this->_file_folder = dirname($fn) . '/';
+	}
+
+
+	/**
+	 * sets the file URL with a trailing slash for this PMT
+	 */
+	protected function _set_file_url()
+	{
+		$plugins_dir_fixed = str_replace('\\', '/', WP_PLUGIN_DIR);
+		$file_folder_fixed = str_replace('\\', '/', $this->file_folder());
+		$file_path         = str_replace($plugins_dir_fixed, WP_PLUGIN_URL, $file_folder_fixed);
+		$this->_file_url   = set_url_scheme($file_path);
+	}
+
+
+	/**
+	 * Gets the default description on all payment methods of this type
+	 *
+	 * @return string
+	 */
+	public function default_description(): ?string
+	{
+		return $this->_default_description;
+	}
+
+
+	/**
+	 * Returns the folder containing the PMT child class, with a trailing slash
+	 *
+	 * @return string
+	 */
+	public function file_folder(): ?string
+	{
+		if (! $this->_file_folder) {
+			$this->_set_file_folder();
+		}
+		return $this->_file_folder;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function file_url(): ?string
+	{
+		if (! $this->_file_url) {
+			$this->_set_file_url();
+		}
+		return $this->_file_url;
+	}
+
+
+	/**
+	 * Sets the payment method instance this payment method type is for.
+	 * Its important teh payment method instance is set before
+	 *
+	 * @param EE_Payment_Method $payment_method_instance
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_instance(EE_Payment_Method $payment_method_instance)
+	{
+		$this->_pm_instance = $payment_method_instance;
+		// if they have already requested the settings form, make sure its
+		// data matches this model object
+		if ($this->_settings_form) {
+			$this->settings_form()->populate_model_obj($payment_method_instance);
+		}
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->set_settings($payment_method_instance->settings_array());
+		}
+	}
+
+
+	/**
+	 * Gets teh form for displaying to admins where they set up the payment method
+	 *
+	 * @return EE_Payment_Method_Form
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function settings_form(): EE_Payment_Method_Form
+	{
+		if (! $this->_settings_form) {
+			$this->_settings_form = $this->generate_new_settings_form();
+			$this->_settings_form->set_payment_method_type($this);
+			// if we have already assigned a model object to this pmt, make
+			// sure it's reflected in the form we just generated
+			if ($this->_pm_instance) {
+				$this->_settings_form->populate_model_obj($this->_pm_instance);
+			}
+		}
+		return $this->_settings_form;
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	abstract public function generate_new_settings_form();
+
+
+	/**
+	 * Sets the form for settings. This may be useful if we have already received
+	 * a form submission and have form data it in, and want to use it anytime we're showing
+	 * this payment method type's settings form later in the request
+	 *
+	 * @param EE_Payment_Method_Form $form
+	 */
+	public function set_settings_form(EE_Payment_Method_Form $form)
+	{
+		$this->_settings_form = $form;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function has_billing_form(): bool
+	{
+		return $this->_has_billing_form;
+	}
+
+
+	/**
+	 * Gets the form for displaying to attendees where they can enter their billing info
+	 * which will be sent to teh gateway (can be null)
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @param array               $extra_args
+	 * @return EE_Billing_Attendee_Info_Form|EE_Billing_Info_Form|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function billing_form(EE_Transaction $transaction = null, array $extra_args = [])
+	{
+		// has billing form already been regenerated ? or overwrite cache?
+		if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
+			$this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
+		}
+		// if we know who the attendee is, and this is a billing form
+		// that uses attendee info, populate it
+		if (
+			apply_filters(
+				'FHEE__populate_billing_form_fields_from_attendee',
+				(
+					$this->_billing_form instanceof EE_Billing_Attendee_Info_Form
+					&& $transaction instanceof EE_Transaction
+					&& $transaction->primary_registration() instanceof EE_Registration
+					&& $transaction->primary_registration()->attendee() instanceof EE_Attendee
+				),
+				$this->_billing_form,
+				$transaction
+			)
+		) {
+			$this->_billing_form->populate_from_attendee($transaction->primary_registration()->attendee());
+		}
+		return $this->_billing_form;
+	}
+
+
+	/**
+	 * Creates the billing form for this payment method type
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @return EE_Billing_Info_Form|null
+	 */
+	abstract public function generate_new_billing_form(EE_Transaction $transaction = null);
+
+
+	/**
+	 * applies debug data to the form
+	 *
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return EE_Billing_Info_Form|null
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		return $billing_form;
+	}
+
+
+	/**
+	 * Sets the billing form for this payment method type. You may want to use this
+	 * if you have form
+	 *
+	 * @param EE_Billing_Info_Form $form
+	 */
+	public function set_billing_form(EE_Billing_Info_Form $form)
+	{
+		$this->_billing_form = $form;
+	}
+
+
+	/**
+	 * Returns whether this payment method requires HTTPS to be used
+	 *
+	 * @return boolean
+	 */
+	public function requires_https(): bool
+	{
+		return $this->_requires_https;
+	}
+
+
+	/**
+	 * @param EE_Transaction            $transaction
+	 * @param float|null                $amount
+	 * @param EE_Billing_Info_Form|null $billing_info
+	 * @param string|null               $return_url
+	 * @param string                    $fail_url
+	 * @param string                    $method
+	 * @param bool                      $by_admin
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function process_payment(
+		EE_Transaction $transaction,
+		$amount = null,
+		$billing_info = null,
+		$return_url = null,
+		$fail_url = '',
+		$method = EEM_Payment_Method::scope_cart,
+		$by_admin = false
+	) {
+		$amount = $amount ?: $transaction->remaining();
+		$method = EEM_Payment_Method::instance()->is_valid_scope($method) ? $method : EEM_Payment_Method::scope_cart;
+
+
+		// @todo: add surcharge for the payment method, if any
+		if (! $this->_gateway instanceof EE_Gateway) {
+			// no gateway provided, must be an offline gateway
+			// create a payment object anyways, but don't save it
+			// but if there is billing info, clean it and save it first
+			if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+				$this->_save_billing_info_to_attendee($billing_info, $transaction);
+			}
+			return EE_Payment::new_instance(
+				[
+					'STS_ID'        => EEM_Payment::status_id_pending,
+					'TXN_ID'        => $transaction->ID(),
+					'PMD_ID'        => $transaction->payment_method_ID(),
+					'PAY_amount'    => 0.00,
+					'PAY_timestamp' => time(),
+				]
+			);
+		}
+
+		$payment = $this->getLastPayment($transaction, $amount, $method);
+		$payment = $this->validatePayment($transaction, $payment, $amount, $method);
+
+		$max_payment_attempts   = apply_filters(
+			'FHEE__EE_PMT_Base__process_payment__max_payment_attempts',
+			5,
+			$transaction
+		);
+		$previous_payment_count = $this->getPreviousPaymentCount($transaction, $amount, $method);
+		// only pass payment to gateway if we haven't exceeded the max attempts
+		$payment = $previous_payment_count < $max_payment_attempts
+			? $this->passPaymentToGateway($payment, $transaction, $billing_info, $return_url, $fail_url)
+			: $payment;
+
+		// if there is billing info, clean it and save it
+		if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+			$this->_save_billing_info_to_attendee($billing_info, $transaction);
+		}
+
+		return $payment;
+	}
+
+
+	/**
+	 * Checks for any existing payments that are in a failed state for the same TXN, amount, and method
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param float          $amount
+	 * @param string         $method
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.28.p
+	 */
+	private function getLastPayment(EE_Transaction $transaction, float $amount, string $method): ?EE_Payment
+	{
+		return EEM_Payment::instance()->get_one(
+			[
+				[
+					'STS_ID'     => EEM_Payment::status_id_failed,
+					'TXN_ID'     => $transaction->ID(),
+					'PMD_ID'     => $this->_pm_instance->ID(),
+					'PAY_source' => $method,
+					'PAY_amount' => $amount,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * IF the last payment was not a failed payment
+	 * (which indicates a payment in progress that has yet to be updated),
+	 * then create a new payment, otherwise just return the existing payment,
+	 * but save it to ensure it has an ID
+	 *
+	 * @param EE_Transaction  $transaction
+	 * @param EE_Payment|null $payment
+	 * @param float           $amount
+	 * @param string          $method
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.28.p
+	 */
+	private function validatePayment(
+		EE_Transaction $transaction,
+		?EE_Payment $payment,
+		float $amount,
+		string $method
+	): EE_Payment {
+		if (! $payment instanceof EE_Payment || ! $payment->is_failed()) {
+			$payment = EE_Payment::new_instance(
+				[
+					'PAY_amount'           => $amount,
+					'PAY_details'          => null,
+					'PAY_extra_accntng'    => null,
+					'PAY_gateway_response' => null,
+					'PAY_po_number'        => null,
+					'PAY_source'           => $method,
+					'PAY_timestamp'        => time(),
+					'PAY_txn_id_chq_nmbr'  => null,
+					'PMD_ID'               => $this->_pm_instance->ID(),
+					'STS_ID'               => EEM_Payment::status_id_failed,
+					'TXN_ID'               => $transaction->ID(),
+				]
+			);
+		}
+		// make sure the payment has been saved to show we started it,
+		// and so it has an ID should the gateway try to log it
+		$payment->save();
+
+		return $payment;
+	}
+
+
+	/**
+	 * Checks for any existing payments that are in a failed state for the same TXN, amount, and method
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param float          $amount
+	 * @param string         $method
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.28.p
+	 */
+	private function getPreviousPaymentCount(EE_Transaction $transaction, float $amount, string $method): int
+	{
+		return EEM_Payment::instance()->count(
+			[
+				[
+					'STS_ID'     => [
+						'IN',
+						[
+							EEM_Payment::status_id_pending,
+							EEM_Payment::status_id_cancelled,
+							EEM_Payment::status_id_declined,
+							EEM_Payment::status_id_failed,
+						],
+					],
+					'TXN_ID'     => $transaction->ID(),
+					'PMD_ID'     => $this->_pm_instance->ID(),
+					'PAY_source' => $method,
+					'PAY_amount' => $amount,
+				],
+				'order_by' => ['PAY_timestamp' => 'DESC'],
+			]
+		);
+	}
+
+
+	/**
+	 * @param EE_Payment                $payment
+	 * @param EE_Transaction            $transaction
+	 * @param EE_Billing_Info_Form|null $billing_info
+	 * @param string|null               $return_url
+	 * @param string|null               $fail_url
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.28.p
+	 */
+	private function passPaymentToGateway(
+		EE_Payment $payment,
+		EE_Transaction $transaction,
+		?EE_Billing_Info_Form $billing_info,
+		?string $return_url = null,
+		?string $fail_url = ''
+	): EE_Payment {
+		$billing_values = $this->_get_billing_values_from_form($billing_info);
+		if ($this->_gateway instanceof EE_Offsite_Gateway) {
+			$payment = $this->_gateway->set_redirection_info(
+				$payment,
+				$billing_values,
+				$return_url,
+				EE_Config::instance()->core->txn_page_url(
+					[
+						'e_reg_url_link'    => $transaction->primary_registration()->reg_url_link(),
+						'ee_payment_method' => $this->_pm_instance->slug(),
+					]
+				),
+				$fail_url
+			);
+			$payment->save();
+		} elseif ($this->_gateway instanceof EE_Onsite_Gateway) {
+			$payment = $this->_gateway->do_direct_payment($payment, $billing_values);
+			$payment->save();
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'Gateway for payment method type "%s" is "%s", not a subclass of either EE_Offsite_Gateway or EE_Onsite_Gateway, or null (to indicate NO gateway)',
+						'event_espresso'
+					),
+					get_class($this),
+					gettype($this->_gateway)
+				)
+			);
+		}
+		return $payment;
+	}
+
+
+	/**
+	 * Gets the values we want to pass onto the gateway. Normally these
+	 * are just the 'pretty' values, but there may be times the data may need
+	 * a  little massaging. Proper subsections will become arrays of inputs
+	 *
+	 * @param EE_Billing_Info_Form|null $billing_form
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		return $billing_form instanceof EE_Form_Section_Proper
+			? $billing_form->input_pretty_values(true)
+			: [];
+	}
+
+
+	/**
+	 * Handles an instant payment notification when the transaction is known (by default).
+	 *
+	 * @param array          $req_data
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function handle_ipn(array $req_data, EE_Transaction $transaction): EE_Payment
+	{
+		$transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
+		if (! $this->_gateway instanceof EE_Offsite_Gateway) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
+					print_r($this->_gateway, true)
+				)
+			);
+		}
+		return $this->_gateway->handle_payment_update($req_data, $transaction);
+	}
+
+
+	/**
+	 * Saves the billing info onto the attendee of the primary registrant on this transaction, and
+	 * cleans it first.
+	 *
+	 * @param EE_Billing_Attendee_Info_Form $billing_form
+	 * @param EE_Transaction|null           $transaction
+	 * @return boolean success
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _save_billing_info_to_attendee(
+		EE_Billing_Attendee_Info_Form $billing_form,
+		?EE_Transaction $transaction
+	): bool {
+		if (! $transaction instanceof EE_Transaction) {
+			EE_Error::add_error(
+				esc_html__("Cannot save billing info because no transaction was specified", "event_espresso"),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$primary_reg = $transaction->primary_registration();
+		if (! $primary_reg) {
+			EE_Error::add_error(
+				esc_html__(
+					"Cannot save billing info because the transaction has no primary registration",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$attendee = $primary_reg->attendee();
+		if (! $attendee) {
+			EE_Error::add_error(
+				esc_html__(
+					"Cannot save billing info because the transaction's primary registration has no attendee!",
+					"event_espresso"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $attendee->save_and_clean_billing_info_for_payment_method($billing_form, $transaction->payment_method());
+	}
+
+
+	/**
+	 * Gets the payment this IPN is for. Children may often want to
+	 * override this to inspect the request
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param array          $req_data
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function find_payment_for_ipn(EE_Transaction $transaction, array $req_data = []): EE_Payment
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * In case generic code cannot provide the payment processor with a specific payment method
+	 * and transaction, it will try calling this method on each activate payment method.
+	 * If the payment method is able to identify the request as being for it, it should fetch
+	 * the payment it's for and return it. If not, it should throw an EE_Error to indicate it cannot
+	 * handle the IPN
+	 *
+	 * @param array $req_data
+	 * @return EE_Payment only if this payment method can find the info its needs from $req_data
+	 * and identifies the IPN as being for this payment method (not just fo ra payment method of this type)
+	 * @throws EE_Error
+	 */
+	public function handle_unclaimed_ipn(array $req_data = []): EE_Payment
+	{
+		throw new EE_Error(
+			sprintf(
+				esc_html__("Payment Method '%s' cannot handle unclaimed IPNs", "event_espresso"),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * Logic to be accomplished when the payment attempt is complete.
+	 * Most payment methods don't need to do anything at this point; but some, like Mijireh, do.
+	 * (Mijireh is an offsite gateway which doesn't send an IPN. So when the user returns to EE from
+	 * mijireh, this method needs to be called so the Mijireh PM can ping Mijireh to know the status
+	 * of the payment). Fed a transaction because it's always assumed to be the last payment that
+	 * we're dealing with. Returns that last payment (if there is one)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function finalize_payment_for(EE_Transaction $transaction): ?EE_Payment
+	{
+		return $transaction->last_payment();
+	}
+
+
+	/**
+	 * Whether this payment method's gateway supports sending refund requests
+	 *
+	 * @return boolean
+	 */
+	public function supports_sending_refunds(): bool
+	{
+		return $this->_gateway instanceof EE_Gateway && $this->_gateway->supports_sending_refunds();
+	}
+
+
+	/**
+	 * @param EE_Payment $payment
+	 * @param array      $refund_info
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 */
+	public function process_refund(EE_Payment $payment, array $refund_info = []): EE_Payment
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			return $this->_gateway->do_direct_refund($payment, $refund_info);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Payment Method Type "%s" does not support sending refund requests', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Returns one the class's constants onsite,offsite, or offline, depending on this
+	 * payment method's gateway.
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function payment_occurs(): string
+	{
+		if (! $this->_gateway) {
+			return EE_PMT_Base::offline;
+		}
+		if ($this->_gateway instanceof EE_Onsite_Gateway) {
+			return EE_PMT_Base::onsite;
+		}
+		if ($this->_gateway instanceof EE_Offsite_Gateway) {
+			return EE_PMT_Base::offsite;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					"Payment method type '%s's gateway isn't an instance of EE_Onsite_Gateway, EE_Offsite_Gateway, or null. It must be one of those",
+					"event_espresso"
+				),
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * For adding any html output ab ove the payment overview.
+	 * Many gateways won't want ot display anything, so this function just returns an empty string.
+	 * Other gateways may want to override this, such as offline gateways.
+	 *
+	 * @param EE_Payment $payment
+	 * @return string
+	 */
+	public function payment_overview_content(EE_Payment $payment)
+	{
+		return EEH_Template::display_template(
+			EE_LIBRARIES . 'payment_methods/templates/payment_details_content.template.php',
+			['payment_method' => $this->_pm_instance, 'payment' => $payment],
+			true
+		);
+	}
+
+
+	/**
+	 * @return array where keys are the help tab name,
+	 * values are: array {
+	 * @type string $title         i18n name for the help tab
+	 * @type string $filename      name of the file located in ./help_tabs/ (ie, in a folder next to this file)
+	 * @type array  $template_args any arguments you want passed to the template file while rendering.
+	 *                             Keys will be variable names and values with be their values.
+	 */
+	public function help_tabs_config()
+	{
+		return [];
+	}
+
+
+	/**
+	 * The system name for this PMT (eg AIM, Paypal_Pro, Invoice... what gets put into
+	 * the payment method's table's PMT_type column)
+	 *
+	 * @return string
+	 */
+	public function system_name()
+	{
+		$classname = get_class($this);
+		return str_replace("EE_PMT_", '', $classname);
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name. Often the same as the "pretty_name", but you can change it by overriding
+	 * this method.
+	 *
+	 * @return string|null
+	 */
+	public function defaultFrontendName()
+	{
+		return $this->pretty_name();
+	}
+
+
+	/**
+	 * A pretty i18n version of the PMT name
+	 *
+	 * @return string|null
+	 */
+	public function pretty_name(): ?string
+	{
+		return $this->_pretty_name;
+	}
+
+
+	/**
+	 * Gets the default absolute URL to the payment method type's button
+	 *
+	 * @return string|null
+	 */
+	public function default_button_url(): ?string
+	{
+		return $this->_default_button_url;
+	}
+
+
+	/**
+	 * Gets the gateway used by this payment method (if any)
+	 *
+	 * @return EE_Gateway
+	 */
+	public function get_gateway(): ?EE_Gateway
+	{
+		return $this->_gateway;
+	}
+
+
+	/**
+	 * @return string html for the link to a help tab
+	 */
+	public function get_help_tab_link(): string
+	{
+		return EEH_Template::get_help_tab_link(
+			$this->get_help_tab_name(),
+			'espresso_payment_settings',
+			'default'
+		);
+	}
+
+
+	/**
+	 * Returns the name of the help tab for this PMT
+	 *
+	 * @return string
+	 */
+	public function get_help_tab_name(): string
+	{
+		return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+	}
+
+
+	/**
+	 * The name of the wp capability that should be associated with the usage of
+	 * this PMT by an admin
+	 *
+	 * @return string
+	 */
+	public function cap_name(): string
+	{
+		return 'ee_payment_method_' . strtolower($this->system_name());
+	}
+
+
+	/**
+	 * Called by client code to tell the gateway that if it wants to change
+	 * the transaction or line items or registrations related to teh payment it already
+	 * processed (we think, but possibly not) that now's the time to do it.
+	 * It is expected that gateways will store any info they need for this on the PAY_details,
+	 * or maybe an extra meta value
+	 *
+	 * @param EE_Payment $payment
+	 * @return void
+	 */
+	public function update_txn_based_on_payment($payment)
+	{
+		if ($this->_gateway instanceof EE_Gateway) {
+			$this->_gateway->update_txn_based_on_payment($payment);
+		}
+	}
+
+
+	/**
+	 * Returns a string of HTML describing this payment method type for an admin,
+	 * primarily intended for them to read before activating it.
+	 * The easiest way to set this is to create a folder 'templates' alongside
+	 * your EE_PMT_{System_Name} file, and in it create a file named "{system_name}_intro.template.php".
+	 * Eg, if your payment method file is named "EE_PMT_Foo_Bar.pm.php",
+	 * then you'd create a file named "templates" in the same folder as it, and name the file
+	 * "foo_bar_intro.template.php", and its content will be returned by this method
+	 *
+	 * @return string
+	 */
+	public function introductory_html(): string
+	{
+		return EEH_Template::locate_template(
+			$this->file_folder() . 'templates/' . strtolower($this->system_name()) . '_intro.template.php',
+			['pmt_obj' => $this, 'pm_instance' => $this->_pm_instance]
+		);
+	}
 }

Spacing +20 added lines, -20 removed lines

@@ -95,7 +95,7 @@ 
             $this->_gateway->set_unsupported_character_remover(new AsciiOnly());
             do_action('AHEE__EE_PMT_Base___construct__done_initializing_gateway_class', $this, $this->_gateway);
         }
-        if (! isset($this->_has_billing_form)) {
+        if ( ! isset($this->_has_billing_form)) {
             // by default, On Site gateways have a billing form
             if ($this->payment_occurs() == EE_PMT_Base::onsite) {
                 $this->set_has_billing_form(true);
@@ -104,7 +104,7 @@ 
             }
         }
 
-        if (! $this->_pretty_name) {
+        if ( ! $this->_pretty_name) {
             throw new EE_Error(
                 esc_html__(
                     'You must set the pretty name for the Payment Method Type in the constructor (_pretty_name), and please make it internationalized',
@@ -114,7 +114,7 @@ 
         }
         // if the child didn't specify a default button, use the credit card one
         if ($this->_default_button_url === null) {
-            $this->_default_button_url = EE_PLUGIN_DIR_URL . 'payment_methods/pay-by-credit-card.png';
+            $this->_default_button_url = EE_PLUGIN_DIR_URL.'payment_methods/pay-by-credit-card.png';
         }
     }
 
@@ -135,7 +135,7 @@ 
     {
         $reflector          = new ReflectionClass(get_class($this));
         $fn                 = $reflector->getFileName();
-        $this->_file_folder = dirname($fn) . '/';
+        $this->_file_folder = dirname($fn).'/';
     }
 
 
@@ -169,7 +169,7 @@ 
      */
     public function file_folder(): ?string
     {
-        if (! $this->_file_folder) {
+        if ( ! $this->_file_folder) {
             $this->_set_file_folder();
         }
         return $this->_file_folder;
@@ -181,7 +181,7 @@ 
      */
     public function file_url(): ?string
     {
-        if (! $this->_file_url) {
+        if ( ! $this->_file_url) {
             $this->_set_file_url();
         }
         return $this->_file_url;
@@ -219,7 +219,7 @@ 
      */
     public function settings_form(): EE_Payment_Method_Form
     {
-        if (! $this->_settings_form) {
+        if ( ! $this->_settings_form) {
             $this->_settings_form = $this->generate_new_settings_form();
             $this->_settings_form->set_payment_method_type($this);
             // if we have already assigned a model object to this pmt, make
@@ -275,7 +275,7 @@ 
     public function billing_form(EE_Transaction $transaction = null, array $extra_args = [])
     {
         // has billing form already been regenerated ? or overwrite cache?
-        if (! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
+        if ( ! $this->_billing_form instanceof EE_Billing_Info_Form || ! $this->_cache_billing_form) {
             $this->_billing_form = $this->generate_new_billing_form($transaction, $extra_args);
         }
         // if we know who the attendee is, and this is a billing form
@@ -369,7 +369,7 @@ 
 
 
         // @todo: add surcharge for the payment method, if any
-        if (! $this->_gateway instanceof EE_Gateway) {
+        if ( ! $this->_gateway instanceof EE_Gateway) {
             // no gateway provided, must be an offline gateway
             // create a payment object anyways, but don't save it
             // but if there is billing info, clean it and save it first
@@ -390,7 +390,7 @@ 
         $payment = $this->getLastPayment($transaction, $amount, $method);
         $payment = $this->validatePayment($transaction, $payment, $amount, $method);
 
-        $max_payment_attempts   = apply_filters(
+        $max_payment_attempts = apply_filters(
             'FHEE__EE_PMT_Base__process_payment__max_payment_attempts',
             5,
             $transaction
@@ -458,7 +458,7 @@ 
         float $amount,
         string $method
     ): EE_Payment {
-        if (! $payment instanceof EE_Payment || ! $payment->is_failed()) {
+        if ( ! $payment instanceof EE_Payment || ! $payment->is_failed()) {
             $payment = EE_Payment::new_instance(
                 [
                     'PAY_amount'           => $amount,
@@ -600,7 +600,7 @@ 
     public function handle_ipn(array $req_data, EE_Transaction $transaction): EE_Payment
     {
         $transaction = EEM_Transaction::instance()->ensure_is_obj($transaction);
-        if (! $this->_gateway instanceof EE_Offsite_Gateway) {
+        if ( ! $this->_gateway instanceof EE_Offsite_Gateway) {
             throw new EE_Error(
                 sprintf(
                     esc_html__("Could not handle IPN because '%s' is not an offsite gateway", "event_espresso"),
@@ -626,7 +626,7 @@ 
         EE_Billing_Attendee_Info_Form $billing_form,
         ?EE_Transaction $transaction
     ): bool {
-        if (! $transaction instanceof EE_Transaction) {
+        if ( ! $transaction instanceof EE_Transaction) {
             EE_Error::add_error(
                 esc_html__("Cannot save billing info because no transaction was specified", "event_espresso"),
                 __FILE__,
@@ -636,7 +636,7 @@ 
             return false;
         }
         $primary_reg = $transaction->primary_registration();
-        if (! $primary_reg) {
+        if ( ! $primary_reg) {
             EE_Error::add_error(
                 esc_html__(
                     "Cannot save billing info because the transaction has no primary registration",
@@ -649,7 +649,7 @@ 
             return false;
         }
         $attendee = $primary_reg->attendee();
-        if (! $attendee) {
+        if ( ! $attendee) {
             EE_Error::add_error(
                 esc_html__(
                     "Cannot save billing info because the transaction's primary registration has no attendee!",
@@ -764,7 +764,7 @@ 
      */
     public function payment_occurs(): string
     {
-        if (! $this->_gateway) {
+        if ( ! $this->_gateway) {
             return EE_PMT_Base::offline;
         }
         if ($this->_gateway instanceof EE_Onsite_Gateway) {
@@ -796,7 +796,7 @@ 
     public function payment_overview_content(EE_Payment $payment)
     {
         return EEH_Template::display_template(
-            EE_LIBRARIES . 'payment_methods/templates/payment_details_content.template.php',
+            EE_LIBRARIES.'payment_methods/templates/payment_details_content.template.php',
             ['payment_method' => $this->_pm_instance, 'payment' => $payment],
             true
         );
@@ -895,7 +895,7 @@ 
      */
     public function get_help_tab_name(): string
     {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+        return 'ee_'.strtolower($this->system_name()).'_help_tab';
     }
 
 
@@ -907,7 +907,7 @@ 
      */
     public function cap_name(): string
     {
-        return 'ee_payment_method_' . strtolower($this->system_name());
+        return 'ee_payment_method_'.strtolower($this->system_name());
     }
 
 
@@ -943,7 +943,7 @@ 
     public function introductory_html(): string
     {
         return EEH_Template::locate_template(
-            $this->file_folder() . 'templates/' . strtolower($this->system_name()) . '_intro.template.php',
+            $this->file_folder().'templates/'.strtolower($this->system_name()).'_intro.template.php',
             ['pmt_obj' => $this, 'pm_instance' => $this->_pm_instance]
         );
     }