eventespresso / event-espresso-core

espresso.php

Indentation +107 added lines, -107 removed lines

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

PaymentMethods/Manager.php

Indentation +211 added lines, -211 removed lines

@@ -21,220 +21,220 @@
  */
 class Manager
 {
-    /**
-     * List of PMs that can be replaced with PP Commerce.
-     * ['payment method name' => 'settings option']
-     *
-     * @var array $pms_can_hide
-     */
-    protected static array $pms_can_hide = [
-        'paypal_express' => 'api_username',
-        'paypal_pro'     => 'api_username',
-        'aim'            => 'login_id',
-    ];
-
-
-    /**
-     * Manager constructor.
-     */
-    public function __construct()
-    {
-        if (DbStatus::isOffline()) {
-            return;
-        }
-        $this->loadPaymentMethods();
-        if (is_admin()) {
-            // Use only PayPal Commerce if it's a new setup.
-            add_filter(
-                'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
-                [__CLASS__, 'hidePaymentMethods']
-            );
-            // Payment methods related admin notices.
-            add_action('admin_init', [__CLASS__, 'adminNotice']);
-        }
-    }
-
-
-    /**
-     * Load all payment methods that are in PaymentMethods folder.
-     *
-     * @return void
-     */
-    protected function loadPaymentMethods()
-    {
-        // Scan the PaymentMethods folder.
-        $pms_list = glob(EE_PLUGIN_DIR_PATH . 'PaymentMethods/*', GLOB_ONLYDIR);
-        // Filter the discovered PM list.
-        $pms_list = apply_filters('FHEE__PaymentMethods__Manager__loadPaymentMethods__pms_list', $pms_list);
-        // Clean from duplicates.
-        $pms_list = array_unique($pms_list);
-        foreach ($pms_list as $pm_path) {
-            $this->registerPaymentMethod($pm_path);
-        }
-    }
-
-
-    /**
-     * Looks for the main payment method file and loads it.
-     *
-     * @param string $pm_path path to the payment method folder
-     * @param string $file_ext
-     * @param string $pm_namespace
-     * @return boolean
-     */
-    public function registerPaymentMethod(
-        string $pm_path,
-        string $file_ext = '.php',
-        string $pm_namespace = 'EventEspresso\PaymentMethods'
-    ): bool {
-        do_action('AHEE__PaymentMethods__Manager__registerPaymentMethod__start', $pm_path);
-        // Separators should match.
-        $pm_path = str_replace('/\\', '/', $pm_path) . DS;
-        // Sanitize PM name.
-        $module_dir = basename($pm_path);
-        // Get class name.
-        $pm_class_name = str_replace(' ', '_', $module_dir);
-        // Check if file exists.
-        if (! is_readable($pm_path . $pm_class_name . $file_ext)) {
-            return false;
-        }
-        // Load the initial PM class.
-        require_once($pm_path . DS . $pm_class_name . $file_ext);
-        $pm_object = "$pm_namespace\\$pm_class_name";
-        if (! class_exists($pm_object)) {
-            return false;
-        }
-        $payment_menthod = new $pm_object();
-        $payment_menthod->initialize();
-        return true;
-    }
-
-
-    /**
-     * Deactivate a few other PMs if it's a new setup. Use PP Commerce.
-     *
-     * @param array $pms_to_list
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function hidePaymentMethods(array $pms_to_list): array
-    {
-        $pms_can_hide = apply_filters(
-            'FHEE__EventEspresso_PaymentMethods_Manager__hidePaymentMethods__pms_can_hide',
-            self::$pms_can_hide
-        );
-        foreach ($pms_can_hide as $pm_name => $pm_option) {
-            // Can we deregister this PM ?
-            if (isset($pms_to_list[ $pm_name ]) && self::pmCanBeHidden($pm_name, $pm_option)) {
-                unset($pms_to_list[ $pm_name ]);
-            }
-        }
-        return $pms_to_list;
-    }
-
-
-    /**
-     * Deregisters the provided payment method if not used.
-     *
-     * @param string $pm_name
-     * @param string $pm_option
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function pmCanBeHidden(string $pm_name, string $pm_option): bool
-    {
-        $pm_to_hide = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
-        $pm_active  = $pm_active_before = false;
-        if ($pm_to_hide instanceof EE_Payment_Method) {
-            $pm_active = $pm_to_hide->active();
-            // Payment method used before ?
-            $option = $pm_to_hide->get_extra_meta($pm_option, true, false);
-            $pm_active_before = ! empty($option);
-        }
-        // If PM not used before and not active, deregister it.
-        if (
-            apply_filters(
-                "FHEE__PaymentMethods__Manager__register_payment_methods__hide_$pm_name",
-                ! $pm_active && ! $pm_active_before,
-                $pm_name
-            )
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Payment methods related admin notices.
-     *
-     * @return void
-     */
-    public static function adminNotice()
-    {
-        // Is this an EE admin page ?
-        $request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $page_name = $request->getRequestParam('page');
-        // Only show the notice on core EE pages
-        if (! str_contains($page_name, 'espresso')) {
-            return;
-        }
-        // Notice if one of the following payment methods is used: PayPal Express, PayPal Pro, Authorize.net AIM.
-        try {
-            $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
-            // Don't show notice if PayPal Commerce is active.
-            if ($pp_commerce instanceof EE_Payment_Method && $pp_commerce->active()) {
-                return;
-            }
-            foreach (self::$pms_can_hide as $pm_name => $pm_option) {
-                $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
-                if ($payment_method instanceof EE_Payment_Method && $payment_method->active()) {
-                    add_action('admin_notices', [__CLASS__, 'usePayPalCommerceNotice']);
-                    return;
-                }
-            }
-        } catch (EE_Error | ReflectionException $e) {
-            // No handling needed right now.
-        }
-    }
-
-
-    /**
-     * Recommend PayPal Commerce notice contents.
-     *
-     * @return void
-     */
-    public static function usePayPalCommerceNotice()
-    {
-        echo '
+	/**
+	 * List of PMs that can be replaced with PP Commerce.
+	 * ['payment method name' => 'settings option']
+	 *
+	 * @var array $pms_can_hide
+	 */
+	protected static array $pms_can_hide = [
+		'paypal_express' => 'api_username',
+		'paypal_pro'     => 'api_username',
+		'aim'            => 'login_id',
+	];
+
+
+	/**
+	 * Manager constructor.
+	 */
+	public function __construct()
+	{
+		if (DbStatus::isOffline()) {
+			return;
+		}
+		$this->loadPaymentMethods();
+		if (is_admin()) {
+			// Use only PayPal Commerce if it's a new setup.
+			add_filter(
+				'FHEE__Payments_Admin_Page___payment_methods_list__payment_methods',
+				[__CLASS__, 'hidePaymentMethods']
+			);
+			// Payment methods related admin notices.
+			add_action('admin_init', [__CLASS__, 'adminNotice']);
+		}
+	}
+
+
+	/**
+	 * Load all payment methods that are in PaymentMethods folder.
+	 *
+	 * @return void
+	 */
+	protected function loadPaymentMethods()
+	{
+		// Scan the PaymentMethods folder.
+		$pms_list = glob(EE_PLUGIN_DIR_PATH . 'PaymentMethods/*', GLOB_ONLYDIR);
+		// Filter the discovered PM list.
+		$pms_list = apply_filters('FHEE__PaymentMethods__Manager__loadPaymentMethods__pms_list', $pms_list);
+		// Clean from duplicates.
+		$pms_list = array_unique($pms_list);
+		foreach ($pms_list as $pm_path) {
+			$this->registerPaymentMethod($pm_path);
+		}
+	}
+
+
+	/**
+	 * Looks for the main payment method file and loads it.
+	 *
+	 * @param string $pm_path path to the payment method folder
+	 * @param string $file_ext
+	 * @param string $pm_namespace
+	 * @return boolean
+	 */
+	public function registerPaymentMethod(
+		string $pm_path,
+		string $file_ext = '.php',
+		string $pm_namespace = 'EventEspresso\PaymentMethods'
+	): bool {
+		do_action('AHEE__PaymentMethods__Manager__registerPaymentMethod__start', $pm_path);
+		// Separators should match.
+		$pm_path = str_replace('/\\', '/', $pm_path) . DS;
+		// Sanitize PM name.
+		$module_dir = basename($pm_path);
+		// Get class name.
+		$pm_class_name = str_replace(' ', '_', $module_dir);
+		// Check if file exists.
+		if (! is_readable($pm_path . $pm_class_name . $file_ext)) {
+			return false;
+		}
+		// Load the initial PM class.
+		require_once($pm_path . DS . $pm_class_name . $file_ext);
+		$pm_object = "$pm_namespace\\$pm_class_name";
+		if (! class_exists($pm_object)) {
+			return false;
+		}
+		$payment_menthod = new $pm_object();
+		$payment_menthod->initialize();
+		return true;
+	}
+
+
+	/**
+	 * Deactivate a few other PMs if it's a new setup. Use PP Commerce.
+	 *
+	 * @param array $pms_to_list
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function hidePaymentMethods(array $pms_to_list): array
+	{
+		$pms_can_hide = apply_filters(
+			'FHEE__EventEspresso_PaymentMethods_Manager__hidePaymentMethods__pms_can_hide',
+			self::$pms_can_hide
+		);
+		foreach ($pms_can_hide as $pm_name => $pm_option) {
+			// Can we deregister this PM ?
+			if (isset($pms_to_list[ $pm_name ]) && self::pmCanBeHidden($pm_name, $pm_option)) {
+				unset($pms_to_list[ $pm_name ]);
+			}
+		}
+		return $pms_to_list;
+	}
+
+
+	/**
+	 * Deregisters the provided payment method if not used.
+	 *
+	 * @param string $pm_name
+	 * @param string $pm_option
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function pmCanBeHidden(string $pm_name, string $pm_option): bool
+	{
+		$pm_to_hide = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
+		$pm_active  = $pm_active_before = false;
+		if ($pm_to_hide instanceof EE_Payment_Method) {
+			$pm_active = $pm_to_hide->active();
+			// Payment method used before ?
+			$option = $pm_to_hide->get_extra_meta($pm_option, true, false);
+			$pm_active_before = ! empty($option);
+		}
+		// If PM not used before and not active, deregister it.
+		if (
+			apply_filters(
+				"FHEE__PaymentMethods__Manager__register_payment_methods__hide_$pm_name",
+				! $pm_active && ! $pm_active_before,
+				$pm_name
+			)
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Payment methods related admin notices.
+	 *
+	 * @return void
+	 */
+	public static function adminNotice()
+	{
+		// Is this an EE admin page ?
+		$request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$page_name = $request->getRequestParam('page');
+		// Only show the notice on core EE pages
+		if (! str_contains($page_name, 'espresso')) {
+			return;
+		}
+		// Notice if one of the following payment methods is used: PayPal Express, PayPal Pro, Authorize.net AIM.
+		try {
+			$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
+			// Don't show notice if PayPal Commerce is active.
+			if ($pp_commerce instanceof EE_Payment_Method && $pp_commerce->active()) {
+				return;
+			}
+			foreach (self::$pms_can_hide as $pm_name => $pm_option) {
+				$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_name);
+				if ($payment_method instanceof EE_Payment_Method && $payment_method->active()) {
+					add_action('admin_notices', [__CLASS__, 'usePayPalCommerceNotice']);
+					return;
+				}
+			}
+		} catch (EE_Error | ReflectionException $e) {
+			// No handling needed right now.
+		}
+	}
+
+
+	/**
+	 * Recommend PayPal Commerce notice contents.
+	 *
+	 * @return void
+	 */
+	public static function usePayPalCommerceNotice()
+	{
+		echo '
         <div class="notice ee-status-outline ee-status-outline--ok ee-status-bg--ok">
             <p class="big-text">
                 <span class="dashicons dashicons-info"></span> &nbsp; '
-                 . sprintf(
-                     esc_html__(
-                         'We recommend using our latest PayPal integration - %1$sPayPal Commerce%2$s payment method in place of PayPal Standard, PayPal Express and PayPal Pro.',
-                         'event_espresso'
-                     ),
-                     '<strong>',
-                     '</strong>'
-                 ) . '
+				 . sprintf(
+					 esc_html__(
+						 'We recommend using our latest PayPal integration - %1$sPayPal Commerce%2$s payment method in place of PayPal Standard, PayPal Express and PayPal Pro.',
+						 'event_espresso'
+					 ),
+					 '<strong>',
+					 '</strong>'
+				 ) . '
             </p>
         </div>';
-    }
-
-
-    /**
-     * @return bool
-     * @since  5.0.20.p
-     */
-    public static function verifySSL(): bool
-    {
-        static $verify_ssl = null;
-        if ($verify_ssl === null) {
-            $verify_ssl = (bool) apply_filters('FHEE__EventEspresso_PaymentMethods_Manager__verifySSL', true);
-        }
-        return (bool) $verify_ssl;
-    }
+	}
+
+
+	/**
+	 * @return bool
+	 * @since  5.0.20.p
+	 */
+	public static function verifySSL(): bool
+	{
+		static $verify_ssl = null;
+		if ($verify_ssl === null) {
+			$verify_ssl = (bool) apply_filters('FHEE__EventEspresso_PaymentMethods_Manager__verifySSL', true);
+		}
+		return (bool) $verify_ssl;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -63,7 +63,7 @@ 
     protected function loadPaymentMethods()
     {
         // Scan the PaymentMethods folder.
-        $pms_list = glob(EE_PLUGIN_DIR_PATH . 'PaymentMethods/*', GLOB_ONLYDIR);
+        $pms_list = glob(EE_PLUGIN_DIR_PATH.'PaymentMethods/*', GLOB_ONLYDIR);
         // Filter the discovered PM list.
         $pms_list = apply_filters('FHEE__PaymentMethods__Manager__loadPaymentMethods__pms_list', $pms_list);
         // Clean from duplicates.
@@ -89,19 +89,19 @@ 
     ): bool {
         do_action('AHEE__PaymentMethods__Manager__registerPaymentMethod__start', $pm_path);
         // Separators should match.
-        $pm_path = str_replace('/\\', '/', $pm_path) . DS;
+        $pm_path = str_replace('/\\', '/', $pm_path).DS;
         // Sanitize PM name.
         $module_dir = basename($pm_path);
         // Get class name.
         $pm_class_name = str_replace(' ', '_', $module_dir);
         // Check if file exists.
-        if (! is_readable($pm_path . $pm_class_name . $file_ext)) {
+        if ( ! is_readable($pm_path.$pm_class_name.$file_ext)) {
             return false;
         }
         // Load the initial PM class.
-        require_once($pm_path . DS . $pm_class_name . $file_ext);
+        require_once($pm_path.DS.$pm_class_name.$file_ext);
         $pm_object = "$pm_namespace\\$pm_class_name";
-        if (! class_exists($pm_object)) {
+        if ( ! class_exists($pm_object)) {
             return false;
         }
         $payment_menthod = new $pm_object();
@@ -126,8 +126,8 @@ 
         );
         foreach ($pms_can_hide as $pm_name => $pm_option) {
             // Can we deregister this PM ?
-            if (isset($pms_to_list[ $pm_name ]) && self::pmCanBeHidden($pm_name, $pm_option)) {
-                unset($pms_to_list[ $pm_name ]);
+            if (isset($pms_to_list[$pm_name]) && self::pmCanBeHidden($pm_name, $pm_option)) {
+                unset($pms_to_list[$pm_name]);
             }
         }
         return $pms_to_list;
@@ -178,7 +178,7 @@ 
         $request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
         $page_name = $request->getRequestParam('page');
         // Only show the notice on core EE pages
-        if (! str_contains($page_name, 'espresso')) {
+        if ( ! str_contains($page_name, 'espresso')) {
             return;
         }
         // Notice if one of the following payment methods is used: PayPal Express, PayPal Pro, Authorize.net AIM.
@@ -219,7 +219,7 @@ 
                      ),
                      '<strong>',
                      '</strong>'
-                 ) . '
+                 ).'
             </p>
         </div>';
     }

PaymentMethods/PayPalCommerce/api/orders/OrderDetails.php

Indentation +70 added lines, -70 removed lines

@@ -20,81 +20,81 @@
  */
 class OrderDetails extends OrdersApi
 {
-    /**
-     * Transaction this order is for.
-     *
-     * @var EE_Transaction
-     */
-    protected EE_Transaction $transaction;
+	/**
+	 * Transaction this order is for.
+	 *
+	 * @var EE_Transaction
+	 */
+	protected EE_Transaction $transaction;
 
-    private FeatureFlags $feature;
+	private FeatureFlags $feature;
 
 
-    /**
-     * OrderDetails constructor.
-     *
-     * @param PayPalApi      $api
-     * @param string         $order_id
-     * @param EE_Transaction $transaction
-     */
-    public function __construct(PayPalApi $api, string $order_id, EE_Transaction $transaction)
-    {
-        parent::__construct($api);
-        $this->transaction = $transaction;
-        $this->request_url = $this->request_url . $order_id;
-    }
+	/**
+	 * OrderDetails constructor.
+	 *
+	 * @param PayPalApi      $api
+	 * @param string         $order_id
+	 * @param EE_Transaction $transaction
+	 */
+	public function __construct(PayPalApi $api, string $order_id, EE_Transaction $transaction)
+	{
+		parent::__construct($api);
+		$this->transaction = $transaction;
+		$this->request_url = $this->request_url . $order_id;
+	}
 
 
-    /**
-     * Create PayPal Order.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get(): array
-    {
-        $response = $this->api->sendRequest([], $this->request_url, 'GET');
-        return $this->validateResponse($response);
-    }
+	/**
+	 * Create PayPal Order.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get(): array
+	{
+		$response = $this->api->sendRequest([], $this->request_url, 'GET');
+		return $this->validateResponse($response);
+	}
 
 
-    /**
-     * Makes sure that we have received the expected Order information back from the API call.
-     *
-     * @param $response
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validateResponse($response): array
-    {
-        PayPalLogger::errorLog(
-            esc_html__('Validating Order Information Response:', 'event_espresso'),
-            [$this->request_url, $response],
-            $this->transaction->payment_method(),
-            false,
-            $this->transaction
-        );
-        if (! empty($response['error'])) {
-            return $response;
-        }
-        if (! isset($response['id']) || ! isset($response['status'])) {
-            $message = esc_html__('No proper order information was found in this response.', 'event_espresso');
-            try {
-                PayPalLogger::errorLog(
-                    $message,
-                    [$this->request_url, $response],
-                    $this->transaction->payment_method()
-                );
-            } catch (EE_Error | ReflectionException $e) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
-            }
-            return [
-                'error'   => $response['error'] ?? 'missing_order_info',
-                'message' => $response['message'] ?? $message,
-            ];
-        }
-        return $response;
-    }
+	/**
+	 * Makes sure that we have received the expected Order information back from the API call.
+	 *
+	 * @param $response
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validateResponse($response): array
+	{
+		PayPalLogger::errorLog(
+			esc_html__('Validating Order Information Response:', 'event_espresso'),
+			[$this->request_url, $response],
+			$this->transaction->payment_method(),
+			false,
+			$this->transaction
+		);
+		if (! empty($response['error'])) {
+			return $response;
+		}
+		if (! isset($response['id']) || ! isset($response['status'])) {
+			$message = esc_html__('No proper order information was found in this response.', 'event_espresso');
+			try {
+				PayPalLogger::errorLog(
+					$message,
+					[$this->request_url, $response],
+					$this->transaction->payment_method()
+				);
+			} catch (EE_Error | ReflectionException $e) {
+				error_log("PayPalLogger Error: $message: " . json_encode($response));
+			}
+			return [
+				'error'   => $response['error'] ?? 'missing_order_info',
+				'message' => $response['message'] ?? $message,
+			];
+		}
+		return $response;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -41,7 +41,7 @@ 
     {
         parent::__construct($api);
         $this->transaction = $transaction;
-        $this->request_url = $this->request_url . $order_id;
+        $this->request_url = $this->request_url.$order_id;
     }
 
 
@@ -76,10 +76,10 @@ 
             false,
             $this->transaction
         );
-        if (! empty($response['error'])) {
+        if ( ! empty($response['error'])) {
             return $response;
         }
-        if (! isset($response['id']) || ! isset($response['status'])) {
+        if ( ! isset($response['id']) || ! isset($response['status'])) {
             $message = esc_html__('No proper order information was found in this response.', 'event_espresso');
             try {
                 PayPalLogger::errorLog(
@@ -88,7 +88,7 @@ 
                     $this->transaction->payment_method()
                 );
             } catch (EE_Error | ReflectionException $e) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
+                error_log("PayPalLogger Error: $message: ".json_encode($response));
             }
             return [
                 'error'   => $response['error'] ?? 'missing_order_info',

PaymentMethods/PayPalCommerce/api/orders/CreateOrder.php

Indentation +274 added lines, -274 removed lines

@@ -30,301 +30,301 @@
  */
 class CreateOrder extends OrdersApi
 {
-    /**
-     * Line items total.
-     *
-     * @var float
-     */
-    protected float $items_total = 0.0;
+	/**
+	 * Line items total.
+	 *
+	 * @var float
+	 */
+	protected float $items_total = 0.0;
 
-    /**
-     * Promotions total.
-     *
-     * @var float
-     */
-    protected float $promos_total = 0.0;
+	/**
+	 * Promotions total.
+	 *
+	 * @var float
+	 */
+	protected float $promos_total = 0.0;
 
-    /**
-     * Tax total.
-     *
-     * @var float
-     */
-    protected float $tax_total = 0.0;
+	/**
+	 * Tax total.
+	 *
+	 * @var float
+	 */
+	protected float $tax_total = 0.0;
 
-    /**
-     * Currency.
-     *
-     * @var string
-     */
-    protected string $currency_code;
+	/**
+	 * Currency.
+	 *
+	 * @var string
+	 */
+	protected string $currency_code;
 
-    /**
-     * Billing info.
-     *
-     * @var array
-     */
-    protected array $billing_info;
+	/**
+	 * Billing info.
+	 *
+	 * @var array
+	 */
+	protected array $billing_info;
 
-    /**
-     * Transaction this order is for.
-     *
-     * @var EE_Transaction
-     */
-    protected EE_Transaction $transaction;
+	/**
+	 * Transaction this order is for.
+	 *
+	 * @var EE_Transaction
+	 */
+	protected EE_Transaction $transaction;
 
-    private FeatureFlags $feature;
+	private FeatureFlags $feature;
 
 
-    /**
-     * CreateOrder constructor.
-     *
-     * @param PayPalApi      $api
-     * @param EE_Transaction $transaction
-     * @param array          $billing_info
-     * @param FeatureFlags   $feature
-     */
-    public function __construct(PayPalApi $api, EE_Transaction $transaction, array $billing_info, FeatureFlags $feature)
-    {
-        parent::__construct($api);
-        $this->transaction   = $transaction;
-        $this->feature       = $feature;
-        $this->currency_code = CurrencyManager::currencyCode();
-        $this->sanitizeRequestParameters($billing_info);
-    }
+	/**
+	 * CreateOrder constructor.
+	 *
+	 * @param PayPalApi      $api
+	 * @param EE_Transaction $transaction
+	 * @param array          $billing_info
+	 * @param FeatureFlags   $feature
+	 */
+	public function __construct(PayPalApi $api, EE_Transaction $transaction, array $billing_info, FeatureFlags $feature)
+	{
+		parent::__construct($api);
+		$this->transaction   = $transaction;
+		$this->feature       = $feature;
+		$this->currency_code = CurrencyManager::currencyCode();
+		$this->sanitizeRequestParameters($billing_info);
+	}
 
 
-    /**
-     * Sanitize the array of billing form data.
-     *
-     * @param array $billing_info
-     * @return void
-     */
-    public function sanitizeRequestParameters(array $billing_info): void
-    {
-        $sanitizer       = new RequestSanitizer(new Basic());
-        foreach ($billing_info as $item => $value) {
-            $this->billing_info[ $item ] = $sanitizer->clean($value);
-        }
-    }
+	/**
+	 * Sanitize the array of billing form data.
+	 *
+	 * @param array $billing_info
+	 * @return void
+	 */
+	public function sanitizeRequestParameters(array $billing_info): void
+	{
+		$sanitizer       = new RequestSanitizer(new Basic());
+		foreach ($billing_info as $item => $value) {
+			$this->billing_info[ $item ] = $sanitizer->clean($value);
+		}
+	}
 
 
-    /**
-     * Create PayPal Order.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function create(): array
-    {
-        $order_parameters = $this->getParameters();
-        // Create Order request.
-        $create_response = $this->api->sendRequest($order_parameters, $this->request_url);
-        return $this->validateOrder($create_response, $order_parameters);
-    }
+	/**
+	 * Create PayPal Order.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function create(): array
+	{
+		$order_parameters = $this->getParameters();
+		// Create Order request.
+		$create_response = $this->api->sendRequest($order_parameters, $this->request_url);
+		return $this->validateOrder($create_response, $order_parameters);
+	}
 
 
-    /**
-     * Form order parameters.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function getParameters(): array
-    {
-        $registrant  = $this->transaction->primary_registration();
-        $attendee    = $registrant->attendee();
-        $event       = $registrant->event();
-        $description = $event->name() ?: sprintf(
-            esc_html__('Tickets for an event at %1$s', 'event_espresso'),
-            get_bloginfo('name')
-        );
-        $parameters  = [
-            'intent'              => 'CAPTURE',
-            'purchase_units'      => [
-                [
-                    'custom_id'   => $this->transaction->ID(),
-                    'description' => substr(wp_strip_all_tags($description), 0, 125),
-                    'items'       => $this->getLineItems(),
-                    'amount'      => [
-                        'value'         => $this->transaction->remaining(),
-                        'currency_code' => $this->currency_code,
-                        'breakdown'     => $this->getBreakdown(),
-                    ],
-                ],
-            ],
-            'application_context' => [
-                'shipping_preference' => 'NO_SHIPPING',
-                'user_action'         => 'PAY_NOW',
-            ],
-            'payer'               => [
-                'email_address' => $attendee->email(),
-                'name'          => [
-                    'given_name' => $attendee->fname(),
-                    'surname'    => $attendee->lname(),
+	/**
+	 * Form order parameters.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function getParameters(): array
+	{
+		$registrant  = $this->transaction->primary_registration();
+		$attendee    = $registrant->attendee();
+		$event       = $registrant->event();
+		$description = $event->name() ?: sprintf(
+			esc_html__('Tickets for an event at %1$s', 'event_espresso'),
+			get_bloginfo('name')
+		);
+		$parameters  = [
+			'intent'              => 'CAPTURE',
+			'purchase_units'      => [
+				[
+					'custom_id'   => $this->transaction->ID(),
+					'description' => substr(wp_strip_all_tags($description), 0, 125),
+					'items'       => $this->getLineItems(),
+					'amount'      => [
+						'value'         => $this->transaction->remaining(),
+						'currency_code' => $this->currency_code,
+						'breakdown'     => $this->getBreakdown(),
+					],
+				],
+			],
+			'application_context' => [
+				'shipping_preference' => 'NO_SHIPPING',
+				'user_action'         => 'PAY_NOW',
+			],
+			'payer'               => [
+				'email_address' => $attendee->email(),
+				'name'          => [
+					'given_name' => $attendee->fname(),
+					'surname'    => $attendee->lname(),
 
-                ],
-            ],
-        ];
-        // Do we have the permissions for the fees ?
-        $scopes = PayPalExtraMetaManager::getPmOption(
-            $this->transaction->payment_method(),
-            Domain::META_KEY_AUTHORIZED_SCOPES
-        );
-        if (
-            (
-                (defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
-                || (! defined('EE_PPC_USE_PAYMENT_FEES')
-                    && $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
-                )
-            )
-            && ! empty($scopes) && in_array('partnerfee', $scopes)
-        ) {
-            $payment_fees = LoaderFactory::getShared(PartnerPaymentFees::class);
-            $parameters['purchase_units'][0]['payment_instruction'] = [
-                'platform_fees' => [
-                    [
-                        'amount' => [
-                            'value'         => (string) $payment_fees->getPartnerFee($this->transaction),
-                            'currency_code' => $this->currency_code,
-                        ],
-                    ],
-                ]
-            ];
-        }
-        return $parameters;
-    }
+				],
+			],
+		];
+		// Do we have the permissions for the fees ?
+		$scopes = PayPalExtraMetaManager::getPmOption(
+			$this->transaction->payment_method(),
+			Domain::META_KEY_AUTHORIZED_SCOPES
+		);
+		if (
+			(
+				(defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
+				|| (! defined('EE_PPC_USE_PAYMENT_FEES')
+					&& $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
+				)
+			)
+			&& ! empty($scopes) && in_array('partnerfee', $scopes)
+		) {
+			$payment_fees = LoaderFactory::getShared(PartnerPaymentFees::class);
+			$parameters['purchase_units'][0]['payment_instruction'] = [
+				'platform_fees' => [
+					[
+						'amount' => [
+							'value'         => (string) $payment_fees->getPartnerFee($this->transaction),
+							'currency_code' => $this->currency_code,
+						],
+					],
+				]
+			];
+		}
+		return $parameters;
+	}
 
 
-    /**
-     * Itemize the payment. List all the line items, discounts and taxes.
-     *
-     * @return array
-     * @throws EE_Error|ReflectionException
-     */
-    protected function getLineItems(): array
-    {
-        // Order line items.
-        $line_items       = [];
-        $event_line_items = $this->transaction->items_purchased();
-        // List actual line items.
-        foreach ($event_line_items as $line_item) {
-            if (
-                $line_item instanceof EE_Line_Item
-                && $line_item->OBJ_type() !== 'Promotion'
-                && $line_item->quantity() > 0
-            ) {
-                $item_money     = $line_item->unit_price();
-                $li_description = $line_item->desc() ?? esc_html__('Event Ticket', 'event_espresso');
-                $line_items []  = [
-                    'name'        => substr(wp_strip_all_tags($line_item->name()), 0, 126),
-                    'quantity'    => $line_item->quantity(),
-                    'description' => substr(wp_strip_all_tags($li_description), 0, 125),
-                    'unit_amount' => [
-                        'currency_code' => $this->currency_code,
-                        'value'         => $item_money,
-                    ],
-                    'category'    => 'DIGITAL_GOODS',
-                ];
-                // Line item total.
-                $this->items_total += $line_item->pretaxTotal();
-            } elseif ($line_item->OBJ_type() === 'Promotion' && $line_item->quantity() > 0) {
-                // Promotions total.
-                $this->promos_total += $line_item->total();
-            }
-        }
-        // Make sure we have an absolute number with only two decimal laces.
-        $this->items_total  = CurrencyManager::normalizeValue($this->items_total);
-        $this->promos_total = CurrencyManager::normalizeValue($this->promos_total);
-        // If this is a partial payment, apply the paid amount as a promo.
-        if ($this->transaction->paid() > 0) {
-            $this->promos_total += CurrencyManager::normalizeValue($this->transaction->paid());
-        }
-        $this->countTaxTotal();
-        return $line_items;
-    }
+	/**
+	 * Itemize the payment. List all the line items, discounts and taxes.
+	 *
+	 * @return array
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function getLineItems(): array
+	{
+		// Order line items.
+		$line_items       = [];
+		$event_line_items = $this->transaction->items_purchased();
+		// List actual line items.
+		foreach ($event_line_items as $line_item) {
+			if (
+				$line_item instanceof EE_Line_Item
+				&& $line_item->OBJ_type() !== 'Promotion'
+				&& $line_item->quantity() > 0
+			) {
+				$item_money     = $line_item->unit_price();
+				$li_description = $line_item->desc() ?? esc_html__('Event Ticket', 'event_espresso');
+				$line_items []  = [
+					'name'        => substr(wp_strip_all_tags($line_item->name()), 0, 126),
+					'quantity'    => $line_item->quantity(),
+					'description' => substr(wp_strip_all_tags($li_description), 0, 125),
+					'unit_amount' => [
+						'currency_code' => $this->currency_code,
+						'value'         => $item_money,
+					],
+					'category'    => 'DIGITAL_GOODS',
+				];
+				// Line item total.
+				$this->items_total += $line_item->pretaxTotal();
+			} elseif ($line_item->OBJ_type() === 'Promotion' && $line_item->quantity() > 0) {
+				// Promotions total.
+				$this->promos_total += $line_item->total();
+			}
+		}
+		// Make sure we have an absolute number with only two decimal laces.
+		$this->items_total  = CurrencyManager::normalizeValue($this->items_total);
+		$this->promos_total = CurrencyManager::normalizeValue($this->promos_total);
+		// If this is a partial payment, apply the paid amount as a promo.
+		if ($this->transaction->paid() > 0) {
+			$this->promos_total += CurrencyManager::normalizeValue($this->transaction->paid());
+		}
+		$this->countTaxTotal();
+		return $line_items;
+	}
 
 
-    /**
-     * Count the tax total.
-     *
-     * @return void
-     * @throws EE_Error|ReflectionException
-     */
-    protected function countTaxTotal(): void
-    {
-        // List taxes.
-        $this->tax_total = 0.0;
-        $tax_items       = $this->transaction->tax_items();
-        foreach ($tax_items as $tax_item) {
-            $this->tax_total += $tax_item->total();
-        }
-        $this->tax_total = CurrencyManager::normalizeValue($this->tax_total);
-    }
+	/**
+	 * Count the tax total.
+	 *
+	 * @return void
+	 * @throws EE_Error|ReflectionException
+	 */
+	protected function countTaxTotal(): void
+	{
+		// List taxes.
+		$this->tax_total = 0.0;
+		$tax_items       = $this->transaction->tax_items();
+		foreach ($tax_items as $tax_item) {
+			$this->tax_total += $tax_item->total();
+		}
+		$this->tax_total = CurrencyManager::normalizeValue($this->tax_total);
+	}
 
 
-    /**
-     * Itemize the payment the breakdown list.
-     *
-     * @return array
-     */
-    protected function getBreakdown(): array
-    {
-        $breakdown['item_total'] = [
-            'currency_code' => $this->currency_code,
-            'value'         => $this->items_total,
-        ];
-        $breakdown['tax_total']  = [
-            'currency_code' => $this->currency_code,
-            'value'         => $this->tax_total,
-        ];
-        $breakdown['discount']   = [
-            'currency_code' => $this->currency_code,
-            'value'         => abs($this->promos_total),
-        ];
-        return $breakdown;
-    }
+	/**
+	 * Itemize the payment the breakdown list.
+	 *
+	 * @return array
+	 */
+	protected function getBreakdown(): array
+	{
+		$breakdown['item_total'] = [
+			'currency_code' => $this->currency_code,
+			'value'         => $this->items_total,
+		];
+		$breakdown['tax_total']  = [
+			'currency_code' => $this->currency_code,
+			'value'         => $this->tax_total,
+		];
+		$breakdown['discount']   = [
+			'currency_code' => $this->currency_code,
+			'value'         => abs($this->promos_total),
+		];
+		return $breakdown;
+	}
 
 
-    /**
-     * Makes sure that we have received an Order back from the API call.
-     *
-     * @param $response
-     * @param $parameters
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validateOrder($response, $parameters): array
-    {
-        PayPalLogger::errorLog(
-            esc_html__('Validating Order Create:', 'event_espresso'),
-            [$this->request_url, $response],
-            $this->transaction->payment_method(),
-            false,
-            $this->transaction
-        );
-        if (! empty($response['error'])) {
-            return $response;
-        }
-        if (! isset($response['id'])) {
-            $message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
-            try {
-                PayPalLogger::errorLog(
-                    $message,
-                    [$this->request_url, $parameters, $response],
-                    $this->transaction->payment_method()
-                );
-            } catch (EE_Error | ReflectionException $e) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
-            }
-            return [
-                'error'   => $response['error'] ?? 'missing_order',
-                'message' => $response['message'] ?? $message,
-            ];
-        }
-        return $response;
-    }
+	/**
+	 * Makes sure that we have received an Order back from the API call.
+	 *
+	 * @param $response
+	 * @param $parameters
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validateOrder($response, $parameters): array
+	{
+		PayPalLogger::errorLog(
+			esc_html__('Validating Order Create:', 'event_espresso'),
+			[$this->request_url, $response],
+			$this->transaction->payment_method(),
+			false,
+			$this->transaction
+		);
+		if (! empty($response['error'])) {
+			return $response;
+		}
+		if (! isset($response['id'])) {
+			$message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
+			try {
+				PayPalLogger::errorLog(
+					$message,
+					[$this->request_url, $parameters, $response],
+					$this->transaction->payment_method()
+				);
+			} catch (EE_Error | ReflectionException $e) {
+				error_log("PayPalLogger Error: $message: " . json_encode($response));
+			}
+			return [
+				'error'   => $response['error'] ?? 'missing_order',
+				'message' => $response['message'] ?? $message,
+			];
+		}
+		return $response;
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -101,9 +101,9 @@ 
      */
     public function sanitizeRequestParameters(array $billing_info): void
     {
-        $sanitizer       = new RequestSanitizer(new Basic());
+        $sanitizer = new RequestSanitizer(new Basic());
         foreach ($billing_info as $item => $value) {
-            $this->billing_info[ $item ] = $sanitizer->clean($value);
+            $this->billing_info[$item] = $sanitizer->clean($value);
         }
     }
 
@@ -141,7 +141,7 @@ 
             esc_html__('Tickets for an event at %1$s', 'event_espresso'),
             get_bloginfo('name')
         );
-        $parameters  = [
+        $parameters = [
             'intent'              => 'CAPTURE',
             'purchase_units'      => [
                 [
@@ -176,7 +176,7 @@ 
         if (
             (
                 (defined('EE_PPC_USE_PAYMENT_FEES') && EE_PPC_USE_PAYMENT_FEES)
-                || (! defined('EE_PPC_USE_PAYMENT_FEES')
+                || ( ! defined('EE_PPC_USE_PAYMENT_FEES')
                     && $this->feature->allowed(FeatureFlag::USE_PAYMENT_PROCESSOR_FEES)
                 )
             )
@@ -276,11 +276,11 @@ 
             'currency_code' => $this->currency_code,
             'value'         => $this->items_total,
         ];
-        $breakdown['tax_total']  = [
+        $breakdown['tax_total'] = [
             'currency_code' => $this->currency_code,
             'value'         => $this->tax_total,
         ];
-        $breakdown['discount']   = [
+        $breakdown['discount'] = [
             'currency_code' => $this->currency_code,
             'value'         => abs($this->promos_total),
         ];
@@ -306,10 +306,10 @@ 
             false,
             $this->transaction
         );
-        if (! empty($response['error'])) {
+        if ( ! empty($response['error'])) {
             return $response;
         }
-        if (! isset($response['id'])) {
+        if ( ! isset($response['id'])) {
             $message = esc_html__('Unexpected response. Unable to find the order.', 'event_espresso');
             try {
                 PayPalLogger::errorLog(
@@ -318,7 +318,7 @@ 
                     $this->transaction->payment_method()
                 );
             } catch (EE_Error | ReflectionException $e) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
+                error_log("PayPalLogger Error: $message: ".json_encode($response));
             }
             return [
                 'error'   => $response['error'] ?? 'missing_order',

PaymentMethods/PayPalCommerce/api/orders/CaptureOrder.php

Indentation +90 added lines, -90 removed lines

@@ -20,101 +20,101 @@
  */
 class CaptureOrder extends OrdersApi
 {
-    /**
-     * Currency.
-     *
-     * @var string
-     */
-    protected string $currency_code;
+	/**
+	 * Currency.
+	 *
+	 * @var string
+	 */
+	protected string $currency_code;
 
-    /**
-     * Transaction this order is for.
-     *
-     * @var EE_Transaction
-     */
-    protected EE_Transaction $transaction;
+	/**
+	 * Transaction this order is for.
+	 *
+	 * @var EE_Transaction
+	 */
+	protected EE_Transaction $transaction;
 
 
-    /**
-     * CaptureOrder constructor.
-     *
-     * @param PayPalApi      $api
-     * @param EE_Transaction $transaction
-     * @param string         $order_id
-     */
-    public function __construct(PayPalApi $api, EE_Transaction $transaction, string $order_id)
-    {
-        parent::__construct($api);
-        $this->transaction   = $transaction;
-        $this->order_id      = $order_id;
-        $this->currency_code = CurrencyManager::currencyCode();
-        $this->request_url   = $this->request_url . $order_id . '/capture';
-    }
+	/**
+	 * CaptureOrder constructor.
+	 *
+	 * @param PayPalApi      $api
+	 * @param EE_Transaction $transaction
+	 * @param string         $order_id
+	 */
+	public function __construct(PayPalApi $api, EE_Transaction $transaction, string $order_id)
+	{
+		parent::__construct($api);
+		$this->transaction   = $transaction;
+		$this->order_id      = $order_id;
+		$this->currency_code = CurrencyManager::currencyCode();
+		$this->request_url   = $this->request_url . $order_id . '/capture';
+	}
 
 
-    /**
-     * Capture payment for PayPal Order.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function capture(): array
-    {
-        // Create Order request.
-        $capture_response = $this->api->sendRequest([], $this->request_url);
-        return $this->validateOrder($capture_response);
-    }
+	/**
+	 * Capture payment for PayPal Order.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function capture(): array
+	{
+		// Create Order request.
+		$capture_response = $this->api->sendRequest([], $this->request_url);
+		return $this->validateOrder($capture_response);
+	}
 
 
-    /**
-     * Makes sure that we have received an Order back from the API call.
-     *
-     * @param $response
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function validateOrder($response): array
-    {
-        $message = esc_html__('Validating Order Capture:', 'event_espresso');
-        PayPalLogger::errorLog(
-            $message,
-            [$this->request_url,  $response],
-            $this->transaction->payment_method(),
-            false,
-            $this->transaction
-        );
-        // We got a direct error response. Not valid. Return that error.
-        if (! empty($response['error'])) {
-            return $response;
-        }
-        // This also could be a retry capture, so consider this valid, if order already captured.
-        if (
-            ! empty($response['message']['details']['issue'])
-            && $response['message']['details']['issue'] === 'ORDER_ALREADY_CAPTURED'
-        ) {
-            // Need to make sure we pass on the order ID.
-            if (empty($response['id'])) {
-                $response['id'] = $this->order_id;
-            }
-            $response['status'] = 'ORDER_ALREADY_CAPTURED';
-            return $response;
-        }
-        // A success capture should return the order ID.
-        if (! isset($response['id'])) {
-            $message = esc_html__('Unexpected response. No order returned.', 'event_espresso');
-            try {
-                PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
-            } catch (EE_Error | ReflectionException $e) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
-            }
-            return [
-                'error'   => $response['error'] ?? 'missing_order',
-                'message' => $response['message'] ?? $message,
-                'name'    => $response['name'] ?? 'UNKNOWN_ERROR',
-            ];
-        }
-        return $response;
-    }
+	/**
+	 * Makes sure that we have received an Order back from the API call.
+	 *
+	 * @param $response
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function validateOrder($response): array
+	{
+		$message = esc_html__('Validating Order Capture:', 'event_espresso');
+		PayPalLogger::errorLog(
+			$message,
+			[$this->request_url,  $response],
+			$this->transaction->payment_method(),
+			false,
+			$this->transaction
+		);
+		// We got a direct error response. Not valid. Return that error.
+		if (! empty($response['error'])) {
+			return $response;
+		}
+		// This also could be a retry capture, so consider this valid, if order already captured.
+		if (
+			! empty($response['message']['details']['issue'])
+			&& $response['message']['details']['issue'] === 'ORDER_ALREADY_CAPTURED'
+		) {
+			// Need to make sure we pass on the order ID.
+			if (empty($response['id'])) {
+				$response['id'] = $this->order_id;
+			}
+			$response['status'] = 'ORDER_ALREADY_CAPTURED';
+			return $response;
+		}
+		// A success capture should return the order ID.
+		if (! isset($response['id'])) {
+			$message = esc_html__('Unexpected response. No order returned.', 'event_espresso');
+			try {
+				PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
+			} catch (EE_Error | ReflectionException $e) {
+				error_log("PayPalLogger Error: $message: " . json_encode($response));
+			}
+			return [
+				'error'   => $response['error'] ?? 'missing_order',
+				'message' => $response['message'] ?? $message,
+				'name'    => $response['name'] ?? 'UNKNOWN_ERROR',
+			];
+		}
+		return $response;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -48,7 +48,7 @@ 
         $this->transaction   = $transaction;
         $this->order_id      = $order_id;
         $this->currency_code = CurrencyManager::currencyCode();
-        $this->request_url   = $this->request_url . $order_id . '/capture';
+        $this->request_url   = $this->request_url.$order_id.'/capture';
     }
 
 
@@ -80,13 +80,13 @@ 
         $message = esc_html__('Validating Order Capture:', 'event_espresso');
         PayPalLogger::errorLog(
             $message,
-            [$this->request_url,  $response],
+            [$this->request_url, $response],
             $this->transaction->payment_method(),
             false,
             $this->transaction
         );
         // We got a direct error response. Not valid. Return that error.
-        if (! empty($response['error'])) {
+        if ( ! empty($response['error'])) {
             return $response;
         }
         // This also could be a retry capture, so consider this valid, if order already captured.
@@ -102,12 +102,12 @@ 
             return $response;
         }
         // A success capture should return the order ID.
-        if (! isset($response['id'])) {
+        if ( ! isset($response['id'])) {
             $message = esc_html__('Unexpected response. No order returned.', 'event_espresso');
             try {
                 PayPalLogger::errorLog($message, [$this->request_url, $response], $this->transaction->payment_method());
             } catch (EE_Error | ReflectionException $e) {
-                error_log("PayPalLogger Error: $message: " . json_encode($response));
+                error_log("PayPalLogger Error: $message: ".json_encode($response));
             }
             return [
                 'error'   => $response['error'] ?? 'missing_order',

PaymentMethods/PayPalCommerce/domain/Domain.php

Indentation +167 added lines, -167 removed lines

@@ -17,171 +17,171 @@
  */
 class Domain
 {
-    /**
-     * Name of the extra meta key that stores this PM options as one meta.
-     */
-    public const META_KEY_PAYPAL_DATA = 'paypal_data';
-    /**
-     * Name of the extra meta key that stores this PM options as one meta.
-     */
-    public const META_KEY_PAYPAL_DATA_SANDBOX = 'paypal_data_sandbox';
-
-    /**
-     * Name of the extra meta that stores whether the credentials were for the sandbox or live mode.
-     */
-    public const META_KEY_SANDBOX_MODE = 'sandbox_mode';
-
-    /**
-     * Name of the extra meta that stores the Access Token that is used to auth in API requests to PayPal.
-     */
-    public const META_KEY_ACCESS_TOKEN = 'access_token';
-
-    /**
-     * Name of the extra meta that stores the last request tracking ID.
-     */
-    public const META_KEY_TRACKING_ID = 'tracking_id';
-
-    /**
-     * Name of the extra meta that stores the Event Espresso PayPal Account's merchant id.
-     */
-    public const META_KEY_APP_ID = 'app_id';
-
-    /**
-     * Name of the extra meta that holds the seller client ID.
-     */
-    public const META_KEY_CLIENT_ID = 'client_id';
-
-    /**
-     * Name of the extra meta that holds the seller secret.
-     */
-    public const META_KEY_CLIENT_SECRET = 'client_secret';
-
-    /**
-     * Name of the extra meta that stores the expiration date of the Access Token.
-     */
-    public const META_KEY_TOKEN_EXPIRES_IN = 'expires_in';
-
-    /**
-     * Name of the extra meta that holds the partner client ID.
-     */
-    public const META_KEY_PARTNER_CLIENT_ID = 'partner_client_id';
-
-    /**
-     * Name of the extra meta that holds the partner merchant ID.
-     */
-    public const META_KEY_PARTNER_MERCHANT_ID = 'partner_merchant_id';
-
-    /**
-     * Name of the extra meta that holds the seller merchant ID.
-     */
-    public const META_KEY_SELLER_MERCHANT_ID = 'merchantIdInPayPal';
-
-    /**
-     * Name of the extra meta that holds the BN / request tracking code.
-     */
-    public const META_KEY_BN_CODE = 'bn_code';
-
-    /**
-     * Name of the extra meta that stores the merchant authorized scopes for our app to work within.
-     */
-    public const META_KEY_AUTHORIZED_SCOPES = 'authorized_scopes';
-
-    /**
-     * Name of the extra meta that stores the PP checkout type selected by merchant after onboarding.
-     */
-    public const META_KEY_CHECKOUT_TYPE = 'checkout_type';
-
-    /**
-     * Name of the extra meta that stores the allowed PP checkout type selected by merchant while onboarding.
-     */
-    public const META_KEY_ALLOWED_CHECKOUT_TYPE = 'allowed_checkout_type';
-
-    /**
-     * Name of the extra meta that stores the selected PP function options.
-     */
-    public const META_KEY_FUNDING_OPTIONS = 'funding_options';
-
-    /**
-     * Name of the PayPal API parameter that holds the auth code.
-     */
-    public const API_KEY_AUTH_CODE = 'authCode';
-
-    /**
-     * Name of the PayPal API parameter that holds the client token.
-     */
-    public const API_KEY_CLIENT_TOKEN = 'client_token';
-
-     /**
-     * Name of the extra meta that holds the seller payer ID.
-     */
-    public const META_KEY_PAYER_ID = 'payer_id';
-
-    /**
-     * Name of the PayPal API parameter that holds the client token expiration time.
-     */
-    public const API_KEY_EXPIRES_IN = 'expires_in';
-
-    /**
-     * Name of the PayPal API parameter that holds the list of oAuth integrations related to the merchant.
-     */
-    public const API_PARAM_OAUTH_INTEGRATIONS = 'oauth_integrations';
-
-    /**
-     * Name of the PayPal API parameter that holds the list of third party permissions that were granted.
-     */
-    public const API_PARAM_PERMISSIONS_GRANTED = 'oauth_third_party';
-
-    /**
-     * Name of the PayPal API parameter that holds the bool of if the primary email was confirmed.
-     */
-    public const API_PARAM_PRIM_EMAIL_CONFIRMED = 'primary_email_confirmed';
-
-    /**
-     * Name of the PayPal API parameter that holds the bool of if email was confirmed.
-     */
-    public const API_PARAM_EMAIL_CONFIRMED = 'isEmailConfirmed';
-
-    /**
-     * Name of the PayPal API parameter that holds the partner ID.
-     */
-    public const API_PARAM_PARTNER_ID = 'merchantId';
-
-    /**
-     * Name of the PayPal API parameter that holds the merchant ID in the Track seller onboarding status request.
-     */
-    public const API_PARAM_TRACK_MERCHANT_ID = 'merchant_id';
-
-    /**
-     * Name of the PayPal API parameter that holds the payments_receivable status.
-     */
-    public const API_PARAM_PAYMENTS_RECEIVABLE = 'payments_receivable';
-
-    /**
-     * Name of the nonce used in the capture order request.
-     */
-    public const CAPTURE_ORDER_NONCE_NAME = 'eea_pp_commerce_capture_order_payment';
-
-    /**
-     * Name of the nonce used in the onboarding process.
-     */
-    public const NONCE_NAME_ONBOARDING_RETURN = 'eea_pp_commerce_onboarding_return';
-
-    /**
-     * Holds this payment method slug.
-     */
-    public const PM_SLUG = 'paypalcheckout';
-
-
-    /**
-     * Returns the base PayPal API URL.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPayPalApiUrl(EE_Payment_Method $payment_method): string
-    {
-        return $payment_method->debug_mode() ? 'https://api-m.sandbox.paypal.com' : 'https://api-m.paypal.com';
-    }
+	/**
+	 * Name of the extra meta key that stores this PM options as one meta.
+	 */
+	public const META_KEY_PAYPAL_DATA = 'paypal_data';
+	/**
+	 * Name of the extra meta key that stores this PM options as one meta.
+	 */
+	public const META_KEY_PAYPAL_DATA_SANDBOX = 'paypal_data_sandbox';
+
+	/**
+	 * Name of the extra meta that stores whether the credentials were for the sandbox or live mode.
+	 */
+	public const META_KEY_SANDBOX_MODE = 'sandbox_mode';
+
+	/**
+	 * Name of the extra meta that stores the Access Token that is used to auth in API requests to PayPal.
+	 */
+	public const META_KEY_ACCESS_TOKEN = 'access_token';
+
+	/**
+	 * Name of the extra meta that stores the last request tracking ID.
+	 */
+	public const META_KEY_TRACKING_ID = 'tracking_id';
+
+	/**
+	 * Name of the extra meta that stores the Event Espresso PayPal Account's merchant id.
+	 */
+	public const META_KEY_APP_ID = 'app_id';
+
+	/**
+	 * Name of the extra meta that holds the seller client ID.
+	 */
+	public const META_KEY_CLIENT_ID = 'client_id';
+
+	/**
+	 * Name of the extra meta that holds the seller secret.
+	 */
+	public const META_KEY_CLIENT_SECRET = 'client_secret';
+
+	/**
+	 * Name of the extra meta that stores the expiration date of the Access Token.
+	 */
+	public const META_KEY_TOKEN_EXPIRES_IN = 'expires_in';
+
+	/**
+	 * Name of the extra meta that holds the partner client ID.
+	 */
+	public const META_KEY_PARTNER_CLIENT_ID = 'partner_client_id';
+
+	/**
+	 * Name of the extra meta that holds the partner merchant ID.
+	 */
+	public const META_KEY_PARTNER_MERCHANT_ID = 'partner_merchant_id';
+
+	/**
+	 * Name of the extra meta that holds the seller merchant ID.
+	 */
+	public const META_KEY_SELLER_MERCHANT_ID = 'merchantIdInPayPal';
+
+	/**
+	 * Name of the extra meta that holds the BN / request tracking code.
+	 */
+	public const META_KEY_BN_CODE = 'bn_code';
+
+	/**
+	 * Name of the extra meta that stores the merchant authorized scopes for our app to work within.
+	 */
+	public const META_KEY_AUTHORIZED_SCOPES = 'authorized_scopes';
+
+	/**
+	 * Name of the extra meta that stores the PP checkout type selected by merchant after onboarding.
+	 */
+	public const META_KEY_CHECKOUT_TYPE = 'checkout_type';
+
+	/**
+	 * Name of the extra meta that stores the allowed PP checkout type selected by merchant while onboarding.
+	 */
+	public const META_KEY_ALLOWED_CHECKOUT_TYPE = 'allowed_checkout_type';
+
+	/**
+	 * Name of the extra meta that stores the selected PP function options.
+	 */
+	public const META_KEY_FUNDING_OPTIONS = 'funding_options';
+
+	/**
+	 * Name of the PayPal API parameter that holds the auth code.
+	 */
+	public const API_KEY_AUTH_CODE = 'authCode';
+
+	/**
+	 * Name of the PayPal API parameter that holds the client token.
+	 */
+	public const API_KEY_CLIENT_TOKEN = 'client_token';
+
+	 /**
+	  * Name of the extra meta that holds the seller payer ID.
+	  */
+	public const META_KEY_PAYER_ID = 'payer_id';
+
+	/**
+	 * Name of the PayPal API parameter that holds the client token expiration time.
+	 */
+	public const API_KEY_EXPIRES_IN = 'expires_in';
+
+	/**
+	 * Name of the PayPal API parameter that holds the list of oAuth integrations related to the merchant.
+	 */
+	public const API_PARAM_OAUTH_INTEGRATIONS = 'oauth_integrations';
+
+	/**
+	 * Name of the PayPal API parameter that holds the list of third party permissions that were granted.
+	 */
+	public const API_PARAM_PERMISSIONS_GRANTED = 'oauth_third_party';
+
+	/**
+	 * Name of the PayPal API parameter that holds the bool of if the primary email was confirmed.
+	 */
+	public const API_PARAM_PRIM_EMAIL_CONFIRMED = 'primary_email_confirmed';
+
+	/**
+	 * Name of the PayPal API parameter that holds the bool of if email was confirmed.
+	 */
+	public const API_PARAM_EMAIL_CONFIRMED = 'isEmailConfirmed';
+
+	/**
+	 * Name of the PayPal API parameter that holds the partner ID.
+	 */
+	public const API_PARAM_PARTNER_ID = 'merchantId';
+
+	/**
+	 * Name of the PayPal API parameter that holds the merchant ID in the Track seller onboarding status request.
+	 */
+	public const API_PARAM_TRACK_MERCHANT_ID = 'merchant_id';
+
+	/**
+	 * Name of the PayPal API parameter that holds the payments_receivable status.
+	 */
+	public const API_PARAM_PAYMENTS_RECEIVABLE = 'payments_receivable';
+
+	/**
+	 * Name of the nonce used in the capture order request.
+	 */
+	public const CAPTURE_ORDER_NONCE_NAME = 'eea_pp_commerce_capture_order_payment';
+
+	/**
+	 * Name of the nonce used in the onboarding process.
+	 */
+	public const NONCE_NAME_ONBOARDING_RETURN = 'eea_pp_commerce_onboarding_return';
+
+	/**
+	 * Holds this payment method slug.
+	 */
+	public const PM_SLUG = 'paypalcheckout';
+
+
+	/**
+	 * Returns the base PayPal API URL.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPayPalApiUrl(EE_Payment_Method $payment_method): string
+	{
+		return $payment_method->debug_mode() ? 'https://api-m.sandbox.paypal.com' : 'https://api-m.paypal.com';
+	}
 }

PaymentMethods/PayPalCommerce/modules/EED_PayPalCommerce.module.php

Indentation +453 added lines, -453 removed lines

@@ -23,457 +23,457 @@
  */
 class EED_PayPalCommerce extends EED_Module
 {
-    /**
-     * @return EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Module
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Run - initial module setup.
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * For hooking into EE Core and other modules.
-     *
-     * @return void
-     */
-    public static function set_hooks(): void
-    {
-        if (DbStatus::isOnline()) {
-            // Don't load PM on the front-end if not Connected.
-            add_filter(
-                'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-                [__CLASS__, 'filterPaymentMethods'],
-                100
-            );
-        }
-    }
-
-
-    /**
-     * For hooking into EE Core and other modules Admin.
-     *
-     * @return void
-     */
-    public static function set_hooks_admin(): void
-    {
-        if (DbStatus::isOnline()) {
-            // Create an Order.
-            add_action('wp_ajax_eeaPPCCreateOrder', [__CLASS__, 'createOrderRequest']);
-            add_action('wp_ajax_nopriv_eeaPPCCreateOrder', [__CLASS__, 'createOrderRequest']);
-            // Log errors from the JS side.
-            add_action('wp_ajax_eeaPPCommerceLogError', [__CLASS__, 'logJsError']);
-            add_action('wp_ajax_nopriv_eeaPPCommerceLogError', [__CLASS__, 'logJsError']);
-            // Don't load PM in the admin if not Connected.
-            add_filter(
-                'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-                [__CLASS__, 'filterPaymentMethods'],
-                100
-            );
-        }
-    }
-
-
-    /**
-     * Create the order and return its data as JSON.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function createOrderRequest(): void
-    {
-        $paypal_pm   = EED_PayPalCommerce::getPaymentMethod();
-        $post_params = EED_Module::getRequest()->postParams();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            PayPalLogger::errorLogAndExit(
-                esc_html__('Related payment method not found (create Order).', 'event_espresso'),
-                $post_params
-            );
-        }
-        $transaction  = EED_PayPalCommerce::getTransaction();
-        $billing_info = $post_params['billing_info'] ?? [];
-        if ($billing_info) {
-            $billing_info_decoded = json_decode(stripslashes($billing_info), true);
-            $billing_info         = is_array($billing_info_decoded) ? $billing_info_decoded : [];
-        }
-        if (! $transaction) {
-            PayPalLogger::errorLogAndExit(
-                esc_html__('Transaction info not found.', 'event_espresso'),
-                $post_params,
-                $paypal_pm
-            );
-        }
-        $order_data = EED_PayPalCommerce::createOrder($transaction, $billing_info, $paypal_pm);
-        wp_send_json($order_data);
-    }
-
-
-    /**
-     * Create a new Order using the PP API.
-     *
-     * @param EE_Transaction    $transaction
-     * @param array             $billing_info
-     * @param EE_Payment_Method $paypal_pm
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function createOrder(
-        EE_Transaction $transaction,
-        array $billing_info,
-        EE_Payment_Method $paypal_pm
-    ): array {
-        $create_order_api = EED_PayPalCommerce::getCreateOrderApi($transaction, $billing_info, $paypal_pm);
-        if (! $create_order_api instanceof CreateOrder) {
-            return [
-                'error'   => 'CREATE_ORDER_API_FAULT',
-                'message' => esc_html__('The Create Order API request fault.', 'event_espresso'),
-            ];
-        }
-        $payment = EEG_PayPalCheckout::createPayment($transaction, $paypal_pm);
-        $order   = $create_order_api->create();
-        if (isset($order['error'])) {
-            EEG_PayPalCheckout::updatePaymentStatus($payment, EEM_Payment::status_id_failed, $order, $order['error']);
-            return [
-                'error'   => 'CREATE_ORDER_API_RESPONSE_ERROR',
-                'message' => $order['message'],
-            ];
-        }
-        return [
-            'pp_order_id' => $order['id'],
-        ];
-    }
-
-
-    /**
-     * Create a new Order using the PP API.
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $order_id
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function captureOrder(
-        EE_Transaction    $transaction,
-        EE_Payment_Method $paypal_pm,
-        string            $order_id
-    ): array {
-        $capture_order_api = EED_PayPalCommerce::getCaptureOrderApi($transaction, $paypal_pm, $order_id);
-        if (! $capture_order_api instanceof CaptureOrder) {
-            return [
-                'error'   => 'CAPTURE_ORDER_API_FAULT',
-                'message' => esc_html__('A capture Order API request fault.', 'event_espresso'),
-            ];
-        }
-        return $capture_order_api->capture();
-    }
-
-
-    /**
-     * Get Order Details using the PP API.
-     *
-     * @param string            $order_id
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $paypal_pm
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getOrderDetails(
-        string            $order_id,
-        EE_Transaction    $transaction,
-        EE_Payment_Method $paypal_pm
-    ): array {
-        $order_details = EED_PayPalCommerce::getOrderDetailsApi($order_id, $transaction, $paypal_pm);
-        if (! $order_details instanceof OrderDetails) {
-            return [
-                'error'   => 'ORDER_DETAILS_API_FAULT',
-                'message' => esc_html__('Get Order Details API request fault.', 'event_espresso'),
-            ];
-        }
-        return $order_details->get();
-    }
-
-
-    /**
-     * Initialize and return Create Order API.
-     *
-     * @param EE_Transaction    $transaction
-     * @param array             $billing_info
-     * @param EE_Payment_Method $paypal_pm
-     * @return CreateOrder|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getCreateOrderApi(
-        EE_Transaction $transaction,
-        array $billing_info,
-        EE_Payment_Method $paypal_pm
-    ): ?CreateOrder {
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
-            return null;
-        }
-        return LoaderFactory::getNew(CreateOrder::class, [$paypal_api, $transaction, $billing_info]);
-    }
-
-
-    /**
-     * Initialize and return Capture Order API.
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $order_id
-     * @return CaptureOrder|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getCaptureOrderApi(
-        EE_Transaction $transaction,
-        EE_Payment_Method $paypal_pm,
-        string $order_id
-    ): ?CaptureOrder {
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
-            return null;
-        }
-        return LoaderFactory::getNew(CaptureOrder::class, [$paypal_api, $transaction, $order_id]);
-    }
-
-
-    /**
-     * Initialize and return Order Details API.
-     *
-     * @param EE_Transaction    $transaction
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $order_id
-     * @return OrderDetails|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getOrderDetailsApi(
-        string $order_id,
-        EE_Transaction $transaction,
-        EE_Payment_Method $paypal_pm
-    ): ?OrderDetails {
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
-            return null;
-        }
-        return LoaderFactory::getNew(OrderDetails::class, [$paypal_api, $order_id, $transaction]);
-    }
-
-
-    /**
-     * Return a PayPal API object, or false on failure.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return PayPalApi|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPayPalApi(EE_Payment_Method $paypal_pm): ?PayPalApi
-    {
-        // Try getting the first party credentials to determine if this is a first party integration that's active.
-        $client_id     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_CLIENT_ID);
-        $client_secret = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_CLIENT_SECRET);
-        $bn_code       = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        if ($client_id && $client_secret) {
-            return new FirstPartyPayPalApi($client_id, $client_secret, $bn_code, $paypal_pm->debug_mode());
-        }
-        // Third party integration credentials:
-        $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token || ! $bn_code) {
-            return null;
-        }
-        $partner_client_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_CLIENT_ID) ?: '';
-        $payer_id          = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?: '';
-        return new ThirdPartyPayPalApi(
-            $access_token,
-            $bn_code,
-            $partner_client_id,
-            $payer_id,
-            $paypal_pm->debug_mode()
-        );
-    }
-
-
-    /**
-     * Requests a client token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function requestClientToken(EE_Payment_Method $paypal_pm): array
-    {
-        $error      = ['error' => 'GET_CLIENT_TOKEN_FAULT'];
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
-            $error['message'] = esc_html__('Got an error while trying to get the client token.', 'event_espresso');
-            return $error;
-        }
-        $client_token_api = new ClientToken($paypal_api, $paypal_pm->debug_mode());
-        $client_token     = $client_token_api->getToken();
-        if (isset($client_token['error'])) {
-            return $client_token;
-        }
-        if (empty($client_token)) {
-            $error['message'] = esc_html__('Client token not valid.', 'event_espresso');
-            return $error;
-        }
-        return $client_token;
-    }
-
-
-    /**
-     * Retrieve the payment method from the provided data.
-     *
-     * @return EE_Transaction|null
-     */
-    public static function getTransaction(): ?EE_Transaction
-    {
-        try {
-            $txn_id      = EED_Module::getRequest()->getRequestParam('txn_id', 0, DataType::INT);
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($txn_id);
-            if (! $transaction instanceof EE_Transaction) {
-                PayPalLogger::errorLog(
-                    esc_html__('No transaction found by ID:', 'event_espresso'),
-                    EED_Module::getRequest()->postParams()
-                );
-                return null;
-            }
-        } catch (Exception $e) {
-            return null;
-        }
-        return $transaction;
-    }
-
-
-    /**
-     * Return a PayPal API object, or false on failure.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function isThirdParty(EE_Payment_Method $paypal_pm): bool
-    {
-        $pp_meta_data = PayPalExtraMetaManager::getAllData($paypal_pm);
-        return ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-            && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ]);
-    }
-
-
-    /**
-     * Retrieve the payment method from the provided data.
-     *
-     * @return EE_Payment_Method|null
-     */
-    public static function getPaymentMethod(): ?EE_Payment_Method
-    {
-        try {
-            // Check if all required parameters are present.
-            $pm_slug        = EED_Module::getRequest()->getRequestParam('payment_method');
-            $payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_slug);
-            if ($payment_method instanceof EE_Payment_Method) {
-                return $payment_method;
-            }
-        } catch (Exception $e) {
-            return null;
-        }
-        return null;
-    }
-
-
-    /**
-     * Log JS error.
-     *
-     * @return void
-     */
-    public static function logJsError(): void
-    {
-        // Default to the "first" PayPal checkout PM.
-        $request        = EED_Module::getRequest();
-        $pm_slug        = $request->getRequestParam('pm_slug', Domain::PM_SLUG);
-        $payment_method = null;
-        $txn_id         = 'unknown';
-        try {
-            $payment_method = EEM_Payment_Method::instance()->get_one_of_type($pm_slug);
-            $txn_id         = sanitize_text_field($request->getRequestParam('txn_id', '-'));
-        } catch (Exception $e) {
-            // Don't throw out anything, log at least something.
-        }
-        $transaction = EED_PayPalCommerce::getTransaction();
-        PayPalLogger::errorLog(
-            "JS Error on transaction: $txn_id",
-            $request->postParams(),
-            $payment_method,
-            false,
-            $transaction
-        );
-    }
-
-
-    /**
-     * Filter the Payment Methods list.
-     * if needed, this filter can also supply the $transaction and $scope parameters.
-     *
-     * @param EE_Payment_Method[] $payment_methods
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function filterPaymentMethods(array $payment_methods): array
-    {
-        // Don't allow this PM on the checkout page if not Connected.
-        foreach ($payment_methods as $key => $pm) {
-            // It is a PayPal Commerce payment method. Check if it's connected. If not - remove from the list.
-            if (str_contains($pm->slug(), Domain::PM_SLUG) && ! EED_PayPalOnboard::isOnboard($pm)) {
-                unset($payment_methods[ $key ]);
-            }
-        }
-        return $payment_methods;
-    }
-
-
-    /**
-     *  Get all active states.
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getActiveStates(): array
-    {
-        $state_options = [];
-        $states        = EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
-            foreach ($states as $numeral => $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[ $numeral ] = $state->abbrev();
-                }
-            }
-        }
-        return $state_options;
-    }
+	/**
+	 * @return EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Module
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Run - initial module setup.
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * For hooking into EE Core and other modules.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks(): void
+	{
+		if (DbStatus::isOnline()) {
+			// Don't load PM on the front-end if not Connected.
+			add_filter(
+				'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+				[__CLASS__, 'filterPaymentMethods'],
+				100
+			);
+		}
+	}
+
+
+	/**
+	 * For hooking into EE Core and other modules Admin.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin(): void
+	{
+		if (DbStatus::isOnline()) {
+			// Create an Order.
+			add_action('wp_ajax_eeaPPCCreateOrder', [__CLASS__, 'createOrderRequest']);
+			add_action('wp_ajax_nopriv_eeaPPCCreateOrder', [__CLASS__, 'createOrderRequest']);
+			// Log errors from the JS side.
+			add_action('wp_ajax_eeaPPCommerceLogError', [__CLASS__, 'logJsError']);
+			add_action('wp_ajax_nopriv_eeaPPCommerceLogError', [__CLASS__, 'logJsError']);
+			// Don't load PM in the admin if not Connected.
+			add_filter(
+				'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+				[__CLASS__, 'filterPaymentMethods'],
+				100
+			);
+		}
+	}
+
+
+	/**
+	 * Create the order and return its data as JSON.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function createOrderRequest(): void
+	{
+		$paypal_pm   = EED_PayPalCommerce::getPaymentMethod();
+		$post_params = EED_Module::getRequest()->postParams();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			PayPalLogger::errorLogAndExit(
+				esc_html__('Related payment method not found (create Order).', 'event_espresso'),
+				$post_params
+			);
+		}
+		$transaction  = EED_PayPalCommerce::getTransaction();
+		$billing_info = $post_params['billing_info'] ?? [];
+		if ($billing_info) {
+			$billing_info_decoded = json_decode(stripslashes($billing_info), true);
+			$billing_info         = is_array($billing_info_decoded) ? $billing_info_decoded : [];
+		}
+		if (! $transaction) {
+			PayPalLogger::errorLogAndExit(
+				esc_html__('Transaction info not found.', 'event_espresso'),
+				$post_params,
+				$paypal_pm
+			);
+		}
+		$order_data = EED_PayPalCommerce::createOrder($transaction, $billing_info, $paypal_pm);
+		wp_send_json($order_data);
+	}
+
+
+	/**
+	 * Create a new Order using the PP API.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param array             $billing_info
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function createOrder(
+		EE_Transaction $transaction,
+		array $billing_info,
+		EE_Payment_Method $paypal_pm
+	): array {
+		$create_order_api = EED_PayPalCommerce::getCreateOrderApi($transaction, $billing_info, $paypal_pm);
+		if (! $create_order_api instanceof CreateOrder) {
+			return [
+				'error'   => 'CREATE_ORDER_API_FAULT',
+				'message' => esc_html__('The Create Order API request fault.', 'event_espresso'),
+			];
+		}
+		$payment = EEG_PayPalCheckout::createPayment($transaction, $paypal_pm);
+		$order   = $create_order_api->create();
+		if (isset($order['error'])) {
+			EEG_PayPalCheckout::updatePaymentStatus($payment, EEM_Payment::status_id_failed, $order, $order['error']);
+			return [
+				'error'   => 'CREATE_ORDER_API_RESPONSE_ERROR',
+				'message' => $order['message'],
+			];
+		}
+		return [
+			'pp_order_id' => $order['id'],
+		];
+	}
+
+
+	/**
+	 * Create a new Order using the PP API.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $order_id
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function captureOrder(
+		EE_Transaction    $transaction,
+		EE_Payment_Method $paypal_pm,
+		string            $order_id
+	): array {
+		$capture_order_api = EED_PayPalCommerce::getCaptureOrderApi($transaction, $paypal_pm, $order_id);
+		if (! $capture_order_api instanceof CaptureOrder) {
+			return [
+				'error'   => 'CAPTURE_ORDER_API_FAULT',
+				'message' => esc_html__('A capture Order API request fault.', 'event_espresso'),
+			];
+		}
+		return $capture_order_api->capture();
+	}
+
+
+	/**
+	 * Get Order Details using the PP API.
+	 *
+	 * @param string            $order_id
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getOrderDetails(
+		string            $order_id,
+		EE_Transaction    $transaction,
+		EE_Payment_Method $paypal_pm
+	): array {
+		$order_details = EED_PayPalCommerce::getOrderDetailsApi($order_id, $transaction, $paypal_pm);
+		if (! $order_details instanceof OrderDetails) {
+			return [
+				'error'   => 'ORDER_DETAILS_API_FAULT',
+				'message' => esc_html__('Get Order Details API request fault.', 'event_espresso'),
+			];
+		}
+		return $order_details->get();
+	}
+
+
+	/**
+	 * Initialize and return Create Order API.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param array             $billing_info
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return CreateOrder|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getCreateOrderApi(
+		EE_Transaction $transaction,
+		array $billing_info,
+		EE_Payment_Method $paypal_pm
+	): ?CreateOrder {
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi) {
+			return null;
+		}
+		return LoaderFactory::getNew(CreateOrder::class, [$paypal_api, $transaction, $billing_info]);
+	}
+
+
+	/**
+	 * Initialize and return Capture Order API.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $order_id
+	 * @return CaptureOrder|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getCaptureOrderApi(
+		EE_Transaction $transaction,
+		EE_Payment_Method $paypal_pm,
+		string $order_id
+	): ?CaptureOrder {
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi) {
+			return null;
+		}
+		return LoaderFactory::getNew(CaptureOrder::class, [$paypal_api, $transaction, $order_id]);
+	}
+
+
+	/**
+	 * Initialize and return Order Details API.
+	 *
+	 * @param EE_Transaction    $transaction
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $order_id
+	 * @return OrderDetails|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getOrderDetailsApi(
+		string $order_id,
+		EE_Transaction $transaction,
+		EE_Payment_Method $paypal_pm
+	): ?OrderDetails {
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi) {
+			return null;
+		}
+		return LoaderFactory::getNew(OrderDetails::class, [$paypal_api, $order_id, $transaction]);
+	}
+
+
+	/**
+	 * Return a PayPal API object, or false on failure.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return PayPalApi|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPayPalApi(EE_Payment_Method $paypal_pm): ?PayPalApi
+	{
+		// Try getting the first party credentials to determine if this is a first party integration that's active.
+		$client_id     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_CLIENT_ID);
+		$client_secret = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_CLIENT_SECRET);
+		$bn_code       = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		if ($client_id && $client_secret) {
+			return new FirstPartyPayPalApi($client_id, $client_secret, $bn_code, $paypal_pm->debug_mode());
+		}
+		// Third party integration credentials:
+		$access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
+		if (! $access_token || ! $bn_code) {
+			return null;
+		}
+		$partner_client_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_CLIENT_ID) ?: '';
+		$payer_id          = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?: '';
+		return new ThirdPartyPayPalApi(
+			$access_token,
+			$bn_code,
+			$partner_client_id,
+			$payer_id,
+			$paypal_pm->debug_mode()
+		);
+	}
+
+
+	/**
+	 * Requests a client token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function requestClientToken(EE_Payment_Method $paypal_pm): array
+	{
+		$error      = ['error' => 'GET_CLIENT_TOKEN_FAULT'];
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi) {
+			$error['message'] = esc_html__('Got an error while trying to get the client token.', 'event_espresso');
+			return $error;
+		}
+		$client_token_api = new ClientToken($paypal_api, $paypal_pm->debug_mode());
+		$client_token     = $client_token_api->getToken();
+		if (isset($client_token['error'])) {
+			return $client_token;
+		}
+		if (empty($client_token)) {
+			$error['message'] = esc_html__('Client token not valid.', 'event_espresso');
+			return $error;
+		}
+		return $client_token;
+	}
+
+
+	/**
+	 * Retrieve the payment method from the provided data.
+	 *
+	 * @return EE_Transaction|null
+	 */
+	public static function getTransaction(): ?EE_Transaction
+	{
+		try {
+			$txn_id      = EED_Module::getRequest()->getRequestParam('txn_id', 0, DataType::INT);
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($txn_id);
+			if (! $transaction instanceof EE_Transaction) {
+				PayPalLogger::errorLog(
+					esc_html__('No transaction found by ID:', 'event_espresso'),
+					EED_Module::getRequest()->postParams()
+				);
+				return null;
+			}
+		} catch (Exception $e) {
+			return null;
+		}
+		return $transaction;
+	}
+
+
+	/**
+	 * Return a PayPal API object, or false on failure.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function isThirdParty(EE_Payment_Method $paypal_pm): bool
+	{
+		$pp_meta_data = PayPalExtraMetaManager::getAllData($paypal_pm);
+		return ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+			&& ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ]);
+	}
+
+
+	/**
+	 * Retrieve the payment method from the provided data.
+	 *
+	 * @return EE_Payment_Method|null
+	 */
+	public static function getPaymentMethod(): ?EE_Payment_Method
+	{
+		try {
+			// Check if all required parameters are present.
+			$pm_slug        = EED_Module::getRequest()->getRequestParam('payment_method');
+			$payment_method = EEM_Payment_Method::instance()->get_one_by_slug($pm_slug);
+			if ($payment_method instanceof EE_Payment_Method) {
+				return $payment_method;
+			}
+		} catch (Exception $e) {
+			return null;
+		}
+		return null;
+	}
+
+
+	/**
+	 * Log JS error.
+	 *
+	 * @return void
+	 */
+	public static function logJsError(): void
+	{
+		// Default to the "first" PayPal checkout PM.
+		$request        = EED_Module::getRequest();
+		$pm_slug        = $request->getRequestParam('pm_slug', Domain::PM_SLUG);
+		$payment_method = null;
+		$txn_id         = 'unknown';
+		try {
+			$payment_method = EEM_Payment_Method::instance()->get_one_of_type($pm_slug);
+			$txn_id         = sanitize_text_field($request->getRequestParam('txn_id', '-'));
+		} catch (Exception $e) {
+			// Don't throw out anything, log at least something.
+		}
+		$transaction = EED_PayPalCommerce::getTransaction();
+		PayPalLogger::errorLog(
+			"JS Error on transaction: $txn_id",
+			$request->postParams(),
+			$payment_method,
+			false,
+			$transaction
+		);
+	}
+
+
+	/**
+	 * Filter the Payment Methods list.
+	 * if needed, this filter can also supply the $transaction and $scope parameters.
+	 *
+	 * @param EE_Payment_Method[] $payment_methods
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function filterPaymentMethods(array $payment_methods): array
+	{
+		// Don't allow this PM on the checkout page if not Connected.
+		foreach ($payment_methods as $key => $pm) {
+			// It is a PayPal Commerce payment method. Check if it's connected. If not - remove from the list.
+			if (str_contains($pm->slug(), Domain::PM_SLUG) && ! EED_PayPalOnboard::isOnboard($pm)) {
+				unset($payment_methods[ $key ]);
+			}
+		}
+		return $payment_methods;
+	}
+
+
+	/**
+	 *  Get all active states.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getActiveStates(): array
+	{
+		$state_options = [];
+		$states        = EEM_State::instance()->get_all_active_states();
+		if (! empty($states)) {
+			foreach ($states as $numeral => $state) {
+				if ($state instanceof EE_State) {
+					$state_options[ $numeral ] = $state->abbrev();
+				}
+			}
+		}
+		return $state_options;
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -99,7 +99,7 @@ 
     {
         $paypal_pm   = EED_PayPalCommerce::getPaymentMethod();
         $post_params = EED_Module::getRequest()->postParams();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             PayPalLogger::errorLogAndExit(
                 esc_html__('Related payment method not found (create Order).', 'event_espresso'),
                 $post_params
@@ -111,7 +111,7 @@ 
             $billing_info_decoded = json_decode(stripslashes($billing_info), true);
             $billing_info         = is_array($billing_info_decoded) ? $billing_info_decoded : [];
         }
-        if (! $transaction) {
+        if ( ! $transaction) {
             PayPalLogger::errorLogAndExit(
                 esc_html__('Transaction info not found.', 'event_espresso'),
                 $post_params,
@@ -139,7 +139,7 @@ 
         EE_Payment_Method $paypal_pm
     ): array {
         $create_order_api = EED_PayPalCommerce::getCreateOrderApi($transaction, $billing_info, $paypal_pm);
-        if (! $create_order_api instanceof CreateOrder) {
+        if ( ! $create_order_api instanceof CreateOrder) {
             return [
                 'error'   => 'CREATE_ORDER_API_FAULT',
                 'message' => esc_html__('The Create Order API request fault.', 'event_espresso'),
@@ -176,7 +176,7 @@ 
         string            $order_id
     ): array {
         $capture_order_api = EED_PayPalCommerce::getCaptureOrderApi($transaction, $paypal_pm, $order_id);
-        if (! $capture_order_api instanceof CaptureOrder) {
+        if ( ! $capture_order_api instanceof CaptureOrder) {
             return [
                 'error'   => 'CAPTURE_ORDER_API_FAULT',
                 'message' => esc_html__('A capture Order API request fault.', 'event_espresso'),
@@ -202,7 +202,7 @@ 
         EE_Payment_Method $paypal_pm
     ): array {
         $order_details = EED_PayPalCommerce::getOrderDetailsApi($order_id, $transaction, $paypal_pm);
-        if (! $order_details instanceof OrderDetails) {
+        if ( ! $order_details instanceof OrderDetails) {
             return [
                 'error'   => 'ORDER_DETAILS_API_FAULT',
                 'message' => esc_html__('Get Order Details API request fault.', 'event_espresso'),
@@ -228,7 +228,7 @@ 
         EE_Payment_Method $paypal_pm
     ): ?CreateOrder {
         $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
+        if ( ! $paypal_api instanceof PayPalApi) {
             return null;
         }
         return LoaderFactory::getNew(CreateOrder::class, [$paypal_api, $transaction, $billing_info]);
@@ -251,7 +251,7 @@ 
         string $order_id
     ): ?CaptureOrder {
         $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
+        if ( ! $paypal_api instanceof PayPalApi) {
             return null;
         }
         return LoaderFactory::getNew(CaptureOrder::class, [$paypal_api, $transaction, $order_id]);
@@ -274,7 +274,7 @@ 
         EE_Payment_Method $paypal_pm
     ): ?OrderDetails {
         $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
+        if ( ! $paypal_api instanceof PayPalApi) {
             return null;
         }
         return LoaderFactory::getNew(OrderDetails::class, [$paypal_api, $order_id, $transaction]);
@@ -300,7 +300,7 @@ 
         }
         // Third party integration credentials:
         $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token || ! $bn_code) {
+        if ( ! $access_token || ! $bn_code) {
             return null;
         }
         $partner_client_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_CLIENT_ID) ?: '';
@@ -327,7 +327,7 @@ 
     {
         $error      = ['error' => 'GET_CLIENT_TOKEN_FAULT'];
         $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi) {
+        if ( ! $paypal_api instanceof PayPalApi) {
             $error['message'] = esc_html__('Got an error while trying to get the client token.', 'event_espresso');
             return $error;
         }
@@ -354,7 +354,7 @@ 
         try {
             $txn_id      = EED_Module::getRequest()->getRequestParam('txn_id', 0, DataType::INT);
             $transaction = EEM_Transaction::instance()->get_one_by_ID($txn_id);
-            if (! $transaction instanceof EE_Transaction) {
+            if ( ! $transaction instanceof EE_Transaction) {
                 PayPalLogger::errorLog(
                     esc_html__('No transaction found by ID:', 'event_espresso'),
                     EED_Module::getRequest()->postParams()
@@ -379,8 +379,8 @@ 
     public static function isThirdParty(EE_Payment_Method $paypal_pm): bool
     {
         $pp_meta_data = PayPalExtraMetaManager::getAllData($paypal_pm);
-        return ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-            && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ]);
+        return ! empty($pp_meta_data[Domain::META_KEY_SELLER_MERCHANT_ID])
+            && ! empty($pp_meta_data[Domain::META_KEY_ACCESS_TOKEN]);
     }
 
 
@@ -449,7 +449,7 @@ 
         foreach ($payment_methods as $key => $pm) {
             // It is a PayPal Commerce payment method. Check if it's connected. If not - remove from the list.
             if (str_contains($pm->slug(), Domain::PM_SLUG) && ! EED_PayPalOnboard::isOnboard($pm)) {
-                unset($payment_methods[ $key ]);
+                unset($payment_methods[$key]);
             }
         }
         return $payment_methods;
@@ -467,10 +467,10 @@ 
     {
         $state_options = [];
         $states        = EEM_State::instance()->get_all_active_states();
-        if (! empty($states)) {
+        if ( ! empty($states)) {
             foreach ($states as $numeral => $state) {
                 if ($state instanceof EE_State) {
-                    $state_options[ $numeral ] = $state->abbrev();
+                    $state_options[$numeral] = $state->abbrev();
                 }
             }
         }

PaymentMethods/PayPalCommerce/modules/EED_PayPalOnboard.module.php

Indentation +729 added lines, -729 removed lines

@@ -20,736 +20,736 @@
  */
 class EED_PayPalOnboard extends EED_Module
 {
-    /**
-     * @return EED_Module
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance(): EED_Module
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * Run - initial module setup.
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * For hooking into EE Admin Core and other modules.
-     *
-     * @return void
-     */
-    public static function set_hooks_admin(): void
-    {
-        // check for the most basic EE capability
-        /** @var EE_Capabilities $capabilities */
-        $capabilities = LoaderFactory::getLoader()->getShared(EE_Capabilities::class);
-        if (
-            DbStatus::isOffline()
-            || ! $capabilities->current_user_can('ee_manage_gateways', 'manage-paypal-onboarding')
-        ) {
-            return;
-        }
-        // Get onboarding URL.
-        add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
-        // Catch the return/redirect from PayPal onboarding page.
-        add_action('init', [__CLASS__, 'updateOnboardingStatus']);
-        // Return the connection/onboard status.
-        add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
-        // Revoke access.
-        add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
-        // Clear all metadata.
-        add_action('wp_ajax_eeaPpClearMetaData', [__CLASS__, 'clearMetaData']);
-        // Admin notice.
-        add_action('admin_init', [__CLASS__, 'adminNotice']);
-    }
-
-
-    /**
-     * Get the onboarding URL.
-     * (AJAX)
-     *
-     * @return void
-     */
-    public static function getOnboardingUrl(): void
-    {
-        $signup_link = '';
-        try {
-            $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-            if (! $paypal_pm instanceof EE_Payment_Method) {
-                PayPalLogger::errorLogAndExit(
-                    esc_html__('No payment method.', 'event_espresso'),
-                    EED_Module::getRequest()->postParams(),
-                    $paypal_pm
-                );
-            }
-            PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
-            // Just get a new onboarding URL every time.
-            $signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
-            if (! $signup_link) {
-                $err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
-                PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
-            }
-        } catch (Exception $e) {
-            PayPalLogger::errorLogAndExit($e->getMessage(), ['trace' => $e->getTrace()]);
-        }
-        // Is it empty (can happen if we didn't get the URL through the API).
-        $signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
-        wp_send_json(
-            [
-                'signup_link' => $signup_link,
-            ]
-        );
-    }
-
-
-    /**
-     * Request the sign-up link from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param bool              $one_time_request
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm, bool $one_time_request = false): string
-    {
-        $signup_link = '';
-        // Get the access token.
-        $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token) {
-            $err_msg = esc_html__('Error! No access token.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
-            return '';
-        }
-        // Request the access token.
-        $body_params = EED_PayPalOnboard::signupLinkRequestBody($paypal_pm);
-        $bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
-        $post_params = [
-            'method'  => 'POST',
-            'headers' => [
-                'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
-                'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $access_token,
-                'PayPal-Partner-Attribution-Id' => $bn_code,
-            ],
-            'body'    => $body_params,
-        ];
-        $request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
-        $response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
-        // Check the data we received.
-        if (isset($response['error']) || empty($response['links'])) {
-            // Did the original access token get replaced by any chance ?
-            if (
-                ! $one_time_request
-                && ! empty($response['message'])
-                && $response['message'] === 'Access Token not found in cache'
-            ) {
-                // Clear all PM metadata and try getting the access token One more time.
-                PayPalExtraMetaManager::deleteData($paypal_pm);
-                PayPalLogger::errorLog(
-                    esc_html__('Removing old metadata before new onboarding.', 'event_espresso'),
-                    $response,
-                    $paypal_pm
-                );
-                return EED_PayPalOnboard::requestOnboardingUrl($paypal_pm, true);
-            }
-            $err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
-            return '';
-        }
-        // Now retrieve that sign-up link.
-        foreach ($response['links'] as $link) {
-            if ($link['rel'] === 'action_url') {
-                $signup_link = $link['href'] ?? '';
-            }
-        }
-        return $signup_link;
-    }
-
-
-    /**
-     * Get the return URL.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws Exception
-     */
-    public static function signupLinkRequestBody(EE_Payment_Method $paypal_pm): string
-    {
-        $identifier_string = new OneTimeString($paypal_pm->debug_mode());
-        $tracking_id       = $identifier_string->value();
-        $request           = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $selected_payment  = $request->getRequestParam('selected_payment', 'EXPRESS_CHECKOUT');
-        // Save the identifier for future use.
-        PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_TRACKING_ID, $tracking_id);
-        // Assemble the return URL.
-        $return_url = EED_PayPalOnboard::getReturnUrl($paypal_pm, $selected_payment);
-        return json_encode(
-            [
-                'tracking_id'             => $tracking_id,
-                'operations'              => [
-                    [
-                        'operation'                  => 'API_INTEGRATION',
-                        'api_integration_preference' => [
-                            'rest_api_integration' => [
-                                'integration_method'  => 'PAYPAL',
-                                'integration_type'    => 'THIRD_PARTY',
-                                'third_party_details' => [
-                                    'features' => ['PAYMENT', 'REFUND', 'PARTNER_FEE'],
-                                ],
-                            ],
-                        ],
-                    ],
-                ],
-                'products'                => [$selected_payment],
-                'legal_consents'          => [
-                    [
-                        'type'    => 'SHARE_DATA_CONSENT',
-                        'granted' => true,
-                    ],
-                ],
-                'partner_config_override' => [
-                    'return_url' => $return_url,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * Get the return URL.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $selected_payment
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getReturnUrl(EE_Payment_Method $paypal_pm, string $selected_payment = ''): string
-    {
-        $wp_nonce = EED_Module::getRequest()->getRequestParam('wp_nonce');
-        $nonce    = wp_create_nonce(Domain::NONCE_NAME_ONBOARDING_RETURN);
-        return add_query_arg(
-            [
-                'page'                        => 'espresso_payment_settings',
-                'webhook_action'              => 'eepPpcMerchantOnboard',
-                'payment_method'              => $paypal_pm->slug(),
-                '_wpnonce'                    => $wp_nonce,
-                'nonce'                       => $nonce,
-                'selected_payment'            => $selected_payment,
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-            admin_url('admin.php')
-        );
-    }
-
-
-    /**
-     * Redirect to the payment method (PP) settings home page.
-     *
-     * @return void
-     */
-    public static function redirectToPmSettingsHome(): void
-    {
-        $get_params = EED_Module::getRequest()->getParams();
-        if (empty($get_params['payment_method'])) {
-            // Simply do not redirect.
-            return;
-        }
-        $args_to_add = [
-            'page'           => 'espresso_payment_settings',
-            'payment_method' => $get_params['payment_method'],
-        ];
-        if (isset($get_params['sandbox_mode'])) {
-            $args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
-        }
-        $home_url = add_query_arg($args_to_add, admin_url('admin.php'));
-        wp_redirect($home_url);
-        exit;
-    }
-
-
-    /**
-     * Check user’s onboarding status.
-     * This will handle the user return from the auth page and also check the status via the API.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function updateOnboardingStatus(): void
-    {
-        // Check if this is the webhook from PayPal.
-        if (
-            ! isset($_GET['webhook_action'], $_GET['nonce'])
-            || $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
-        ) {
-            return;  // Ignore.
-        }
-        $get_params = EED_Module::getRequest()->getParams();
-        // Get the payment method.
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        // Check the response (GET) parameters.
-        if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
-            // Missing parameters. Can't proceed.
-            PayPalLogger::errorLog(
-                esc_html__('Missing required onboarding parameters.', 'event_espresso'),
-                $get_params,
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Check on the onboarding status (recommended by PP).
-        $onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
-            $paypal_pm,
-            $get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
-        );
-        if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
-            PayPalLogger::errorLog(
-                $onboarding_status['message'],
-                array_merge($get_params, $onboarding_status),
-                $paypal_pm
-            );
-            EED_PayPalOnboard::redirectToPmSettingsHome();
-            return;
-        }
-        // Start saving the setup and info.
-        PayPalExtraMetaManager::parseAndSaveOptions($paypal_pm, $onboarding_status, $get_params);
-        // Save the credentials.
-        PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
-        // Also clen GET params by redirecting, because PP auto redirects to the return_url on closing the onboarding window.
-        EED_PayPalOnboard::redirectToPmSettingsHome();
-    }
-
-
-    /**
-     * Check if all required parameters for the onboarding status check are present.
-     *
-     * @param array $data
-     * @param mixed $paypal_pm
-     * @return bool
-     */
-    public static function onboardingStatusResponseValid(array $data, $paypal_pm): bool
-    {
-        // Check that we have all the required parameters and the nonce is ok.
-        if (
-            $paypal_pm instanceof EE_Payment_Method
-            && wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
-            && ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
-            && ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-            && isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
-        ) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        // Do we have it saved ?
-        $access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
-        // If we don't have it, request/update it.
-        if (! $access_token) {
-            return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
-        }
-        if (EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm)) {
-            return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
-        }
-        // Access token is saved as encrypted, but return decrypted.
-        return $access_token;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
-    {
-        $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_TOKEN_EXPIRES_IN);
-        if (! $expires_at) {
-            return true;
-        }
-        // Validate the token expiration date.
-        $minutes_left = round(($expires_at - time()) / 60);
-        // Count as expired if less than 60 minutes till expiration left.
-        if ($minutes_left <= 60) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Request the partner access token from PayPal and save/update it.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
-    {
-        $nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
-        // Request the access token.
-        $post_args = [
-            'method' => 'POST',
-            'body'   => [
-                'nonce'                       => $nonce,
-                'api_version'                 => 'v1',
-                Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
-            ],
-        ];
-        if (defined('LOCAL_MIDDLEMAN_SERVER')) {
-            $post_args['sslverify'] = Manager::verifySSL();
-        }
-        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
-        $response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
-        if (isset($response['error'])) {
-            return '';
-        }
-        // Check the data we received.
-        if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
-            return '';
-        }
-        // If we are here all seems to be ok. Save the token and it's data.
-        $saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
-        if (! $saved) {
-            return '';
-        }
-        return $response['access_token'];
-    }
-
-
-    /**
-     * Request seller onboarding status from PayPal.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $merchant_id
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
-    {
-        $track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
-        if (! $track_onboarding instanceof TrackSellerOnboarding) {
-            return [
-                'error'   => 'TRACK_ONBOARDING_FAILED',
-                'message' => esc_html__('Failed to track seller onboarding.', 'event_espresso')
-            ];
-        }
-        return $track_onboarding->isValid();
-    }
-
-
-    /**
-     * Returns the Track Seller Onboarding API.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $merchant_id
-     * @return TrackSellerOnboarding|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getTrackOnboardingApi(
-        EE_Payment_Method $paypal_pm,
-        string $merchant_id
-    ): ?TrackSellerOnboarding {
-        $partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
-        $paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
-        if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
-            return null;
-        }
-        return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
-    }
-
-
-    /**
-     * Check the onboard status and return the result.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getOnboardStatus(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            $err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
-            wp_send_json(['on_board' => false]);
-        }
-        try {
-            $seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?? '--';
-        } catch (Exception $e) {
-            $seller_id = '--';
-            PayPalLogger::errorLog($e->getMessage(), ['trace' => $e->getTrace()]);
-        }
-        wp_send_json(
-            [
-                'on_board'  => EED_PayPalOnboard::isOnboard($paypal_pm),
-                'seller_id' => $seller_id,
-            ]
-        );
-    }
-
-
-    /**
-     * De-authorize the seller. Remove all API credentials.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function offboard(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        EED_PayPalOnboard::validatePmAjax($paypal_pm);
-        PayPalExtraMetaManager::deleteData($paypal_pm);
-        PayPalLogger::errorLog(
-            esc_html__('Offboarding. Removing metadata.', 'event_espresso'),
-            EED_Module::getRequest()->postParams(),
-            $paypal_pm
-        );
-        wp_send_json(['success' => true]);
-    }
-
-
-    /**
-     * Clear all credentials metadata.
-     * (AJAX)
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function clearMetaData(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        EED_PayPalOnboard::validatePmAjax($paypal_pm);
-        PayPalExtraMetaManager::deleteAllData($paypal_pm);
-        PayPalLogger::errorLog(
-            esc_html__('Doing a Reset. Removing all PM settings metadata.', 'event_espresso'),
-            EED_Module::getRequest()->postParams(),
-            $paypal_pm
-        );
-        wp_send_json(['success' => true]);
-    }
-
-
-    /**
-     * Validate the PM instance, returning an ajax response on invalid.
-     *
-     * @param $paypal_pm
-     * @return void
-     */
-    public static function validatePmAjax($paypal_pm): void
-    {
-        if (! $paypal_pm instanceof EE_Payment_Method) {
-            wp_send_json(
-                [
-                    'error'   => 'INVALID_PM',
-                    'message' => esc_html__(
-                        'Invalid payment method. Please refresh the page and try again.',
-                        'event_espresso'
-                    ),
-                ]
-            );
-        }
-    }
-
-
-    /**
-     * Checks if already onboard.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return boolean
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function isOnboard(EE_Payment_Method $payment_method): bool
-    {
-        $pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
-        return
-            (
-                // onborded with a third party integration ?
-                ! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
-            ) || (
-                // or with the first party integration ?
-                ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
-                && ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
-            );
-    }
-
-
-    /**
-     * Send a request and return a decoded response body.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @param string            $request_url
-     * @param array             $request_args
-     * @return array
-     */
-    public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
-    {
-        $error_return = ['error' => true];
-        $response     = wp_remote_request($request_url, $request_args);
-        if (is_wp_error($response)) {
-            $message = $response->get_error_message();
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        $response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
-        if (empty($response_body) || isset($response_body['error'])) {
-            $message = $response_body['error_description']
-                ?? sprintf(
-                    esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
-                    $request_url
-                );
-            PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
-            $error_return['message'] = $message;
-            return $error_return;
-        }
-        return $response_body;
-    }
-
-
-    /**
-     * Check the response for a partner token request.
-     *
-     * @param array             $response
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function partnerTokenResponseValid(array $response, EE_Payment_Method $paypal_pm): bool
-    {
-        // Check the data we received.
-        if (
-            empty($response['nonce'])
-            || ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
-            || empty($response['access_token'])
-            || empty($response['app_id'])
-            || empty($response['expires_in'])
-            || empty($response['partner_client_id'])
-            || empty($response['partner_merchant_id'])
-        ) {
-            // This is an error.
-            PayPalLogger::errorLog(
-                esc_html__('Incoming parameter validation failed.', 'event_espresso'),
-                $response,
-                $paypal_pm
-            );
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Returns the base URL to the middleman server.
-     * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
-    {
-        $target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
-        // If this PM is used under different provider accounts, you might need an account indicator.
-        $account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
-        $postfix = $payment_method->debug_mode() ? '_sandbox' : '';
-        return "https://connect.eventespresso.$target/paypal_commerce$account$postfix/";
-    }
-
-
-    /**
-     * This Payment Method admin notices.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function adminNotice()
-    {
-        // Show the notice if PayPal Commerce PM is active but merchant is not onboard.
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
-        if (
-            $pp_commerce instanceof EE_Payment_Method
-            && $pp_commerce->active()
-            && ! EED_PayPalOnboard::isOnboard($pp_commerce)
-        ) {
-            add_action('admin_notices', [EED_PayPalOnboard::class, 'notOnboardNotice']);
-        }
-    }
-
-
-    /**
-     * Contents of the not onboard admin notice.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function notOnboardNotice()
-    {
-        $open_anchor = $close_anchor = '';
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
-        if ($pp_commerce instanceof EE_Payment_Method) {
-            $pm_page      = add_query_arg(
-                [
-                    'page'           => 'espresso_payment_settings',
-                    'webhook_action' => 'eepPpcMerchantOnboard',
-                    'payment_method' => $pp_commerce->slug(),
-                ],
-                admin_url('admin.php')
-            );
-            $open_anchor  = "<a href='$pm_page'>";
-            $close_anchor = "</a>";
-        }
-        $notice = sprintf(
-            esc_html__(
-                '%1$sPayPal Commerce%2$s payment method was activated but is not connected to PayPal. Please %3$sfinish setting up%4$s this payment method.',
-                'event_espresso'
-            ),
-            '<strong>',
-            '</strong>',
-            $open_anchor,
-            $close_anchor
-        );
-        echo "
+	/**
+	 * @return EED_Module
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance(): EED_Module
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * Run - initial module setup.
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * For hooking into EE Admin Core and other modules.
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin(): void
+	{
+		// check for the most basic EE capability
+		/** @var EE_Capabilities $capabilities */
+		$capabilities = LoaderFactory::getLoader()->getShared(EE_Capabilities::class);
+		if (
+			DbStatus::isOffline()
+			|| ! $capabilities->current_user_can('ee_manage_gateways', 'manage-paypal-onboarding')
+		) {
+			return;
+		}
+		// Get onboarding URL.
+		add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
+		// Catch the return/redirect from PayPal onboarding page.
+		add_action('init', [__CLASS__, 'updateOnboardingStatus']);
+		// Return the connection/onboard status.
+		add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
+		// Revoke access.
+		add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
+		// Clear all metadata.
+		add_action('wp_ajax_eeaPpClearMetaData', [__CLASS__, 'clearMetaData']);
+		// Admin notice.
+		add_action('admin_init', [__CLASS__, 'adminNotice']);
+	}
+
+
+	/**
+	 * Get the onboarding URL.
+	 * (AJAX)
+	 *
+	 * @return void
+	 */
+	public static function getOnboardingUrl(): void
+	{
+		$signup_link = '';
+		try {
+			$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+			if (! $paypal_pm instanceof EE_Payment_Method) {
+				PayPalLogger::errorLogAndExit(
+					esc_html__('No payment method.', 'event_espresso'),
+					EED_Module::getRequest()->postParams(),
+					$paypal_pm
+				);
+			}
+			PayPalExtraMetaManager::updateDebugMode($paypal_pm, EED_Module::getRequest()->postParams());
+			// Just get a new onboarding URL every time.
+			$signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
+			if (! $signup_link) {
+				$err_msg = esc_html__('Error! Could not generate a sign-up link.', 'event_espresso');
+				PayPalLogger::errorLogAndExit($err_msg, ['signup_link' => $signup_link], $paypal_pm);
+			}
+		} catch (Exception $e) {
+			PayPalLogger::errorLogAndExit($e->getMessage(), ['trace' => $e->getTrace()]);
+		}
+		// Is it empty (can happen if we didn't get the URL through the API).
+		$signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
+		wp_send_json(
+			[
+				'signup_link' => $signup_link,
+			]
+		);
+	}
+
+
+	/**
+	 * Request the sign-up link from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param bool              $one_time_request
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public static function requestOnboardingUrl(EE_Payment_Method $paypal_pm, bool $one_time_request = false): string
+	{
+		$signup_link = '';
+		// Get the access token.
+		$access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
+		if (! $access_token) {
+			$err_msg = esc_html__('Error! No access token.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
+			return '';
+		}
+		// Request the access token.
+		$body_params = EED_PayPalOnboard::signupLinkRequestBody($paypal_pm);
+		$bn_code     = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_BN_CODE);
+		$post_params = [
+			'method'  => 'POST',
+			'headers' => [
+				'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
+				'Content-Type'                  => 'application/json',
+				'Authorization'                 => 'Bearer ' . $access_token,
+				'PayPal-Partner-Attribution-Id' => $bn_code,
+			],
+			'body'    => $body_params,
+		];
+		$request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
+		$response    = EED_PayPalOnboard::sendRequest($paypal_pm, $request_url, $post_params);
+		// Check the data we received.
+		if (isset($response['error']) || empty($response['links'])) {
+			// Did the original access token get replaced by any chance ?
+			if (
+				! $one_time_request
+				&& ! empty($response['message'])
+				&& $response['message'] === 'Access Token not found in cache'
+			) {
+				// Clear all PM metadata and try getting the access token One more time.
+				PayPalExtraMetaManager::deleteData($paypal_pm);
+				PayPalLogger::errorLog(
+					esc_html__('Removing old metadata before new onboarding.', 'event_espresso'),
+					$response,
+					$paypal_pm
+				);
+				return EED_PayPalOnboard::requestOnboardingUrl($paypal_pm, true);
+			}
+			$err_msg = esc_html__('Incoming sign-up link parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, $response, $paypal_pm);
+			return '';
+		}
+		// Now retrieve that sign-up link.
+		foreach ($response['links'] as $link) {
+			if ($link['rel'] === 'action_url') {
+				$signup_link = $link['href'] ?? '';
+			}
+		}
+		return $signup_link;
+	}
+
+
+	/**
+	 * Get the return URL.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws Exception
+	 */
+	public static function signupLinkRequestBody(EE_Payment_Method $paypal_pm): string
+	{
+		$identifier_string = new OneTimeString($paypal_pm->debug_mode());
+		$tracking_id       = $identifier_string->value();
+		$request           = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$selected_payment  = $request->getRequestParam('selected_payment', 'EXPRESS_CHECKOUT');
+		// Save the identifier for future use.
+		PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_TRACKING_ID, $tracking_id);
+		// Assemble the return URL.
+		$return_url = EED_PayPalOnboard::getReturnUrl($paypal_pm, $selected_payment);
+		return json_encode(
+			[
+				'tracking_id'             => $tracking_id,
+				'operations'              => [
+					[
+						'operation'                  => 'API_INTEGRATION',
+						'api_integration_preference' => [
+							'rest_api_integration' => [
+								'integration_method'  => 'PAYPAL',
+								'integration_type'    => 'THIRD_PARTY',
+								'third_party_details' => [
+									'features' => ['PAYMENT', 'REFUND', 'PARTNER_FEE'],
+								],
+							],
+						],
+					],
+				],
+				'products'                => [$selected_payment],
+				'legal_consents'          => [
+					[
+						'type'    => 'SHARE_DATA_CONSENT',
+						'granted' => true,
+					],
+				],
+				'partner_config_override' => [
+					'return_url' => $return_url,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * Get the return URL.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $selected_payment
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getReturnUrl(EE_Payment_Method $paypal_pm, string $selected_payment = ''): string
+	{
+		$wp_nonce = EED_Module::getRequest()->getRequestParam('wp_nonce');
+		$nonce    = wp_create_nonce(Domain::NONCE_NAME_ONBOARDING_RETURN);
+		return add_query_arg(
+			[
+				'page'                        => 'espresso_payment_settings',
+				'webhook_action'              => 'eepPpcMerchantOnboard',
+				'payment_method'              => $paypal_pm->slug(),
+				'_wpnonce'                    => $wp_nonce,
+				'nonce'                       => $nonce,
+				'selected_payment'            => $selected_payment,
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+			admin_url('admin.php')
+		);
+	}
+
+
+	/**
+	 * Redirect to the payment method (PP) settings home page.
+	 *
+	 * @return void
+	 */
+	public static function redirectToPmSettingsHome(): void
+	{
+		$get_params = EED_Module::getRequest()->getParams();
+		if (empty($get_params['payment_method'])) {
+			// Simply do not redirect.
+			return;
+		}
+		$args_to_add = [
+			'page'           => 'espresso_payment_settings',
+			'payment_method' => $get_params['payment_method'],
+		];
+		if (isset($get_params['sandbox_mode'])) {
+			$args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $get_params['sandbox_mode'];
+		}
+		$home_url = add_query_arg($args_to_add, admin_url('admin.php'));
+		wp_redirect($home_url);
+		exit;
+	}
+
+
+	/**
+	 * Check user’s onboarding status.
+	 * This will handle the user return from the auth page and also check the status via the API.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function updateOnboardingStatus(): void
+	{
+		// Check if this is the webhook from PayPal.
+		if (
+			! isset($_GET['webhook_action'], $_GET['nonce'])
+			|| $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
+		) {
+			return;  // Ignore.
+		}
+		$get_params = EED_Module::getRequest()->getParams();
+		// Get the payment method.
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		// Check the response (GET) parameters.
+		if (! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
+			// Missing parameters. Can't proceed.
+			PayPalLogger::errorLog(
+				esc_html__('Missing required onboarding parameters.', 'event_espresso'),
+				$get_params,
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Check on the onboarding status (recommended by PP).
+		$onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
+			$paypal_pm,
+			$get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
+		);
+		if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
+			PayPalLogger::errorLog(
+				$onboarding_status['message'],
+				array_merge($get_params, $onboarding_status),
+				$paypal_pm
+			);
+			EED_PayPalOnboard::redirectToPmSettingsHome();
+			return;
+		}
+		// Start saving the setup and info.
+		PayPalExtraMetaManager::parseAndSaveOptions($paypal_pm, $onboarding_status, $get_params);
+		// Save the credentials.
+		PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
+		// Also clen GET params by redirecting, because PP auto redirects to the return_url on closing the onboarding window.
+		EED_PayPalOnboard::redirectToPmSettingsHome();
+	}
+
+
+	/**
+	 * Check if all required parameters for the onboarding status check are present.
+	 *
+	 * @param array $data
+	 * @param mixed $paypal_pm
+	 * @return bool
+	 */
+	public static function onboardingStatusResponseValid(array $data, $paypal_pm): bool
+	{
+		// Check that we have all the required parameters and the nonce is ok.
+		if (
+			$paypal_pm instanceof EE_Payment_Method
+			&& wp_verify_nonce($data['nonce'], Domain::NONCE_NAME_ONBOARDING_RETURN)
+			&& ! empty($data[ Domain::API_PARAM_PARTNER_ID ])
+			&& ! empty($data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+			&& isset($data[ Domain::API_PARAM_EMAIL_CONFIRMED ])
+		) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		// Do we have it saved ?
+		$access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
+		// If we don't have it, request/update it.
+		if (! $access_token) {
+			return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
+		}
+		if (EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm)) {
+			return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
+		}
+		// Access token is saved as encrypted, but return decrypted.
+		return $access_token;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
+	{
+		$expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_TOKEN_EXPIRES_IN);
+		if (! $expires_at) {
+			return true;
+		}
+		// Validate the token expiration date.
+		$minutes_left = round(($expires_at - time()) / 60);
+		// Count as expired if less than 60 minutes till expiration left.
+		if ($minutes_left <= 60) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Request the partner access token from PayPal and save/update it.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function requestPartnerAccessToken(EE_Payment_Method $paypal_pm): string
+	{
+		$nonce = wp_create_nonce('eea_pp_commerce_get_access_token');
+		// Request the access token.
+		$post_args = [
+			'method' => 'POST',
+			'body'   => [
+				'nonce'                       => $nonce,
+				'api_version'                 => 'v1',
+				Domain::META_KEY_SANDBOX_MODE => $paypal_pm->debug_mode() ? '1' : '0',
+			],
+		];
+		if (defined('LOCAL_MIDDLEMAN_SERVER')) {
+			$post_args['sslverify'] = Manager::verifySSL();
+		}
+		$post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
+		$response = EED_PayPalOnboard::sendRequest($paypal_pm, $post_url, $post_args);
+		if (isset($response['error'])) {
+			return '';
+		}
+		// Check the data we received.
+		if (! EED_PayPalOnboard::partnerTokenResponseValid($response, $paypal_pm)) {
+			return '';
+		}
+		// If we are here all seems to be ok. Save the token and it's data.
+		$saved = PayPalExtraMetaManager::savePartnerAccessToken($paypal_pm, $response);
+		if (! $saved) {
+			return '';
+		}
+		return $response['access_token'];
+	}
+
+
+	/**
+	 * Request seller onboarding status from PayPal.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $merchant_id
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function trackSellerOnboarding(EE_Payment_Method $paypal_pm, string $merchant_id): array
+	{
+		$track_onboarding = EED_PayPalOnboard::getTrackOnboardingApi($paypal_pm, $merchant_id);
+		if (! $track_onboarding instanceof TrackSellerOnboarding) {
+			return [
+				'error'   => 'TRACK_ONBOARDING_FAILED',
+				'message' => esc_html__('Failed to track seller onboarding.', 'event_espresso')
+			];
+		}
+		return $track_onboarding->isValid();
+	}
+
+
+	/**
+	 * Returns the Track Seller Onboarding API.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $merchant_id
+	 * @return TrackSellerOnboarding|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getTrackOnboardingApi(
+		EE_Payment_Method $paypal_pm,
+		string $merchant_id
+	): ?TrackSellerOnboarding {
+		$partner_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_PARTNER_MERCHANT_ID);
+		$paypal_api = EED_PayPalCommerce::getPayPalApi($paypal_pm);
+		if (! $paypal_api instanceof PayPalApi || ! $partner_id) {
+			return null;
+		}
+		return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
+	}
+
+
+	/**
+	 * Check the onboard status and return the result.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getOnboardStatus(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			$err_msg = esc_html__('Could not specify the payment method.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, EED_Module::getRequest()->postParams(), $paypal_pm);
+			wp_send_json(['on_board' => false]);
+		}
+		try {
+			$seller_id = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_SELLER_MERCHANT_ID) ?? '--';
+		} catch (Exception $e) {
+			$seller_id = '--';
+			PayPalLogger::errorLog($e->getMessage(), ['trace' => $e->getTrace()]);
+		}
+		wp_send_json(
+			[
+				'on_board'  => EED_PayPalOnboard::isOnboard($paypal_pm),
+				'seller_id' => $seller_id,
+			]
+		);
+	}
+
+
+	/**
+	 * De-authorize the seller. Remove all API credentials.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function offboard(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		EED_PayPalOnboard::validatePmAjax($paypal_pm);
+		PayPalExtraMetaManager::deleteData($paypal_pm);
+		PayPalLogger::errorLog(
+			esc_html__('Offboarding. Removing metadata.', 'event_espresso'),
+			EED_Module::getRequest()->postParams(),
+			$paypal_pm
+		);
+		wp_send_json(['success' => true]);
+	}
+
+
+	/**
+	 * Clear all credentials metadata.
+	 * (AJAX)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function clearMetaData(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		EED_PayPalOnboard::validatePmAjax($paypal_pm);
+		PayPalExtraMetaManager::deleteAllData($paypal_pm);
+		PayPalLogger::errorLog(
+			esc_html__('Doing a Reset. Removing all PM settings metadata.', 'event_espresso'),
+			EED_Module::getRequest()->postParams(),
+			$paypal_pm
+		);
+		wp_send_json(['success' => true]);
+	}
+
+
+	/**
+	 * Validate the PM instance, returning an ajax response on invalid.
+	 *
+	 * @param $paypal_pm
+	 * @return void
+	 */
+	public static function validatePmAjax($paypal_pm): void
+	{
+		if (! $paypal_pm instanceof EE_Payment_Method) {
+			wp_send_json(
+				[
+					'error'   => 'INVALID_PM',
+					'message' => esc_html__(
+						'Invalid payment method. Please refresh the page and try again.',
+						'event_espresso'
+					),
+				]
+			);
+		}
+	}
+
+
+	/**
+	 * Checks if already onboard.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return boolean
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function isOnboard(EE_Payment_Method $payment_method): bool
+	{
+		$pp_meta_data = PayPalExtraMetaManager::getAllData($payment_method);
+		return
+			(
+				// onborded with a third party integration ?
+				! empty($pp_meta_data[ Domain::META_KEY_SELLER_MERCHANT_ID ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_ACCESS_TOKEN ])
+			) || (
+				// or with the first party integration ?
+				! empty($pp_meta_data[ Domain::META_KEY_CLIENT_ID ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_CLIENT_SECRET ])
+				&& ! empty($pp_meta_data[ Domain::META_KEY_PAYER_ID ])
+			);
+	}
+
+
+	/**
+	 * Send a request and return a decoded response body.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @param string            $request_url
+	 * @param array             $request_args
+	 * @return array
+	 */
+	public static function sendRequest(EE_Payment_Method $paypal_pm, string $request_url, array $request_args): array
+	{
+		$error_return = ['error' => true];
+		$response     = wp_remote_request($request_url, $request_args);
+		if (is_wp_error($response)) {
+			$message = $response->get_error_message();
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		$response_body = (isset($response['body']) && $response['body']) ? json_decode($response['body'], true) : [];
+		if (empty($response_body) || isset($response_body['error'])) {
+			$message = $response_body['error_description']
+				?? sprintf(
+					esc_html__('Unknown response received while sending a request to: %1$s', 'event_espresso'),
+					$request_url
+				);
+			PayPalLogger::errorLog($message, [$request_url, $request_args, $response], $paypal_pm);
+			$error_return['message'] = $message;
+			return $error_return;
+		}
+		return $response_body;
+	}
+
+
+	/**
+	 * Check the response for a partner token request.
+	 *
+	 * @param array             $response
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function partnerTokenResponseValid(array $response, EE_Payment_Method $paypal_pm): bool
+	{
+		// Check the data we received.
+		if (
+			empty($response['nonce'])
+			|| ! wp_verify_nonce($response['nonce'], 'eea_pp_commerce_get_access_token')
+			|| empty($response['access_token'])
+			|| empty($response['app_id'])
+			|| empty($response['expires_in'])
+			|| empty($response['partner_client_id'])
+			|| empty($response['partner_merchant_id'])
+		) {
+			// This is an error.
+			PayPalLogger::errorLog(
+				esc_html__('Incoming parameter validation failed.', 'event_espresso'),
+				$response,
+				$paypal_pm
+			);
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Returns the base URL to the middleman server.
+	 * If LOCAL_MIDDLEMAN_SERVER is defined, requests will be sent to connect.eventespresso.test
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getMiddlemanBaseUrl(EE_Payment_Method $payment_method): string
+	{
+		$target = defined('LOCAL_MIDDLEMAN_SERVER') ? 'test' : 'com';
+		// If this PM is used under different provider accounts, you might need an account indicator.
+		$account = defined('EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR') ? EE_PAYPAL_COMMERCE_ACCOUNT_INDICATOR : '';
+		$postfix = $payment_method->debug_mode() ? '_sandbox' : '';
+		return "https://connect.eventespresso.$target/paypal_commerce$account$postfix/";
+	}
+
+
+	/**
+	 * This Payment Method admin notices.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function adminNotice()
+	{
+		// Show the notice if PayPal Commerce PM is active but merchant is not onboard.
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
+		if (
+			$pp_commerce instanceof EE_Payment_Method
+			&& $pp_commerce->active()
+			&& ! EED_PayPalOnboard::isOnboard($pp_commerce)
+		) {
+			add_action('admin_notices', [EED_PayPalOnboard::class, 'notOnboardNotice']);
+		}
+	}
+
+
+	/**
+	 * Contents of the not onboard admin notice.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function notOnboardNotice()
+	{
+		$open_anchor = $close_anchor = '';
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
+		if ($pp_commerce instanceof EE_Payment_Method) {
+			$pm_page      = add_query_arg(
+				[
+					'page'           => 'espresso_payment_settings',
+					'webhook_action' => 'eepPpcMerchantOnboard',
+					'payment_method' => $pp_commerce->slug(),
+				],
+				admin_url('admin.php')
+			);
+			$open_anchor  = "<a href='$pm_page'>";
+			$close_anchor = "</a>";
+		}
+		$notice = sprintf(
+			esc_html__(
+				'%1$sPayPal Commerce%2$s payment method was activated but is not connected to PayPal. Please %3$sfinish setting up%4$s this payment method.',
+				'event_espresso'
+			),
+			'<strong>',
+			'</strong>',
+			$open_anchor,
+			$close_anchor
+		);
+		echo "
         <div class='error'>
             <p>$notice</p>
         </div>";
-    }
+	}
 }

PaymentMethods/PayPalCommerce/PayPalCheckout/EE_PMT_PayPalCheckout.pm.php

Indentation +129 added lines, -129 removed lines

@@ -16,144 +16,144 @@
  */
 class EE_PMT_PayPalCheckout extends EE_PMT_Base
 {
-    /**
-     * @param EE_Payment_Method|null $pm_instance
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function __construct($pm_instance = null)
-    {
-        $this->_template_path       = dirname(__FILE__) . DS . 'templates' . DS;
-        $this->_default_description = esc_html__('Please provide the following billing information.', 'event_espresso');
-        $this->_default_button_url  = $this->file_url() . 'lib/default-cc-logo.png';
-        $this->_pretty_name         = esc_html__('PayPal Commerce', 'event_espresso');
-        $this->_cache_billing_form  = true;
-        $this->_requires_https      = true;
+	/**
+	 * @param EE_Payment_Method|null $pm_instance
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function __construct($pm_instance = null)
+	{
+		$this->_template_path       = dirname(__FILE__) . DS . 'templates' . DS;
+		$this->_default_description = esc_html__('Please provide the following billing information.', 'event_espresso');
+		$this->_default_button_url  = $this->file_url() . 'lib/default-cc-logo.png';
+		$this->_pretty_name         = esc_html__('PayPal Commerce', 'event_espresso');
+		$this->_cache_billing_form  = true;
+		$this->_requires_https      = true;
 
-        // Load gateway.
-        require_once(
-            EEP_PAYPAL_COMMERCE_PATH . 'EEG_PayPalCheckout.gateway.php'
-        );
-        $this->_gateway = new EEG_PayPalCheckout();
+		// Load gateway.
+		require_once(
+			EEP_PAYPAL_COMMERCE_PATH . 'EEG_PayPalCheckout.gateway.php'
+		);
+		$this->_gateway = new EEG_PayPalCheckout();
 
-        // Display a refund message at transactions actions area.
-        add_action(
-            'AHEE__txn_admin_details_main_meta_box_txn_details__after_actions_buttons',
-            [__CLASS__, 'refundNotice']
-        );
+		// Display a refund message at transactions actions area.
+		add_action(
+			'AHEE__txn_admin_details_main_meta_box_txn_details__after_actions_buttons',
+			[__CLASS__, 'refundNotice']
+		);
 
-        parent::__construct($pm_instance);
-    }
+		parent::__construct($pm_instance);
+	}
 
 
-    /**
-     * Generate a new payment method settings form.
-     *
-     * @return EE_Payment_Method_Form
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_new_settings_form()
-    {
-        // Settings form.
-        $settings_form = new SettingsForm($this, $this->_pm_instance);
-        // Filter the form contents.
-        return apply_filters(
-            'FHEE__EE_PMT_PayPalCheckout__generate_new_settings_form__form_filtering',
-            $settings_form,
-            $this,
-            $this->_pm_instance
-        );
-    }
+	/**
+	 * Generate a new payment method settings form.
+	 *
+	 * @return EE_Payment_Method_Form
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_new_settings_form()
+	{
+		// Settings form.
+		$settings_form = new SettingsForm($this, $this->_pm_instance);
+		// Filter the form contents.
+		return apply_filters(
+			'FHEE__EE_PMT_PayPalCheckout__generate_new_settings_form__form_filtering',
+			$settings_form,
+			$this,
+			$this->_pm_instance
+		);
+	}
 
 
-    /**
-     * Creates a billing form for this payment method type.
-     *
-     * @param EE_Transaction|null $transaction
-     * @param array|null          $extra_args
-     * @return EE_Billing_Info_Form|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function generate_new_billing_form(EE_Transaction $transaction = null, ?array $extra_args = [])
-    {
-        $request        = LoaderFactory::getShared(Request::class);
-        $request_params = $request->requestParams();
-        // Return the default billing form for the postbox if this is a WP admin transaction info page.
-        if (! empty($request_params['page']) && $request_params['page'] === 'espresso_transactions') {
-            $default_form = new EE_Billing_Attendee_Info_Form($this->_pm_instance, $extra_args);
-            $default_form->add_subsections(['credit_card' => new EE_Credit_Card_Input()]);
-            return $default_form;
-        }
-        // Just in case this is used on other admin pages.
-        if (empty($transaction) && ! empty($request_params['TXN_ID'])) {
-            $txn_instance = EEM_Transaction::instance()->get_one_by_ID($request_params['TXN_ID']);
-            $transaction  = $txn_instance instanceof EE_Transaction ? $txn_instance : null;
-        }
-        $options = array_merge(
-            [
-                'transaction'   => $transaction,
-                'template_path' => $this->_template_path,
-            ],
-            $extra_args
-        );
-        return LoaderFactory::getNew(BillingForm::class, [$this->_pm_instance, $options]);
-    }
+	/**
+	 * Creates a billing form for this payment method type.
+	 *
+	 * @param EE_Transaction|null $transaction
+	 * @param array|null          $extra_args
+	 * @return EE_Billing_Info_Form|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function generate_new_billing_form(EE_Transaction $transaction = null, ?array $extra_args = [])
+	{
+		$request        = LoaderFactory::getShared(Request::class);
+		$request_params = $request->requestParams();
+		// Return the default billing form for the postbox if this is a WP admin transaction info page.
+		if (! empty($request_params['page']) && $request_params['page'] === 'espresso_transactions') {
+			$default_form = new EE_Billing_Attendee_Info_Form($this->_pm_instance, $extra_args);
+			$default_form->add_subsections(['credit_card' => new EE_Credit_Card_Input()]);
+			return $default_form;
+		}
+		// Just in case this is used on other admin pages.
+		if (empty($transaction) && ! empty($request_params['TXN_ID'])) {
+			$txn_instance = EEM_Transaction::instance()->get_one_by_ID($request_params['TXN_ID']);
+			$transaction  = $txn_instance instanceof EE_Transaction ? $txn_instance : null;
+		}
+		$options = array_merge(
+			[
+				'transaction'   => $transaction,
+				'template_path' => $this->_template_path,
+			],
+			$extra_args
+		);
+		return LoaderFactory::getNew(BillingForm::class, [$this->_pm_instance, $options]);
+	}
 
 
-    /**
-     * Adds PM info to the help tab.
-     *
-     * @return array
-     * @see EE_PMT_Base::help_tabs_config()
-     */
-    public function help_tabs_config(): array
-    {
-        return [
-            $this->get_help_tab_name() => [
-                'title'    => esc_html__('PayPal Commerce settings', 'event_espresso'),
-                'filename' => 'pp-commerce-overview',
-            ],
-        ];
-    }
+	/**
+	 * Adds PM info to the help tab.
+	 *
+	 * @return array
+	 * @see EE_PMT_Base::help_tabs_config()
+	 */
+	public function help_tabs_config(): array
+	{
+		return [
+			$this->get_help_tab_name() => [
+				'title'    => esc_html__('PayPal Commerce settings', 'event_espresso'),
+				'filename' => 'pp-commerce-overview',
+			],
+		];
+	}
 
 
-    /**
-     * Adds a refund related message section.
-     *
-     * @param bool $can_edit_payments Flag that tells if user can edit payments.
-     * @access public
-     * @return void
-     */
-    public static function refundNotice(bool $can_edit_payments)
-    {
-        if (! $can_edit_payments) {
-            return;
-        }
-        $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $txn_id  = $request->getRequestParam('TXN_ID', 0, DataType::INT);
-        try {
-            $transaction = EEM_Transaction::instance()->get_one_by_ID($txn_id);
-            if (! $transaction instanceof EE_Transaction) {
-                return;
-            }
-            // Was this transaction paid using PayPal ?
-            if (strpos((string) $transaction->payment_method(), 'PayPal Commerce') === false) {
-                return;
-            }
-            // Try loading the template.
-            EE_Registry::instance()->load_helper('Template');
-        } catch (EE_Error | ReflectionException $e) {
-            // Just return, adding nothing.
-            return;
-        }
-        $html = EEH_Template::locate_template(
-            apply_filters(
-                'FHEEA__EE_PMT_PayPalCheckout__refundNotice',
-                dirname(__FILE__) . DS . 'templates' . DS . 'apply-refund-notice.template.php'
-            )
-        );
-        echo $html;
-    }
+	/**
+	 * Adds a refund related message section.
+	 *
+	 * @param bool $can_edit_payments Flag that tells if user can edit payments.
+	 * @access public
+	 * @return void
+	 */
+	public static function refundNotice(bool $can_edit_payments)
+	{
+		if (! $can_edit_payments) {
+			return;
+		}
+		$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$txn_id  = $request->getRequestParam('TXN_ID', 0, DataType::INT);
+		try {
+			$transaction = EEM_Transaction::instance()->get_one_by_ID($txn_id);
+			if (! $transaction instanceof EE_Transaction) {
+				return;
+			}
+			// Was this transaction paid using PayPal ?
+			if (strpos((string) $transaction->payment_method(), 'PayPal Commerce') === false) {
+				return;
+			}
+			// Try loading the template.
+			EE_Registry::instance()->load_helper('Template');
+		} catch (EE_Error | ReflectionException $e) {
+			// Just return, adding nothing.
+			return;
+		}
+		$html = EEH_Template::locate_template(
+			apply_filters(
+				'FHEEA__EE_PMT_PayPalCheckout__refundNotice',
+				dirname(__FILE__) . DS . 'templates' . DS . 'apply-refund-notice.template.php'
+			)
+		);
+		echo $html;
+	}
 }