give / src / Form / Template / Options.php

Options.php in GiveWP – Donation Plugin and Fundraising Platform 4.16.8.1, at src/Form/Template/Options.php

251 lines 9.2 KB

Raw Download Zip

1	<?php
2
3	namespace Give\Form\Template;
4
5	use Give\FormAPI\Section;
6
7	/**
8	* Class Options
9	*
10	* @package Give\Form\Template
11	* @since 2.7.0
12	*/
13	final class Options
14	{
15	/**
16	* Theme Options
17	*
18	* @since 2.7.0
19	* @var array
20	*/
21	public $sections = [];
22
23	/**
24	* ThemeOptions constructor.
25	*
26	* @since 2.7.0
27	*
28	* @param $array
29	*
30	* @return Options
31	*/
32	public static function fromArray($array)
33	{
34	$options = new static();
35
36	foreach ($array as $id => $group) {
37	$group['id'] = $id;
38	$options->sections[] = Section::fromArray($group);
39	}
40
41	return $options;
42	}
43
44	/**
45	* Return array configuration for checkout label setting field.
46	*
47	* Note: if you want to add an option in template to overwrite "Donate Now" button title then instead of define it manually in template options, developer can call this function.
48	* This function help to maintain backward compatibility with legacy donation form renderer.
49	*
50	* @return array
51	*/
52	public static function getCheckoutLabelField()
53	{
54	return [
55	'id' => 'checkout_label',
56	'name' => __('Submit Button', 'give'),
57	'desc' => __('The button label for completing a donation.', 'give'),
58	'type' => 'text_medium',
59	'attributes' => [
60	'placeholder' => __('Donate Now', 'give'),
61	],
62	'default' => __('Donate Now', 'give'),
63	LegacyFormSettingCompatibility::$key => '_give_checkout_label',
64	];
65	}
66
67	/**
68	* Return array configuration for display style setting field.
69	*
70	* Note: if you want to add an option in template to overwrite donation levels style then instead of define it manually in template options, developer can call this function.
71	* This function help to maintain backward compatibility with legacy donation form renderer.
72	*
73	* @return array
74	*/
75	public static function getDonationLevelsDisplayStyleField()
76	{
77	return [
78	'name' => __('Display Style', 'give'),
79	'description' => __('Set how the donations levels will display on the form.', 'give'),
80	'id' => 'display_style',
81	'type' => 'radio_inline',
82	'default' => 'buttons',
83	'options' => [
84	'buttons' => __('Buttons', 'give'),
85	'radios' => __('Radios', 'give'),
86	'dropdown' => __('Dropdown', 'give'),
87	],
88	'wrapper_class' => 'give-hidden _give_display_style_field',
89	LegacyFormSettingCompatibility::$key => '_give_display_style',
90	];
91	}
92
93	/**
94	* Return array configuration for display options setting field.
95	*
96	* Note: if you want to add an option in template to overwrite donation form display style then instead of define it manually in template options, developer can call this function.
97	* This function help to maintain backward compatibility with legacy donation form renderer.
98	*
99	* @param array $displayType
100	*
101	* @return array
102	*/
103	public static function getDisplayOptionsField($displayType = [])
104	{
105	return [
106	'name' => __('Display Options', 'give'),
107	'desc' => sprintf(__('How would you like to display donation information for this form?', 'give'), '#'),
108	'id' => 'payment_display',
109	'type' => 'radio_inline',
110	'options' => array_merge(
111	[
112	'onpage' => __('All Fields', 'give'),
113	'button' => __('Button', 'give'),
114	],
115	$displayType
116	),
117	'wrapper_class' => '_give_payment_display_field',
118	'default' => 'onpage',
119	LegacyFormSettingCompatibility::$key => '_give_payment_display',
120	];
121	}
122
123	/**
124	* Return array configuration for continue to donation button label ( reveal label ) setting field.
125	*
126	* Note: if you want to add an option in template to overwrite reveal_label text then instead of define it manually in template options, developer can call this function.
127	* This function help to maintain backward compatibility with legacy donation form renderer.
128	*
129	* @return array
130	*/
131	public static function getContinueToDonationFormField()
132	{
133	return [
134	'id' => 'reveal_label',
135	'name' => __('Continue Button', 'give'),
136	'desc' => __('The button label for displaying the additional payment fields.', 'give'),
137	'type' => 'text_small',
138	'attributes' => [
139	'placeholder' => __('Donate Now', 'give'),
140	],
141	'wrapper_class' => '_give_reveal_label_field give-hidden',
142	LegacyFormSettingCompatibility::$key => '_give_reveal_label',
143	];
144	}
145
146	/**
147	* Return array configuration for float labels setting field.
148	*
149	* Note: if you want to add an option in template to overwrite float labels feature then instead of define it manually in template options, developer can call this function.
150	* This function help to maintain backward compatibility with legacy donation form renderer.
151	*
152	* @return array
153	*/
154	public static function getFloatLabelsField()
155	{
156	return [
157	'name' => __('Floating Labels', 'give'),
158	/* translators: %s: forms http://docs.givewp.com/form-floating-labels */
159	'desc' => sprintf(
160	__(
161	'Select the <a href="%s" target="_blank">floating labels</a> setting for this GiveWP form. Be aware that if you have the "Disable CSS" option enabled, you will need to style the floating labels yourself.',
162	'give'
163	),
164	esc_url('http://docs.givewp.com/form-floating-labels')
165	),
166	'id' => 'form_floating_labels',
167	'type' => 'radio_inline',
168	'options' => [
169	'global' => __('Global Option', 'give'),
170	'enabled' => __('Enabled', 'give'),
171	'disabled' => __('Disabled', 'give'),
172	],
173	'default' => 'global',
174	LegacyFormSettingCompatibility::$key => '_give_form_floating_labels',
175	];
176	}
177
178	/**
179	* Return array configuration for display content setting field.
180	*
181	* Note: if you want to add an option in template to overwrite display content feature then instead of define it manually in template options, developer can call this function.
182	* This function help to maintain backward compatibility with legacy donation form renderer.
183	*
184	* @return array
185	*/
186	public static function getDisplayContentField()
187	{
188	return [
189	'name' => __('Display Content', 'give'),
190	'description' => __('Do you want to add custom content to this form?', 'give'),
191	'id' => 'display_content',
192	'type' => 'radio_inline',
193	'options' => [
194	'enabled' => __('Enabled', 'give'),
195	'disabled' => __('Disabled', 'give'),
196	],
197	'wrapper_class' => '_give_display_content_field',
198	'default' => 'disabled',
199	LegacyFormSettingCompatibility::$key => '_give_display_content',
200	];
201	}
202
203	/**
204	* Return array configuration for content placement setting field.
205	*
206	* Note: if you want to add an option in template to overwrite content placement feature then instead of define it manually in template options, developer can call this function.
207	* This function help to maintain backward compatibility with legacy donation form renderer.
208	*
209	* @return array
210	*/
211	public static function getContentPlacementField()
212	{
213	return [
214	'name' => __('Content Placement', 'give'),
215	'description' => __('This option controls where the content appears within the donation form.', 'give'),
216	'id' => 'content_placement',
217	'type' => 'radio_inline',
218	'options' => apply_filters(
219	'give_forms_content_options_select',
220	[
221	'give_pre_form' => __('Above fields', 'give'),
222	'give_post_form' => __('Below fields', 'give'),
223	]
224	),
225	'wrapper_class' => '_give_content_placement_field give-hidden',
226	'default' => 'give_pre_form',
227	LegacyFormSettingCompatibility::$key => '_give_content_placement',
228	];
229	}
230
231	/**
232	* Return array configuration for form content setting field.
233	*
234	* Note: if you want to add an option in template to overwrite form content feature then instead of define it manually in template options, developer can call this function.
235	* This function help to maintain backward compatibility with legacy donation form renderer.
236	*
237	* @return array
238	*/
239	public static function getFormContentField()
240	{
241	return [
242	'name' => __('Content', 'give'),
243	'description' => __('This content will display on the single give form page.', 'give'),
244	'id' => 'form_content',
245	'type' => 'wysiwyg',
246	'wrapper_class' => '_give_form_content_field give-hidden',
247	LegacyFormSettingCompatibility::$key => '_give_form_content',
248	];
249	}
250	}
251