AmazonPay.php at 11.0.1 · WooCommerce

woocommerce / src / Internal / Admin / Settings / PaymentsProviders / AmazonPay.php

AmazonPay.php

154 lines 5.7 KB

Raw Download Zip

1	<?php
2	declare( strict_types=1 );
3
4	namespace Automattic\WooCommerce\Internal\Admin\Settings\PaymentsProviders;
5
6	use Automattic\WooCommerce\Internal\Logging\SafeGlobalFunctionProxy;
7	use WC_Payment_Gateway;
8
9	defined( 'ABSPATH' ) \|\| exit;
10
11	/**
12	* AmazonPay payment gateway provider class.
13	*
14	* This class handles all the custom logic for the AmazonPay payment gateway provider.
15	*/
16	class AmazonPay extends PaymentGateway {
17
18	/**
19	* Try to determine if the payment gateway is in test mode.
20	*
21	* This is a best-effort attempt, as there is no standard way to determine this.
22	* Trust the true value, but don't consider a false value as definitive.
23	*
24	* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
25	*
26	* @return bool True if the payment gateway is in test mode, false otherwise.
27	*/
28	public function is_in_test_mode( WC_Payment_Gateway $payment_gateway ): bool {
29	return $this->is_amazon_pay_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode( $payment_gateway );
30	}
31
32	/**
33	* Try to determine if the payment gateway is in dev mode.
34	*
35	* This is a best-effort attempt, as there is no standard way to determine this.
36	* Trust the true value, but don't consider a false value as definitive.
37	*
38	* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
39	*
40	* @return bool True if the payment gateway is in dev mode, false otherwise.
41	*/
42	public function is_in_dev_mode( WC_Payment_Gateway $payment_gateway ): bool {
43	return $this->is_amazon_pay_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_dev_mode( $payment_gateway );
44	}
45
46	/**
47	* Check if the payment gateway has a payments processor account connected.
48	*
49	* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
50	*
51	* @return bool True if the payment gateway account is connected, false otherwise.
52	* If the payment gateway does not provide the information, it will return true.
53	*/
54	public function is_account_connected( WC_Payment_Gateway $payment_gateway ): bool {
55	return $this->is_amazon_pay_onboarded( $payment_gateway ) ?? parent::is_account_connected( $payment_gateway );
56	}
57
58	/**
59	* Check if the payment gateway has completed the onboarding process.
60	*
61	* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
62	*
63	* @return bool True if the payment gateway has completed the onboarding process, false otherwise.
64	* If the payment gateway does not provide the information,
65	* it will infer it from having a connected account.
66	*/
67	public function is_onboarding_completed( WC_Payment_Gateway $payment_gateway ): bool {
68	return $this->is_amazon_pay_onboarded( $payment_gateway ) ?? parent::is_onboarding_completed( $payment_gateway );
69	}
70
71	/**
72	* Try to determine if the payment gateway is in test mode onboarding (aka sandbox or test-drive).
73	*
74	* This is a best-effort attempt, as there is no standard way to determine this.
75	* Trust the true value, but don't consider a false value as definitive.
76	*
77	* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
78	*
79	* @return bool True if the payment gateway is in test mode onboarding, false otherwise.
80	*/
81	public function is_in_test_mode_onboarding( WC_Payment_Gateway $payment_gateway ): bool {
82	return $this->is_amazon_pay_in_sandbox_mode( $payment_gateway ) ?? parent::is_in_test_mode_onboarding( $payment_gateway );
83	}
84
85	/**
86	* Check if the AmazonPay payment gateway is in sandbox mode.
87	*
88	* For AmazonPay, there are two different environments: sandbox and production.
89	*
90	* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
91	*
92	* @return ?bool True if the payment gateway is in sandbox mode, false otherwise.
93	* Null if the environment could not be determined.
94	*/
95	private function is_amazon_pay_in_sandbox_mode( WC_Payment_Gateway $payment_gateway ): ?bool {
96	try {
97	if ( class_exists( '\WC_Amazon_Payments_Advanced_API' ) &&
98	is_callable( '\WC_Amazon_Payments_Advanced_API::get_settings' ) ) {
99
100	$settings = \WC_Amazon_Payments_Advanced_API::get_settings();
101	if ( isset( $settings['sandbox'] ) ) {
102	return wc_string_to_bool( $settings['sandbox'] );
103	}
104	}
105	} catch ( \Throwable $e ) {
106	// Do nothing but log so we can investigate.
107	SafeGlobalFunctionProxy::wc_get_logger()->debug(
108	'Failed to determine if gateway is in sandbox mode: ' . $e->getMessage(),
109	array(
110	'gateway' => $payment_gateway->id,
111	'source' => 'settings-payments',
112	'exception' => $e,
113	)
114	);
115	}
116
117	// Let the caller know that we couldn't determine the environment.
118	return null;
119	}
120
121	/**
122	* Check if the AmazonPay payment gateway is onboarded.
123	*
124	* For AmazonPay, there are two different environments: sandbox and production.
125	*
126	* @param WC_Payment_Gateway $payment_gateway The payment gateway object.
127	*
128	* @return ?bool True if the payment gateway is onboarded, false otherwise.
129	* Null if we failed to determine the onboarding status.
130	*/
131	private function is_amazon_pay_onboarded( WC_Payment_Gateway $payment_gateway ): ?bool {
132	try {
133	if ( class_exists( '\WC_Amazon_Payments_Advanced_API' ) &&
134	is_callable( '\WC_Amazon_Payments_Advanced_API::validate_api_settings' ) ) {
135
136	return true === \WC_Amazon_Payments_Advanced_API::validate_api_settings();
137	}
138	} catch ( \Throwable $e ) {
139	// Do nothing but log so we can investigate.
140	SafeGlobalFunctionProxy::wc_get_logger()->debug(
141	'Failed to determine if gateway is onboarded: ' . $e->getMessage(),
142	array(
143	'gateway' => $payment_gateway->id,
144	'source' => 'settings-payments',
145	'exception' => $e,
146	)
147	);
148	}
149
150	// Let the caller know that we couldn't determine the onboarding status.
151	return null;
152	}
153	}
154