give / src / DonationForms / Blocks / DonationFormBlock / Controllers / BlockRenderController.php

BlockRenderController.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.9, at src/DonationForms/Blocks/DonationFormBlock/Controllers/BlockRenderController.php

156 lines 5.2 KB

Raw Download Zip

1	<?php
2
3	namespace Give\DonationForms\Blocks\DonationFormBlock\Controllers;
4
5	use Give\DonationForms\Actions\GenerateDonationConfirmationReceiptViewRouteUrl;
6	use Give\DonationForms\Actions\GenerateDonationFormViewRouteUrl;
7	use Give\DonationForms\Blocks\DonationFormBlock\DataTransferObjects\BlockAttributes;
8	use Give\DonationForms\DataTransferObjects\DonationConfirmationReceiptViewRouteData;
9	use Give\DonationForms\Models\DonationForm;
10	use Give\Framework\EnqueueScript;
11	use Give\Framework\Routes\RouteListener;
12	use Give\Helpers\Language;
13
14	class BlockRenderController
15	{
16	/**
17	* @since 4.1.0
18	*/
19	protected static int $embedInstance = 0;
20
21	/**
22	* @since 4.14.5 add escaping to the output.
23	* @since 4.7.0 detach check for gutenberg editor to make this more reusable
24	* @since 4.1.0 updated with embed ID instance fallback when block ID is not set.
25	* @since 3.22.0 Add locale support
26	* @since 3.2.0 include form url for new tab format.
27	* @since 3.0.0
28	*
29	* @return string\|null
30	*/
31	public function render(array $attributes)
32	{
33	static::$embedInstance++;
34
35	$blockAttributes = BlockAttributes::fromArray($attributes);
36
37	if (!$blockAttributes->formId) {
38	return null;
39	}
40
41	$this->loadEmbedScript();
42
43	/** @var DonationForm $donationForm */
44	$donationForm = DonationForm::find($blockAttributes->formId);
45
46	$embedId = $blockAttributes->blockId ?? 'givewp-embed-' . static::$embedInstance;
47
48	$locale = Language::getLocale();
49	$viewUrl = $this->getViewUrl($donationForm, $embedId);
50	$formUrl = add_query_arg(['p' => $blockAttributes->formId], site_url('?post_type=give_forms'));
51	$formViewUrl = $this->getFormViewUrl($donationForm);
52	$colorSettings = $donationForm->getColorSettings();
53
54	/**
55	* Note: iframe-resizer uses querySelectorAll so using a data attribute makes the most sense to target.
56	* It will also generate a dynamic ID - so when we have multiple embeds on a page there will be no conflict.
57	*/
58	return sprintf(
59	"<div class='root-data-givewp-embed' data-form-locale='%s' data-form-url='%s' data-form-view-url='%s' data-src='%s' data-givewp-embed-id='%s' data-form-format='%s' data-open-form-button='%s' style='--givewp-primary-color: %s; --givewp-secondary-color: %s;'></div>",
60	esc_attr($locale),
61	esc_attr($formUrl),
62	esc_attr($formViewUrl),
63	esc_attr($viewUrl),
64	esc_attr($embedId),
65	esc_attr($blockAttributes->formFormat),
66	esc_attr($blockAttributes->openFormButton),
67	esc_attr($colorSettings['primaryColor']),
68	esc_attr($colorSettings['secondaryColor'])
69	);
70	}
71
72	/**
73	* Return early if we're still inside the editor to avoid server side effects
74	*
75	* @since 4.7.0
76	*
77	* @return boolean
78	*/
79	public function isGutenbergEditor(): bool
80	{
81	return !empty($_REQUEST['post']) \|\| !empty($_REQUEST['action']) \|\| !empty($_REQUEST['_locale']);
82	}
83
84	/**
85	* If the page loads with our receipt route listener args then we need to render the receipt.
86	*
87	* @since 3.0.0
88	*/
89	protected function shouldDisplayDonationConfirmationReceipt(string $embedId): bool
90	{
91	$routeListener = new RouteListener(
92	'donation-completed',
93	'show-donation-confirmation-receipt'
94	);
95
96	return $routeListener->isValid($_GET, function ($request) use ($embedId) {
97	$isset = isset($request['givewp-embed-id'], $request['givewp-receipt-id']);
98
99	return $isset && $request['givewp-embed-id'] === $embedId && DonationConfirmationReceiptViewRouteData::isReceiptIdValid(
100	$request['givewp-receipt-id']
101	);
102	});
103	}
104
105	/**
106	* Get the iframe URL.
107	* This could either be the donation form view or the donation confirmation receipt view.
108	*
109	* @since 3.0.0
110	*/
111	private function getViewUrl(DonationForm $donationForm, string $embedId): string
112	{
113	if ($this->shouldDisplayDonationConfirmationReceipt($embedId)) {
114	$receiptId = give_clean($_GET['givewp-receipt-id']);
115
116	return (new GenerateDonationConfirmationReceiptViewRouteUrl())($receiptId);
117	}
118
119	return $this->getFormViewUrl($donationForm);
120	}
121
122	/**
123	* @since 3.4.0
124	*/
125	private function getFormViewUrl(DonationForm $donationForm): string
126	{
127	return (new GenerateDonationFormViewRouteUrl())($donationForm->id);
128	}
129
130	/**
131	*
132	* Load embed givewp script to resize iframe
133	* @see https://github.com/davidjbradshaw/iframe-resizer
134	*
135	* @since 3.0.0
136	*/
137	protected function loadEmbedScript()
138	{
139	(new EnqueueScript(
140	'givewp-donation-form-embed-app',
141	'build/donationFormBlockApp.js',
142	GIVE_PLUGIN_DIR,
143	GIVE_PLUGIN_URL,
144	'give'
145	))
146	->dependencies(['jquery'])
147	->loadInFooter()
148	->enqueue();
149
150	wp_enqueue_style(
151	'givewp-donation-form-embed-app',
152	GIVE_PLUGIN_URL . 'build/donationFormBlockApp.css'
153	);
154	}
155	}
156