eventespresso / event-espresso-core

core/libraries/iframe_display/iframe_wrapper.template.php

Braces +5 added lines, -2 removed lines

@@ -31,11 +31,14 @@
     <meta name="robots" content="noindex,nofollow">
     <?php if ($enqueue_wp_assets) : ?>
         <?php wp_head(); ?>
-    <?php else : ?>
+    <?php else {
+	: ?>
         <?php foreach ($css as $handle => $url) : ?>
             <?php if (isset($inline_styles["{$handle}_before"])) :?>
                 <style>
-                    <?php echo wp_kses($inline_styles["{$handle}_before"], AllowedTags::getWithFullTags()); ?>
+                    <?php echo wp_kses($inline_styles["{$handle}_before"], AllowedTags::getWithFullTags());
+}
+?>
                 </style>
             <?php endif; ?>
             <link rel="stylesheet" type="text/css" id="<?php esc_attr_e($handle); ?>" href="<?php echo esc_url_raw($url); ?>">

core/libraries/payment_methods/EE_Payment_Method_Manager.lib.php

Indentation +597 added lines, -597 removed lines

@@ -17,601 +17,601 @@
  */
 class EE_Payment_Method_Manager implements ResettableInterface
 {
-    /**
-     * prefix added to all payment method capabilities names
-     */
-    const CAPABILITIES_PREFIX = 'ee_payment_method_';
-
-    private static ?EE_Payment_Method_Manager $_instance = null;
-
-    /**
-     * @var boolean
-     */
-    protected bool $payment_method_caps_initialized = false;
-
-    /**
-     * @var string[] keys are class names without 'EE_PMT_', values are their filepaths
-     */
-    protected array $_payment_method_types = [];
-
-    /**
-     * @var EE_PMT_Base[]
-     */
-    protected array $payment_method_objects = [];
-
-
-    /**
-     * EE_Payment_Method_Manager constructor.
-     *
-     * @throws DomainException
-     */
-    public function __construct()
-    {
-        // if in admin lets ensure caps are set.
-        if (is_admin()) {
-            $this->_register_payment_methods();
-            // add PM caps when EE_Capabilities is initialized
-            add_action(
-                'AHEE__EE_Capabilities__init_caps__before_initialization',
-                [$this, 'initializePaymentMethodCaps']
-            );
-            // plus any time they get reset
-            add_filter(
-                'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
-                [$this, 'addPaymentMethodCapsDuringReset']
-            );
-        }
-        add_action('http_api_curl', ['EE_Payment_Method_Manager', 'curlRequestsToPaypalUseTls'], 10, 3);
-    }
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @return EE_Payment_Method_Manager instance
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EE_Payment_Method_Manager
-    {
-        // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
-            EE_Registry::instance()->load_lib('PMT_Base');
-            self::$_instance = new self();
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets the instance and returns a new one
-     *
-     * @return EE_Payment_Method_Manager
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset(): EE_Payment_Method_Manager
-    {
-        self::$_instance = null;
-        return self::instance();
-    }
-
-
-    /**
-     * Force posts to PayPal to use TLS v1.2. See:
-     * https://core.trac.wordpress.org/ticket/36320
-     * https://core.trac.wordpress.org/ticket/34924#comment:15
-     * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
-     * This will affect PayPal standard, pro, express, and Payflow.
-     *
-     * @param $handle
-     * @param $r
-     * @param $url
-     */
-    public static function curlRequestsToPaypalUseTls($handle, $r, $url)
-    {
-        if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
-            // Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
-            // instead of the constant because it might not be defined
-            curl_setopt($handle, CURLOPT_SSLVERSION, 6);
-        }
-    }
-
-
-    /**
-     * If necessary, re-register payment methods
-     *
-     * @param boolean $force_recheck whether to recheck for payment method types,
-     *                               or just re-use the PMTs we found last time we checked during this request (if
-     *                               we have not yet checked during this request, then we need to check anyways)
-     */
-    public function maybe_register_payment_methods(bool $force_recheck = false)
-    {
-        if (! $this->_payment_method_types || $force_recheck) {
-            $this->_register_payment_methods();
-        }
-    }
-
-
-    /**
-     * register_payment_methods
-     *
-     * @return array
-     */
-    protected function _register_payment_methods(): array
-    {
-        // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
-        // filter list of modules to register
-        $pm_to_register = apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            $pm_to_register
-        );
-        // remove any duplicates if that should happen for some reason
-        $pm_to_register = array_unique($pm_to_register);
-        // loop through folders
-        foreach ($pm_to_register as $pm_path) {
-            $this->register_payment_method($pm_path);
-        }
-        do_action(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods',
-            $this->_payment_method_types
-        );
-        // filter list of installed modules
-        // keep them organized alphabetically by the payment method type's name
-        ksort($this->_payment_method_types);
-        return apply_filters(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
-            $this->_payment_method_types
-        );
-    }
-
-
-    /**
-     * register_payment_method- makes core aware of this payment method
-     *
-     * @param string $payment_method_path - full path up to and including payment method folder
-     * @return boolean
-     */
-    public function register_payment_method(string $payment_method_path = ''): bool
-    {
-        do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
-        $module_ext = '.pm.php';
-        // make all separators match
-        $payment_method_path = rtrim(str_replace('/\\', '/', $payment_method_path), '/');
-        // grab and sanitize module name
-        $module_dir = basename($payment_method_path);
-        // create class name from module directory name
-        $module = str_replace(['_', ' '], [' ', '_'], $module_dir);
-        // add class prefix
-        $module_class = 'EE_PMT_' . $module;
-        // does the module exist ?
-        if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %s payment method file could not be found or is not readable due to file permissions.',
-                    'event_espresso'
-                ),
-                $module
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the module class file
-        require_once($payment_method_path . '/' . $module_class . $module_ext);
-        // verify that class exists
-        if (! class_exists($module_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s module class does not exist.', 'event_espresso'),
-                $module_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // add to array of registered modules
-        $this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
-        return true;
-    }
-
-
-    /**
-     * Checks if a payment method has been registered, and if so includes it
-     *
-     * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
-     * @param boolean $force_recheck       whether to force re-checking for new payment method types
-     * @return boolean
-     */
-    public function payment_method_type_exists(string $payment_method_name, bool $force_recheck = false): bool
-    {
-        if (
-            $force_recheck
-            || empty($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[ $payment_method_name ])
-        ) {
-            $this->maybe_register_payment_methods($force_recheck);
-        }
-        if (isset($this->_payment_method_types[ $payment_method_name ])) {
-            require_once($this->_payment_method_types[ $payment_method_name ]);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns all the class names of the various payment method types
-     *
-     * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
-     *                               (what you'd find in wp_esp_payment_method.PMD_type)
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return array
-     */
-    public function payment_method_type_names(bool $with_prefixes = false, bool $force_recheck = false): array
-    {
-        $this->maybe_register_payment_methods($force_recheck);
-        if ($with_prefixes) {
-            $classnames      = array_keys($this->_payment_method_types);
-            $payment_methods = [];
-            foreach ($classnames as $classname) {
-                $payment_methods[] = $this->payment_method_class_from_type($classname);
-            }
-            return $payment_methods;
-        }
-        return array_keys($this->_payment_method_types);
-    }
-
-
-    /**
-     * Gets an object of each payment method type, none of which are bound to a
-     * payment method instance
-     *
-     * @param boolean $force_recheck whether to force re-checking for new payment method types
-     * @return EE_PMT_Base[]
-     */
-    public function payment_method_types(bool $force_recheck = false): array
-    {
-        if ($force_recheck || empty($this->payment_method_objects)) {
-            $this->maybe_register_payment_methods($force_recheck);
-            foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[ $classname ])) {
-                    $this->payment_method_objects[ $classname ] = new $classname();
-                }
-            }
-        }
-        return $this->payment_method_objects;
-    }
-
-
-    /**
-     * Changes the payment method's class name into the payment method type's name
-     * (as used on the payment method's table's PMD_type field)
-     *
-     * @param string $classname
-     * @return string
-     */
-    public function payment_method_type_sans_class_prefix(string $classname): string
-    {
-        return str_replace('EE_PMT_', '', $classname);
-    }
-
-
-    /**
-     * Does the opposite of payment-method_type_sans_prefix
-     *
-     * @param string $type
-     * @return string
-     */
-    public function payment_method_class_from_type(string $type): string
-    {
-        return 'EE_PMT_' . $type;
-    }
-
-
-    /**
-     * Activates a payment method of the given type.
-     *
-     * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
-     * @return EE_Payment_Method
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function activate_a_payment_method_of_type(string $payment_method_type): EE_Payment_Method
-    {
-        $this->maybe_register_payment_methods();
-        $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
-            $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
-            if (class_exists($pm_type_class)) {
-                /** @var $pm_type_obj EE_PMT_Base */
-                $pm_type_obj    = new $pm_type_class();
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
-                    $payment_method = $this->create_payment_method_of_type($pm_type_obj);
-                }
-                $payment_method->set_type($payment_method_type);
-                $this->initialize_payment_method($payment_method);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'There is no payment method of type %1$s, so it could not be activated',
-                            'event_espresso'
-                        ),
-                        $pm_type_class
-                    )
-                );
-            }
-        }
-        $payment_method->set_active();
-        $payment_method->save();
-
-        // delete any auto-deactivation notices that may have been set
-        PersistentAdminNoticeManager::deletePersistentAdminNotice('auto-deactivated-' . $payment_method->slug());
-
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        // if this was the invoice message type, make sure users can view their invoices
-        if (
-            $payment_method->type() === 'Invoice'
-            && (
-            ! EEH_MSG_Template::is_mt_active('invoice')
-            )
-        ) {
-            $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            /** @type EE_Message_Resource_Manager $message_resource_manager */
-            $message_resource_manager->ensure_message_type_is_active('invoice', 'html');
-            new PersistentAdminNotice(
-                'invoice_pm_requirements_notice',
-                sprintf(
-                    esc_html__(
-                        'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
-                        'event_espresso'
-                    ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
-                    '</a>'
-                ),
-                true
-            );
-        }
-
-        do_action(
-            'AHEE__EE_Payment_Method_Manager__activate_a_payment_method_of_type__after_activation',
-            $payment_method,
-            $payment_method_type
-        );
-        return $payment_method;
-    }
-
-
-    /**
-     * Creates a payment method of the specified type. Does not save it.
-     *
-     * @param EE_PMT_Base $pm_type_obj
-     * @return EE_Payment_Method
-     * @throws EE_Error*@throws ReflectionException
-     * @throws ReflectionException
-     * @global WP_User    $current_user
-     */
-    public function create_payment_method_of_type(EE_PMT_Base $pm_type_obj): EE_Payment_Method
-    {
-        global $current_user;
-        return EE_Payment_Method::new_instance(
-            [
-                'PMD_type'       => $pm_type_obj->system_name(),
-                'PMD_name'       => $pm_type_obj->defaultFrontendName(),
-                'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
-                'PMD_wp_user'    => $current_user->ID,
-                'PMD_order'      => EEM_Payment_Method::instance()->count(
-                    [['PMD_type' => ['!=', 'Admin_Only']]]
-                ) * 10,
-            ]
-        );
-    }
-
-
-    /**
-     * Sets the initial payment method properties (including extra meta)
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_payment_method(EE_Payment_Method $payment_method): EE_Payment_Method
-    {
-        $pm_type_obj = $payment_method->type_obj();
-        $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
-            $payment_method->set_button_url($pm_type_obj->default_button_url());
-        }
-        // now add setup its default extra meta properties
-        $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
-            // verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
-                $payment_method->save();
-            }
-            foreach ($extra_metas as $meta_name => $input) {
-                $payment_method->update_extra_meta($meta_name, $input->raw_value());
-            }
-        }
-        return $payment_method;
-    }
-
-
-    /**
-     * Makes sure the payment method is related to the specified payment method
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return EE_Payment_Method
-     * @deprecated in 4.9.40 because the currency payment method table is being deprecated
-     */
-    public function set_usable_currencies_on_payment_method(EE_Payment_Method $payment_method): EE_Payment_Method
-    {
-        EE_Error::doing_it_wrong(
-            'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
-            esc_html__(
-                'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
-                'event_espresso'
-            ),
-            '4.9.40'
-        );
-        return $payment_method;
-    }
-
-
-    /**
-     * Deactivates a payment method of the given payment method slug.
-     *
-     * @param string $payment_method_slug The slug for the payment method to deactivate.
-     * @return int count of rows updated.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function deactivate_payment_method(string $payment_method_slug): int
-    {
-        EE_Log::instance()->log(
-            __FILE__,
-            __FUNCTION__,
-            sprintf(
-                esc_html__(
-                    'Payment method with slug %1$s is being deactivated by site admin',
-                    'event_espresso'
-                ),
-                $payment_method_slug
-            ),
-            'payment_method_change'
-        );
-        $count_updated = EEM_Payment_Method::instance()->update(
-            ['PMD_scope' => []],
-            [['PMD_slug' => $payment_method_slug]]
-        );
-        do_action(
-            'AHEE__EE_Payment_Method_Manager__deactivate_payment_method__after_deactivating_payment_method',
-            $payment_method_slug,
-            $count_updated
-        );
-        return $count_updated;
-    }
-
-
-    /**
-     * initializes payment method access caps via EE_Capabilities::init_role_caps()
-     * upon EE_Payment_Method_Manager construction
-     *
-     * @throws EE_Error
-     * @throws DomainException
-     */
-    public function initializePaymentMethodCaps()
-    {
-        // don't do this twice
-        if ($this->payment_method_caps_initialized) {
-            return;
-        }
-        EE_Capabilities::instance()->addCaps(
-            $this->getPaymentMethodCaps()
-        );
-        $this->payment_method_caps_initialized = true;
-    }
-
-
-    /**
-     * array  of dynamic payment method access caps.
-     * at the time of writing, october 20 2014, these are the caps added:
-     *  ee_payment_method_admin_only
-     *  ee_payment_method_aim
-     *  ee_payment_method_bank
-     *  ee_payment_method_check
-     *  ee_payment_method_invoice
-     *  ee_payment_method_mijireh
-     *  ee_payment_method_paypal_pro
-     *  ee_payment_method_paypal_standard
-     * Any other payment methods added to core or via addons will also get
-     * their related capability automatically added too, so long as they are
-     * registered properly using EE_Register_Payment_Method::register()
-     *
-     * @return array
-     * @throws DomainException
-     */
-    protected function getPaymentMethodCaps(): array
-    {
-        $caps = [];
-        foreach ($this->payment_method_type_names() as $payment_method_name) {
-            $caps = $this->addPaymentMethodCap($payment_method_name, $caps);
-        }
-        return $caps;
-    }
-
-
-    /**
-     * @param string $payment_method_name
-     * @param array  $payment_method_caps
-     * @param string $role
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCap(
-        string $payment_method_name,
-        array $payment_method_caps,
-        string $role = 'administrator'
-    ): array {
-        if (empty($payment_method_name)) {
-            throw new DomainException(
-                esc_html__(
-                    'The name of a payment method must be specified to add capabilities.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (empty($role)) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'No role was supplied while trying to add capabilities for the %1$s payment method.',
-                        'event_espresso'
-                    ),
-                    $payment_method_name
-                )
-            );
-        }
-        if (! isset($payment_method_caps[ $role ])) {
-            $payment_method_caps[ $role ] = [];
-        }
-        $payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
-                                          . strtolower($payment_method_name);
-        return $payment_method_caps;
-    }
-
-
-    /**
-     * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
-     * to add dynamic payment method access caps when capabilities are reset
-     * (or if that filter is called and PM caps are not already set)
-     *
-     * @param array $caps capabilities being filtered
-     * @param bool  $reset
-     * @return array
-     * @throws DomainException
-     */
-    public function addPaymentMethodCapsDuringReset(array $caps, bool $reset = false): array
-    {
-        if ($reset || ! $this->payment_method_caps_initialized) {
-            $this->payment_method_caps_initialized = true;
-            $caps                                  = array_merge_recursive($caps, $this->getPaymentMethodCaps());
-        }
-        return $caps;
-    }
-
-
-    /**
-     * @param $caps
-     * @return mixed
-     * @deprecated 4.9.42
-     */
-    public function add_payment_method_caps($caps)
-    {
-        return $caps;
-    }
+	/**
+	 * prefix added to all payment method capabilities names
+	 */
+	const CAPABILITIES_PREFIX = 'ee_payment_method_';
+
+	private static ?EE_Payment_Method_Manager $_instance = null;
+
+	/**
+	 * @var boolean
+	 */
+	protected bool $payment_method_caps_initialized = false;
+
+	/**
+	 * @var string[] keys are class names without 'EE_PMT_', values are their filepaths
+	 */
+	protected array $_payment_method_types = [];
+
+	/**
+	 * @var EE_PMT_Base[]
+	 */
+	protected array $payment_method_objects = [];
+
+
+	/**
+	 * EE_Payment_Method_Manager constructor.
+	 *
+	 * @throws DomainException
+	 */
+	public function __construct()
+	{
+		// if in admin lets ensure caps are set.
+		if (is_admin()) {
+			$this->_register_payment_methods();
+			// add PM caps when EE_Capabilities is initialized
+			add_action(
+				'AHEE__EE_Capabilities__init_caps__before_initialization',
+				[$this, 'initializePaymentMethodCaps']
+			);
+			// plus any time they get reset
+			add_filter(
+				'FHEE__EE_Capabilities__addCaps__capabilities_to_add',
+				[$this, 'addPaymentMethodCapsDuringReset']
+			);
+		}
+		add_action('http_api_curl', ['EE_Payment_Method_Manager', 'curlRequestsToPaypalUseTls'], 10, 3);
+	}
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @return EE_Payment_Method_Manager instance
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EE_Payment_Method_Manager
+	{
+		// check if class object is instantiated, and instantiated properly
+		if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+			EE_Registry::instance()->load_lib('PMT_Base');
+			self::$_instance = new self();
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets the instance and returns a new one
+	 *
+	 * @return EE_Payment_Method_Manager
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset(): EE_Payment_Method_Manager
+	{
+		self::$_instance = null;
+		return self::instance();
+	}
+
+
+	/**
+	 * Force posts to PayPal to use TLS v1.2. See:
+	 * https://core.trac.wordpress.org/ticket/36320
+	 * https://core.trac.wordpress.org/ticket/34924#comment:15
+	 * https://www.paypal-knowledge.com/infocenter/index?page=content&widgetview=true&id=FAQ1914&viewlocale=en_US
+	 * This will affect PayPal standard, pro, express, and Payflow.
+	 *
+	 * @param $handle
+	 * @param $r
+	 * @param $url
+	 */
+	public static function curlRequestsToPaypalUseTls($handle, $r, $url)
+	{
+		if (strpos($url, 'https://') !== false && strpos($url, '.paypal.com') !== false) {
+			// Use the value of the constant CURL_SSLVERSION_TLSv1 = 1
+			// instead of the constant because it might not be defined
+			curl_setopt($handle, CURLOPT_SSLVERSION, 6);
+		}
+	}
+
+
+	/**
+	 * If necessary, re-register payment methods
+	 *
+	 * @param boolean $force_recheck whether to recheck for payment method types,
+	 *                               or just re-use the PMTs we found last time we checked during this request (if
+	 *                               we have not yet checked during this request, then we need to check anyways)
+	 */
+	public function maybe_register_payment_methods(bool $force_recheck = false)
+	{
+		if (! $this->_payment_method_types || $force_recheck) {
+			$this->_register_payment_methods();
+		}
+	}
+
+
+	/**
+	 * register_payment_methods
+	 *
+	 * @return array
+	 */
+	protected function _register_payment_methods(): array
+	{
+		// grab list of installed modules
+		$pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+		// filter list of modules to register
+		$pm_to_register = apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			$pm_to_register
+		);
+		// remove any duplicates if that should happen for some reason
+		$pm_to_register = array_unique($pm_to_register);
+		// loop through folders
+		foreach ($pm_to_register as $pm_path) {
+			$this->register_payment_method($pm_path);
+		}
+		do_action(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods',
+			$this->_payment_method_types
+		);
+		// filter list of installed modules
+		// keep them organized alphabetically by the payment method type's name
+		ksort($this->_payment_method_types);
+		return apply_filters(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__installed_payment_methods',
+			$this->_payment_method_types
+		);
+	}
+
+
+	/**
+	 * register_payment_method- makes core aware of this payment method
+	 *
+	 * @param string $payment_method_path - full path up to and including payment method folder
+	 * @return boolean
+	 */
+	public function register_payment_method(string $payment_method_path = ''): bool
+	{
+		do_action('AHEE__EE_Payment_Method_Manager__register_payment_method__begin', $payment_method_path);
+		$module_ext = '.pm.php';
+		// make all separators match
+		$payment_method_path = rtrim(str_replace('/\\', '/', $payment_method_path), '/');
+		// grab and sanitize module name
+		$module_dir = basename($payment_method_path);
+		// create class name from module directory name
+		$module = str_replace(['_', ' '], [' ', '_'], $module_dir);
+		// add class prefix
+		$module_class = 'EE_PMT_' . $module;
+		// does the module exist ?
+		if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %s payment method file could not be found or is not readable due to file permissions.',
+					'event_espresso'
+				),
+				$module
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the module class file
+		require_once($payment_method_path . '/' . $module_class . $module_ext);
+		// verify that class exists
+		if (! class_exists($module_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s module class does not exist.', 'event_espresso'),
+				$module_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// add to array of registered modules
+		$this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
+		return true;
+	}
+
+
+	/**
+	 * Checks if a payment method has been registered, and if so includes it
+	 *
+	 * @param string  $payment_method_name like 'PayPal_Pro', (ie class name without the prefix 'EEPM_')
+	 * @param boolean $force_recheck       whether to force re-checking for new payment method types
+	 * @return boolean
+	 */
+	public function payment_method_type_exists(string $payment_method_name, bool $force_recheck = false): bool
+	{
+		if (
+			$force_recheck
+			|| empty($this->_payment_method_types)
+			|| ! isset($this->_payment_method_types[ $payment_method_name ])
+		) {
+			$this->maybe_register_payment_methods($force_recheck);
+		}
+		if (isset($this->_payment_method_types[ $payment_method_name ])) {
+			require_once($this->_payment_method_types[ $payment_method_name ]);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns all the class names of the various payment method types
+	 *
+	 * @param boolean $with_prefixes TRUE: get payment method type class names; false just their 'names'
+	 *                               (what you'd find in wp_esp_payment_method.PMD_type)
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return array
+	 */
+	public function payment_method_type_names(bool $with_prefixes = false, bool $force_recheck = false): array
+	{
+		$this->maybe_register_payment_methods($force_recheck);
+		if ($with_prefixes) {
+			$classnames      = array_keys($this->_payment_method_types);
+			$payment_methods = [];
+			foreach ($classnames as $classname) {
+				$payment_methods[] = $this->payment_method_class_from_type($classname);
+			}
+			return $payment_methods;
+		}
+		return array_keys($this->_payment_method_types);
+	}
+
+
+	/**
+	 * Gets an object of each payment method type, none of which are bound to a
+	 * payment method instance
+	 *
+	 * @param boolean $force_recheck whether to force re-checking for new payment method types
+	 * @return EE_PMT_Base[]
+	 */
+	public function payment_method_types(bool $force_recheck = false): array
+	{
+		if ($force_recheck || empty($this->payment_method_objects)) {
+			$this->maybe_register_payment_methods($force_recheck);
+			foreach ($this->payment_method_type_names(true) as $classname) {
+				if (! isset($this->payment_method_objects[ $classname ])) {
+					$this->payment_method_objects[ $classname ] = new $classname();
+				}
+			}
+		}
+		return $this->payment_method_objects;
+	}
+
+
+	/**
+	 * Changes the payment method's class name into the payment method type's name
+	 * (as used on the payment method's table's PMD_type field)
+	 *
+	 * @param string $classname
+	 * @return string
+	 */
+	public function payment_method_type_sans_class_prefix(string $classname): string
+	{
+		return str_replace('EE_PMT_', '', $classname);
+	}
+
+
+	/**
+	 * Does the opposite of payment-method_type_sans_prefix
+	 *
+	 * @param string $type
+	 * @return string
+	 */
+	public function payment_method_class_from_type(string $type): string
+	{
+		return 'EE_PMT_' . $type;
+	}
+
+
+	/**
+	 * Activates a payment method of the given type.
+	 *
+	 * @param string $payment_method_type the PMT_type; for EE_PMT_Invoice this would be 'Invoice'
+	 * @return EE_Payment_Method
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function activate_a_payment_method_of_type(string $payment_method_type): EE_Payment_Method
+	{
+		$this->maybe_register_payment_methods();
+		$payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
+		if (! $payment_method instanceof EE_Payment_Method) {
+			$pm_type_class = $this->payment_method_class_from_type($payment_method_type);
+			if (class_exists($pm_type_class)) {
+				/** @var $pm_type_obj EE_PMT_Base */
+				$pm_type_obj    = new $pm_type_class();
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
+				if (! $payment_method) {
+					$payment_method = $this->create_payment_method_of_type($pm_type_obj);
+				}
+				$payment_method->set_type($payment_method_type);
+				$this->initialize_payment_method($payment_method);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'There is no payment method of type %1$s, so it could not be activated',
+							'event_espresso'
+						),
+						$pm_type_class
+					)
+				);
+			}
+		}
+		$payment_method->set_active();
+		$payment_method->save();
+
+		// delete any auto-deactivation notices that may have been set
+		PersistentAdminNoticeManager::deletePersistentAdminNotice('auto-deactivated-' . $payment_method->slug());
+
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		// if this was the invoice message type, make sure users can view their invoices
+		if (
+			$payment_method->type() === 'Invoice'
+			&& (
+			! EEH_MSG_Template::is_mt_active('invoice')
+			)
+		) {
+			$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			/** @type EE_Message_Resource_Manager $message_resource_manager */
+			$message_resource_manager->ensure_message_type_is_active('invoice', 'html');
+			new PersistentAdminNotice(
+				'invoice_pm_requirements_notice',
+				sprintf(
+					esc_html__(
+						'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
+						'event_espresso'
+					),
+					'<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
+					'</a>'
+				),
+				true
+			);
+		}
+
+		do_action(
+			'AHEE__EE_Payment_Method_Manager__activate_a_payment_method_of_type__after_activation',
+			$payment_method,
+			$payment_method_type
+		);
+		return $payment_method;
+	}
+
+
+	/**
+	 * Creates a payment method of the specified type. Does not save it.
+	 *
+	 * @param EE_PMT_Base $pm_type_obj
+	 * @return EE_Payment_Method
+	 * @throws EE_Error*@throws ReflectionException
+	 * @throws ReflectionException
+	 * @global WP_User    $current_user
+	 */
+	public function create_payment_method_of_type(EE_PMT_Base $pm_type_obj): EE_Payment_Method
+	{
+		global $current_user;
+		return EE_Payment_Method::new_instance(
+			[
+				'PMD_type'       => $pm_type_obj->system_name(),
+				'PMD_name'       => $pm_type_obj->defaultFrontendName(),
+				'PMD_admin_name' => $pm_type_obj->pretty_name(),
+				'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
+				'PMD_wp_user'    => $current_user->ID,
+				'PMD_order'      => EEM_Payment_Method::instance()->count(
+					[['PMD_type' => ['!=', 'Admin_Only']]]
+				) * 10,
+			]
+		);
+	}
+
+
+	/**
+	 * Sets the initial payment method properties (including extra meta)
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_payment_method(EE_Payment_Method $payment_method): EE_Payment_Method
+	{
+		$pm_type_obj = $payment_method->type_obj();
+		$payment_method->set_description($pm_type_obj->default_description());
+		if (! $payment_method->button_url()) {
+			$payment_method->set_button_url($pm_type_obj->default_button_url());
+		}
+		// now add setup its default extra meta properties
+		$extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
+		if (! empty($extra_metas)) {
+			// verify the payment method has an ID before adding extra meta
+			if (! $payment_method->ID()) {
+				$payment_method->save();
+			}
+			foreach ($extra_metas as $meta_name => $input) {
+				$payment_method->update_extra_meta($meta_name, $input->raw_value());
+			}
+		}
+		return $payment_method;
+	}
+
+
+	/**
+	 * Makes sure the payment method is related to the specified payment method
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return EE_Payment_Method
+	 * @deprecated in 4.9.40 because the currency payment method table is being deprecated
+	 */
+	public function set_usable_currencies_on_payment_method(EE_Payment_Method $payment_method): EE_Payment_Method
+	{
+		EE_Error::doing_it_wrong(
+			'EE_Payment_Method_Manager::set_usable_currencies_on_payment_method',
+			esc_html__(
+				'We no longer define what currencies are usable by payment methods. Its not used nor efficient.',
+				'event_espresso'
+			),
+			'4.9.40'
+		);
+		return $payment_method;
+	}
+
+
+	/**
+	 * Deactivates a payment method of the given payment method slug.
+	 *
+	 * @param string $payment_method_slug The slug for the payment method to deactivate.
+	 * @return int count of rows updated.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function deactivate_payment_method(string $payment_method_slug): int
+	{
+		EE_Log::instance()->log(
+			__FILE__,
+			__FUNCTION__,
+			sprintf(
+				esc_html__(
+					'Payment method with slug %1$s is being deactivated by site admin',
+					'event_espresso'
+				),
+				$payment_method_slug
+			),
+			'payment_method_change'
+		);
+		$count_updated = EEM_Payment_Method::instance()->update(
+			['PMD_scope' => []],
+			[['PMD_slug' => $payment_method_slug]]
+		);
+		do_action(
+			'AHEE__EE_Payment_Method_Manager__deactivate_payment_method__after_deactivating_payment_method',
+			$payment_method_slug,
+			$count_updated
+		);
+		return $count_updated;
+	}
+
+
+	/**
+	 * initializes payment method access caps via EE_Capabilities::init_role_caps()
+	 * upon EE_Payment_Method_Manager construction
+	 *
+	 * @throws EE_Error
+	 * @throws DomainException
+	 */
+	public function initializePaymentMethodCaps()
+	{
+		// don't do this twice
+		if ($this->payment_method_caps_initialized) {
+			return;
+		}
+		EE_Capabilities::instance()->addCaps(
+			$this->getPaymentMethodCaps()
+		);
+		$this->payment_method_caps_initialized = true;
+	}
+
+
+	/**
+	 * array  of dynamic payment method access caps.
+	 * at the time of writing, october 20 2014, these are the caps added:
+	 *  ee_payment_method_admin_only
+	 *  ee_payment_method_aim
+	 *  ee_payment_method_bank
+	 *  ee_payment_method_check
+	 *  ee_payment_method_invoice
+	 *  ee_payment_method_mijireh
+	 *  ee_payment_method_paypal_pro
+	 *  ee_payment_method_paypal_standard
+	 * Any other payment methods added to core or via addons will also get
+	 * their related capability automatically added too, so long as they are
+	 * registered properly using EE_Register_Payment_Method::register()
+	 *
+	 * @return array
+	 * @throws DomainException
+	 */
+	protected function getPaymentMethodCaps(): array
+	{
+		$caps = [];
+		foreach ($this->payment_method_type_names() as $payment_method_name) {
+			$caps = $this->addPaymentMethodCap($payment_method_name, $caps);
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * @param string $payment_method_name
+	 * @param array  $payment_method_caps
+	 * @param string $role
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCap(
+		string $payment_method_name,
+		array $payment_method_caps,
+		string $role = 'administrator'
+	): array {
+		if (empty($payment_method_name)) {
+			throw new DomainException(
+				esc_html__(
+					'The name of a payment method must be specified to add capabilities.',
+					'event_espresso'
+				)
+			);
+		}
+		if (empty($role)) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'No role was supplied while trying to add capabilities for the %1$s payment method.',
+						'event_espresso'
+					),
+					$payment_method_name
+				)
+			);
+		}
+		if (! isset($payment_method_caps[ $role ])) {
+			$payment_method_caps[ $role ] = [];
+		}
+		$payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+										  . strtolower($payment_method_name);
+		return $payment_method_caps;
+	}
+
+
+	/**
+	 * callback for FHEE__EE_Capabilities__init_role_caps__caps_map filter
+	 * to add dynamic payment method access caps when capabilities are reset
+	 * (or if that filter is called and PM caps are not already set)
+	 *
+	 * @param array $caps capabilities being filtered
+	 * @param bool  $reset
+	 * @return array
+	 * @throws DomainException
+	 */
+	public function addPaymentMethodCapsDuringReset(array $caps, bool $reset = false): array
+	{
+		if ($reset || ! $this->payment_method_caps_initialized) {
+			$this->payment_method_caps_initialized = true;
+			$caps                                  = array_merge_recursive($caps, $this->getPaymentMethodCaps());
+		}
+		return $caps;
+	}
+
+
+	/**
+	 * @param $caps
+	 * @return mixed
+	 * @deprecated 4.9.42
+	 */
+	public function add_payment_method_caps($caps)
+	{
+		return $caps;
+	}
 }

