Merge branch 'trunk' into pcp-541-onboarding

modules/ppcp-admin-notices/src/Repository/Repository.php

@@ -25,6 +25,9 @@ class Repository implements RepositoryInterface {
 	 */
 	public function current_message(): array {
 		return array_filter(
+			/**
+			 * Returns the list of admin messages.
+			 */
 			(array) apply_filters(
 				self::NOTICES_FILTER,
 				array()

modules/ppcp-api-client/services.php

@@ -395,6 +395,9 @@ return array(
 	 * The matrix which countries and currency combinations can be used for DCC.
 	 */
 	'api.dcc-supported-country-currency-matrix' => static function ( ContainerInterface $container ) : array {
+		/**
+		 * Returns which countries and currency combinations can be used for DCC.
+		 */
 		return apply_filters(
 			'woocommerce_paypal_payments_supported_country_currency_matrix',
 			array(
@@ -540,6 +543,9 @@ return array(
 	 * Which countries support which credit cards. Empty credit card arrays mean no restriction on currency.
 	 */
 	'api.dcc-supported-country-card-matrix'     => static function ( ContainerInterface $container ) : array {
+		/**
+		 * Returns which countries support which credit cards. Empty credit card arrays mean no restriction on currency.
+		 */
 		return apply_filters(
 			'woocommerce_paypal_payments_supported_country_card_matrix',
 			array(

modules/ppcp-api-client/src/Entity/PaymentToken.php

@@ -105,6 +105,9 @@ class PaymentToken {
 	 * @return array
 	 */
 	public static function get_valid_types() {
+		/**
+		 * Returns a list of valid payment token types.
+		 */
 		return apply_filters(
 			'woocommerce_paypal_payments_valid_payment_token_types',
 			array(

modules/ppcp-api-client/src/Factory/PayerFactory.php

@@ -55,10 +55,12 @@ class PayerFactory {
 			$national_number = preg_replace( '/[^0-9]/', '', $national_number );
 			$national_number = substr( $national_number, 0, 14 );
 
-			$phone = new PhoneWithType(
-				'HOME',
-				new Phone( $national_number )
-			);
+			if ( $national_number ) {
+				$phone = new PhoneWithType(
+					'HOME',
+					new Phone( $national_number )
+				);
+			}
 		}
 		return new Payer(
 			new PayerName(
@@ -91,10 +93,12 @@ class PayerFactory {
 			$national_number = preg_replace( '/[^0-9]/', '', $national_number );
 			$national_number = substr( $national_number, 0, 14 );
 
-			$phone = new PhoneWithType(
-				'HOME',
-				new Phone( $national_number )
-			);
+			if ( $national_number ) {
+				$phone = new PhoneWithType(
+					'HOME',
+					new Phone( $national_number )
+				);
+			}
 		}
 		return new Payer(
 			new PayerName(
@@ -176,10 +180,12 @@ class PayerFactory {
 			if ( null !== $national_number ) {
 				$national_number = substr( $national_number, 0, 14 );
 
-				$phone = new PhoneWithType(
-					'HOME',
-					new Phone( $national_number )
-				);
+				if ( $national_number ) {
+					$phone = new PhoneWithType(
+						'HOME',
+						new Phone( $national_number )
+					);
+				}
 			}
 		}
 

modules/ppcp-api-client/src/Factory/PurchaseUnitFactory.php

@@ -134,6 +134,9 @@ class PurchaseUnitFactory {
 			$invoice_id,
 			$soft_descriptor
 		);
+		/**
+		 * Returns PurchaseUnit for the WC order.
+		 */
 		return apply_filters(
 			'woocommerce_paypal_payments_purchase_unit_from_wc_order',
 			$purchase_unit,

modules/ppcp-api-client/src/Repository/ApplicationContextRepository.php

@@ -74,7 +74,10 @@ class ApplicationContextRepository {
 
 		$parts = explode( '-', $locale );
 		if ( count( $parts ) === 3 ) {
-			return substr( $locale, 0, strrpos( $locale, '-' ) );
+			$ret = substr( $locale, 0, strrpos( $locale, '-' ) );
+			if ( false !== $ret ) {
+				return $ret;
+			}
 		}
 
 		return 'en';

modules/ppcp-api-client/src/Repository/CustomerRepository.php

@@ -45,6 +45,8 @@ class CustomerRepository {
 			}
 
 			$unique_id = substr( $this->prefix . strrev( uniqid() ), 0, self::CLIENT_ID_MAX_LENGTH );
+			assert( is_string( $unique_id ) );
+
 			WC()->session->set( 'ppcp_guest_customer_id', $unique_id );
 
 			return $unique_id;

modules/ppcp-api-client/src/Repository/PartnerReferralsData.php

@@ -75,10 +75,16 @@ class PartnerReferralsData {
 		return array(
 			'partner_config_override' => array(
 				'partner_logo_url'       => 'https://connect.woocommerce.com/images/woocommerce_logo.png',
+				/**
+				 * Returns the URL which will be opened at the end of onboarding.
+				 */
 				'return_url'             => apply_filters(
 					'woocommerce_paypal_payments_partner_config_override_return_url',
 					admin_url( 'admin.php?page=wc-settings&tab=checkout&section=ppcp-gateway' )
 				),
+				/**
+				 * Returns the description of the URL which will be opened at the end of onboarding.
+				 */
 				'return_url_description' => apply_filters(
 					'woocommerce_paypal_payments_partner_config_override_return_url_description',
 					__( 'Return to your shop.', 'woocommerce-paypal-payments' )

modules/ppcp-button/services.php

@@ -73,6 +73,7 @@ return array(
 		$currency = $container->get( 'api.shop.currency' );
 		return new SmartButton(
 			$container->get( 'button.url' ),
+			$container->get( 'ppcp.asset-version' ),
 			$container->get( 'session.handler' ),
 			$settings,
 			$payer_factory,

modules/ppcp-button/src/Assets/SmartButton.php

@@ -44,6 +44,13 @@ class SmartButton implements SmartButtonInterface {
 	 */
 	private $module_url;
 
+	/**
+	 * The assets version.
+	 *
+	 * @var string
+	 */
+	private $version;
+
 	/**
 	 * The Session Handler.
 	 *
@@ -125,6 +132,7 @@ class SmartButton implements SmartButtonInterface {
 	 * SmartButton constructor.
 	 *
 	 * @param string                 $module_url The URL to the module.
+	 * @param string                 $version                            The assets version.
 	 * @param SessionHandler         $session_handler The Session Handler.
 	 * @param Settings               $settings The Settings.
 	 * @param PayerFactory           $payer_factory The Payer factory.
@@ -140,6 +148,7 @@ class SmartButton implements SmartButtonInterface {
 	 */
 	public function __construct(
 		string $module_url,
+		string $version,
 		SessionHandler $session_handler,
 		Settings $settings,
 		PayerFactory $payer_factory,
@@ -155,6 +164,7 @@ class SmartButton implements SmartButtonInterface {
 	) {
 
 		$this->module_url               = $module_url;
+		$this->version                  = $version;
 		$this->session_handler          = $session_handler;
 		$this->settings                 = $settings;
 		$this->payer_factory            = $payer_factory;
@@ -406,7 +416,7 @@ class SmartButton implements SmartButtonInterface {
 				'ppcp-hosted-fields',
 				untrailingslashit( $this->module_url ) . '/assets/css/hosted-fields.css',
 				array(),
-				1
+				$this->version
 			);
 		}
 		if ( $load_script ) {
@@ -414,7 +424,7 @@ class SmartButton implements SmartButtonInterface {
 				'ppcp-smart-button',
 				untrailingslashit( $this->module_url ) . '/assets/js/button.js',
 				array( 'jquery' ),
-				'1.3.2',
+				$this->version,
 				true
 			);
 
@@ -1012,38 +1022,50 @@ class SmartButton implements SmartButtonInterface {
 	}
 
 	/**
-	 * Return action name PayPal buttons will be rendered at on checkout page.
+	 * Returns the action name that PayPal button will use for rendering on the checkout page.
 	 *
 	 * @return string Action name.
 	 */
 	private function checkout_button_renderer_hook(): string {
+		/**
+		 * The filter returning the action name that PayPal button will use for rendering on the checkout page.
+		 */
 		return (string) apply_filters( 'woocommerce_paypal_payments_checkout_button_renderer_hook', 'woocommerce_review_order_after_payment' );
 	}
 
 	/**
-	 * Return action name PayPal DCC button will be rendered at on checkout page.
+	 * Returns the action name that PayPal DCC button will use for rendering on the checkout page.
 	 *
 	 * @return string
 	 */
 	private function checkout_dcc_button_renderer_hook(): string {
+		/**
+		 * The filter returning the action name that PayPal DCC button will use for rendering on the checkout page.
+		 */
 		return (string) apply_filters( 'woocommerce_paypal_payments_checkout_dcc_renderer_hook', 'woocommerce_review_order_after_submit' );
 	}
 
 	/**
-	 * Return action name PayPal button and Pay Later message will be rendered at on pay-order page.
+	 * Returns the action name that PayPal button and Pay Later message will use for rendering on the pay-order page.
 	 *
 	 * @return string
 	 */
 	private function pay_order_renderer_hook(): string {
+		/**
+		 * The filter returning the action name that PayPal button and Pay Later message will use for rendering on the pay-order page.
+		 */
 		return (string) apply_filters( 'woocommerce_paypal_payments_pay_order_dcc_renderer_hook', 'woocommerce_pay_order_after_submit' );
 	}
 
 	/**
-	 * Return action name PayPal button will be rendered next to Proceed to checkout button (normally displayed in cart).
+	 * Returns action name that PayPal button will use for rendering next to Proceed to checkout button (normally displayed in cart).
 	 *
 	 * @return string
 	 */
 	private function proceed_to_checkout_button_renderer_hook(): string {
+		/**
+		 * The filter returning the action name that PayPal button will use for rendering next to Proceed to checkout button (normally displayed in cart).
+		 */
 		return (string) apply_filters(
 			'woocommerce_paypal_payments_proceed_to_checkout_button_renderer_hook',
 			'woocommerce_proceed_to_checkout'
@@ -1051,11 +1073,14 @@ class SmartButton implements SmartButtonInterface {
 	}
 
 	/**
-	 * Return action name PayPal button will be rendered in the WC mini cart.
+	 * Returns the action name that PayPal button will use for rendering in the WC mini cart.
 	 *
 	 * @return string
 	 */
 	private function mini_cart_button_renderer_hook(): string {
+		/**
+		 * The filter returning the action name that PayPal button will use for rendering in the WC mini cart.
+		 */
 		return (string) apply_filters(
 			'woocommerce_paypal_payments_mini_cart_button_renderer_hook',
 			'woocommerce_widget_shopping_cart_after_buttons'
@@ -1063,11 +1088,14 @@ class SmartButton implements SmartButtonInterface {
 	}
 
 	/**
-	 * Return action name PayPal button and Pay Later message will be rendered at on the single product page.
+	 * Returns the action name that PayPal button and Pay Later message will use for rendering on the single product page.
 	 *
 	 * @return string
 	 */
 	private function single_product_renderer_hook(): string {
+		/**
+		 * The filter returning the action name that PayPal button and Pay Later message will use for rendering on the single product page.
+		 */
 		return (string) apply_filters( 'woocommerce_paypal_payments_single_product_renderer_hook', 'woocommerce_single_product_summary' );
 	}
 }

modules/ppcp-compat/src/PPEC/PPECHelper.php

@@ -89,6 +89,9 @@ class PPECHelper {
 	 * @return bool
 	 */
 	public static function use_ppec_compat_layer_for_subscriptions() {
+		/**
+		 * The filter returning whether the compatibility layer for PPEC Subscriptions should be initialized.
+		 */
 		return ( ! self::is_gateway_available() ) && self::site_has_ppec_subscriptions() && apply_filters( 'woocommerce_paypal_payments_process_legacy_subscriptions', true );
 	}
 

modules/ppcp-onboarding/services.php

@@ -131,9 +131,11 @@ return array(
 		$login_seller_endpoint = $container->get( 'onboarding.endpoint.login-seller' );
 		return new OnboardingAssets(
 			$container->get( 'onboarding.url' ),
+			$container->get( 'ppcp.asset-version' ),
 			$state,
 			$container->get( 'onboarding.environment' ),
-			$login_seller_endpoint
+			$login_seller_endpoint,
+			$container->get( 'wcgateway.current-ppcp-settings-page-id' )
 		);
 	},
 

modules/ppcp-onboarding/src/Assets/OnboardingAssets.php

@@ -12,6 +12,7 @@ namespace WooCommerce\PayPalCommerce\Onboarding\Assets;
 use WooCommerce\PayPalCommerce\Onboarding\Endpoint\LoginSellerEndpoint;
 use WooCommerce\PayPalCommerce\Onboarding\Environment;
 use WooCommerce\PayPalCommerce\Onboarding\State;
+use WooCommerce\PayPalCommerce\WcGateway\Gateway\PayPalGateway;
 
 /**
  * Class OnboardingAssets
@@ -25,6 +26,13 @@ class OnboardingAssets {
 	 */
 	private $module_url;
 
+	/**
+	 * The assets version.
+	 *
+	 * @var string
+	 */
+	private $version;
+
 	/**
 	 * The State.
 	 *
@@ -46,25 +54,38 @@ class OnboardingAssets {
 	 */
 	private $login_seller_endpoint;
 
+	/**
+	 * ID of the current PPCP gateway settings page, or empty if it is not such page.
+	 *
+	 * @var string
+	 */
+	protected $page_id;
+
 	/**
 	 * OnboardingAssets constructor.
 	 *
 	 * @param string              $module_url                         The URL to the module.
+	 * @param string              $version                            The assets version.
 	 * @param State               $state                               The State object.
 	 * @param Environment         $environment  The Environment.
 	 * @param LoginSellerEndpoint $login_seller_endpoint The LoginSeller endpoint.
+	 * @param string              $page_id ID of the current PPCP gateway settings page, or empty if it is not such page.
 	 */
 	public function __construct(
 		string $module_url,
+		string $version,
 		State $state,
 		Environment $environment,
-		LoginSellerEndpoint $login_seller_endpoint
+		LoginSellerEndpoint $login_seller_endpoint,
+		string $page_id
 	) {
 
 		$this->module_url            = untrailingslashit( $module_url );
+		$this->version               = $version;
 		$this->state                 = $state;
 		$this->environment           = $environment;
 		$this->login_seller_endpoint = $login_seller_endpoint;
+		$this->page_id               = $page_id;
 	}
 
 	/**
@@ -79,14 +100,14 @@ class OnboardingAssets {
 			'ppcp-onboarding',
 			$url,
 			array(),
-			1
+			$this->version
 		);
 		$url = untrailingslashit( $this->module_url ) . '/assets/js/settings.js';
 		wp_register_script(
 			'ppcp-settings',
 			$url,
 			array(),
-			1,
+			$this->version,
 			true
 		);
 
@@ -95,7 +116,7 @@ class OnboardingAssets {
 			'ppcp-onboarding',
 			$url,
 			array( 'jquery' ),
-			1,
+			$this->version,
 			true
 		);
 		wp_localize_script(
@@ -149,7 +170,6 @@ class OnboardingAssets {
 	 * @return bool
 	 */
 	private function should_render_onboarding_script(): bool {
-		global $current_section;
-		return 'ppcp-gateway' === $current_section;
+		return PayPalGateway::ID === $this->page_id;
 	}
 }

modules/ppcp-subscription/src/RenewalHandler.php

@@ -174,6 +174,9 @@ class RenewalHandler {
 	 * @return PaymentToken|null
 	 */
 	private function get_token_for_customer( \WC_Customer $customer, \WC_Order $wc_order ) {
+		/**
+		 * Returns a payment token for a customer, or null.
+		 */
 		$token = apply_filters( 'woocommerce_paypal_payments_subscriptions_get_token_for_customer', null, $customer, $wc_order );
 		if ( null !== $token ) {
 			return $token;

modules/ppcp-vaulting/services.php

@@ -22,7 +22,8 @@ return array(
 	},
 	'vaulting.assets.myaccount-payments' => function( ContainerInterface $container ) : MyAccountPaymentsAssets {
 		return new MyAccountPaymentsAssets(
-			$container->get( 'vaulting.module-url' )
+			$container->get( 'vaulting.module-url' ),
+			$container->get( 'ppcp.asset-version' )
 		);
 	},
 	'vaulting.payment-tokens-renderer'   => static function (): PaymentTokensRenderer {

modules/ppcp-vaulting/src/Assets/MyAccountPaymentsAssets.php

@@ -23,15 +23,25 @@ class MyAccountPaymentsAssets {
 	 */
 	private $module_url;
 
+	/**
+	 * The assets version.
+	 *
+	 * @var string
+	 */
+	private $version;
+
 	/**
 	 * MyAccountPaymentsAssets constructor.
 	 *
 	 * @param string $module_url The URL to the module.
+	 * @param string $version                            The assets version.
 	 */
 	public function __construct(
-		string $module_url
+		string $module_url,
+		string $version
 	) {
 		$this->module_url = untrailingslashit( $module_url );
+		$this->version    = $version;
 	}
 
 	/**
@@ -44,7 +54,7 @@ class MyAccountPaymentsAssets {
 			'ppcp-vaulting-myaccount-payments',
 			untrailingslashit( $this->module_url ) . '/assets/js/myaccount-payments.js',
 			array( 'jquery' ),
-			'1',
+			$this->version,
 			true
 		);
 	}

modules/ppcp-wc-gateway/services.php

@@ -905,6 +905,9 @@ return array(
 				'type'         => 'select',
 				'class'        => array(),
 				'input_class'  => array( 'wc-enhanced-select' ),
+				/**
+				 * Returns default label ID of the PayPal button.
+				 */
 				'default'      => apply_filters( 'woocommerce_paypal_payments_button_label_default', 'paypal' ),
 				'desc_tip'     => true,
 				'description'  => __(
@@ -1207,6 +1210,9 @@ return array(
 				'type'         => 'select',
 				'class'        => array(),
 				'input_class'  => array( 'wc-enhanced-select' ),
+				/**
+				 * Returns default label ID of the PayPal button on product pages.
+				 */
 				'default'      => apply_filters( 'woocommerce_paypal_payments_button_product_label_default', 'paypal' ),
 				'desc_tip'     => true,
 				'description'  => __(
@@ -1510,6 +1516,9 @@ return array(
 				'type'         => 'select',
 				'class'        => array(),
 				'input_class'  => array( 'wc-enhanced-select' ),
+				/**
+				 * Returns default label ID of the PayPal button in cart.
+				 */
 				'default'      => apply_filters( 'woocommerce_paypal_payments_button_cart_label_default', 'paypal' ),
 				'desc_tip'     => true,
 				'description'  => __(
@@ -1813,6 +1822,9 @@ return array(
 				'type'         => 'select',
 				'class'        => array(),
 				'input_class'  => array( 'wc-enhanced-select' ),
+				/**
+				 * Returns default label ID of the PayPal button in mini cart.
+				 */
 				'default'      => apply_filters( 'woocommerce_paypal_payments_button_mini_cart_label_default', 'paypal' ),
 				'desc_tip'     => true,
 				'description'  => __(

modules/ppcp-wc-gateway/src/Assets/SettingsPageAssets.php

@@ -25,11 +25,11 @@ class SettingsPageAssets {
 	private $module_url;
 
 	/**
-	 * The filesystem path to the module dir.
+	 * The assets version.
 	 *
 	 * @var string
 	 */
-	private $module_path;
+	private $version;
 
 	/**
 	 * The bearer.
@@ -42,13 +42,13 @@ class SettingsPageAssets {
 	 * Assets constructor.
 	 *
 	 * @param string $module_url The url of this module.
-	 * @param string $module_path The filesystem path to this module.
+	 * @param string $version                            The assets version.
 	 * @param Bearer $bearer The bearer.
 	 */
-	public function __construct( string $module_url, string $module_path, Bearer $bearer ) {
-		$this->module_url  = $module_url;
-		$this->module_path = $module_path;
-		$this->bearer      = $bearer;
+	public function __construct( string $module_url, string $version, Bearer $bearer ) {
+		$this->module_url = $module_url;
+		$this->version    = $version;
+		$this->bearer     = $bearer;
 	}
 
 	/**
@@ -102,13 +102,11 @@ class SettingsPageAssets {
 	 * @param Bearer $bearer The bearer.
 	 */
 	private function register_admin_assets( Bearer $bearer ) {
-		$gateway_settings_script_path = trailingslashit( $this->module_path ) . 'assets/js/gateway-settings.js';
-
 		wp_enqueue_script(
 			'ppcp-gateway-settings',
 			trailingslashit( $this->module_url ) . 'assets/js/gateway-settings.js',
 			array(),
-			file_exists( $gateway_settings_script_path ) ? (string) filemtime( $gateway_settings_script_path ) : null,
+			$this->version,
 			true
 		);
 

modules/ppcp-wc-gateway/src/Settings/SettingsListener.php

@@ -146,8 +146,14 @@ class SettingsListener {
 		}
 		$this->settings->persist();
 
+		/**
+		 * The hook fired before performing the redirect at the end of onboarding after saving the merchant ID/email.
+		 */
 		do_action( 'woocommerce_paypal_payments_onboarding_before_redirect' );
 
+		/**
+		 * The URL opened at the end of onboarding after saving the merchant ID/email.
+		 */
 		$redirect_url = apply_filters( 'woocommerce_paypal_payments_onboarding_redirect_url', admin_url( 'admin.php?page=wc-settings&tab=checkout&section=ppcp-gateway' ) );
 		if ( ! $this->settings->has( 'client_id' ) || ! $this->settings->get( 'client_id' ) ) {
 			$redirect_url = add_query_arg( 'ppcp-onboarding-error', '1', $redirect_url );

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

@@ -74,7 +74,7 @@ class WCGatewayModule implements ModuleInterface {
 		if ( $c->has( 'wcgateway.url' ) ) {
 			$assets = new SettingsPageAssets(
 				$c->get( 'wcgateway.url' ),
-				$c->get( 'wcgateway.absolute-path' ),
+				$c->get( 'ppcp.asset-version' ),
 				$c->get( 'api.bearer' )
 			);
 			$assets->register_assets();

modules/ppcp-webhooks/services.php

@@ -156,7 +156,8 @@ return array(
 
 	'webhook.status.assets'                   => function( ContainerInterface $container ) : WebhooksStatusPageAssets {
 		return new WebhooksStatusPageAssets(
-			$container->get( 'webhook.module-url' )
+			$container->get( 'webhook.module-url' ),
+			$container->get( 'ppcp.asset-version' )
 		);
 	},
 

modules/ppcp-webhooks/src/Status/Assets/WebhooksStatusPageAssets.php

@@ -26,15 +26,25 @@ class WebhooksStatusPageAssets {
 	 */
 	private $module_url;
 
+	/**
+	 * The assets version.
+	 *
+	 * @var string
+	 */
+	private $version;
+
 	/**
 	 * WebhooksStatusPageAssets constructor.
 	 *
 	 * @param string $module_url                         The URL to the module.
+	 * @param string $version                            The assets version.
 	 */
 	public function __construct(
-		string $module_url
+		string $module_url,
+		string $version
 	) {
 		$this->module_url = untrailingslashit( $module_url );
+		$this->version    = $version;
 	}
 
 	/**
@@ -47,14 +57,14 @@ class WebhooksStatusPageAssets {
 			'ppcp-webhooks-status-page-style',
 			untrailingslashit( $this->module_url ) . '/assets/css/status-page.css',
 			array(),
-			'1'
+			$this->version
 		);
 
 		wp_register_script(
 			'ppcp-webhooks-status-page',
 			untrailingslashit( $this->module_url ) . '/assets/js/status-page.js',
 			array(),
-			'1',
+			$this->version,
 			true
 		);