elementor / modules / atomic-widgets / elements / atomic-form / atomic-form.php

atomic-form.php in Elementor Website Builder – more than just a page builder 4.3.0-beta3, at modules/atomic-widgets/elements/atomic-form/atomic-form.php

533 lines 16.9 KB

Raw Download Zip

1	<?php
2	namespace Elementor\Modules\AtomicWidgets\Elements\Atomic_Form;
3
4	use Elementor\Modules\AtomicWidgets\Controls\Section;
5	use Elementor\Modules\AtomicWidgets\Controls\Types\Chips_Control;
6	use Elementor\Modules\AtomicWidgets\Controls\Types\Email_Form_Action_Control;
7	use Elementor\Modules\AtomicWidgets\Controls\Types\Switch_Control;
8	use Elementor\Modules\AtomicWidgets\Controls\Types\Text_Control;
9	use Elementor\Modules\AtomicWidgets\Controls\Types\Toggle_Control;
10	use Elementor\Modules\AtomicWidgets\Elements\Atomic_Paragraph\Atomic_Paragraph;
11	use Elementor\Modules\AtomicWidgets\Elements\Atomic_Form\Form_Success_Message\Form_Success_Message;
12	use Elementor\Modules\AtomicWidgets\Elements\Atomic_Form\Form_Error_Message\Form_Error_Message;
13	use Elementor\Modules\AtomicWidgets\Elements\Base\Atomic_Element_Base;
14	use Elementor\Modules\AtomicWidgets\Elements\Base\Element_Builder;
15	use Elementor\Modules\AtomicWidgets\Elements\Base\Has_Element_Template;
16	use Elementor\Modules\AtomicWidgets\Elements\Base\Html_Tag_Computer;
17	use Elementor\Modules\AtomicWidgets\Elements\Base\Widget_Builder;
18	use Elementor\Modules\AtomicWidgets\PropDependencies\Manager as Dependency_Manager;
19	use Elementor\Modules\AtomicWidgets\PropTypes\Attributes_Prop_Type;
20	use Elementor\Modules\AtomicWidgets\PropTypes\Classes_Prop_Type;
21	use Elementor\Modules\AtomicWidgets\PropTypes\Emails_Prop_Type;
22	use Elementor\Modules\AtomicWidgets\PropTypes\Key_Value_Prop_Type;
23	use Elementor\Modules\AtomicWidgets\PropTypes\Primitives\Boolean_Prop_Type;
24	use Elementor\Modules\AtomicWidgets\PropTypes\Primitives\Number_Prop_Type;
25	use Elementor\Modules\AtomicWidgets\PropTypes\Size_Prop_Type;
26	use Elementor\Modules\AtomicWidgets\PropTypes\Escaped_Html_Prop_Type;
27	use Elementor\Modules\AtomicWidgets\PropTypes\Primitives\String_Array_Prop_Type;
28	use Elementor\Modules\AtomicWidgets\PropTypes\Primitives\String_Prop_Type;
29	use Elementor\Modules\AtomicWidgets\Styles\Style_Definition;
30	use Elementor\Modules\AtomicWidgets\Styles\Style_Variant;
31	use Elementor\Core\Breakpoints\Manager as Breakpoints_Manager;
32	use Elementor\Modules\Components\PropTypes\Overridable_Prop_Type;
33	use Elementor\Plugin;
34
35	if ( ! defined( 'ABSPATH' ) ) {
36	exit; // Exit if accessed directly.
37	}
38
39	class Atomic_Form extends Atomic_Element_Base {
40	use Has_Element_Template;
41
42	const BASE_STYLE_KEY = 'base';
43
44	public static $widget_description = 'A form container that holds form field widgets (labels, inputs, textareas, checkboxes, submit button) and status messages.';
45
46	public const ACTION_EMAIL = 'email';
47	public const ACTION_COLLECT_SUBMISSIONS = 'collect-submissions';
48	public const ACTION_WEBHOOK = 'webhook';
49	public const METADATA_REMOTE_IP = 'remote_ip';
50	public const METADATA_USER_AGENT = 'user_agent';
51
52
53
54	public function __construct( $data = [], $args = null ) {
55	parent::__construct( $data, $args );
56	$this->meta( 'is_container', true );
57	$this->meta( 'is_compound', true );
58	}
59
60	public static function get_default_recipient_email(): string {
61	return sanitize_email( (string) get_option( 'admin_email', '' ) );
62	}
63
64	public static function get_default_sender_email(): string {
65	return sanitize_email( (string) 'email@' . wp_parse_url( home_url(), PHP_URL_HOST ) );
66	}
67
68	public static function get_type() {
69	return 'e-form';
70	}
71
72	public static function get_element_type(): string {
73	return self::get_type();
74	}
75
76	public function get_title() {
77	return esc_html__( 'Atomic form', 'elementor' );
78	}
79
80	public function get_keywords() {
81	return [ 'atomic', 'form' ];
82	}
83
84	public function get_icon() {
85	return 'eicon-atomic-form';
86	}
87
88	public static function get_computed_html_tag( array $settings ): string {
89	return Html_Tag_Computer::compute( $settings, 'form' );
90	}
91
92	public static function get_base_props_schema(): array {
93	return self::define_props_schema();
94	}
95
96	protected static function define_props_schema(): array {
97	$submissions_metadata_dependencies = Dependency_Manager::make()
98	->where( [
99	'operator' => 'contains',
100	'path' => [ 'actions-after-submit' ],
101	'value' => self::ACTION_COLLECT_SUBMISSIONS,
102	'effect' => 'hide',
103	] )
104	->get();
105
106	$webhook_dependencies = Dependency_Manager::make()
107	->where( [
108	'operator' => 'contains',
109	'path' => [ 'actions-after-submit' ],
110	'value' => self::ACTION_WEBHOOK,
111	'effect' => 'hide',
112	] )
113	->get();
114
115	$props = [
116	'classes' => Classes_Prop_Type::make()
117	->default( [] ),
118	'form-name' => String_Prop_Type::make()
119	->default( __( 'Form', 'elementor' ) ),
120	'webmcp-autosubmit' => Boolean_Prop_Type::make()
121	->default( false ),
122	'form-state' => String_Prop_Type::make()
123	->enum( [ 'default', 'success', 'error' ] )
124	->default( 'default' )
125	->meta( 'generates_class', 'form-state-{value}' ),
126	'actions-after-submit' => String_Array_Prop_Type::make()
127	->initial_value( [ String_Prop_Type::generate( self::ACTION_EMAIL ) ] )
128	->default( [ String_Prop_Type::generate( self::ACTION_EMAIL ) ] ),
129	'submissions_metadata' => String_Array_Prop_Type::make()
130	->set_dependencies( $submissions_metadata_dependencies )
131	->default( [
132	String_Prop_Type::generate( self::METADATA_REMOTE_IP ),
133	String_Prop_Type::generate( self::METADATA_USER_AGENT ),
134	] ),
135	];
136
137	$props = array_merge( $props, self::get_emails_prop_settings(), [
138	'webhook_url' => String_Prop_Type::make()
139	->set_dependencies( $webhook_dependencies )
140	->meta( Overridable_Prop_Type::ignore() )
141	->default( '' ),
142	'attributes' => Attributes_Prop_Type::make()->meta( Overridable_Prop_Type::ignore() ),
143	] );
144
145	return $props;
146	}
147
148	protected function define_atomic_controls(): array {
149	$state_control = Toggle_Control::bind_to( 'form-state' )
150	->add_options( [
151	'default' => [
152	'title' => __( 'Normal', 'elementor' ),
153	],
154	'success' => [
155	'title' => __( 'Success', 'elementor' ),
156	],
157	'error' => [
158	'title' => __( 'Error', 'elementor' ),
159	],
160	] )
161	->set_exclusive( true )
162	->set_convert_options( true )
163	->set_size( 'tiny' )
164	->set_full_width( true )
165	->set_label( __( 'States', 'elementor' ) )
166	->set_meta( [ 'topDivider' => true ] );
167
168	$email_control_settings = $this->get_emails_control_settings();
169	$form_action_chips = $email_control_settings['form-action-chips'];
170	$email_controls = $email_control_settings['email-controls'];
171
172	if ( class_exists( '\ElementorPro\License\API' ) ) {
173	$has_form_submissions_feature = \ElementorPro\License\API::is_licence_has_feature( 'form-submissions' );
174
175	if ( $has_form_submissions_feature ) {
176	$form_action_chips = array_merge( $form_action_chips, [
177	[
178	'label' => __( 'Collect submissions', 'elementor' ),
179	'value' => self::ACTION_COLLECT_SUBMISSIONS,
180	],
181	] );
182	}
183	}
184
185	$content_controls = [
186	Text_Control::bind_to( 'form-name' )
187	->set_label( __( 'Form name', 'elementor' ) ),
188	$state_control,
189	Chips_Control::bind_to( 'actions-after-submit' )
190	->set_options( array_merge( $form_action_chips, [
191	[
192	'label' => __( 'Webhook', 'elementor' ),
193	'value' => self::ACTION_WEBHOOK,
194	],
195	] ) )
196	->set_label( __( 'Actions after submit', 'elementor' ) )
197	->set_meta( [ 'topDivider' => true ] ),
198	];
199
200	return [
201	Section::make()
202	->set_label( __( 'Content', 'elementor' ) )
203	->set_id( 'content' )
204	->set_items( $content_controls ),
205	...$email_controls,
206	Section::make()
207	->set_label( __( 'Collect submissions', 'elementor' ) )
208	->set_items( [
209	Chips_Control::bind_to( 'submissions_metadata' )
210	->set_options( [
211	[
212	'label' => __( 'User IP', 'elementor' ),
213	'value' => self::METADATA_REMOTE_IP,
214	],
215	[
216	'label' => __( 'User Agent', 'elementor' ),
217	'value' => self::METADATA_USER_AGENT,
218	],
219	] )
220	->set_label( __( 'Include metadata', 'elementor' ) ),
221	] ),
222	Section::make()
223	->set_label( __( 'Webhook', 'elementor' ) )
224	->set_items( [
225	Text_Control::bind_to( 'webhook_url' )
226	->set_placeholder( __( 'https://your-webhook-url.com', 'elementor' ) )
227	->set_label( __( 'Webhook URL', 'elementor' ) ),
228	] ),
229	Section::make()
230	->set_label( __( 'Settings', 'elementor' ) )
231	->set_id( 'settings' )
232	->set_items( [
233	Text_Control::bind_to( '_cssid' )
234	->set_label( __( 'ID', 'elementor' ) )
235	->set_meta( $this->get_css_id_control_meta() ),
236	Switch_Control::bind_to( 'webmcp-autosubmit' )
237	->set_label( __( 'Agent auto-submit', 'elementor' ) ),
238	] ),
239	];
240	}
241
242	protected function define_base_settings(): array {
243	$settings = [];
244
245	foreach ( self::build_email_action_defaults() as $key => $default_email ) {
246	$settings[ $key ] = Emails_Prop_Type::generate( $default_email );
247	}
248
249	return $settings;
250	}
251
252	protected function define_base_styles(): array {
253	return [
254	static::BASE_STYLE_KEY => Style_Definition::make()
255	->add_variant(
256	Style_Variant::make()
257	->set_breakpoint( Breakpoints_Manager::BREAKPOINT_KEY_DESKTOP )
258	->add_prop( 'display', String_Prop_Type::generate( 'flex' ) )
259	->add_prop( 'flex', String_Prop_Type::generate( '1' ) )
260	->add_prop( 'flex-direction', String_Prop_Type::generate( 'row' ) )
261	->add_prop( 'flex-wrap', String_Prop_Type::generate( 'wrap' ) )
262	->add_prop( 'align-items', String_Prop_Type::generate( 'flex-start' ) )
263	->add_prop( 'align-content', String_Prop_Type::generate( 'start' ) )
264	->add_prop( 'gap', Size_Prop_Type::generate( [
265	'size' => 10,
266	'unit' => 'px',
267	] ) )
268	->add_prop( 'padding', Size_Prop_Type::generate( [
269	'size' => 20,
270	'unit' => 'px',
271	] ) )
272	),
273	static::BASE_STYLE_KEY . ' .e-form-checkbox-row' => Style_Definition::make()
274	->add_variant(
275	Style_Variant::make()
276	->add_prop( 'align-items', String_Prop_Type::generate( 'center' ) )
277	->add_prop( 'gap', Size_Prop_Type::generate( [
278	'size' => 8,
279	'unit' => 'px',
280	] ) )
281	->add_prop( 'padding', Size_Prop_Type::generate( [
282	'size' => 0,
283	'unit' => 'px',
284	] ) )
285	),
286	];
287	}
288
289	protected function define_panel_categories(): array {
290	return [ 'atomic-form' ];
291	}
292
293	protected function define_default_children() {
294
295	$prefix = 'e-form-';
296
297	$children = [
298	$this->build_label( __( 'First name', 'elementor' ), $prefix . 'first-name' ),
299	$this->build_input( __( 'First name', 'elementor' ), 'text', $prefix . 'first-name' ),
300
301	$this->build_label( __( 'Last name', 'elementor' ), $prefix . 'last-name' ),
302	$this->build_input( __( 'Last name', 'elementor' ), 'text', $prefix . 'last-name' ),
303
304	$this->build_label( __( 'Email', 'elementor' ), $prefix . 'email' ),
305	$this->build_input( __( 'your@mail.com', 'elementor' ), 'email', $prefix . 'email' ),
306
307	$this->build_label( __( 'Message', 'elementor' ), $prefix . 'message' ),
308	$this->build_input( __( 'Your message', 'elementor' ), 'textarea', $prefix . 'message' ),
309	];
310
311	$children[] = $this->build_checkbox_row( __( 'Checkbox', 'elementor' ), $prefix . 'checkbox' );
312
313	$children[] = Widget_Builder::make( 'e-form-submit-button' )
314	->settings( [
315	'text' => Escaped_Html_Prop_Type::generate( __( 'Submit', 'elementor' ) ),
316	] )
317	->build();
318	$children[] = $this->build_status_message(
319	__( 'Great! We’ve received your information.', 'elementor' ),
320	'success',
321	__( 'Success message', 'elementor' )
322	);
323	$children[] = $this->build_status_message(
324	__( 'We couldn’t process your submission. Please retry', 'elementor' ),
325	'error',
326	__( 'Error message', 'elementor' )
327	);
328
329	return $children;
330	}
331
332	private function build_checkbox_row( string $label_text, string $checkbox_id ): array {
333	$checkbox = Widget_Builder::make( 'e-form-checkbox' )
334	->settings( [
335	'_cssid' => String_Prop_Type::generate( $checkbox_id ),
336	] )
337	->build();
338
339	$label = $this->build_label( $label_text, $checkbox_id );
340
341	return Element_Builder::make( 'e-flexbox' )
342	->children( [ $checkbox, $label ] )
343	->settings( [
344	'classes' => Classes_Prop_Type::generate( [ 'e-form-checkbox-row' ] ),
345	] )
346	->build();
347	}
348
349	private function build_label( string $text, string $input_id ): array {
350	return Widget_Builder::make( 'e-form-label' )
351	->settings( [
352	'text' => Escaped_Html_Prop_Type::generate( $text ),
353	'input-id' => String_Prop_Type::generate( $input_id ),
354	] )
355	->build();
356	}
357
358	private function build_input( string $placeholder, string $type = 'text', $input_id = '' ): array {
359	if ( 'textarea' === $type ) {
360	return Widget_Builder::make( 'e-form-textarea' )
361	->settings( [
362	'placeholder' => String_Prop_Type::generate( $placeholder ),
363	'rows' => Number_Prop_Type::generate( 4 ),
364	'_cssid' => String_Prop_Type::generate( $input_id ),
365	] )
366	->build();
367	}
368
369	return Widget_Builder::make( 'e-form-input' )
370	->settings( [
371	'placeholder' => String_Prop_Type::generate( $placeholder ),
372	'type' => String_Prop_Type::generate( $type ),
373	'_cssid' => String_Prop_Type::generate( $input_id ),
374	] )
375	->build();
376	}
377
378	private function build_status_message( string $message, string $state, string $title ): array {
379	$paragraph_value = Escaped_Html_Prop_Type::generate( $message );
380
381	$element_type = 'success' === $state
382	? Form_Success_Message::get_element_type()
383	: Form_Error_Message::get_element_type();
384
385	return Element_Builder::make( $element_type )
386	->meta( [ 'required' => true ] )
387	->settings( [
388	'attributes' => Attributes_Prop_Type::generate( [
389	Key_Value_Prop_Type::generate( [] ),
390	] ),
391	] )
392	->editor_settings( [
393	'title' => $title,
394	] )
395	->children( [
396	Widget_Builder::make( Atomic_Paragraph::get_element_type() )
397	->settings( [
398	'paragraph' => $paragraph_value,
399	] )
400	->build(),
401	] )
402	->build();
403	}
404
405	protected function get_templates(): array {
406	return [
407	'elementor/elements/atomic-form' => __DIR__ . '/atomic-form.html.twig',
408	];
409	}
410
411	protected function build_template_context(): array {
412	$context = $this->build_base_template_context();
413
414	$context['form_state'] = 'default';
415
416	if ( ! $this->is_webmcp_enabled() ) {
417	return $context;
418	}
419
420	$form_name = (string) ( $this->get_atomic_settings()['form-name'] ?? '' );
421	$context['webmcp_tool_name'] = Webmcp_Utils::build_tool_name( $form_name, (string) $this->get_id() );
422	$context['webmcp_tool_description'] = Webmcp_Utils::build_tool_description( $form_name );
423
424	return $context;
425	}
426
427	private function is_webmcp_enabled(): bool {
428	return ! Plugin::$instance->editor->is_edit_mode();
429	}
430
431	public static function is_instance_form( $instance ): bool {
432	return $instance instanceof Atomic_Form;
433	}
434
435	public function render_markdown(): string {
436	return '';
437	}
438
439	private static function get_emails_prop_settings(): array {
440	$props = [];
441
442	foreach ( self::build_email_action_defaults() as $key => $default_value ) {
443	$props[ $key ] = Emails_Prop_Type::make()
444	->set_dependencies( self::make_action_dependency( $key ) )
445	->meta( Overridable_Prop_Type::ignore() )
446	->initial_value( $default_value )
447	->default( $default_value );
448	}
449
450	return $props;
451	}
452
453	private function get_emails_control_settings(): array {
454	$form_action_chips = [];
455	$email_controls = [];
456
457	for ( $i = 0; $i < self::get_email_action_count(); $i++ ) {
458	$key = self::get_email_action_key( $i );
459	$label = self::get_email_action_label( $i );
460
461	$form_action_chips[] = [
462	'label' => $label,
463	'value' => $key,
464	];
465
466	$email_controls[] = Section::make()
467	->set_label( $label )
468	->set_items( [
469	Email_Form_Action_Control::bind_to( $key )
470	->set_free_chips( true )
471	->set_label( $label ),
472	] );
473	}
474
475	return [
476	'form-action-chips' => $form_action_chips,
477	'email-controls' => $email_controls,
478	];
479	}
480
481	private static function get_email_action_key( int $index ): string {
482	return 0 === $index
483	? self::ACTION_EMAIL
484	: self::ACTION_EMAIL . '_' . ( $index + 1 );
485	}
486
487	private static function get_email_action_label( int $index ): string {
488	if ( 0 === $index ) {
489	return __( 'Email', 'elementor' );
490	}
491
492	// translators: %d is the index of the email action.
493	return sprintf( __( 'Email %d', 'elementor' ), $index + 1 );
494	}
495
496	private static function build_email_action_defaults(): array {
497	$defaults = [];
498	$default_email = self::get_default_email_value();
499
500	for ( $i = 0; $i < self::get_email_action_count(); $i++ ) {
501	$key = self::get_email_action_key( $i );
502	$defaults[ $key ] = $default_email;
503	}
504
505	return $defaults;
506	}
507
508	private static function get_default_email_value(): array {
509	return [
510	'to' => String_Array_Prop_Type::generate( [
511	String_Prop_Type::generate( self::get_default_recipient_email() ),
512	] ),
513	'from' => String_Prop_Type::generate( self::get_default_sender_email() ),
514	'message' => String_Prop_Type::generate( '[all-fields]' ),
515	];
516	}
517
518	private static function make_action_dependency( string $action_key ): ?array {
519	return Dependency_Manager::make()
520	->where( [
521	'operator' => 'contains',
522	'path' => [ 'actions-after-submit' ],
523	'value' => $action_key,
524	'effect' => 'hide',
525	] )
526	->get();
527	}
528
529	private static function get_email_action_count(): int {
530	return apply_filters( 'elementor/atomic/form/email_action_count', 1 );
531	}
532	}
533