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.17.rc.000');
-        }
+		/**
+		 * espresso_version
+		 * Returns the plugin version
+		 *
+		 * @return string
+		 */
+		function espresso_version(): string
+		{
+			return apply_filters('FHEE__espresso__espresso_version', '5.0.17.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/PayPalCommerce/domain/Domain.php

Indentation +165 added lines, -165 removed lines

@@ -15,169 +15,169 @@
  */
 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 PayPal Access Token that is used get onboarding URL.
-     */
-    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 client ID.
-     */
-    public const META_KEY_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 onboarding URL.
-     */
-    public const META_KEY_ONBOARDING_URL = 'onboarding_url';
-
-    /**
-     * 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 holds the last order details.
-     */
-    public const META_KEY_LAST_ORDER = 'last_order_details';
-
-    /**
-     * 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 PP checkout type selected by merchant after onboarding.
-     */
-    public const META_KEY_CHECKOUT_TYPE = 'checkout_type';
-
-    /**
-     * 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
-     */
-    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 PayPal Access Token that is used get onboarding URL.
+	 */
+	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 client ID.
+	 */
+	public const META_KEY_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 onboarding URL.
+	 */
+	public const META_KEY_ONBOARDING_URL = 'onboarding_url';
+
+	/**
+	 * 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 holds the last order details.
+	 */
+	public const META_KEY_LAST_ORDER = 'last_order_details';
+
+	/**
+	 * 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 PP checkout type selected by merchant after onboarding.
+	 */
+	public const META_KEY_CHECKOUT_TYPE = 'checkout_type';
+
+	/**
+	 * 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
+	 */
+	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/api/partners/TrackSellerOnboarding.php

Indentation +104 added lines, -104 removed lines

@@ -17,115 +17,115 @@
  */
 class TrackSellerOnboarding extends PartnersApi
 {
-    /**
-     * Partner ID.
-     *
-     * @var string
-     */
-    protected string $partner_id;
+	/**
+	 * Partner ID.
+	 *
+	 * @var string
+	 */
+	protected string $partner_id;
 
-    /**
-     * Seller ID.
-     *
-     * @var string
-     */
-    protected string $seller_id;
+	/**
+	 * Seller ID.
+	 *
+	 * @var string
+	 */
+	protected string $seller_id;
 
 
-    /**
-     * TrackSellerOnboarding constructor.
-     *
-     * @param PayPalApi $api
-     * @param string    $partner_id
-     * @param string    $seller_id
-     * @param bool      $sandbox_mode
-     */
-    public function __construct(
-        PayPalApi $api,
-        string $partner_id,
-        string $seller_id,
-        bool $sandbox_mode
-    ) {
-        parent::__construct($api, $sandbox_mode);
-        $this->partner_id  = $partner_id;
-        $this->seller_id   = $seller_id;
-        $this->request_url = $this->request_url . "/{$partner_id}/merchant-integrations/{$seller_id}";
-    }
+	/**
+	 * TrackSellerOnboarding constructor.
+	 *
+	 * @param PayPalApi $api
+	 * @param string    $partner_id
+	 * @param string    $seller_id
+	 * @param bool      $sandbox_mode
+	 */
+	public function __construct(
+		PayPalApi $api,
+		string $partner_id,
+		string $seller_id,
+		bool $sandbox_mode
+	) {
+		parent::__construct($api, $sandbox_mode);
+		$this->partner_id  = $partner_id;
+		$this->seller_id   = $seller_id;
+		$this->request_url = $this->request_url . "/{$partner_id}/merchant-integrations/{$seller_id}";
+	}
 
 
-    /**
-     * Get the onboarding status and validate it.
-     *
-     * @return array
-     */
-    public function isValid(): array
-    {
-        // Send GET request.
-        $response = $this->api->sendRequest([], $this->request_url, 'GET');
-        return $this->validateStatus($response);
-    }
+	/**
+	 * Get the onboarding status and validate it.
+	 *
+	 * @return array
+	 */
+	public function isValid(): array
+	{
+		// Send GET request.
+		$response = $this->api->sendRequest([], $this->request_url, 'GET');
+		return $this->validateStatus($response);
+	}
 
 
-    /**
-     * Makes sure that we have received proper parameters and the status is valid.
-     *
-     * @param array $response
-     * @return array
-     */
-    public function validateStatus(array $response): array
-    {
-        if (! empty($response['error'])) {
-            return $response;
-        }
-        if (! empty($response['name']) && ! empty($response['message'])) {
-            return ['error' => $response['name'], 'message' => $response['message']];
-        }
-        // Check the data we received.
-        if (
-            empty($response[ Domain::API_PARAM_TRACK_MERCHANT_ID ])
-            || ! isset($response[ Domain::API_PARAM_PAYMENTS_RECEIVABLE ])
-            || ! isset($response[ Domain::API_PARAM_PRIM_EMAIL_CONFIRMED ])
-            || ! isset($response[ Domain::API_PARAM_OAUTH_INTEGRATIONS ])
-        ) {
-            $err_msg = esc_html__('Missing required data for validating the onboarding status.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, $response);
-            return ['error' => 'ONBOARDING_MISSING_REQUIRED_DATA', 'message' => $err_msg];
-        }
-        // Now validate the onboarding status.
-        if (! $response[ Domain::API_PARAM_PAYMENTS_RECEIVABLE ]) {
-            $err_msg = esc_html__(
-                'Your Account has been limited by PayPal. Please check your PayPal account inbox for an email from PayPal to determine the next steps for this.',
-                'event_espresso'
-            );
-            PayPalLogger::errorLog($err_msg, $response);
-            return ['error' => 'ONBOARDING_LIMITED_BY_PAYPAL', 'message' => $err_msg];
-        }
-        if (! $response[ Domain::API_PARAM_PRIM_EMAIL_CONFIRMED ]) {
-            $err_msg = esc_html__('Email address not confirmed. Please confirm your email address.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, $response);
-            return ['error' => 'ONBOARDING_CONFIRM_EMAIL', 'message' => $err_msg];
-        }
-        if (empty($response[ Domain::API_PARAM_OAUTH_INTEGRATIONS ])) {
-            $permissions_valid = false;
-            // Look for the granted permissions.
-            foreach ($response[ Domain::API_PARAM_OAUTH_INTEGRATIONS ] as $integration_type) {
-                if (! empty($integration_type[ Domain::API_PARAM_PERMISSIONS_GRANTED ])) {
-                    $permissions_valid = true;
-                }
-            }
-            // Did we find any ? If no - oauth not valid.
-            if (! $permissions_valid) {
-                $err_msg = esc_html__(
-                    'Not all required permissions were granted. Please allow all permissions while onboarding.',
-                    'event_espresso'
-                );
-                PayPalLogger::errorLog($err_msg, $response);
-                return ['error' => 'ONBOARDING_PERMISSIONS_NOT_GRANTED', 'message' => $err_msg];
-            }
-        }
-        return [
-            'valid'    => true,
-            'response' => $response,
-        ];
-    }
+	/**
+	 * Makes sure that we have received proper parameters and the status is valid.
+	 *
+	 * @param array $response
+	 * @return array
+	 */
+	public function validateStatus(array $response): array
+	{
+		if (! empty($response['error'])) {
+			return $response;
+		}
+		if (! empty($response['name']) && ! empty($response['message'])) {
+			return ['error' => $response['name'], 'message' => $response['message']];
+		}
+		// Check the data we received.
+		if (
+			empty($response[ Domain::API_PARAM_TRACK_MERCHANT_ID ])
+			|| ! isset($response[ Domain::API_PARAM_PAYMENTS_RECEIVABLE ])
+			|| ! isset($response[ Domain::API_PARAM_PRIM_EMAIL_CONFIRMED ])
+			|| ! isset($response[ Domain::API_PARAM_OAUTH_INTEGRATIONS ])
+		) {
+			$err_msg = esc_html__('Missing required data for validating the onboarding status.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, $response);
+			return ['error' => 'ONBOARDING_MISSING_REQUIRED_DATA', 'message' => $err_msg];
+		}
+		// Now validate the onboarding status.
+		if (! $response[ Domain::API_PARAM_PAYMENTS_RECEIVABLE ]) {
+			$err_msg = esc_html__(
+				'Your Account has been limited by PayPal. Please check your PayPal account inbox for an email from PayPal to determine the next steps for this.',
+				'event_espresso'
+			);
+			PayPalLogger::errorLog($err_msg, $response);
+			return ['error' => 'ONBOARDING_LIMITED_BY_PAYPAL', 'message' => $err_msg];
+		}
+		if (! $response[ Domain::API_PARAM_PRIM_EMAIL_CONFIRMED ]) {
+			$err_msg = esc_html__('Email address not confirmed. Please confirm your email address.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, $response);
+			return ['error' => 'ONBOARDING_CONFIRM_EMAIL', 'message' => $err_msg];
+		}
+		if (empty($response[ Domain::API_PARAM_OAUTH_INTEGRATIONS ])) {
+			$permissions_valid = false;
+			// Look for the granted permissions.
+			foreach ($response[ Domain::API_PARAM_OAUTH_INTEGRATIONS ] as $integration_type) {
+				if (! empty($integration_type[ Domain::API_PARAM_PERMISSIONS_GRANTED ])) {
+					$permissions_valid = true;
+				}
+			}
+			// Did we find any ? If no - oauth not valid.
+			if (! $permissions_valid) {
+				$err_msg = esc_html__(
+					'Not all required permissions were granted. Please allow all permissions while onboarding.',
+					'event_espresso'
+				);
+				PayPalLogger::errorLog($err_msg, $response);
+				return ['error' => 'ONBOARDING_PERMISSIONS_NOT_GRANTED', 'message' => $err_msg];
+			}
+		}
+		return [
+			'valid'    => true,
+			'response' => $response,
+		];
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -49,7 +49,7 @@ 
         parent::__construct($api, $sandbox_mode);
         $this->partner_id  = $partner_id;
         $this->seller_id   = $seller_id;
-        $this->request_url = $this->request_url . "/{$partner_id}/merchant-integrations/{$seller_id}";
+        $this->request_url = $this->request_url."/{$partner_id}/merchant-integrations/{$seller_id}";
     }
 
 
@@ -74,25 +74,25 @@ 
      */
     public function validateStatus(array $response): array
     {
-        if (! empty($response['error'])) {
+        if ( ! empty($response['error'])) {
             return $response;
         }
-        if (! empty($response['name']) && ! empty($response['message'])) {
+        if ( ! empty($response['name']) && ! empty($response['message'])) {
             return ['error' => $response['name'], 'message' => $response['message']];
         }
         // Check the data we received.
         if (
-            empty($response[ Domain::API_PARAM_TRACK_MERCHANT_ID ])
-            || ! isset($response[ Domain::API_PARAM_PAYMENTS_RECEIVABLE ])
-            || ! isset($response[ Domain::API_PARAM_PRIM_EMAIL_CONFIRMED ])
-            || ! isset($response[ Domain::API_PARAM_OAUTH_INTEGRATIONS ])
+            empty($response[Domain::API_PARAM_TRACK_MERCHANT_ID])
+            || ! isset($response[Domain::API_PARAM_PAYMENTS_RECEIVABLE])
+            || ! isset($response[Domain::API_PARAM_PRIM_EMAIL_CONFIRMED])
+            || ! isset($response[Domain::API_PARAM_OAUTH_INTEGRATIONS])
         ) {
             $err_msg = esc_html__('Missing required data for validating the onboarding status.', 'event_espresso');
             PayPalLogger::errorLog($err_msg, $response);
             return ['error' => 'ONBOARDING_MISSING_REQUIRED_DATA', 'message' => $err_msg];
         }
         // Now validate the onboarding status.
-        if (! $response[ Domain::API_PARAM_PAYMENTS_RECEIVABLE ]) {
+        if ( ! $response[Domain::API_PARAM_PAYMENTS_RECEIVABLE]) {
             $err_msg = esc_html__(
                 'Your Account has been limited by PayPal. Please check your PayPal account inbox for an email from PayPal to determine the next steps for this.',
                 'event_espresso'
@@ -100,21 +100,21 @@ 
             PayPalLogger::errorLog($err_msg, $response);
             return ['error' => 'ONBOARDING_LIMITED_BY_PAYPAL', 'message' => $err_msg];
         }
-        if (! $response[ Domain::API_PARAM_PRIM_EMAIL_CONFIRMED ]) {
+        if ( ! $response[Domain::API_PARAM_PRIM_EMAIL_CONFIRMED]) {
             $err_msg = esc_html__('Email address not confirmed. Please confirm your email address.', 'event_espresso');
             PayPalLogger::errorLog($err_msg, $response);
             return ['error' => 'ONBOARDING_CONFIRM_EMAIL', 'message' => $err_msg];
         }
-        if (empty($response[ Domain::API_PARAM_OAUTH_INTEGRATIONS ])) {
+        if (empty($response[Domain::API_PARAM_OAUTH_INTEGRATIONS])) {
             $permissions_valid = false;
             // Look for the granted permissions.
-            foreach ($response[ Domain::API_PARAM_OAUTH_INTEGRATIONS ] as $integration_type) {
-                if (! empty($integration_type[ Domain::API_PARAM_PERMISSIONS_GRANTED ])) {
+            foreach ($response[Domain::API_PARAM_OAUTH_INTEGRATIONS] as $integration_type) {
+                if ( ! empty($integration_type[Domain::API_PARAM_PERMISSIONS_GRANTED])) {
                     $permissions_valid = true;
                 }
             }
             // Did we find any ? If no - oauth not valid.
-            if (! $permissions_valid) {
+            if ( ! $permissions_valid) {
                 $err_msg = esc_html__(
                     'Not all required permissions were granted. Please allow all permissions while onboarding.',
                     'event_espresso'

PaymentMethods/PayPalCommerce/modules/EED_PayPalOnboard.module.php

Indentation +658 added lines, -658 removed lines

@@ -20,662 +20,662 @@
  */
 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
-    {
-        if (DbStatus::isOnline()) {
-            // Get onboarding URL.
-            add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
-            // Catch the return/redirect from PayPal onboarding page.
-            add_action('init', [__CLASS__, 'updateOnboardingStatus'], 10);
-            // Return the connection/onboard status.
-            add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
-            // Revoke access.
-            add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
-            // 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());
-            // $signup_link   = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
-            // $token_expired = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
-            // if (! $signup_link || $token_expired) {
-            $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);
-            }
-            PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL, $signup_link);
-        } catch (Exception $exception) {
-            PayPalLogger::errorLogAndExit($exception->getMessage());
-        }
-        // 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::deleteAllData($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);
-        $checkout_type     = $request->getRequestParam('checkout_type', 'EXPRESS_CHECKOUT', DataType::STRING);
-        // 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);
-        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'],
-                            ],
-                        ],
-                    ],
-                ],
-            ],
-            'products'                => [$checkout_type],
-            '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
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function getReturnUrl(EE_Payment_Method $paypal_pm): 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,
-                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);
-        // Save the credentials.
-        PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
-        // If onboarded successfully, remove the onboarding URL.
-        PayPalExtraMetaManager::deletePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
-        // 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);
-        $expired      = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
-        // If we don't have it, request/update it.
-        if (! $access_token || $expired) {
-            return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
-        }
-        // Access token is saved as encrypted, so return decrypted.
-        return $access_token;
-    }
-
-
-    /**
-     * Get partner access token.
-     *
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
-    {
-        $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_EXPIRES_IN);
-        if (! $expires_at) {
-            return true;
-        }
-        // Validate the token expiration date.
-        $now          = time();
-        $minutes_left = round(($expires_at - $now) / 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'] = false;
-        }
-        $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
-     */
-    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) {
-            $err_msg = esc_html__('Failed to track seller onboarding.', 'event_espresso');
-            return ['error' => 'TRACK_ONBOARDING_FAILED', 'message' => $err_msg];
-        }
-        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
-     */
-    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 = '--';
-        }
-        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
-     */
-    public static function offboard(): void
-    {
-        $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        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'
-                ),
-            ]);
-        }
-        PayPalExtraMetaManager::deleteAllData($paypal_pm);
-        wp_send_json(['success' => true]);
-    }
-
-
-    /**
-     * Checks if already onboard.
-     *
-     * @param EE_Payment_Method $payment_method
-     * @return boolean
-     */
-    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                   $response
-     * @param EE_Payment_Method $paypal_pm
-     * @return bool
-     */
-    public static function partnerTokenResponseValid($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.
-            $err_msg = esc_html__('Incoming parameter validation failed.', 'event_espresso');
-            PayPalLogger::errorLog($err_msg, (array) $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' : '';
-        $path    = 'paypal_commerce' . $account . $postfix;
-        return 'https://connect.eventespresso.' . $target . '/' . $path . '/';
-    }
-
-
-    /**
-     * This Payment Method admin notices.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function adminNotice()
-    {
-        // A notice to re-connect if still connected through the first party integration.
-        $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
-        // Show the notice only if PayPal Commerce is active.
-        if (! $pp_commerce instanceof EE_Payment_Method
-            || ! EED_PayPalOnboard::isOnboard($pp_commerce)
-            || EED_PayPalCommerce::isThirdParty($pp_commerce)
-        ) {
-            return;
-        }
-        add_action('admin_notices', [__CLASS__, 'reConnectNotice']);
-    }
-
-
-    /**
-     * Re-connect notice contents.
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reConnectNotice()
-    {
-        $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>";
-        }
-        echo '<div class="error"><p>'
-        . sprintf(
-            esc_html__(
-                '%1$sPayPal Commerce%2$s has updated the API integration type to allow more flexibility with payments. Please disconnect and re-Connect on the %3$sPayment Methods admin%4$s page to update the credentials and allow advanced payment type options.',
-                'event_espresso'
-            ),
-            '<strong>',
-            '</strong>',
-            $open_anchor,
-            $close_anchor
-         )
-         . '</p></div>';
-    }
+	/**
+	 * @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
+	{
+		if (DbStatus::isOnline()) {
+			// Get onboarding URL.
+			add_action('wp_ajax_eeaPpGetOnboardingUrl', [__CLASS__, 'getOnboardingUrl']);
+			// Catch the return/redirect from PayPal onboarding page.
+			add_action('init', [__CLASS__, 'updateOnboardingStatus'], 10);
+			// Return the connection/onboard status.
+			add_action('wp_ajax_eeaPpGetOnboardStatus', [__CLASS__, 'getOnboardStatus']);
+			// Revoke access.
+			add_action('wp_ajax_eeaPpOffboard', [__CLASS__, 'offboard']);
+			// 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());
+			// $signup_link   = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
+			// $token_expired = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
+			// if (! $signup_link || $token_expired) {
+			$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);
+			}
+			PayPalExtraMetaManager::savePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL, $signup_link);
+		} catch (Exception $exception) {
+			PayPalLogger::errorLogAndExit($exception->getMessage());
+		}
+		// 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::deleteAllData($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);
+		$checkout_type     = $request->getRequestParam('checkout_type', 'EXPRESS_CHECKOUT', DataType::STRING);
+		// 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);
+		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'],
+							],
+						],
+					],
+				],
+			],
+			'products'                => [$checkout_type],
+			'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
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function getReturnUrl(EE_Payment_Method $paypal_pm): 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,
+				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);
+		// Save the credentials.
+		PayPalExtraMetaManager::saveSellerApiCredentials($paypal_pm, $get_params);
+		// If onboarded successfully, remove the onboarding URL.
+		PayPalExtraMetaManager::deletePmOption($paypal_pm, Domain::META_KEY_ONBOARDING_URL);
+		// 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);
+		$expired      = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
+		// If we don't have it, request/update it.
+		if (! $access_token || $expired) {
+			return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
+		}
+		// Access token is saved as encrypted, so return decrypted.
+		return $access_token;
+	}
+
+
+	/**
+	 * Get partner access token.
+	 *
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
+	{
+		$expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_EXPIRES_IN);
+		if (! $expires_at) {
+			return true;
+		}
+		// Validate the token expiration date.
+		$now          = time();
+		$minutes_left = round(($expires_at - $now) / 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'] = false;
+		}
+		$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
+	 */
+	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) {
+			$err_msg = esc_html__('Failed to track seller onboarding.', 'event_espresso');
+			return ['error' => 'TRACK_ONBOARDING_FAILED', 'message' => $err_msg];
+		}
+		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
+	 */
+	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 = '--';
+		}
+		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
+	 */
+	public static function offboard(): void
+	{
+		$paypal_pm = EED_PayPalCommerce::getPaymentMethod();
+		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'
+				),
+			]);
+		}
+		PayPalExtraMetaManager::deleteAllData($paypal_pm);
+		wp_send_json(['success' => true]);
+	}
+
+
+	/**
+	 * Checks if already onboard.
+	 *
+	 * @param EE_Payment_Method $payment_method
+	 * @return boolean
+	 */
+	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                   $response
+	 * @param EE_Payment_Method $paypal_pm
+	 * @return bool
+	 */
+	public static function partnerTokenResponseValid($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.
+			$err_msg = esc_html__('Incoming parameter validation failed.', 'event_espresso');
+			PayPalLogger::errorLog($err_msg, (array) $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' : '';
+		$path    = 'paypal_commerce' . $account . $postfix;
+		return 'https://connect.eventespresso.' . $target . '/' . $path . '/';
+	}
+
+
+	/**
+	 * This Payment Method admin notices.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function adminNotice()
+	{
+		// A notice to re-connect if still connected through the first party integration.
+		$pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
+		// Show the notice only if PayPal Commerce is active.
+		if (! $pp_commerce instanceof EE_Payment_Method
+			|| ! EED_PayPalOnboard::isOnboard($pp_commerce)
+			|| EED_PayPalCommerce::isThirdParty($pp_commerce)
+		) {
+			return;
+		}
+		add_action('admin_notices', [__CLASS__, 'reConnectNotice']);
+	}
+
+
+	/**
+	 * Re-connect notice contents.
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reConnectNotice()
+	{
+		$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>";
+		}
+		echo '<div class="error"><p>'
+		. sprintf(
+			esc_html__(
+				'%1$sPayPal Commerce%2$s has updated the API integration type to allow more flexibility with payments. Please disconnect and re-Connect on the %3$sPayment Methods admin%4$s page to update the credentials and allow advanced payment type options.',
+				'event_espresso'
+			),
+			'<strong>',
+			'</strong>',
+			$open_anchor,
+			$close_anchor
+		 )
+		 . '</p></div>';
+	}
 }

Spacing +33 added lines, -33 removed lines

@@ -75,7 +75,7 @@ 
         $signup_link = '';
         try {
             $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-            if (! $paypal_pm instanceof EE_Payment_Method) {
+            if ( ! $paypal_pm instanceof EE_Payment_Method) {
                 PayPalLogger::errorLogAndExit(
                     esc_html__('No payment method.', 'event_espresso'),
                     EED_Module::getRequest()->postParams(),
@@ -88,7 +88,7 @@ 
             // if (! $signup_link || $token_expired) {
             $signup_link = EED_PayPalOnboard::requestOnboardingUrl($paypal_pm);
             // }
-            if (! $signup_link) {
+            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);
             }
@@ -97,7 +97,7 @@ 
             PayPalLogger::errorLogAndExit($exception->getMessage());
         }
         // Is it empty (can happen if we didn't get the URL through the API).
-        $signup_link = $signup_link ? $signup_link . '?&displayMode=minibrowser' : '#';
+        $signup_link = $signup_link ? $signup_link.'?&displayMode=minibrowser' : '#';
         wp_send_json(
             [
                 'signup_link' => $signup_link,
@@ -120,7 +120,7 @@ 
         $signup_link = '';
         // Get the access token.
         $access_token = EED_PayPalOnboard::getPartnerAccessToken($paypal_pm);
-        if (! $access_token) {
+        if ( ! $access_token) {
             $err_msg = esc_html__('Error! No access token.', 'event_espresso');
             PayPalLogger::errorLog($err_msg, ['access_token' => $access_token], $paypal_pm);
             return '';
@@ -133,17 +133,17 @@ 
             'headers' => [
                 'User-Agent'                    => sanitize_text_field($_SERVER['HTTP_USER_AGENT']),
                 'Content-Type'                  => 'application/json',
-                'Authorization'                 => 'Bearer ' . $access_token,
+                'Authorization'                 => 'Bearer '.$access_token,
                 'PayPal-Partner-Attribution-Id' => $bn_code,
             ],
             'body'    => $body_params,
         ];
-        $request_url = Domain::getPayPalApiUrl($paypal_pm) . '/v2/customer/partner-referrals';
+        $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
+            if ( ! $one_time_request
                 && ! empty($response['message'])
                 && $response['message'] === 'Access Token not found in cache'
             ) {
@@ -255,7 +255,7 @@ 
             'payment_method' => $get_params['payment_method'],
         ];
         if (isset($get_params['sandbox_mode'])) {
-            $args_to_add[ Domain::META_KEY_SANDBOX_MODE ] = $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);
@@ -274,16 +274,16 @@ 
     public static function updateOnboardingStatus(): void
     {
         // Check if this is the webhook from PayPal.
-        if (! isset($_GET['webhook_action'], $_GET['nonce'])
+        if ( ! isset($_GET['webhook_action'], $_GET['nonce'])
             || $_GET['webhook_action'] !== 'eepPpcMerchantOnboard'
         ) {
-            return;  // Ignore.
+            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)) {
+        if ( ! EED_PayPalOnboard::onboardingStatusResponseValid($get_params, $paypal_pm)) {
             // Missing parameters. Can't proceed.
             PayPalLogger::errorLog(
                 esc_html__('Missing required onboarding parameters.', 'event_espresso'),
@@ -296,9 +296,9 @@ 
         // Check on the onboarding status (recommended by PP).
         $onboarding_status = EED_PayPalOnboard::trackSellerOnboarding(
             $paypal_pm,
-            $get_params[ Domain::META_KEY_SELLER_MERCHANT_ID ]
+            $get_params[Domain::META_KEY_SELLER_MERCHANT_ID]
         );
-        if (! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
+        if ( ! isset($onboarding_status['valid']) || ! $onboarding_status['valid']) {
             PayPalLogger::errorLog(
                 $onboarding_status['message'],
                 array_merge($get_params, $onboarding_status),
@@ -330,9 +330,9 @@ 
         // 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 ])
+            && ! empty($data[Domain::API_PARAM_PARTNER_ID])
+            && ! empty($data[Domain::META_KEY_SELLER_MERCHANT_ID])
+            && isset($data[Domain::API_PARAM_EMAIL_CONFIRMED])
         ) {
             return true;
         }
@@ -354,7 +354,7 @@ 
         $access_token = PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_ACCESS_TOKEN);
         $expired      = EED_PayPalOnboard::partnerAccessTokenExpired($paypal_pm);
         // If we don't have it, request/update it.
-        if (! $access_token || $expired) {
+        if ( ! $access_token || $expired) {
             return EED_PayPalOnboard::requestPartnerAccessToken($paypal_pm);
         }
         // Access token is saved as encrypted, so return decrypted.
@@ -371,7 +371,7 @@ 
     public static function partnerAccessTokenExpired(EE_Payment_Method $paypal_pm): bool
     {
         $expires_at = (int) PayPalExtraMetaManager::getPmOption($paypal_pm, Domain::META_KEY_EXPIRES_IN);
-        if (! $expires_at) {
+        if ( ! $expires_at) {
             return true;
         }
         // Validate the token expiration date.
@@ -408,18 +408,18 @@ 
         if (defined('LOCAL_MIDDLEMAN_SERVER')) {
             $post_args['sslverify'] = false;
         }
-        $post_url = EED_PayPalOnboard::getMiddlemanBaseUrl($paypal_pm) . 'get_token';
+        $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)) {
+        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) {
+        if ( ! $saved) {
             return '';
         }
         return $response['access_token'];
@@ -436,7 +436,7 @@ 
     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) {
+        if ( ! $track_onboarding instanceof TrackSellerOnboarding) {
             $err_msg = esc_html__('Failed to track seller onboarding.', 'event_espresso');
             return ['error' => 'TRACK_ONBOARDING_FAILED', 'message' => $err_msg];
         }
@@ -459,7 +459,7 @@ 
     ): ?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) {
+        if ( ! $paypal_api instanceof PayPalApi || ! $partner_id) {
             return null;
         }
         return new TrackSellerOnboarding($paypal_api, $partner_id, $merchant_id, $paypal_pm->debug_mode());
@@ -475,7 +475,7 @@ 
     public static function getOnboardStatus(): void
     {
         $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        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]);
@@ -503,7 +503,7 @@ 
     public static function offboard(): void
     {
         $paypal_pm = EED_PayPalCommerce::getPaymentMethod();
-        if (! $paypal_pm instanceof EE_Payment_Method) {
+        if ( ! $paypal_pm instanceof EE_Payment_Method) {
             wp_send_json([
                 'error'   => 'INVALID_PM',
                 'message' => esc_html__(
@@ -528,13 +528,13 @@ 
         $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 ])
+            ( ! 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 ])
+            || ( ! 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])
             );
     }
 
@@ -615,8 +615,8 @@ 
         // 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' : '';
-        $path    = 'paypal_commerce' . $account . $postfix;
-        return 'https://connect.eventespresso.' . $target . '/' . $path . '/';
+        $path    = 'paypal_commerce'.$account.$postfix;
+        return 'https://connect.eventespresso.'.$target.'/'.$path.'/';
     }
 
 
@@ -632,7 +632,7 @@ 
         // A notice to re-connect if still connected through the first party integration.
         $pp_commerce = EEM_Payment_Method::instance()->get_one_by_slug('paypalcheckout');
         // Show the notice only if PayPal Commerce is active.
-        if (! $pp_commerce instanceof EE_Payment_Method
+        if ( ! $pp_commerce instanceof EE_Payment_Method
             || ! EED_PayPalOnboard::isOnboard($pp_commerce)
             || EED_PayPalCommerce::isThirdParty($pp_commerce)
         ) {