give / includes / admin / settings / class-settings-gateways.php

class-settings-gateways.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.9, at includes/admin/settings/class-settings-gateways.php

558 lines 26.0 KB

Raw Download Zip

1	<?php
2
3	/**
4	* Give Settings Page/Tab
5	*
6	* @package Give
7	* @since 1.8
8	* @copyright Copyright (c) 2016, GiveWP
9	* @license http://opensource.org/licenses/gpl-2.0.php GNU Public License
10	* @subpackage Classes/Give_Settings_Gateways
11	*/
12
13	use Give\PaymentGateways\PayPalCommerce\Repositories\MerchantDetails;
14	use Give\PaymentGateways\Stripe\Admin\AccountManagerSettingField;
15
16	if (! defined('ABSPATH')) {
17	exit; // Exit if accessed directly
18	}
19
20	if (! class_exists('Give_Settings_Gateways')) :
21
22	/**
23	* Give_Settings_Gateways.
24	*
25	* @sine 1.8
26	*/
27	class Give_Settings_Gateways extends Give_Settings_Page
28	{
29	/**
30	* Constructor.
31	*/
32	public function __construct()
33	{
34	$this->id = 'gateways';
35	$this->label = esc_html__('Payment Gateways', 'give');
36
37	$this->default_tab = 'gateways-settings';
38
39	parent::__construct();
40
41	// Do not use main form for this tab.
42	if (give_get_current_setting_tab() === $this->id) {
43	add_action('give_admin_field_gateway_notice', [$this, 'render_gateway_notice'], 10, 2);
44	add_action('give_admin_field_enabled_gateways', [$this, 'render_enabled_gateways'], 10, 2);
45	}
46	}
47
48	/**
49	* Get settings array.
50	*
51	* @since 1.8
52	* @return array
53	*/
54	public function get_settings()
55	{
56	$settings = [];
57	$current_section = give_get_current_setting_section();
58
59	switch ($current_section) {
60	case 'offline-donations':
61	$settings = [
62	// Section 3: Offline gateway.
63	[
64	'type' => 'title',
65	'id' => 'give_title_gateway_settings_3',
66	],
67	[
68	'name' => __('Collect Billing Details', 'give'),
69	'desc' => __('If enabled, required billing address fields are added to Offline Donation forms. These fields are not required to process the transaction, but you may have a need to collect the data. Billing address details are added to both the donation and donor record in GiveWP. ', 'give'),
70	'id' => 'give_offline_donation_enable_billing_fields',
71	'type' => 'radio_inline',
72	'default' => 'disabled',
73	'options' => [
74	'enabled' => __('Enabled', 'give'),
75	'disabled' => __('Disabled', 'give'),
76	],
77	],
78	[
79	'name' => __('Offline Donation Instructions', 'give'),
80	'desc' => __('The Offline Donation Instructions are a chance for you to educate the donor on how to best submit offline donations. These instructions appear directly on the form, and after submission of the form. Note: You may also customize the instructions on individual forms as needed.', 'give'),
81	'id' => 'global_offline_donation_content',
82	'default' => give_get_default_offline_donation_content(),
83	'type' => 'wysiwyg',
84	'options' => [
85	'textarea_rows' => 6,
86	],
87	],
88	[
89	'name' => esc_html__('Offline Donations Settings Docs Link', 'give'),
90	'id' => 'offline_gateway_settings_docs_link',
91	'url' => esc_url('http://docs.givewp.com/offlinegateway'),
92	'title' => __('Offline Gateway Settings', 'give'),
93	'type' => 'give_docs_link',
94	],
95	[
96	'type' => 'sectionend',
97	'id' => 'give_title_gateway_settings_3',
98	],
99	];
100	break;
101
102	case 'gateways-settings':
103	$settings = [
104	// Section 1: Gateways.
105	[
106	'id' => 'give_title_gateway_settings_1',
107	'type' => 'title',
108	],
109	[
110	'id' => 'gateway_notice',
111	'type' => 'gateway_notice',
112	],
113	[
114	'name' => __('Test Mode', 'give'),
115	'desc' => __(
116	'If enabled, donations are processed through the sandbox/test accounts configured in each gateway\'s settings. This prevents having to use real money for tests. See the payment gateway documentation for instructions on configuring sandbox accounts.',
117	'give'
118	),
119	'id' => 'test_mode',
120	'type' => 'radio_inline',
121	'default' => 'disabled',
122	'options' => [
123	'enabled' => __('Enabled', 'give'),
124	'disabled' => __('Disabled', 'give'),
125	],
126	],
127	[
128	'name' => __('Enabled Gateways', 'give') . ' - v2',
129	'desc' => __('Enable your payment gateway. Can be ordered by dragging.', 'give'),
130	'id' => 'gateways',
131	'type' => 'enabled_gateways',
132	],
133	[
134	'name' => __('Enabled Gateways', 'give') . ' - v3',
135	'desc' => __('Enable your payment gateway. Can be ordered by dragging.', 'give'),
136	'id' => 'gateways_v3',
137	'type' => 'enabled_gateways_hidden',
138	],
139
140	/**
141	* "Enabled Gateways" setting field contains gateways label setting but when you save gateway settings then label will not save
142	* because this is not registered setting API and code will not recognize them.
143	*
144	* This setting will not render on admin setting screen but help internal code to recognize "gateways_label" setting and add them to give setting when save.
145	*/
146	[
147	'name' => __('Gateways Label', 'give') . ' - v2',
148	'desc' => '',
149	'id' => 'gateways_label',
150	'type' => 'gateways_label_hidden',
151	],
152	[
153	'name' => __('Gateways Label', 'give') . ' - v3',
154	'desc' => '',
155	'id' => 'gateways_label_v3',
156	'type' => 'gateways_label_hidden',
157	],
158
159	/**
160	* "Enabled Gateways" setting field contains default gateway setting but when you save gateway settings then this setting will not save
161	* because this is not registered setting API and code will not recognize them.
162	*
163	* This setting will not render on admin setting screen but help internal code to recognize "default_gateway" setting and add them to give setting when save.
164	*/
165	[
166	'name' => __('Default Gateway', 'give') . ' - v2',
167	'desc' => __('The gateway that will be selected by default.', 'give'),
168	'id' => 'default_gateway',
169	'type' => 'default_gateway_hidden',
170	],
171	[
172	'name' => __('Default Gateway', 'give') . ' - v3',
173	'desc' => __('The gateway that will be selected by default.', 'give'),
174	'id' => 'default_gateway_v3',
175	'type' => 'default_gateway_hidden',
176	],
177
178	[
179	'name' => __('Gateways Docs Link', 'give'),
180	'id' => 'gateway_settings_docs_link',
181	'url' => esc_url('http://docs.givewp.com/settings-gateways'),
182	'title' => __('Gateway Settings', 'give'),
183	'type' => 'give_docs_link',
184	],
185	[
186	'id' => 'give_title_gateway_settings_1',
187	'type' => 'sectionend',
188	],
189	];
190	break;
191	}
192
193	/**
194	* Filter the payment gateways settings.
195	* Backward compatibility: Please do not use this filter. This filter is deprecated in 1.8
196	*/
197	$settings = apply_filters('give_settings_gateways', $settings);
198
199	/**
200	* Filter the settings.
201	*
202	* @since 1.8
203	*
204	* @param array $settings
205	*/
206	$settings = apply_filters('give_get_settings_' . $this->id, $settings);
207
208	// Output.
209	return $settings;
210	}
211
212	/**
213	* Get sections.
214	*
215	* @since 2.9.0 move offline-donations to end of gateway list
216	* @since 1.8
217	*
218	* @return array
219	*/
220	public function get_sections()
221	{
222	$sections = apply_filters(
223	'give_get_sections_' . $this->id,
224	[
225	'gateways-settings' => __('Gateways', 'give'),
226	]
227	);
228
229	$sections['offline-donations'] = __('Offline Donations', 'give');
230
231	return $sections;
232	}
233
234	/**
235	* @since 2.13.0
236	* @return bool
237	*/
238	private function hasPremiumPaymentGateway()
239	{
240	$gateways = give_get_payment_gateways();
241
242	return (bool)apply_filters('give_gateway_upsell_notice_conditions', count($gateways) > 8);
243	}
244
245	/**
246	* @since 2.13.0
247	*
248	* @return bool
249	*/
250	private function canAcceptCreditCard()
251	{
252	return Give\Helpers\Gateways\Stripe::isAccountConfigured() \|\|
253	give(MerchantDetails::class)->accountIsConnected();
254	}
255
256
257	/**
258	* Render Gateway Notice
259	*
260	* @since 4.2.0 Updated messages removing mentions to Stripe fees
261	* @since 2.3.0
262	* @access public
263	*
264	* @param $field
265	* @param $settings
266	*/
267	public function render_gateway_notice($field, $settings)
268	{
269	if (! $this->hasPremiumPaymentGateway() && ! $this->canAcceptCreditCard()) {
270	?>
271	<div class="give-gateways-notice">
272	<div class="give-gateways-cc-icon">
273	<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="35"
274	height="29" viewBox="0 0 35 29">
275	<defs>
276	<path id="credit-card-a"
277	d="M32.0772569,3.88888889 L2.92274306,3.88888889 C1.30642361,3.88888889 0,5.1953125 0,6.80555556 L0,28.1944444 C0,29.8046875 1.30642361,31.1111111 2.92274306,31.1111111 L32.0772569,31.1111111 C33.6935764,31.1111111 35,29.8046875 35,28.1944444 L35,6.80555556 C35,5.1953125 33.6935764,3.88888889 32.0772569,3.88888889 Z M3.28732639,6.80555556 L31.7126736,6.80555556 C31.9131944,6.80555556 32.0772569,6.96961806 32.0772569,7.17013889 L32.0772569,9.72222222 L2.92274306,9.72222222 L2.92274306,7.17013889 C2.92274306,6.96961806 3.08680556,6.80555556 3.28732639,6.80555556 Z M31.7126736,28.1944444 L3.28732639,28.1944444 C3.08680556,28.1944444 2.92274306,28.0303819 2.92274306,27.8298611 L2.92274306,17.5 L32.0772569,17.5 L32.0772569,27.8298611 C32.0772569,28.0303819 31.9131944,28.1944444 31.7126736,28.1944444 Z M11.6666667,22.1180556 L11.6666667,24.5486111 C11.6666667,24.9496528 11.3385417,25.2777778 10.9375,25.2777778 L6.5625,25.2777778 C6.16145833,25.2777778 5.83333333,24.9496528 5.83333333,24.5486111 L5.83333333,22.1180556 C5.83333333,21.7170139 6.16145833,21.3888889 6.5625,21.3888889 L10.9375,21.3888889 C11.3385417,21.3888889 11.6666667,21.7170139 11.6666667,22.1180556 Z M23.3333333,22.1180556 L23.3333333,24.5486111 C23.3333333,24.9496528 23.0052083,25.2777778 22.6041667,25.2777778 L14.3402778,25.2777778 C13.9392361,25.2777778 13.6111111,24.9496528 13.6111111,24.5486111 L13.6111111,22.1180556 C13.6111111,21.7170139 13.9392361,21.3888889 14.3402778,21.3888889 L22.6041667,21.3888889 C23.0052083,21.3888889 23.3333333,21.7170139 23.3333333,22.1180556 Z" />
278	</defs>
279	<g fill="none" fill-rule="evenodd" opacity=".341" transform="translate(0 -3)">
280	<mask id="credit-card-b" fill="#fff">
281	<use xlink:href="#credit-card-a" />
282	</mask>
283	<g fill="#242A42" mask="url(#credit-card-b)">
284	<rect width="35" height="35" />
285	</g>
286	</g>
287	</svg>
288	</div>
289
290	<p class="give-gateways-notice-title">
291	<strong>
292	<?php esc_html_e(
293	'Want to accept credit card donations directly on your website?',
294	'give'
295	); ?>
296	</strong>
297	</p>
298
299	<p class="give-gateways-notice-message">
300	<?php
301	printf(
302	__(
303	'Activate the free Stripe payment gateway %1$s, <a href="%2$s" target="_blank">PayPal Donations</a>, or a premium gateway like <a href="%3$s" target="_blank">2checkout</a>, or <a href="%4$s" target="_blank">Authorize.Net</a>.',
304	'give'
305	),
306	Give()->tooltips->render_help(
307	__(
308	'The Stripe payment gateway includes a 2% processing fee in addition to Stripe’s transaction fee. This ensures our ability to provide future support and updates for the plugin.',
309	'give'
310	)
311	),
312	admin_url('edit.php?post_type=give_forms&page=give-settings&tab=gateways&section=paypal'),
313	'https://givewp.com/addons/2checkout/?utm_source=WP%20Admin%20%3E%20Donations%20%3E%20Settings%20%3E%20Gateways&utm_medium=banner',
314	'https://givewp.com/addons/authorize-net-gateway/?utm_source=WP%20Admin%20%3E%20Donations%20%3E%20Settings%20%3E%20Gateways&utm_medium=banner'
315	);
316	?>
317	</p>
318
319	<div class="give-gateways-notice-button">
320	<?php echo give(AccountManagerSettingField::class)->getStripeConnectButtonMarkup(); ?>
321	<a href="https://givewp.com/addons/category/payment-gateways/?utm_source=WP%20Admin%20%3E%20Donations%20%3E%20Settings%20%3E%20Gateways&utm_medium=banner"
322	target="_blank" class="give-view-gateways-btn button">
323	<?php esc_html_e('View Premium Gateways', 'give'); ?>
324	</a>
325	</div>
326	</div>
327	<?php
328	}
329	}
330
331	/**
332	* Render enabled gateways
333	*
334	* @since 3.15.0 Set the v3 settings tab as default in the gateways list
335	* @since 3.0.0 split gateways into separated tabs for v2 and v3 settings
336	* @since 2.0.5
337	* @access public
338	*
339	* @param $field
340	* @param $settings
341	*/
342	public function render_enabled_gateways($field, $settings)
343	{
344	$id = $field['id'];
345	$gateways = give_get_payment_gateways();
346
347	$current_page = give_get_current_setting_page();
348	$current_tab = give_get_current_setting_tab();
349	$current_section = give_get_current_setting_section();
350
351	// Legacy gateways are gateways that are not registered with updated gateway registration API.
352	// For example: Razorpay, Paytm, Mollie etc.
353	// These payment gateways support donation processing only with v2 donation forms.
354	$legacyGateways = array_filter(
355	$gateways,
356	static function ($value, $key) {
357	return ! give()->gateways->hasPaymentGateway($key);
358	},
359	ARRAY_FILTER_USE_BOTH
360	);
361
362	// v2 gateways are gateways that are registered with updated gateway registration API.
363	// These payment gateways support donation processing with v2 donation forms.
364	// Legacy payment gateways will display with v2 gateways.
365	$v2Gateways = give_get_ordered_payment_gateways(
366	array_merge(
367	$legacyGateways,
368	array_intersect_key(
369	$gateways,
370	give()->gateways->getPaymentGateways(2)
371	)
372	),
373	2
374	);
375
376	// v3 gateways are gateways that are registered with updated gateway registration API.
377	// These payment gateways support donation processing with v3 donation forms.
378	$v3Gateways = give_get_ordered_payment_gateways(
379	array_intersect_key($gateways, give()->gateways->getPaymentGateways(3)),
380	3
381	);
382
383	$groups = [
384	'v3' => [
385	'label' => __('Visual Form Builder', 'give'),
386	'gateways' => $v3Gateways,
387	'settings' => give_get_option('gateways_v3', []),
388	'gatewaysLabel' => give_get_option('gateways_label_v3', []),
389	'defaultGateway' => give_get_option('default_gateway_v3', current(array_keys($v3Gateways))),
390	'helper' => [
391	'text' => __(
392	'Uses the blocks-based visual form builder for creating and customizing a donation form.',
393	'give'
394	),
395	'image' => GIVE_PLUGIN_URL . 'build/assets/dist/images/admin/give-settings-gateways-v3.jpg',
396	]
397	],
398	'v2' => [
399	'label' => __('Option-Based Form Editor', 'give'),
400	'gateways' => $v2Gateways,
401	'settings' => $settings,
402	'gatewaysLabel' => give_get_option('gateways_label', []),
403	'defaultGateway' => give_get_option('default_gateway', current(array_keys($v2Gateways))),
404	'helper' => [
405	'text' => __(
406	'Uses the traditional settings options for creating and customizing a donation form.',
407	'give'
408	),
409	'image' => GIVE_PLUGIN_URL . 'build/assets/dist/images/admin/give-settings-gateways-v2.jpg',
410	],
411	],
412	];
413
414	/**
415	* @since 3.18.0
416	*/
417	$groups = apply_filters('give_settings_payment_gateways_menu_groups', $groups);
418
419	$defaultGroup = current(array_keys($groups));
420
421	ob_start();
422
423	echo '<h4>' . __('Enabled Gateways', 'give') . '</h4>';
424	echo '<div class="give-settings-section-content give-payment-gateways-settings">';
425
426	if (count($groups) > 1) {
427	echo '<div class="give-settings-section-group-menu">';
428	echo '<ul>';
429	foreach ($groups as $slug => $group) {
430	$current_group = ! empty($_GET['group']) ? give_clean($_GET['group']) : $defaultGroup;
431	$active_class = ($slug === $current_group) ? 'active' : '';
432
433	if ($group['helper']) {
434	$helper = sprintf(
435	'<div class="give-settings-section-group-helper">
436	<img src="%1$s" />
437	<div class="give-settings-section-group-helper__popout">
438	<img src="%2$s" />
439	<h5>%3$s</h5>
440	<p>%4$s</p>
441	</div>
442	</div>',
443	esc_url(GIVE_PLUGIN_URL . 'build/assets/dist/images/admin/help-circle.svg'),
444	esc_url($group['helper']['image']),
445	esc_html($group['label']),
446	esc_html($group['helper']['text'])
447	);
448	}
449
450	echo sprintf(
451	'<li><a class="%1$s" href="%2$s" data-group="%3$s">%4$s %5$s</a></li>',
452	esc_html($active_class),
453	esc_url(
454	admin_url(
455	"edit.php?post_type=give_forms&page={$current_page}&tab={$current_tab}&section={$current_section}&group={$slug}"
456	)
457	),
458	esc_html($slug),
459	esc_html($group['label']),
460	$helper ?? ''
461	);
462	}
463	echo '</ul>';
464	echo '</div>';
465	}
466
467	echo '<div class="give-settings-section-group-content">';
468	foreach ($groups as $slug => $group) :
469	$current_group = !empty($_GET['group']) ? give_clean($_GET['group']) : $defaultGroup;
470	$hide_class = $slug !== $current_group ? 'give-hidden' : '';
471	$suffix = $slug === 'v3' ? '_v3' : '';
472
473	printf(
474	'<div id="give-settings-section-group-%1$s" class="give-settings-section-group %2$s">',
475	esc_attr($slug),
476	esc_html($hide_class)
477	);
478
479	echo '<div class="gateway-enabled-wrap">';
480	echo '<div class="gateway-enabled-settings-title">';
481	printf(
482	'
483	<span></span>
484	<span>%1$s</span>
485	<span>%2$s</span>
486	<span style="text-align: center;">%3$s</span>
487	<span style="text-align: center;">%4$s</span>
488	',
489	__('Gateway', 'give'),
490	__('Label', 'give'),
491	__('Default', 'give'),
492	__('Enabled', 'give')
493	);
494	echo '</div>';
495
496	echo '<ul class="give-checklist-fields give-payment-gatways-list">';
497	foreach ($group['gateways'] as $key => $option) :
498	$enabled = null;
499	if (is_array($group['settings']) && array_key_exists($key, $group['settings'])) {
500	$enabled = '1';
501	}
502
503	echo '<li>';
504	printf('<span class="give-drag-handle"><span class="dashicons dashicons-menu"></span></span>');
505	printf(
506	'<span class="admin-label">%1$s %2$s</span>',
507	esc_html($option['admin_label']),
508	!empty($option['admin_tooltip']) ? Give()->tooltips->render_help(
509	esc_attr($option['admin_tooltip'])
510	) : ''
511	);
512
513	$label = '';
514	if (!empty($group['gatewaysLabel'][$key])) {
515	$label = $group['gatewaysLabel'][$key];
516	}
517
518	printf(
519	'<input class="checkout-label" type="text" id="%1$s[%2$s]" name="%1$s[%2$s]" value="%3$s" placeholder="%4$s"/>',
520	'gateways_label' . $suffix,
521	esc_attr($key),
522	esc_html($label),
523	esc_html($option['checkout_label'])
524	);
525
526	printf(
527	'<input class="gateways-radio" type="radio" name="%1$s" value="%2$s" %3$s %4$s>',
528	'default_gateway' . $suffix,
529	$key,
530	checked($key, $group['defaultGateway'], false),
531	disabled(null, $enabled, false)
532	);
533
534	printf(
535	'<input class="gateways-checkbox" name="%1$s[%2$s]" id="%1$s[%2$s]" type="checkbox" value="1" %3$s data-payment-gateway="%4$s"/>',
536	esc_attr($id) . $suffix,
537	esc_attr($key),
538	checked('1', $enabled, false),
539	esc_html($option['admin_label'])
540	);
541	echo '</li>';
542	endforeach;
543	echo '</ul>';
544
545	echo '</div>'; // end gateway-enabled-wrap.
546	echo '</div>'; // end give-settings-section-group-content.
547	endforeach;
548
549	echo '</div>'; // end give-settings-section-content.
550
551	printf('<tr><td colspan="2" style="padding: 0">%s</td></tr>', ob_get_clean());
552	}
553	}
554
555	endif;
556
557	return new Give_Settings_Gateways();
558