give / src / PaymentGateways / Actions / RegisterPaymentGateways.php

RegisterPaymentGateways.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.9, at src/PaymentGateways/Actions/RegisterPaymentGateways.php

182 lines 5.9 KB

Raw Download Zip

1	<?php
2
3	namespace Give\PaymentGateways\Actions;
4
5	use Give\Donations\Models\Donation;
6	use Give\Framework\Exceptions\Primitives\Exception;
7	use Give\Framework\Exceptions\Primitives\InvalidArgumentException;
8	use Give\Framework\LegacyPaymentGateways\Adapters\LegacyPaymentGatewayRegisterAdapter;
9	use Give\Framework\PaymentGateways\PaymentGatewayRegister;
10	use Give\PaymentGateways\Gateways\Offline\OfflineGateway;
11	use Give\PaymentGateways\Gateways\PayPalStandard\PayPalStandard;
12	use Give\PaymentGateways\Gateways\Stripe\Actions\GetPaymentMethodFromRequest;
13	use Give\PaymentGateways\Gateways\Stripe\BECSGateway as StripeBECSGateway;
14	use Give\PaymentGateways\Gateways\Stripe\CheckoutGateway as StripeCheckoutGateway;
15	use Give\PaymentGateways\Gateways\Stripe\CreditCardGateway as StripeCreditCardGateway;
16	use Give\PaymentGateways\Gateways\Stripe\SEPAGateway as StripeSEPAGateway;
17	use Give\PaymentGateways\Gateways\TestGateway\TestGateway;
18	use Give\PaymentGateways\PayPalCommerce\Exceptions\PayPalOrderException;
19	use Give\PaymentGateways\PayPalCommerce\Exceptions\PayPalOrderIdException;
20	use Give\PaymentGateways\PayPalCommerce\PayPalCommerce;
21	use Give\PaymentGateways\PayPalCommerce\Repositories\PayPalOrder;
22
23	class RegisterPaymentGateways
24	{
25	/**
26	* Array of Stripe payment method PaymentGateway classes to be bootstrapped
27	*
28	* @var string[]
29	*/
30	private $stripePaymentMethods = [
31	StripeBECSGateway::class,
32	StripeCheckoutGateway::class,
33	StripeCreditCardGateway::class,
34	StripeSEPAGateway::class,
35	];
36
37	/**
38	* Array of PaymentGateway classes to be bootstrapped
39	*
40	* @var string[]
41	*/
42	public $gateways = [
43	TestGateway::class,
44	PayPalStandard::class,
45	OfflineGateway::class,
46	];
47
48	/**
49	* Registers all the payment gateways with GiveWP
50	*
51	* @since 2.25.0 add afterRegisteredGateways
52	* @since 2.18.0
53	*
54	* @param array $gateways
55	*
56	* @return array
57	*
58	* @throws InvalidArgumentException\|Exception
59	*
60	*/
61	public function __invoke(array $gateways): array
62	{
63	$this->gateways = array_merge(
64	$this->gateways,
65	$this->stripePaymentMethods
66	);
67
68	/** @var PaymentGatewayRegister $paymentGatewayRegister */
69	$paymentGatewayRegister = give(PaymentGatewayRegister::class);
70
71	foreach ($this->gateways as $gateway) {
72	$paymentGatewayRegister->registerGateway($gateway);
73	}
74
75	$this->addGatewayDataToStripPaymentMethods();
76	$this->addGatewayDataToPayPalCommerce();
77
78	$this->register3rdPartyPaymentGateways($paymentGatewayRegister);
79	$this->unregister3rdPartyPaymentGateways($paymentGatewayRegister);
80
81	$this->afterRegisteredGateways();
82
83	return $gateways;
84	}
85
86	/**
87	* Register 3rd party payment gateways
88	*
89	* @since 2.21.0 use givewp prefix for action
90	* @since 2.18.0
91	*
92	* @param PaymentGatewayRegister $paymentGatewayRegister
93	*/
94	private function register3rdPartyPaymentGateways(PaymentGatewayRegister $paymentGatewayRegister)
95	{
96	do_action('givewp_register_payment_gateway', $paymentGatewayRegister);
97	}
98
99	/**
100	* Unregister 3rd party payment gateways
101	*
102	* @since 2.21.0 use givewp prefix for action
103	* @since 2.18.0
104	*
105	* @param PaymentGatewayRegister $paymentGatewayRegister
106	*/
107	private function unregister3rdPartyPaymentGateways(PaymentGatewayRegister $paymentGatewayRegister)
108	{
109	do_action('givewp_unregister_payment_gateway', $paymentGatewayRegister);
110	}
111
112	/**
113	* @since 2.21.2
114	*/
115	private function addGatewayDataToStripPaymentMethods()
116	{
117	foreach ($this->stripePaymentMethods as $gatewayClass) {
118	add_filter(
119	sprintf(
120	'givewp_create_payment_gateway_data_%1$s',
121	$gatewayClass::id()
122	),
123	function ($gatewayData, Donation $donation) {
124	$gatewayData['stripePaymentMethod'] = (new GetPaymentMethodFromRequest())($donation);
125
126	return $gatewayData;
127	},
128	10,
129	2
130	);
131	}
132	}
133
134	/**
135	* @since 4.0.0 updated to support authorize and capture
136	* @since 3.2.0 Prevent undefined index notice when getting payPalOrderId from gateway data.
137	* @since 2.26.0 Add support for the updated PayPal Commerce gateway data.
138	* @since 2.21.2
139	*
140	* @throws PayPalOrderIdException
141	*/
142	private function addGatewayDataToPayPalCommerce()
143	{
144	add_filter(
145	sprintf(
146	'givewp_create_payment_gateway_data_%1$s',
147	PayPalCommerce::id()
148	),
149	static function ($gatewayData) {
150	if (array_key_exists('payPalOrderId', $gatewayData)) {
151	$paypalOrderId = $gatewayData['payPalOrderId'];
152	} else {
153	$paypalOrderId = give_clean($_POST['payPalOrderId']);
154	$gatewayData['payPalOrderId'] = $paypalOrderId;
155	}
156
157	if (! $paypalOrderId) {
158	throw new PayPalOrderIdException(__('PayPal order id is missing.', 'give'));
159	}
160
161	return $gatewayData;
162	}
163	);
164	}
165
166	/**
167	* After gateways have been registered, connect to legacy payment gateway adapter
168	*/
169	private function afterRegisteredGateways()
170	{
171	/** @var PaymentGatewayRegister $paymentGatewayRegister */
172	$paymentGatewayRegister = give(PaymentGatewayRegister::class);
173
174	/** @var LegacyPaymentGatewayRegisterAdapter $legacyPaymentGatewayRegisterAdapter */
175	$legacyPaymentGatewayRegisterAdapter = give(LegacyPaymentGatewayRegisterAdapter::class);
176
177	foreach ($paymentGatewayRegister->getPaymentGateways() as $gatewayClass) {
178	$legacyPaymentGatewayRegisterAdapter->connectGatewayToLegacyPaymentGatewayAdapter($gatewayClass);
179	}
180	}
181	}
182