Spacing +27 added lines, -27 removed lines

@@ -75,7 +75,7 @@ 
     public static function instance(): EE_Payment_Method_Manager
     {
         // check if class object is instantiated, and instantiated properly
-        if (! self::$_instance instanceof EE_Payment_Method_Manager) {
+        if ( ! self::$_instance instanceof EE_Payment_Method_Manager) {
             EE_Registry::instance()->load_lib('PMT_Base');
             self::$_instance = new self();
         }
@@ -128,7 +128,7 @@ 
      */
     public function maybe_register_payment_methods(bool $force_recheck = false)
     {
-        if (! $this->_payment_method_types || $force_recheck) {
+        if ( ! $this->_payment_method_types || $force_recheck) {
             $this->_register_payment_methods();
         }
     }
@@ -142,7 +142,7 @@ 
     protected function _register_payment_methods(): array
     {
         // grab list of installed modules
-        $pm_to_register = glob(EE_PAYMENT_METHODS . '*', GLOB_ONLYDIR);
+        $pm_to_register = glob(EE_PAYMENT_METHODS.'*', GLOB_ONLYDIR);
         // filter list of modules to register
         $pm_to_register = apply_filters(
             'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
@@ -185,9 +185,9 @@ 
         // create class name from module directory name
         $module = str_replace(['_', ' '], [' ', '_'], $module_dir);
         // add class prefix
-        $module_class = 'EE_PMT_' . $module;
+        $module_class = 'EE_PMT_'.$module;
         // does the module exist ?
-        if (! is_readable($payment_method_path . '/' . $module_class . $module_ext)) {
+        if ( ! is_readable($payment_method_path.'/'.$module_class.$module_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %s payment method file could not be found or is not readable due to file permissions.',
@@ -195,22 +195,22 @@ 
                 ),
                 $module
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the module class file
-        require_once($payment_method_path . '/' . $module_class . $module_ext);
+        require_once($payment_method_path.'/'.$module_class.$module_ext);
         // verify that class exists
-        if (! class_exists($module_class)) {
+        if ( ! class_exists($module_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s module class does not exist.', 'event_espresso'),
                 $module_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // add to array of registered modules
-        $this->_payment_method_types[ $module ] = $payment_method_path . '/' . $module_class . $module_ext;
+        $this->_payment_method_types[$module] = $payment_method_path.'/'.$module_class.$module_ext;
         return true;
     }
 
@@ -227,12 +227,12 @@ 
         if (
             $force_recheck
             || empty($this->_payment_method_types)
-            || ! isset($this->_payment_method_types[ $payment_method_name ])
+            || ! isset($this->_payment_method_types[$payment_method_name])
         ) {
             $this->maybe_register_payment_methods($force_recheck);
         }
-        if (isset($this->_payment_method_types[ $payment_method_name ])) {
-            require_once($this->_payment_method_types[ $payment_method_name ]);
+        if (isset($this->_payment_method_types[$payment_method_name])) {
+            require_once($this->_payment_method_types[$payment_method_name]);
             return true;
         }
         return false;
@@ -274,8 +274,8 @@ 
         if ($force_recheck || empty($this->payment_method_objects)) {
             $this->maybe_register_payment_methods($force_recheck);
             foreach ($this->payment_method_type_names(true) as $classname) {
-                if (! isset($this->payment_method_objects[ $classname ])) {
-                    $this->payment_method_objects[ $classname ] = new $classname();
+                if ( ! isset($this->payment_method_objects[$classname])) {
+                    $this->payment_method_objects[$classname] = new $classname();
                 }
             }
         }
@@ -304,7 +304,7 @@ 
      */
     public function payment_method_class_from_type(string $type): string
     {
-        return 'EE_PMT_' . $type;
+        return 'EE_PMT_'.$type;
     }
 
 
@@ -321,13 +321,13 @@ 
     {
         $this->maybe_register_payment_methods();
         $payment_method = EEM_Payment_Method::instance()->get_one_of_type($payment_method_type);
-        if (! $payment_method instanceof EE_Payment_Method) {
+        if ( ! $payment_method instanceof EE_Payment_Method) {
             $pm_type_class = $this->payment_method_class_from_type($payment_method_type);
             if (class_exists($pm_type_class)) {
                 /** @var $pm_type_obj EE_PMT_Base */
                 $pm_type_obj    = new $pm_type_class();
                 $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_type_obj->system_name());
-                if (! $payment_method) {
+                if ( ! $payment_method) {
                     $payment_method = $this->create_payment_method_of_type($pm_type_obj);
                 }
                 $payment_method->set_type($payment_method_type);
@@ -348,7 +348,7 @@ 
         $payment_method->save();
 
         // delete any auto-deactivation notices that may have been set
-        PersistentAdminNoticeManager::deletePersistentAdminNotice('auto-deactivated-' . $payment_method->slug());
+        PersistentAdminNoticeManager::deletePersistentAdminNotice('auto-deactivated-'.$payment_method->slug());
 
         /** @type EE_Message_Resource_Manager $message_resource_manager */
         // if this was the invoice message type, make sure users can view their invoices
@@ -368,7 +368,7 @@ 
                         'The Invoice payment method has been activated. It requires the %1$sinvoice message%2$s type to be active, so it was automatically activated for you.',
                         'event_espresso'
                     ),
-                    '<a href="' . admin_url('admin.php?page=espresso_messages&action=settings') . '">',
+                    '<a href="'.admin_url('admin.php?page=espresso_messages&action=settings').'">',
                     '</a>'
                 ),
                 true
@@ -401,7 +401,7 @@ 
                 'PMD_type'       => $pm_type_obj->system_name(),
                 'PMD_name'       => $pm_type_obj->defaultFrontendName(),
                 'PMD_admin_name' => $pm_type_obj->pretty_name(),
-                'PMD_slug'       => $pm_type_obj->system_name(),// automatically converted to slug
+                'PMD_slug'       => $pm_type_obj->system_name(), // automatically converted to slug
                 'PMD_wp_user'    => $current_user->ID,
                 'PMD_order'      => EEM_Payment_Method::instance()->count(
                     [['PMD_type' => ['!=', 'Admin_Only']]]
@@ -423,14 +423,14 @@ 
     {
         $pm_type_obj = $payment_method->type_obj();
         $payment_method->set_description($pm_type_obj->default_description());
-        if (! $payment_method->button_url()) {
+        if ( ! $payment_method->button_url()) {
             $payment_method->set_button_url($pm_type_obj->default_button_url());
         }
         // now add setup its default extra meta properties
         $extra_metas = $pm_type_obj->settings_form()->extra_meta_inputs();
-        if (! empty($extra_metas)) {
+        if ( ! empty($extra_metas)) {
             // verify the payment method has an ID before adding extra meta
-            if (! $payment_method->ID()) {
+            if ( ! $payment_method->ID()) {
                 $payment_method->save();
             }
             foreach ($extra_metas as $meta_name => $input) {
@@ -576,10 +576,10 @@ 
                 )
             );
         }
-        if (! isset($payment_method_caps[ $role ])) {
-            $payment_method_caps[ $role ] = [];
+        if ( ! isset($payment_method_caps[$role])) {
+            $payment_method_caps[$role] = [];
         }
-        $payment_method_caps[ $role ][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
+        $payment_method_caps[$role][] = EE_Payment_Method_Manager::CAPABILITIES_PREFIX
                                           . strtolower($payment_method_name);
         return $payment_method_caps;
     }

core/libraries/payment_methods/EE_PMT_Base.lib.php

Indentation +926 added lines, -926 removed lines

@@ -16,930 +16,930 @@
  */
 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;
-
-        // if there is billing info, clean it and save it NOW before doing anything else
-        if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
-            $this->_save_billing_info_to_attendee($billing_info, $transaction);
-        }
-
-        // @todo: add surcharge for the payment method, if any
-        if (! $this->_gateway instanceof EE_Gateway) {
-            // no gateway provided
-            // there is no payment. Must be an offline gateway
-            // create a payment object anyways, but don't save it
-            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);
-        if ($previous_payment_count >= $max_payment_attempts) {
-            return $payment;
-        }
-
-        return $this->passPaymentToGateway($payment, $transaction, $billing_info, $return_url, $fail_url);
-    }
-
-
-    /**
-     * 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;
+
+		// if there is billing info, clean it and save it NOW before doing anything else
+		if ($billing_info instanceof EE_Billing_Attendee_Info_Form) {
+			$this->_save_billing_info_to_attendee($billing_info, $transaction);
+		}
+
+		// @todo: add surcharge for the payment method, if any
+		if (! $this->_gateway instanceof EE_Gateway) {
+			// no gateway provided
+			// there is no payment. Must be an offline gateway
+			// create a payment object anyways, but don't save it
+			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);
+		if ($previous_payment_count >= $max_payment_attempts) {
+			return $payment;
+		}
+
+		return $this->passPaymentToGateway($payment, $transaction, $billing_info, $return_url, $fail_url);
+	}
+
+
+	/**
+	 * 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
@@ -373,7 +373,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
             // there is no payment. Must be an offline gateway
             // create a payment object anyways, but don't save it
@@ -391,7 +391,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
@@ -453,7 +453,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,
@@ -595,7 +595,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"),
@@ -621,7 +621,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__,
@@ -631,7 +631,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",
@@ -644,7 +644,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!",
@@ -759,7 +759,7 @@ 
      */
     public function payment_occurs(): string
     {
-        if (! $this->_gateway) {
+        if ( ! $this->_gateway) {
             return EE_PMT_Base::offline;
         }
         if ($this->_gateway instanceof EE_Onsite_Gateway) {
@@ -791,7 +791,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
         );
@@ -890,7 +890,7 @@ 
      */
     public function get_help_tab_name(): string
     {
-        return 'ee_' . strtolower($this->system_name()) . '_help_tab';
+        return 'ee_'.strtolower($this->system_name()).'_help_tab';
     }
 
 
@@ -902,7 +902,7 @@ 
      */
     public function cap_name(): string
     {
-        return 'ee_payment_method_' . strtolower($this->system_name());
+        return 'ee_payment_method_'.strtolower($this->system_name());
     }
 
 
@@ -938,7 +938,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]
         );
     }

core/services/orm/ModelFieldFactory.php

Indentation +619 added lines, -619 removed lines

@@ -46,623 +46,623 @@
  */
 class ModelFieldFactory
 {
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-
-    /**
-     * ModelFieldFactory constructor.
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_All_Caps_Text_Field
-     */
-    public function createAllCapsTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_All_Caps_Text_Field {
-        return $this->loader->getNew(
-            'EE_All_Caps_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param string $model_name
-     * @return EE_Any_Foreign_Model_Name_Field
-     */
-    public function createAnyForeignModelNameField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null,
-        string $model_name = ''
-    ): EE_Any_Foreign_Model_Name_Field {
-        return $this->loader->getNew(
-            'EE_Any_Foreign_Model_Name_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $model_name]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Boolean_Field
-     */
-    public function createBooleanField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Boolean_Field {
-        return $this->loader->getNew(
-            'EE_Boolean_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @param string $timezone_string
-     * @return EE_Datetime_Field
-     */
-    public function createDatetimeField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable = false,
-        string $default_value = EE_Datetime_Field::now,
-        string $timezone_string = ''
-    ): EE_Datetime_Field {
-        return $this->loader->getNew(
-            'EE_Datetime_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $timezone_string]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_DB_Only_Float_Field
-     */
-    public function createDbOnlyFloatField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_DB_Only_Float_Field {
-        return $this->loader->getNew(
-            'EE_DB_Only_Float_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_DB_Only_Int_Field
-     */
-    public function createDbOnlyIntField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_DB_Only_Int_Field {
-        return $this->loader->getNew(
-            'EE_DB_Only_Int_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_DB_Only_Text_Field
-     */
-    public function createDbOnlyTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_DB_Only_Text_Field {
-        return $this->loader->getNew(
-            'EE_DB_Only_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string      $table_column
-     * @param string      $nice_name
-     * @param bool        $nullable
-     * @param string|null $default_value
-     * @return EE_Email_Field
-     */
-    public function createEmailField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable = true,
-        string $default_value = ''
-    ): EE_Email_Field {
-        return $this->loader->getNew(
-            'EE_Email_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param array  $allowed_enum_values keys are values to be used in the DB,
-     *                                    values are how they should be displayed
-     * @return EE_Enum_Integer_Field
-     */
-    public function createEnumIntegerField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null,
-        array $allowed_enum_values = []
-    ): EE_Enum_Integer_Field {
-        return $this->loader->getNew(
-            'EE_Enum_Integer_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $allowed_enum_values]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param array  $allowed_enum_values keys are values to be used in the DB,
-     *                                    values are how they should be displayed
-     * @return EE_Enum_Text_Field
-     */
-    public function createEnumTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value,
-        array $allowed_enum_values
-    ): EE_Enum_Text_Field {
-        return $this->loader->getNew(
-            'EE_Enum_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $allowed_enum_values]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Float_Field
-     */
-    public function createFloatField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Float_Field {
-        return $this->loader->getNew(
-            'EE_Float_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param string $model_name
-     * @return EE_Foreign_Key_Int_Field
-     */
-    public function createForeignKeyIntField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value,
-        string $model_name
-    ): EE_Foreign_Key_Int_Field {
-        return $this->loader->getNew(
-            'EE_Foreign_Key_Int_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $model_name]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @param string $model_name
-     * @return EE_Foreign_Key_String_Field
-     */
-    public function createForeignKeyStringField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value,
-        string $model_name
-    ): EE_Foreign_Key_String_Field {
-        return $this->loader->getNew(
-            'EE_Foreign_Key_String_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $model_name]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Full_HTML_Field
-     */
-    public function createFullHtmlField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Full_HTML_Field {
-        return $this->loader->getNew(
-            'EE_Full_HTML_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Infinite_Integer_Field
-     */
-    public function createInfiniteIntegerField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Infinite_Integer_Field {
-        return $this->loader->getNew(
-            'EE_Infinite_Integer_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string  $table_column
-     * @param string  $nice_name
-     * @param bool    $nullable
-     * @param integer $default_value
-     * @return EE_Integer_Field
-     */
-    public function createIntegerField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable = false,
-        int $default_value = 0
-    ): EE_Integer_Field {
-        return $this->loader->getNew(
-            'EE_Integer_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Maybe_Serialized_Simple_HTML_Field
-     */
-    public function createMaybeSerializedSimpleHtmlField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Maybe_Serialized_Simple_HTML_Field {
-        return $this->loader->getNew(
-            'EE_Maybe_Serialized_Simple_HTML_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Maybe_Serialized_Text_Field
-     */
-    public function createMaybeSerializedTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Maybe_Serialized_Text_Field {
-        return $this->loader->getNew(
-            'EE_Maybe_Serialized_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Money_Field
-     */
-    public function createMoneyField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Money_Field {
-        return $this->loader->getNew(
-            'EE_Money_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param string $default_value
-     * @return EE_Plain_Text_Field
-     */
-    public function createPlainTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable = true,
-        string $default_value = ''
-    ): EE_Plain_Text_Field {
-        return $this->loader->getNew(
-            'EE_Plain_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Post_Content_Field
-     */
-    public function createPostContentField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Post_Content_Field {
-        return $this->loader->getNew(
-            'EE_Post_Content_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @return EE_Primary_Key_Int_Field
-     */
-    public function createPrimaryKeyIntField(string $table_column, string $nice_name): EE_Primary_Key_Int_Field
-    {
-        return $this->loader->getNew('EE_Primary_Key_Int_Field', [$table_column, $nice_name]);
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @return EE_Primary_Key_String_Field
-     */
-    public function createPrimaryKeyStringField(string $table_column, string $nice_name): EE_Primary_Key_String_Field
-    {
-        return $this->loader->getNew('EE_Primary_Key_String_Field', [$table_column, $nice_name]);
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Serialized_Text_Field
-     */
-    public function createSerializedTextField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Serialized_Text_Field {
-        return $this->loader->getNew(
-            'EE_Serialized_Text_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Simple_HTML_Field
-     */
-    public function createSimpleHtmlField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Simple_HTML_Field {
-        return $this->loader->getNew(
-            'EE_Simple_HTML_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Slug_Field
-     */
-    public function createSlugField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable = false,
-        $default_value = null
-    ): EE_Slug_Field {
-        return $this->loader->getNew(
-            'EE_Slug_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param null   $default_value
-     * @return EE_Trashed_Flag_Field
-     */
-    public function createTrashedFlagField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null
-    ): EE_Trashed_Flag_Field {
-        return $this->loader->getNew(
-            'EE_Trashed_Flag_Field',
-            [$table_column, $nice_name, $nullable, $default_value]
-        );
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @param mixed  $default_value
-     * @param array $values     If additional statuses are to be used other than the default WP statuses,
-     *                          then they can be registered via this property.
-     *                          The format of the array should be as follows:
-     *                          [
-     *                              'status_reference' => [
-     *                                  'label' => __('Status Reference Label', 'event_espresso'),
-     *                                  // whether status is shown on the frontend of the site
-     *                                  'public' => true,
-     *                                  // whether status is excluded from wp searches
-     *                                  'exclude_from_search' => false,
-     *                                  // whether status is included in queries
-     *                                  for the admin 'all' view in list table views.
-     *                                  'show_in_admin_all_list' => true,
-     *                                  // show in the list of statuses with post counts
-     *                                  // at the top of the admin list tables (i.e. Status Reference(2) )
-     *                                  'show_in_admin_status_list' => true,
-     *                                  // the text to display on the admin screen
-     *                                  // ( or you won't see your status count )
-     *                                  'label_count' => _n_noop(
-     *                                      'Status Reference <span class="count">(%s)</span>',
-     *                                      'Status References <span class="count">(%s)</span>'
-     *                                  ),
-     *                              ]
-     *                          ]
-     * @return EE_WP_Post_Status_Field
-     * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     */
-    public function createWpPostStatusField(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        $default_value = null,
-        array $values = []
-    ): EE_WP_Post_Status_Field {
-        return $this->loader->getNew(
-            'EE_WP_Post_Status_Field',
-            [$table_column, $nice_name, $nullable, $default_value, $values]
-        );
-    }
-
-
-    /**
-     * @param string $post_type
-     * @return EE_WP_Post_Type_Field
-     */
-    public function createWpPostTypeField(string $post_type): EE_WP_Post_Type_Field
-    {
-        return $this->loader->getNew('EE_WP_Post_Type_Field', [$post_type]);
-    }
-
-
-    /**
-     * @param string $table_column
-     * @param string $nice_name
-     * @param bool   $nullable
-     * @return EE_WP_User_Field
-     */
-    public function createWpUserField(string $table_column, string $nice_name, bool $nullable): EE_WP_User_Field
-    {
-        return $this->loader->getNew('EE_WP_User_Field', [$table_column, $nice_name, $nullable]);
-    }
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+
+	/**
+	 * ModelFieldFactory constructor.
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_All_Caps_Text_Field
+	 */
+	public function createAllCapsTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_All_Caps_Text_Field {
+		return $this->loader->getNew(
+			'EE_All_Caps_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param string $model_name
+	 * @return EE_Any_Foreign_Model_Name_Field
+	 */
+	public function createAnyForeignModelNameField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null,
+		string $model_name = ''
+	): EE_Any_Foreign_Model_Name_Field {
+		return $this->loader->getNew(
+			'EE_Any_Foreign_Model_Name_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $model_name]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Boolean_Field
+	 */
+	public function createBooleanField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Boolean_Field {
+		return $this->loader->getNew(
+			'EE_Boolean_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @param string $timezone_string
+	 * @return EE_Datetime_Field
+	 */
+	public function createDatetimeField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable = false,
+		string $default_value = EE_Datetime_Field::now,
+		string $timezone_string = ''
+	): EE_Datetime_Field {
+		return $this->loader->getNew(
+			'EE_Datetime_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $timezone_string]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_DB_Only_Float_Field
+	 */
+	public function createDbOnlyFloatField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_DB_Only_Float_Field {
+		return $this->loader->getNew(
+			'EE_DB_Only_Float_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_DB_Only_Int_Field
+	 */
+	public function createDbOnlyIntField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_DB_Only_Int_Field {
+		return $this->loader->getNew(
+			'EE_DB_Only_Int_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_DB_Only_Text_Field
+	 */
+	public function createDbOnlyTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_DB_Only_Text_Field {
+		return $this->loader->getNew(
+			'EE_DB_Only_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string      $table_column
+	 * @param string      $nice_name
+	 * @param bool        $nullable
+	 * @param string|null $default_value
+	 * @return EE_Email_Field
+	 */
+	public function createEmailField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable = true,
+		string $default_value = ''
+	): EE_Email_Field {
+		return $this->loader->getNew(
+			'EE_Email_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param array  $allowed_enum_values keys are values to be used in the DB,
+	 *                                    values are how they should be displayed
+	 * @return EE_Enum_Integer_Field
+	 */
+	public function createEnumIntegerField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null,
+		array $allowed_enum_values = []
+	): EE_Enum_Integer_Field {
+		return $this->loader->getNew(
+			'EE_Enum_Integer_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $allowed_enum_values]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param array  $allowed_enum_values keys are values to be used in the DB,
+	 *                                    values are how they should be displayed
+	 * @return EE_Enum_Text_Field
+	 */
+	public function createEnumTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value,
+		array $allowed_enum_values
+	): EE_Enum_Text_Field {
+		return $this->loader->getNew(
+			'EE_Enum_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $allowed_enum_values]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Float_Field
+	 */
+	public function createFloatField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Float_Field {
+		return $this->loader->getNew(
+			'EE_Float_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param string $model_name
+	 * @return EE_Foreign_Key_Int_Field
+	 */
+	public function createForeignKeyIntField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value,
+		string $model_name
+	): EE_Foreign_Key_Int_Field {
+		return $this->loader->getNew(
+			'EE_Foreign_Key_Int_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $model_name]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @param string $model_name
+	 * @return EE_Foreign_Key_String_Field
+	 */
+	public function createForeignKeyStringField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value,
+		string $model_name
+	): EE_Foreign_Key_String_Field {
+		return $this->loader->getNew(
+			'EE_Foreign_Key_String_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $model_name]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Full_HTML_Field
+	 */
+	public function createFullHtmlField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Full_HTML_Field {
+		return $this->loader->getNew(
+			'EE_Full_HTML_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Infinite_Integer_Field
+	 */
+	public function createInfiniteIntegerField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Infinite_Integer_Field {
+		return $this->loader->getNew(
+			'EE_Infinite_Integer_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string  $table_column
+	 * @param string  $nice_name
+	 * @param bool    $nullable
+	 * @param integer $default_value
+	 * @return EE_Integer_Field
+	 */
+	public function createIntegerField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable = false,
+		int $default_value = 0
+	): EE_Integer_Field {
+		return $this->loader->getNew(
+			'EE_Integer_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Maybe_Serialized_Simple_HTML_Field
+	 */
+	public function createMaybeSerializedSimpleHtmlField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Maybe_Serialized_Simple_HTML_Field {
+		return $this->loader->getNew(
+			'EE_Maybe_Serialized_Simple_HTML_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Maybe_Serialized_Text_Field
+	 */
+	public function createMaybeSerializedTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Maybe_Serialized_Text_Field {
+		return $this->loader->getNew(
+			'EE_Maybe_Serialized_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Money_Field
+	 */
+	public function createMoneyField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Money_Field {
+		return $this->loader->getNew(
+			'EE_Money_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param string $default_value
+	 * @return EE_Plain_Text_Field
+	 */
+	public function createPlainTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable = true,
+		string $default_value = ''
+	): EE_Plain_Text_Field {
+		return $this->loader->getNew(
+			'EE_Plain_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Post_Content_Field
+	 */
+	public function createPostContentField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Post_Content_Field {
+		return $this->loader->getNew(
+			'EE_Post_Content_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @return EE_Primary_Key_Int_Field
+	 */
+	public function createPrimaryKeyIntField(string $table_column, string $nice_name): EE_Primary_Key_Int_Field
+	{
+		return $this->loader->getNew('EE_Primary_Key_Int_Field', [$table_column, $nice_name]);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @return EE_Primary_Key_String_Field
+	 */
+	public function createPrimaryKeyStringField(string $table_column, string $nice_name): EE_Primary_Key_String_Field
+	{
+		return $this->loader->getNew('EE_Primary_Key_String_Field', [$table_column, $nice_name]);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Serialized_Text_Field
+	 */
+	public function createSerializedTextField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Serialized_Text_Field {
+		return $this->loader->getNew(
+			'EE_Serialized_Text_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Simple_HTML_Field
+	 */
+	public function createSimpleHtmlField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Simple_HTML_Field {
+		return $this->loader->getNew(
+			'EE_Simple_HTML_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Slug_Field
+	 */
+	public function createSlugField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable = false,
+		$default_value = null
+	): EE_Slug_Field {
+		return $this->loader->getNew(
+			'EE_Slug_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 * @return EE_Trashed_Flag_Field
+	 */
+	public function createTrashedFlagField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null
+	): EE_Trashed_Flag_Field {
+		return $this->loader->getNew(
+			'EE_Trashed_Flag_Field',
+			[$table_column, $nice_name, $nullable, $default_value]
+		);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @param mixed  $default_value
+	 * @param array $values     If additional statuses are to be used other than the default WP statuses,
+	 *                          then they can be registered via this property.
+	 *                          The format of the array should be as follows:
+	 *                          [
+	 *                              'status_reference' => [
+	 *                                  'label' => __('Status Reference Label', 'event_espresso'),
+	 *                                  // whether status is shown on the frontend of the site
+	 *                                  'public' => true,
+	 *                                  // whether status is excluded from wp searches
+	 *                                  'exclude_from_search' => false,
+	 *                                  // whether status is included in queries
+	 *                                  for the admin 'all' view in list table views.
+	 *                                  'show_in_admin_all_list' => true,
+	 *                                  // show in the list of statuses with post counts
+	 *                                  // at the top of the admin list tables (i.e. Status Reference(2) )
+	 *                                  'show_in_admin_status_list' => true,
+	 *                                  // the text to display on the admin screen
+	 *                                  // ( or you won't see your status count )
+	 *                                  'label_count' => _n_noop(
+	 *                                      'Status Reference <span class="count">(%s)</span>',
+	 *                                      'Status References <span class="count">(%s)</span>'
+	 *                                  ),
+	 *                              ]
+	 *                          ]
+	 * @return EE_WP_Post_Status_Field
+	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
+	 */
+	public function createWpPostStatusField(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		$default_value = null,
+		array $values = []
+	): EE_WP_Post_Status_Field {
+		return $this->loader->getNew(
+			'EE_WP_Post_Status_Field',
+			[$table_column, $nice_name, $nullable, $default_value, $values]
+		);
+	}
+
+
+	/**
+	 * @param string $post_type
+	 * @return EE_WP_Post_Type_Field
+	 */
+	public function createWpPostTypeField(string $post_type): EE_WP_Post_Type_Field
+	{
+		return $this->loader->getNew('EE_WP_Post_Type_Field', [$post_type]);
+	}
+
+
+	/**
+	 * @param string $table_column
+	 * @param string $nice_name
+	 * @param bool   $nullable
+	 * @return EE_WP_User_Field
+	 */
+	public function createWpUserField(string $table_column, string $nice_name, bool $nullable): EE_WP_User_Field
+	{
+		return $this->loader->getNew('EE_WP_User_Field', [$table_column, $nice_name, $nullable]);
+	}
 }

core/services/graphql/interfaces/GraphQLInterface.php

Indentation +78 added lines, -78 removed lines

@@ -10,82 +10,82 @@
 
 abstract class GraphQLInterface implements GraphQLInterfaceInterface
 {
-    protected string $namespace = 'Espresso';
-
-    protected string $name;
-
-    protected FieldResolverV2 $resolver;
-
-    /**
-     * @var GraphQLFieldInterface[]
-     */
-    protected array $fields;
-
-    public function __construct()
-    {
-        $this->name = $this->namespace . $this->getShortName();
-
-        $this->validateFields($this->getArrayOfFields());
-
-        $this->fields = $this->getArrayOfFields();
-
-        $this->resolver = new FieldResolverV2($this->getArrayOfFields());
-    }
-
-    public function getName(): string
-    {
-        return $this->name;
-    }
-
-    public function getDescription(): string
-    {
-        return '';
-    }
-
-    /**
-     * @return GraphQLFieldInterface[]
-     */
-    public function getFields(): array
-    {
-        return $this->fields;
-    }
-
-    /**
-     * Get GraphQL interface name *without* namespace prefix
-     */
-    abstract protected function getShortName(): string;
-
-    /**
-     * @return GraphQLFieldInterface[]
-     */
-    abstract protected function getArrayOfFields(): array;
-
-    /**
-     * @param mixed[] $array
-     * @return GraphQLFieldInterface[]
-     */
-    protected function validateFields(array $array): array
-    {
-        foreach ($array as $field) {
-            if (! ($field instanceof GraphQLFieldInterface)) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__(
-                            'GraphQL interface %1$s expects its fields to be instance of %2$s',
-                            'event_espresso'
-                        ),
-                        $this->name,
-                        GraphQLFieldInterface::class
-                    )
-                );
-            }
-        }
-
-        return $array;
-    }
-
-    public function resolveField($source, array $args, AppContext $context, ResolveInfo $info)
-    {
-        return $this->resolver->resolve($source, $args, $context, $info);
-    }
+	protected string $namespace = 'Espresso';
+
+	protected string $name;
+
+	protected FieldResolverV2 $resolver;
+
+	/**
+	 * @var GraphQLFieldInterface[]
+	 */
+	protected array $fields;
+
+	public function __construct()
+	{
+		$this->name = $this->namespace . $this->getShortName();
+
+		$this->validateFields($this->getArrayOfFields());
+
+		$this->fields = $this->getArrayOfFields();
+
+		$this->resolver = new FieldResolverV2($this->getArrayOfFields());
+	}
+
+	public function getName(): string
+	{
+		return $this->name;
+	}
+
+	public function getDescription(): string
+	{
+		return '';
+	}
+
+	/**
+	 * @return GraphQLFieldInterface[]
+	 */
+	public function getFields(): array
+	{
+		return $this->fields;
+	}
+
+	/**
+	 * Get GraphQL interface name *without* namespace prefix
+	 */
+	abstract protected function getShortName(): string;
+
+	/**
+	 * @return GraphQLFieldInterface[]
+	 */
+	abstract protected function getArrayOfFields(): array;
+
+	/**
+	 * @param mixed[] $array
+	 * @return GraphQLFieldInterface[]
+	 */
+	protected function validateFields(array $array): array
+	{
+		foreach ($array as $field) {
+			if (! ($field instanceof GraphQLFieldInterface)) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__(
+							'GraphQL interface %1$s expects its fields to be instance of %2$s',
+							'event_espresso'
+						),
+						$this->name,
+						GraphQLFieldInterface::class
+					)
+				);
+			}
+		}
+
+		return $array;
+	}
+
+	public function resolveField($source, array $args, AppContext $context, ResolveInfo $info)
+	{
+		return $this->resolver->resolve($source, $args, $context, $info);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
 
     public function __construct()
     {
-        $this->name = $this->namespace . $this->getShortName();
+        $this->name = $this->namespace.$this->getShortName();
 
         $this->validateFields($this->getArrayOfFields());
 
@@ -67,7 +67,7 @@ 
     protected function validateFields(array $array): array
     {
         foreach ($array as $field) {
-            if (! ($field instanceof GraphQLFieldInterface)) {
+            if ( ! ($field instanceof GraphQLFieldInterface)) {
                 throw new RuntimeException(
                     sprintf(
                         esc_html__(

core/services/graphql/connections/ConnectionInterface.php

Indentation +14 added lines, -14 removed lines

@@ -16,19 +16,19 @@
  */
 interface ConnectionInterface
 {
-    /**
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function config();
+	/**
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function config();
 
-    /**
-     * @param EE_Base      $entity
-     * @param array        $args
-     * @param AppContext   $context
-     * @param ResolveInfo  $info
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function resolveConnection($entity, $args, $context, $info);
+	/**
+	 * @param EE_Base      $entity
+	 * @param array        $args
+	 * @param AppContext   $context
+	 * @param ResolveInfo  $info
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function resolveConnection($entity, $args, $context, $info);
 }

core/services/database/WordPressOption.php

Indentation +175 added lines, -175 removed lines

@@ -17,179 +17,179 @@
  */
 abstract class WordPressOption
 {
-    public const NOT_SET_YET = 'wordpress-option-value-not-yet-set';
-
-    /**
-     * WordPress makes it difficult to determine if an option successfully saved or not,
-     * which is sometimes really important to know, especially if the information you are saving is critical.
-     * The following options allow us to have a better chance of knowing when an update actually failed
-     * or when everything is OK but it just didn't update because the value hasn't changed.
-     */
-    public const UPDATE_SUCCESS = 1;
-
-    public const UPDATE_NONE    = 0;
-
-    public const UPDATE_ERROR   = -1;
-
-    private bool $autoload = false;
-
-    /**
-     * @var mixed
-     */
-    private $default_value = null;
-
-    private string $option_name = '';
-
-    /**
-     * @var mixed
-     */
-    private $value = WordPressOption::NOT_SET_YET;
-
-    private OptionEngine $option_engine;
-
-
-    /**
-     * WordPressOption constructor.
-     *
-     * @param string $option_name
-     * @param mixed  $default_value
-     * @param bool   $autoload          if true, will load the option on EVERY request
-     * @param bool   $is_network_option if true, will save the option to the network as opposed to the current blog
-     */
-    public function __construct(
-        string $option_name,
-        $default_value,
-        bool $autoload = false,
-        bool $is_network_option = false
-    ) {
-        $this->setAutoload($autoload);
-        $this->setDefaultValue($default_value);
-        $this->setOptionName($option_name);
-        $this->option_engine = new OptionEngine($is_network_option);
-    }
-
-
-    /**
-     * @param bool|string $autoload
-     */
-    public function setAutoload($autoload): void
-    {
-        $this->autoload = filter_var($autoload, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @param mixed $default_value
-     */
-    public function setDefaultValue($default_value): void
-    {
-        $this->default_value = $default_value;
-    }
-
-
-    /**
-     * @param string $option_name
-     */
-    public function setOptionName(string $option_name): void
-    {
-        $this->option_name = sanitize_key($option_name);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function optionExists(): string
-    {
-        return $this->option_engine->getOption(
-            $this->getOptionName(),
-            WordPressOption::NOT_SET_YET
-        ) !== WordPressOption::NOT_SET_YET;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getOptionName(): string
-    {
-        return $this->option_name;
-    }
-
-
-    /**
-     * @return false|mixed|void
-     */
-    public function loadOption()
-    {
-        if ($this->value === WordPressOption::NOT_SET_YET) {
-            $this->value = $this->option_engine->getOption($this->getOptionName(), null);
-            if ($this->value === null) {
-                $this->updateOption($this->default_value, true);
-            }
-        }
-        return $this->value;
-    }
-
-
-    /**
-     * @param $value
-     * @param bool $force_update
-     * @return int
-     */
-    public function updateOption($value, bool $force_update = false): int
-    {
-        // don't update if value has not changed since last update
-        if (! $force_update && $this->valueIsUnchanged($value)) {
-            return WordPressOption::UPDATE_NONE;
-        }
-        if ($force_update) {
-            $this->option_engine->updateOption($this->getOptionName(), null);
-        }
-        $this->value = $value;
-        // because the options for updating differ when adding an option for the first time
-        // we use the WordPressOption::NOT_SET_YET to determine if things already exist in the db
-        $updated = $this->optionExists()
-            ? $this->option_engine->updateOption($this->getOptionName(), $this->value)
-            : $this->option_engine->addOption($this->getOptionName(), $this->value, $this->autoload());
-
-        if ($updated) {
-            return WordPressOption::UPDATE_SUCCESS;
-        }
-        return WordPressOption::UPDATE_ERROR;
-    }
-
-
-    private function valueIsUnchanged($value): bool
-    {
-        if (is_array($value) && is_array($this->value)) {
-            $diff = EEH_Array::array_diff_recursive($value, $this->value);
-            // $diff = array_diff($value, $this->value);
-            return empty($diff);
-        }
-        // emulate WP's method for checking equality
-        return $value === $this->value && maybe_serialize($value) === maybe_serialize($this->value);
-    }
-
-
-    /**
-     * @return string
-     */
-    private function autoload(): string
-    {
-        return $this->autoload ? 'yes' : 'no';
-    }
-
-
-    /**
-     * Deletes the option from the database
-     * for the rest of the request
-     *
-     * @return bool
-     * @since  5.0.0.p
-     */
-    public function deleteOption(): bool
-    {
-        return $this->option_engine->deleteOption($this->getOptionName());
-    }
+	public const NOT_SET_YET = 'wordpress-option-value-not-yet-set';
+
+	/**
+	 * WordPress makes it difficult to determine if an option successfully saved or not,
+	 * which is sometimes really important to know, especially if the information you are saving is critical.
+	 * The following options allow us to have a better chance of knowing when an update actually failed
+	 * or when everything is OK but it just didn't update because the value hasn't changed.
+	 */
+	public const UPDATE_SUCCESS = 1;
+
+	public const UPDATE_NONE    = 0;
+
+	public const UPDATE_ERROR   = -1;
+
+	private bool $autoload = false;
+
+	/**
+	 * @var mixed
+	 */
+	private $default_value = null;
+
+	private string $option_name = '';
+
+	/**
+	 * @var mixed
+	 */
+	private $value = WordPressOption::NOT_SET_YET;
+
+	private OptionEngine $option_engine;
+
+
+	/**
+	 * WordPressOption constructor.
+	 *
+	 * @param string $option_name
+	 * @param mixed  $default_value
+	 * @param bool   $autoload          if true, will load the option on EVERY request
+	 * @param bool   $is_network_option if true, will save the option to the network as opposed to the current blog
+	 */
+	public function __construct(
+		string $option_name,
+		$default_value,
+		bool $autoload = false,
+		bool $is_network_option = false
+	) {
+		$this->setAutoload($autoload);
+		$this->setDefaultValue($default_value);
+		$this->setOptionName($option_name);
+		$this->option_engine = new OptionEngine($is_network_option);
+	}
+
+
+	/**
+	 * @param bool|string $autoload
+	 */
+	public function setAutoload($autoload): void
+	{
+		$this->autoload = filter_var($autoload, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @param mixed $default_value
+	 */
+	public function setDefaultValue($default_value): void
+	{
+		$this->default_value = $default_value;
+	}
+
+
+	/**
+	 * @param string $option_name
+	 */
+	public function setOptionName(string $option_name): void
+	{
+		$this->option_name = sanitize_key($option_name);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function optionExists(): string
+	{
+		return $this->option_engine->getOption(
+			$this->getOptionName(),
+			WordPressOption::NOT_SET_YET
+		) !== WordPressOption::NOT_SET_YET;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getOptionName(): string
+	{
+		return $this->option_name;
+	}
+
+
+	/**
+	 * @return false|mixed|void
+	 */
+	public function loadOption()
+	{
+		if ($this->value === WordPressOption::NOT_SET_YET) {
+			$this->value = $this->option_engine->getOption($this->getOptionName(), null);
+			if ($this->value === null) {
+				$this->updateOption($this->default_value, true);
+			}
+		}
+		return $this->value;
+	}
+
+
+	/**
+	 * @param $value
+	 * @param bool $force_update
+	 * @return int
+	 */
+	public function updateOption($value, bool $force_update = false): int
+	{
+		// don't update if value has not changed since last update
+		if (! $force_update && $this->valueIsUnchanged($value)) {
+			return WordPressOption::UPDATE_NONE;
+		}
+		if ($force_update) {
+			$this->option_engine->updateOption($this->getOptionName(), null);
+		}
+		$this->value = $value;
+		// because the options for updating differ when adding an option for the first time
+		// we use the WordPressOption::NOT_SET_YET to determine if things already exist in the db
+		$updated = $this->optionExists()
+			? $this->option_engine->updateOption($this->getOptionName(), $this->value)
+			: $this->option_engine->addOption($this->getOptionName(), $this->value, $this->autoload());
+
+		if ($updated) {
+			return WordPressOption::UPDATE_SUCCESS;
+		}
+		return WordPressOption::UPDATE_ERROR;
+	}
+
+
+	private function valueIsUnchanged($value): bool
+	{
+		if (is_array($value) && is_array($this->value)) {
+			$diff = EEH_Array::array_diff_recursive($value, $this->value);
+			// $diff = array_diff($value, $this->value);
+			return empty($diff);
+		}
+		// emulate WP's method for checking equality
+		return $value === $this->value && maybe_serialize($value) === maybe_serialize($this->value);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	private function autoload(): string
+	{
+		return $this->autoload ? 'yes' : 'no';
+	}
+
+
+	/**
+	 * Deletes the option from the database
+	 * for the rest of the request
+	 *
+	 * @return bool
+	 * @since  5.0.0.p
+	 */
+	public function deleteOption(): bool
+	{
+		return $this->option_engine->deleteOption($this->getOptionName());
+	}
 }

core/services/admin/AdminPageHeaderDecoratorInterface.php

Indentation +6 added lines, -6 removed lines

@@ -12,10 +12,10 @@
  */
 interface AdminPageHeaderDecoratorInterface
 {
-    /**
-     * @param string $text
-     * @return string
-     * @since 4.10.2.p
-     */
-    public function getHeaderText(string $text = ''): string;
+	/**
+	 * @param string $text
+	 * @return string
+	 * @since 4.10.2.p
+	 */
+	public function getHeaderText(string $text = ''): string;
 }

core/services/admin/AdminPageHeaderDecorator.php

Indentation +10 added lines, -10 removed lines

@@ -15,16 +15,16 @@
  */
 abstract class AdminPageHeaderDecorator implements AdminPageHeaderDecoratorInterface
 {
-    protected RequestInterface $request;
+	protected RequestInterface $request;
 
 
-    /**
-     * AdminPageHeader constructor.
-     *
-     * @param RequestInterface $request
-     */
-    public function __construct(RequestInterface $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * AdminPageHeader constructor.
+	 *
+	 * @param RequestInterface $request
+	 */
+	public function __construct(RequestInterface $request)
+	{
+		$this->request = $request;
+	}
 }