give / src / Form / LoadTemplate.php

LoadTemplate.php in GiveWP – Donation Plugin and Fundraising Platform 2.23.0, at src/Form/LoadTemplate.php

291 lines 7.4 KB

Raw Download Zip

1	<?php
2
3	/**
4	* Handle Template Loading Handler
5	*
6	* @package Give
7	* @since 2.7.0
8	*/
9
10	namespace Give\Form;
11
12	use _WP_Dependency;
13	use Give\Form\Template\Hookable;
14	use Give\Form\Template\Scriptable;
15	use Give\Helpers\Form\Template as FormTemplateUtils;
16	use Give\Helpers\Form\Template\Utils\Frontend as FrontendFormTemplateUtils;
17	use Give\Helpers\Form\Utils;
18	use Give\Helpers\Form\Utils as FormUtils;
19	use Give\Session\SessionDonation\DonationAccessor;
20
21	defined('ABSPATH') \|\| exit;
22
23	/**
24	* LoadTemplate class.
25	* This class is responsible to load necessary hooks and run required functions which help to render form template (in different style).
26	*
27	* @since 2.7.0
28	*/
29	class LoadTemplate
30	{
31	/**
32	* Default form template ID.
33	*
34	* @var string
35	*/
36	private $defaultTemplateID = 'legacy';
37
38	/**
39	* Form template config.
40	*
41	* @var Template
42	*/
43	private $template;
44
45	/**
46	* setup form template
47	*
48	* @since 2.7.0
49	*
50	* @param int $formId Form Id. Default value: check explanation in src/Helpers/Form/Utils.php:103
51	*/
52	private function setUpTemplate($formId = null)
53	{
54	$formId = (int)($formId ?: FrontendFormTemplateUtils::getFormId());
55
56	$templateID = FormTemplateUtils::getActiveID($formId) ?: $this->defaultTemplateID;
57
58	$this->template = Give()->templates->getTemplate($templateID);
59	}
60
61	/**
62	* Initialize form template
63	*/
64	public function init()
65	{
66	$this->setUpTemplate();
67
68	// Exit is template is not valid.
69	if (! ($this->template instanceof Template)) {
70	return;
71	}
72
73	// Load template hooks.
74	if ($this->template instanceof Hookable) {
75	$this->template->loadHooks();
76	}
77
78	// Load template scripts.
79	if ($this->template instanceof Scriptable) {
80	add_action('wp_enqueue_scripts', [$this->template, 'loadScripts']);
81	}
82
83	$this->setUpFrontendHooks();
84	}
85
86	/**
87	* Setup frontend hooks
88	*
89	* @since 2.7.0
90	*/
91	private function setUpFrontendHooks()
92	{
93	add_action('give_embed_head', [$this, 'noRobots']);
94	add_action('give_embed_head', 'wp_enqueue_scripts', 1);
95	add_action('give_embed_head', [$this, 'handleEnqueueScripts'], 2);
96	add_action('give_embed_head', 'wp_print_styles', 8);
97	add_action('give_embed_head', 'wp_print_head_scripts', 9);
98	add_action('give_embed_footer', 'wp_print_footer_scripts', 20);
99	add_filter('give_form_wrap_classes', [$this, 'editClassList'], 999);
100	add_action('give_hidden_fields_after', [$this, 'addHiddenField']);
101	add_filter('give_donation_form_submit_button', [$this, 'disableDonationButtonInPreviewMode'], 999, 2);
102
103	// Handle receipt screen template
104	add_action('wp_ajax_get_receipt', [$this, 'handleReceiptAjax'], 9);
105	add_action('wp_ajax_nopriv_get_receipt', [$this, 'handleReceiptAjax'], 9);
106	}
107
108	/**
109	* Display a noindex meta tag.
110	*
111	* Outputs a noindex meta tag that tells web robots not to index and follow content.
112	*
113	* @since 2.7.0
114	*/
115	public function noRobots()
116	{
117	echo "<meta name='robots' content='noindex,nofollow'/>\n";
118	}
119
120	/**
121	* Render sequoia receipt by ajax
122	*
123	* @since 2.7.0
124	*/
125	public function handleReceiptAjax()
126	{
127	// Let core handle receipt for legacy form.
128	if (FormUtils::isLegacyForm()) {
129	return;
130	}
131
132	// Remove protocol before url comparison.
133	$referer = preg_replace('/^https?:\/\//i', '', untrailingslashit(wp_get_referer()));
134	$successPageUrl = preg_replace('/^https?:\/\//i', '', untrailingslashit(FormUtils::getSuccessPageURL()));
135
136	// Show new receipt view only on donation confirmation page.
137	if (false === strpos($referer, $successPageUrl)) {
138	return;
139	}
140
141	/**
142	* Fixes #5513 by clearing the payment post cache.
143	* @link https://github.com/impress-org/givewp/issues/5513
144	*/
145	clean_post_cache(
146	(new DonationAccessor())->getDonationId()
147	);
148
149	ob_start();
150	include_once $this->template->getReceiptView();
151	$data = ob_get_clean();
152	wp_send_json($data);
153	wp_die(); // All ajax handlers die when finished
154	}
155
156	/**
157	* Handle enqueue script
158	*
159	* @since 2.7.0
160	*/
161	public function handleEnqueueScripts()
162	{
163	global $wp_scripts, $wp_styles;
164	wp_enqueue_scripts();
165
166	$wp_styles->dequeue($this->getListOfScriptsToDequeue($wp_styles->registered));
167	$wp_scripts->dequeue($this->getListOfScriptsToDequeue($wp_scripts->registered));
168	}
169
170	/**
171	* Edit donation form wrapper class list.
172	*
173	* @since 2.7.0
174	*
175	* @param array $classes
176	*
177	* @return array
178	*/
179	public function editClassList($classes)
180	{
181	// Remove display_style related classes because they (except onpage ) creates style conflict with form template.
182	$classes = array_filter(
183	$classes,
184	static function ($class) {
185	return false === strpos($class, 'give-display-');
186	}
187	);
188
189	$classes[] = 'give-embed-form';
190
191	if (FormUtils::inIframe()) {
192	$classes[] = 'give-viewing-form-in-iframe';
193	}
194
195	return $classes;
196	}
197
198	/**
199	* Add hidden field
200	*
201	* @since 2.7.0
202	*/
203	public function addHiddenField()
204	{
205	printf(
206	'<input type="hidden" name="%1$s" value="%2$s">',
207	'give_embed_form',
208	'1'
209	);
210	}
211
212	/**
213	* Disable donation submit in donation form preview mode.
214	*
215	* @since 2.7.0
216	*
217	* @param int $formId
218	* @param string $buttonHtml
219	*
220	* @return string
221	*/
222	public function disableDonationButtonInPreviewMode($buttonHtml, $formId)
223	{
224	if (Utils::canDisableDonationNowButton()) {
225	$search = 'input type="submit"';
226
227	$buttonHtml = str_replace(
228	$search,
229	"{$search} onclick=\"return false;\"",
230	$buttonHtml
231	);
232	}
233
234	return $buttonHtml;
235	}
236
237	/**
238	* Get filter list to dequeue scripts and style
239	*
240	* @since 2.7.0
241	*
242	* @param array $scripts
243	*
244	* @return array
245	*/
246	private function getListOfScriptsToDequeue($scripts)
247	{
248	$list = [];
249	$skip = [];
250	$themeDir = get_template_directory_uri();
251
252	/* @var _WP_Dependency $data */
253	foreach ($scripts as $handle => $data) {
254	// Do not unset dependency.
255	if (in_array($handle, $skip, true)) {
256	continue;
257	}
258
259	// Do not allow styles and scripts from theme.
260	if (false !== strpos((string)$data->src, $themeDir)) {
261	$list[] = $handle;
262	continue;
263	}
264
265	if (
266	0 === strpos($handle, 'give') \|\|
267	false !== strpos($data->src, '\give')
268	) {
269	// Store dependencies to skip.
270	$skip = array_merge($skip, $data->deps);
271	continue;
272	}
273
274	$list[] = $handle;
275	}
276
277	return $list;
278	}
279
280	/**
281	* Get template.
282	*
283	* @since 2.7.0
284	* @return Template
285	*/
286	public function getTheme()
287	{
288	return $this->template;
289	}
290	}
291