Add ENUM class for country codes

changelog/dev-7886-add-country-codes-enum

@@ -0,0 +1,4 @@
+Significance: minor
+Type: dev
+
+Added enum class for country codes

includes/admin/class-wc-rest-payments-settings-controller.php

@@ -5,6 +5,7 @@
  * @package WooCommerce\Payments\Admin
  */
 
+use WCPay\Constants\Country_Codes;
 use WCPay\Fraud_Prevention\Fraud_Risk_Tools;
 use WCPay\Constants\Track_Events;
 
@@ -388,7 +389,7 @@ public function validate_business_support_phone( string $value, WP_REST_Request
 		}
 
 		// Japan accounts require Japanese phone numbers.
-		if ( 'JP' === $this->account->get_account_country() ) {
+		if ( Country_Codes::JAPAN === $this->account->get_account_country() ) {
 			if ( '+81' !== substr( $value, 0, 3 ) ) {
 				return new WP_Error(
 					'rest_invalid_pattern',

includes/class-wc-payment-gateway-wcpay.php

@@ -9,6 +9,7 @@
 	exit; // Exit if accessed directly.
 }
 
+use WCPay\Constants\Country_Codes;
 use WCPay\Constants\Fraud_Meta_Box_Type;
 use WCPay\Constants\Order_Status;
 use WCPay\Constants\Payment_Capture_Type;
@@ -2456,7 +2457,7 @@ protected function get_deposit_delay_days( int $default_value = 7 ): int {
 	 *
 	 * @return string code of the country.
 	 */
-	protected function get_account_country( string $default_value = 'US' ): string {
+	protected function get_account_country( string $default_value = Country_Codes::UNITED_STATES ): string {
 		try {
 			if ( $this->is_connected() ) {
 				return $this->account->get_account_country() ?? $default_value;

includes/class-wc-payments-account.php

@@ -11,6 +11,7 @@
 
 use Automattic\WooCommerce\Admin\Notes\DataStore;
 use Automattic\WooCommerce\Admin\Notes\Note;
+use WCPay\Constants\Country_Codes;
 use WCPay\Core\Server\Request\Get_Account;
 use WCPay\Core\Server\Request\Get_Account_Capital_Link;
 use WCPay\Core\Server\Request\Get_Account_Login_Data;
@@ -277,7 +278,7 @@ public function get_account_status_data() {
 
 		return [
 			'email'                 => $account['email'] ?? '',
-			'country'               => $account['country'] ?? 'US',
+			'country'               => $account['country'] ?? Country_Codes::UNITED_STATES,
 			'status'                => $account['status'],
 			'created'               => $account['created'] ?? '',
 			'paymentsEnabled'       => $account['payments_enabled'],
@@ -1786,7 +1787,7 @@ private function get_actioned_notes(): array {
 	 */
 	public function get_account_country() {
 		$account = $this->get_cached_account_data();
-		return $account['country'] ?? 'US';
+		return $account['country'] ?? Country_Codes::UNITED_STATES;
 	}
 
 	/**

includes/class-wc-payments-features.php

@@ -5,6 +5,8 @@
  * @package WooCommerce\Payments
  */
 
+use WCPay\Constants\Country_Codes;
+
 if ( ! defined( 'ABSPATH' ) ) {
 	exit; // Exit if accessed directly.
 }
@@ -310,7 +312,7 @@ public static function is_stripe_billing_eligible() {
 		}
 
 		$store_base_location = wc_get_base_location();
-		return ! empty( $store_base_location['country'] ) && 'US' === $store_base_location['country'];
+		return ! empty( $store_base_location['country'] ) && Country_Codes::UNITED_STATES === $store_base_location['country'];
 	}
 
 	/**

includes/class-wc-payments-payment-request-button-handler.php

@@ -13,6 +13,7 @@
 	exit;
 }
 
+use WCPay\Constants\Country_Codes;
 use WCPay\Exceptions\Invalid_Price_Exception;
 use WCPay\Fraud_Prevention\Fraud_Prevention_Service;
 use WCPay\Logger;
@@ -444,7 +445,7 @@ public function get_normalized_postal_code( $postcode, $country ) {
 		 * when passing it back from the shippingcontactselected object. This causes WC to invalidate
 		 * the postal code and not calculate shipping zones correctly.
 		 */
-		if ( 'GB' === $country ) {
+		if ( Country_Codes::UNITED_KINGDOM === $country ) {
 			// Replaces a redacted string with something like LN10***.
 			return str_pad( preg_replace( '/\s+/', '', $postcode ), 7, '*' );
 		}

includes/class-wc-payments-utils.php

@@ -10,6 +10,7 @@
 }
 
 use WCPay\Exceptions\{ Amount_Too_Small_Exception, API_Exception, Connection_Exception };
+use WCPay\Constants\Country_Codes;
 
 /**
  * WC Payments Utils class
@@ -223,44 +224,44 @@ public static function zero_decimal_currencies(): array {
 	 */
 	public static function supported_countries(): array {
 		return [
-			'AE' => __( 'United Arab Emirates', 'woocommerce-payments' ),
-			'AT' => __( 'Austria', 'woocommerce-payments' ),
-			'AU' => __( 'Australia', 'woocommerce-payments' ),
-			'BE' => __( 'Belgium', 'woocommerce-payments' ),
-			'BG' => __( 'Bulgaria', 'woocommerce-payments' ),
-			'CA' => __( 'Canada', 'woocommerce-payments' ),
-			'CH' => __( 'Switzerland', 'woocommerce-payments' ),
-			'CY' => __( 'Cyprus', 'woocommerce-payments' ),
-			'CZ' => __( 'Czech Republic', 'woocommerce-payments' ),
-			'DE' => __( 'Germany', 'woocommerce-payments' ),
-			'DK' => __( 'Denmark', 'woocommerce-payments' ),
-			'EE' => __( 'Estonia', 'woocommerce-payments' ),
-			'FI' => __( 'Finland', 'woocommerce-payments' ),
-			'ES' => __( 'Spain', 'woocommerce-payments' ),
-			'FR' => __( 'France', 'woocommerce-payments' ),
-			'HR' => __( 'Croatia', 'woocommerce-payments' ),
-			'JP' => __( 'Japan', 'woocommerce-payments' ),
-			'LU' => __( 'Luxembourg', 'woocommerce-payments' ),
-			'GB' => __( 'United Kingdom (UK)', 'woocommerce-payments' ),
-			'GR' => __( 'Greece', 'woocommerce-payments' ),
-			'HK' => __( 'Hong Kong', 'woocommerce-payments' ),
-			'HU' => __( 'Hungary', 'woocommerce-payments' ),
-			'IE' => __( 'Ireland', 'woocommerce-payments' ),
-			'IT' => __( 'Italy', 'woocommerce-payments' ),
-			'LT' => __( 'Lithuania', 'woocommerce-payments' ),
-			'LV' => __( 'Latvia', 'woocommerce-payments' ),
-			'MT' => __( 'Malta', 'woocommerce-payments' ),
-			'NL' => __( 'Netherlands', 'woocommerce-payments' ),
-			'NO' => __( 'Norway', 'woocommerce-payments' ),
-			'NZ' => __( 'New Zealand', 'woocommerce-payments' ),
-			'PL' => __( 'Poland', 'woocommerce-payments' ),
-			'PT' => __( 'Portugal', 'woocommerce-payments' ),
-			'RO' => __( 'Romania', 'woocommerce-payments' ),
-			'SE' => __( 'Sweden', 'woocommerce-payments' ),
-			'SI' => __( 'Slovenia', 'woocommerce-payments' ),
-			'SK' => __( 'Slovakia', 'woocommerce-payments' ),
-			'SG' => __( 'Singapore', 'woocommerce-payments' ),
-			'US' => __( 'United States (US)', 'woocommerce-payments' ),
+			Country_Codes::UNITED_ARAB_EMIRATES => __( 'United Arab Emirates', 'woocommerce-payments' ),
+			Country_Codes::AUSTRIA              => __( 'Austria', 'woocommerce-payments' ),
+			Country_Codes::AUSTRALIA            => __( 'Australia', 'woocommerce-payments' ),
+			Country_Codes::BELGIUM              => __( 'Belgium', 'woocommerce-payments' ),
+			Country_Codes::BULGARIA             => __( 'Bulgaria', 'woocommerce-payments' ),
+			Country_Codes::CANADA               => __( 'Canada', 'woocommerce-payments' ),
+			Country_Codes::SWITZERLAND          => __( 'Switzerland', 'woocommerce-payments' ),
+			Country_Codes::CYPRUS               => __( 'Cyprus', 'woocommerce-payments' ),
+			Country_Codes::CZECHIA              => __( 'Czech Republic', 'woocommerce-payments' ),
+			Country_Codes::GERMANY              => __( 'Germany', 'woocommerce-payments' ),
+			Country_Codes::DENMARK              => __( 'Denmark', 'woocommerce-payments' ),
+			Country_Codes::ESTONIA              => __( 'Estonia', 'woocommerce-payments' ),
+			Country_Codes::FINLAND              => __( 'Finland', 'woocommerce-payments' ),
+			Country_Codes::SPAIN                => __( 'Spain', 'woocommerce-payments' ),
+			Country_Codes::FRANCE               => __( 'France', 'woocommerce-payments' ),
+			Country_Codes::CROATIA              => __( 'Croatia', 'woocommerce-payments' ),
+			Country_Codes::JAPAN                => __( 'Japan', 'woocommerce-payments' ),
+			Country_Codes::LUXEMBOURG           => __( 'Luxembourg', 'woocommerce-payments' ),
+			Country_Codes::UNITED_KINGDOM       => __( 'United Kingdom (UK)', 'woocommerce-payments' ),
+			Country_Codes::GREECE               => __( 'Greece', 'woocommerce-payments' ),
+			'HK'                                => __( 'Hong Kong', 'woocommerce-payments' ),
+			Country_Codes::HUNGARY              => __( 'Hungary', 'woocommerce-payments' ),
+			Country_Codes::IRELAND              => __( 'Ireland', 'woocommerce-payments' ),
+			Country_Codes::ITALY                => __( 'Italy', 'woocommerce-payments' ),
+			Country_Codes::LITHUANIA            => __( 'Lithuania', 'woocommerce-payments' ),
+			Country_Codes::LATVIA               => __( 'Latvia', 'woocommerce-payments' ),
+			Country_Codes::MALTA                => __( 'Malta', 'woocommerce-payments' ),
+			Country_Codes::NETHERLANDS          => __( 'Netherlands', 'woocommerce-payments' ),
+			Country_Codes::NORWAY               => __( 'Norway', 'woocommerce-payments' ),
+			Country_Codes::NEW_ZEALAND          => __( 'New Zealand', 'woocommerce-payments' ),
+			Country_Codes::POLAND               => __( 'Poland', 'woocommerce-payments' ),
+			Country_Codes::PORTUGAL             => __( 'Portugal', 'woocommerce-payments' ),
+			Country_Codes::ROMANIA              => __( 'Romania', 'woocommerce-payments' ),
+			Country_Codes::SWEDEN               => __( 'Sweden', 'woocommerce-payments' ),
+			Country_Codes::SLOVENIA             => __( 'Slovenia', 'woocommerce-payments' ),
+			Country_Codes::SLOVAKIA             => __( 'Slovakia', 'woocommerce-payments' ),
+			Country_Codes::SINGAPORE            => __( 'Singapore', 'woocommerce-payments' ),
+			Country_Codes::UNITED_STATES        => __( 'United States (US)', 'woocommerce-payments' ),
 		];
 	}
 

includes/class-wc-payments.php

@@ -435,6 +435,7 @@ public static function init() {
 		include_once __DIR__ . '/exceptions/class-fraud-ruleset-exception.php';
 		include_once __DIR__ . '/exceptions/class-order-not-found-exception.php';
 		include_once __DIR__ . '/constants/class-base-constant.php';
+		include_once __DIR__ . '/constants/class-country-codes.php';
 		include_once __DIR__ . '/constants/class-fraud-meta-box-type.php';
 		include_once __DIR__ . '/constants/class-order-status.php';
 		include_once __DIR__ . '/constants/class-payment-type.php';