Template.php — GiveWP – Donation Plugin and Fundraising Platform 2.10.3

give / src / Form / Template.php

give / src / Form Last commit date

LegacyConsumer 5 years ago Template 6 years ago LoadTemplate.php 5 years ago Template.php 5 years ago Templates.php 6 years ago

Template.php

327 lines

1	<?php
2
3	/**
4	* Handle basic setup of form template
5	*
6	* @package Give
7	* @since 2.7.0
8	*/
9
10	namespace Give\Form;
11
12	use Give\Form\Template\Options;
13	use Give\Helpers\Form\Template as FormTemplateUtils;
14	use Give\Helpers\Form\Utils as FormUtils;
15	use Give\Receipt\DonationReceipt;
16
17	defined( 'ABSPATH' ) \|\| exit;
18
19	/**
20	* Template class.
21	*
22	* @since 2.7.0
23	*/
24	abstract class Template {
25	/**
26	* Flag to check whether or not open success page in iframe.
27	*
28	* @var bool $openSuccessPageInIframe If set to false then success page will open in window instead of iframe.
29	*/
30	public $openSuccessPageInIframe = true;
31
32	/**
33	* Flag to check whether or not open failed page in iframe.
34	*
35	* @var bool $openFailedPageInIframe If set to false then failed page will open in window instead of iframe.
36	*/
37	public $openFailedPageInIframe = true;
38
39	/**
40	* Determines how the form is rendered to the page.
41	*
42	* Acceptable values:
43	* - button (show a button that displays the form when clicked)
44	* - onpage (render the form right on the page)
45	*
46	* @var string
47	*/
48	public $donationFormStyle = 'button';
49
50	/**
51	* Determines how the form amount choices are rendered to the page.
52	*
53	* Acceptable values:
54	* - buttons (render donation amount choices as button )
55	* - radio (render donation amount choices as radio )
56	* - dropdown (render donation amount choices in dropdown (select) )
57	*
58	* @var string
59	*/
60	public $donationFormLevelsStyle = 'buttons';
61
62	/**
63	* Determines how the form field labels render on the page.
64	*
65	* Acceptable values:
66	* - true (render with floating label style)
67	* - false (render as is)
68	*
69	* @var bool
70	*/
71	public $floatingLabelsStyle = false;
72
73	/**
74	* Determines whether or not render form content on page.
75	*
76	* Acceptable values:
77	* - true (render form content on page )
78	* - false (do not render form content on page)
79	*
80	* @var bool
81	*/
82	public $showDonationIntroductionContent = false;
83
84	/**
85	* Get starting form height
86	*
87	* Returns starting height for iframe (in pixels), this is used to predict iframe height before the iframe loads
88	* Implemented in includes/shortcodes.php:
89	*
90	* @param int $formId Form ID
91	*
92	* @return int
93	**/
94	public function getFormStartingHeight( $formId ) {
95	return 600;
96	}
97
98	/**
99	* Get form receipt height
100	*
101	* Returns receipt height for iframe (in pixels), this is used to predict iframe height before the iframe loads
102	* Implemented in includes/shortcodes.php:
103	* Implemented in form donation processing view
104	*
105	* @return int
106	**/
107	public function getFormReceiptHeight() {
108	return 977;
109	}
110
111	/**
112	* Get loading view filepath
113	*
114	* @since 2.7.0
115	*
116	* @return string
117	*/
118	public function getLoadingView() {
119	return GIVE_PLUGIN_DIR . 'src/Views/Form/defaultLoadingView.php';
120	}
121
122	/**
123	* Renders the loading view
124	*
125	* @since 2.9.2
126	*
127	* @param int $formId
128	*/
129	public function renderLoadingView( $formId = null ) {
130	include $this->getLoadingView();
131	}
132
133	/**
134	* Get form view filepath
135	*
136	* @since 2.7.0
137	*
138	* @return string
139	*/
140	public function getFormView() {
141	return GIVE_PLUGIN_DIR . 'src/Views/Form/defaultFormTemplate.php';
142	}
143
144	/**
145	* Get receipt view filepath
146	*
147	* @since 2.7.0
148	*
149	* @return string
150	*/
151	public function getReceiptView() {
152	return GIVE_PLUGIN_DIR . 'src/Views/Form/defaultFormReceiptTemplate.php';
153	}
154
155	/**
156	* return form template ID.
157	*
158	* @since 2.7.0
159	* @return string
160	*/
161	abstract public function getID();
162
163	/**
164	* Get form template name.
165	*
166	* @since 2.7.0
167	* @return string
168	*/
169	abstract public function getName();
170
171	/**
172	* Get form template image.
173	*
174	* @since 2.7.0
175	* @return string
176	*/
177	abstract public function getImage();
178
179	/**
180	* Get options config
181	*
182	* @since 2.7.0
183	* @return array
184	*/
185	abstract public function getOptionsConfig();
186
187	/**
188	* Get form template options
189	*
190	* @return Options
191	*/
192	public function getOptions() {
193	return Options::fromArray( $this->getOptionsConfig() );
194	}
195
196	/**
197	* Get failed/cancelled donation message.
198	*
199	* @since 2.7.0
200	* @return string
201	*/
202	public function getFailedDonationMessage() {
203	return esc_html__(
204	'We\'re sorry, your donation failed to process. Please try again or contact site support.',
205	'give'
206	);
207	}
208
209
210	/**
211	* Get failed donation page URL.
212	*
213	* @since 2.7.0
214	*
215	* @param int $formId
216	*
217	* @return mixed
218	*/
219	public function getFailedPageURL( $formId ) {
220	return FormUtils::createFailedPageURL( Give()->routeForm->getURL( get_post_field( 'post_name', $formId ) ) );
221	}
222
223	/**
224	* Get donate now button label text.
225	*
226	* @since 2.7.0
227	* @return string
228	*/
229	public function getDonateNowButtonLabel() {
230	return __( 'Donate Now', 'give' );
231	}
232
233	/**
234	* Get continue to donation form button label text.
235	*
236	* @since 2.7.0
237	* @return string
238	*/
239	public function getContinueToDonationFormLabel() {
240	return __( 'Donate Now', 'give' );
241	}
242
243	/**
244	* Get donation introduction text.
245	*
246	* @since 2.7.0
247	* @return string\|null
248	*/
249	public function getDonationIntroductionContent() {
250	return null;
251	}
252
253	/**
254	* Return content position on donation form.
255	*
256	* Note: Even you are free to add introduction content at any place on donation form
257	* But still this depends upon form template style and configuration on which places you are allowed to show display introduction content.
258	*
259	* @since 2.7.0
260	* @return string\|null
261	*/
262	public function getDonationIntroductionContentPosition() {
263	return null;
264	}
265
266	/**
267	* Get receipt details.
268	*
269	* @since 2.7.0
270	*
271	* @param int $donationId
272	*
273	* @return DonationReceipt
274	*/
275	public function getReceiptDetails( $donationId ) {
276	$receipt = new DonationReceipt( $donationId );
277
278	/**
279	* Fire the action for receipt object.
280	*
281	* @since 2.7.0
282	*/
283	do_action( 'give_new_receipt', $receipt );
284
285	return $receipt;
286	}
287
288	/**
289	* Get form heading
290	*
291	* @since 2.7.0
292	*
293	* @param int $formId
294	*
295	* @return string
296	*/
297	public function getFormHeading( $formId ) {
298	return get_the_title( $formId );
299	}
300
301	/**
302	* Get form image
303	*
304	* @since 2.7.0
305	*
306	* @param int $formId
307	*
308	* @return string
309	*/
310	public function getFormFeaturedImage( $formId ) {
311	return get_the_post_thumbnail_url( $formId, 'full' );
312	}
313
314	/**
315	* Get form excerpt
316	*
317	* @since 2.7.0
318	*
319	* @param int\|null $formId
320	*
321	* @return string
322	*/
323	public function getFormExcerpt( $formId ) {
324	return get_the_excerpt( $formId );
325	}
326	}
327