Merge pull request #1433 from woocommerce/fix/PCP-159_currency_unsupported_notice

Add notice when shop currency is unsupported

modules/ppcp-wc-gateway/services.php

@@ -57,6 +57,7 @@ use WooCommerce\PayPalCommerce\WcGateway\Helper\SettingsStatus;
 use WooCommerce\PayPalCommerce\WcGateway\Notice\AuthorizeOrderActionNotice;
 use WooCommerce\PayPalCommerce\WcGateway\Notice\ConnectAdminNotice;
 use WooCommerce\PayPalCommerce\WcGateway\Notice\GatewayWithoutPayPalAdminNotice;
+use WooCommerce\PayPalCommerce\WcGateway\Notice\UnsupportedCurrencyAdminNotice;
 use WooCommerce\PayPalCommerce\WcGateway\Processor\AuthorizedPaymentsProcessor;
 use WooCommerce\PayPalCommerce\WcGateway\Processor\OrderProcessor;
 use WooCommerce\PayPalCommerce\WcGateway\Processor\RefundProcessor;
@@ -208,6 +209,12 @@ return array(
 		$settings = $container->get( 'wcgateway.settings' );
 		return new ConnectAdminNotice( $state, $settings );
 	},
+	'wcgateway.notice.currency-unsupported'                => static function ( ContainerInterface $container ): UnsupportedCurrencyAdminNotice {
+		$state = $container->get( 'onboarding.state' );
+		$shop_currency = $container->get( 'api.shop.currency' );
+		$supported_currencies = $container->get( 'api.supported-currencies' );
+		return new UnsupportedCurrencyAdminNotice( $state, $shop_currency, $supported_currencies );
+	},
 	'wcgateway.notice.dcc-without-paypal'                  => static function ( ContainerInterface $container ): GatewayWithoutPayPalAdminNotice {
 		return new GatewayWithoutPayPalAdminNotice(
 			CreditCardGateway::ID,

modules/ppcp-wc-gateway/src/Notice/UnsupportedCurrencyAdminNotice.php

@@ -0,0 +1,97 @@
+<?php
+/**
+ * Registers the admin message about unsupported currency set in WC shop settings.
+ *
+ * @package WooCommerce\PayPalCommerce\WcGateway\Notice
+ */
+
+declare(strict_types=1);
+
+namespace WooCommerce\PayPalCommerce\WcGateway\Notice;
+
+use WooCommerce\PayPalCommerce\AdminNotices\Entity\Message;
+use WooCommerce\PayPalCommerce\Onboarding\State;
+use WooCommerce\PayPalCommerce\WcGateway\Settings\Settings;
+use WooCommerce\PayPalCommerce\Vendor\Psr\Container\ContainerInterface;
+
+/**
+ * Class UnsupportedCurrencyAdminNotice
+ */
+class UnsupportedCurrencyAdminNotice {
+
+	/**
+	 * The state.
+	 *
+	 * @var State
+	 */
+	private $state;
+
+	/**
+	 * The supported currencies.
+	 *
+	 * @var array
+	 */
+	private $supported_currencies;
+
+	/**
+	 * The shop currency.
+	 *
+	 * @var string
+	 */
+	private $shop_currency;
+
+	/**
+	 * UnsupportedCurrencyAdminNotice constructor.
+	 *
+	 * @param State  $state The state.
+	 * @param string $shop_currency The shop currency.
+	 * @param array  $supported_currencies The supported currencies.
+	 */
+	public function __construct( State $state, string $shop_currency, array $supported_currencies ) {
+		$this->state                = $state;
+		$this->shop_currency        = $shop_currency;
+		$this->supported_currencies = $supported_currencies;
+	}
+
+	/**
+	 * Returns the message.
+	 *
+	 * @return Message|null
+	 */
+	public function unsupported_currency_message() {
+		if ( ! $this->should_display() ) {
+			return null;
+		}
+
+		$message = sprintf(
+			/* translators: %1$s the shop currency, 2$s the gateway name. */
+			__(
+				'Attention: Your current WooCommerce store currency (%1$s) is not supported by PayPal. Please update your store currency to one that is supported by PayPal to ensure smooth transactions. Visit the <a href="%2$s">PayPal currency support page</a> for more information on supported currencies.',
+				'woocommerce-paypal-payments'
+			),
+			$this->shop_currency,
+			'https://developer.paypal.com/api/rest/reference/currency-codes/'
+		);
+		return new Message( $message, 'warning' );
+	}
+
+	/**
+	 * Whether the message should display.
+	 *
+	 * @return bool
+	 */
+	protected function should_display(): bool {
+		return $this->state->current_state() === State::STATE_ONBOARDED && ! $this->currency_supported();
+	}
+
+	/**
+	 * Whether the currency is supported by PayPal.
+	 *
+	 * @return bool
+	 */
+	private function currency_supported(): bool {
+		$currency             = $this->shop_currency;
+		$supported_currencies = $this->supported_currencies;
+		return in_array( $currency, $supported_currencies, true );
+	}
+}

modules/ppcp-wc-gateway/src/WCGatewayModule.php

@@ -39,6 +39,7 @@ use WooCommerce\PayPalCommerce\WcGateway\Helper\PayUponInvoiceProductStatus;
 use WooCommerce\PayPalCommerce\WcGateway\Helper\SettingsStatus;
 use WooCommerce\PayPalCommerce\WcGateway\Notice\ConnectAdminNotice;
 use WooCommerce\PayPalCommerce\WcGateway\Notice\GatewayWithoutPayPalAdminNotice;
+use WooCommerce\PayPalCommerce\WcGateway\Notice\UnsupportedCurrencyAdminNotice;
 use WooCommerce\PayPalCommerce\WcGateway\Processor\AuthorizedPaymentsProcessor;
 use WooCommerce\PayPalCommerce\WcGateway\Settings\HeaderRenderer;
 use WooCommerce\PayPalCommerce\WcGateway\Settings\SectionsRenderer;
@@ -197,6 +198,13 @@ class WCGatewayModule implements ModuleInterface {
 					$notices[] = $connect_message;
 				}
 
+				$notice = $c->get( 'wcgateway.notice.currency-unsupported' );
+				assert( $notice instanceof UnsupportedCurrencyAdminNotice );
+				$unsupported_currency_message = $notice->unsupported_currency_message();
+				if ( $unsupported_currency_message ) {
+					$notices[] = $unsupported_currency_message;
+				}
+
 				foreach ( array(
 					$c->get( 'wcgateway.notice.dcc-without-paypal' ),
 					$c->get( 'wcgateway.notice.card-button-without-paypal' ),