← All changes | modules/atomic-widgets/elements/atomic-form/atomic-form.php +254 -85 4.0.9 → 4.3.2 View file →

		@@ -3,8 +3,9 @@
3	3
4	4	use Elementor\Modules\AtomicWidgets\Controls\Section;
5	5	use Elementor\Modules\AtomicWidgets\Controls\Types\Chips_Control;
6	6	use Elementor\Modules\AtomicWidgets\Controls\Types\Email_Form_Action_Control;
	7	+use Elementor\Modules\AtomicWidgets\Controls\Types\Switch_Control;
7	8	use Elementor\Modules\AtomicWidgets\Controls\Types\Text_Control;
8	9	use Elementor\Modules\AtomicWidgets\Controls\Types\Toggle_Control;
9	10	use Elementor\Modules\AtomicWidgets\Elements\Atomic_Paragraph\Atomic_Paragraph;
10	11	use Elementor\Modules\AtomicWidgets\Elements\Atomic_Form\Form_Success_Message\Form_Success_Message;
		@@ -11,17 +12,19 @@
11	12	use Elementor\Modules\AtomicWidgets\Elements\Atomic_Form\Form_Error_Message\Form_Error_Message;
12	13	use Elementor\Modules\AtomicWidgets\Elements\Base\Atomic_Element_Base;
13	14	use Elementor\Modules\AtomicWidgets\Elements\Base\Element_Builder;
14	15	use Elementor\Modules\AtomicWidgets\Elements\Base\Has_Element_Template;
	16	+use Elementor\Modules\AtomicWidgets\Elements\Base\Html_Tag_Computer;
15	17	use Elementor\Modules\AtomicWidgets\Elements\Base\Widget_Builder;
16	18	use Elementor\Modules\AtomicWidgets\PropDependencies\Manager as Dependency_Manager;
17	19	use Elementor\Modules\AtomicWidgets\PropTypes\Attributes_Prop_Type;
18	20	use Elementor\Modules\AtomicWidgets\PropTypes\Classes_Prop_Type;
19		-use Elementor\Modules\AtomicWidgets\PropTypes\Email_Prop_Type;
	21	+use Elementor\Modules\AtomicWidgets\PropTypes\Emails_Prop_Type;
20	22	use Elementor\Modules\AtomicWidgets\PropTypes\Key_Value_Prop_Type;
	23	+use Elementor\Modules\AtomicWidgets\PropTypes\Primitives\Boolean_Prop_Type;
21	24	use Elementor\Modules\AtomicWidgets\PropTypes\Primitives\Number_Prop_Type;
22	25	use Elementor\Modules\AtomicWidgets\PropTypes\Size_Prop_Type;
23		-use Elementor\Modules\AtomicWidgets\PropTypes\Html_V3_Prop_Type;
	26	+use Elementor\Modules\AtomicWidgets\PropTypes\Escaped_Html_Prop_Type;
24	27	use Elementor\Modules\AtomicWidgets\PropTypes\Primitives\String_Array_Prop_Type;
25	28	use Elementor\Modules\AtomicWidgets\PropTypes\Primitives\String_Prop_Type;
26	29	use Elementor\Modules\AtomicWidgets\Styles\Style_Definition;
27	30	use Elementor\Modules\AtomicWidgets\Styles\Style_Variant;
		@@ -26,8 +29,9 @@
26	29	use Elementor\Modules\AtomicWidgets\Styles\Style_Definition;
27	30	use Elementor\Modules\AtomicWidgets\Styles\Style_Variant;
28	31	use Elementor\Core\Breakpoints\Manager as Breakpoints_Manager;
29	32	use Elementor\Modules\Components\PropTypes\Overridable_Prop_Type;
	33	+use Elementor\Plugin;
30	34
31	35	if ( ! defined( 'ABSPATH' ) ) {
32	36	exit; // Exit if accessed directly.
33	37	}
		@@ -36,17 +40,32 @@
36	40	use Has_Element_Template;
37	41
38	42	const BASE_STYLE_KEY = 'base';
39	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';
40	47	public const ACTION_COLLECT_SUBMISSIONS = 'collect-submissions';
	48	+ public const ACTION_WEBHOOK = 'webhook';
41	49	public const METADATA_REMOTE_IP = 'remote_ip';
42	50	public const METADATA_USER_AGENT = 'user_agent';
43	51
	52	+
	53	+
44	54	public function __construct( $data = [], $args = null ) {
45	55	parent::__construct( $data, $args );
46	56	$this->meta( 'is_container', true );
	57	+ $this->meta( 'is_compound', true );
47	58	}
48	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	+
49	68	public static function get_type() {
50	69	return 'e-form';
51	70	}
52	71
		@@ -65,38 +84,49 @@
65	84	public function get_icon() {
66	85	return 'eicon-atomic-form';
67	86	}
68	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	+
69	96	protected static function define_props_schema(): array {
70		- $email_dependencies = Dependency_Manager::make()
	97	+ $submissions_metadata_dependencies = Dependency_Manager::make()
71	98	->where( [
72	99	'operator' => 'contains',
73	100	'path' => [ 'actions-after-submit' ],
74		- 'value' => 'email',
	101	+ 'value' => self::ACTION_COLLECT_SUBMISSIONS,
75	102	'effect' => 'hide',
76	103	] )
77	104	->get();
78	105
79		- $submissions_metadata_dependencies = Dependency_Manager::make()
	106	+ $webhook_dependencies = Dependency_Manager::make()
80	107	->where( [
81	108	'operator' => 'contains',
82	109	'path' => [ 'actions-after-submit' ],
83		- 'value' => self::ACTION_COLLECT_SUBMISSIONS,
	110	+ 'value' => self::ACTION_WEBHOOK,
84	111	'effect' => 'hide',
85	112	] )
86	113	->get();
87	114
88		- return [
	115	+ $props = [
89	116	'classes' => Classes_Prop_Type::make()
90	117	->default( [] ),
91	118	'form-name' => String_Prop_Type::make()
92	119	->default( __( 'Form', 'elementor' ) ),
	120	+ 'webmcp-autosubmit' => Boolean_Prop_Type::make()
	121	+ ->default( false ),
93	122	'form-state' => String_Prop_Type::make()
94	123	->enum( [ 'default', 'success', 'error' ] )
95	124	->default( 'default' )
96	125	->meta( 'generates_class', 'form-state-{value}' ),
97	126	'actions-after-submit' => String_Array_Prop_Type::make()
98		- ->default( [ String_Prop_Type::generate( 'email' ) ] ),
	127	+ ->initial_value( [ String_Prop_Type::generate( self::ACTION_EMAIL ) ] )
	128	+ ->default( [ String_Prop_Type::generate( self::ACTION_EMAIL ) ] ),
99	129	'submissions_metadata' => String_Array_Prop_Type::make()
100	130	->set_dependencies( $submissions_metadata_dependencies )
101	131	->default( [
102	132	String_Prop_Type::generate( self::METADATA_REMOTE_IP ),
		@@ -101,63 +131,83 @@
101	131	->default( [
102	132	String_Prop_Type::generate( self::METADATA_REMOTE_IP ),
103	133	String_Prop_Type::generate( self::METADATA_USER_AGENT ),
104	134	] ),
105		- 'email' => Email_Prop_Type::make()
106		- ->set_dependencies( $email_dependencies )
	135	+ ];
	136	+
	137	+ $props = array_merge( $props, self::get_emails_prop_settings(), [
	138	+ 'webhook_url' => String_Prop_Type::make()
	139	+ ->set_dependencies( $webhook_dependencies )
107	140	->meta( Overridable_Prop_Type::ignore() )
108		- ->default( [] ),
	141	+ ->default( '' ),
109	142	'attributes' => Attributes_Prop_Type::make()->meta( Overridable_Prop_Type::ignore() ),
110		- ];
	143	+ ] );
	144	+
	145	+ return $props;
111	146	}
112	147
113	148	protected function define_atomic_controls(): array {
114	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 )
115	165	->set_label( __( 'States', 'elementor' ) )
116	166	->set_meta( [ 'topDivider' => true ] );
117	167
118		- if ( $state_control instanceof Toggle_Control ) {
119		- $state_control
120		- ->add_options( [
121		- 'default' => [
122		- 'title' => __( 'Normal', 'elementor' ),
	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,
123	180	],
124		- 'success' => [
125		- 'title' => __( 'Success', 'elementor' ),
	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,
126	194	],
127		- 'error' => [
128		- 'title' => __( 'Error', 'elementor' ),
129		- ],
130		- ] )
131		- ->set_exclusive( true )
132		- ->set_convert_options( true )
133		- ->set_size( 'tiny' )
134		- ->set_full_width( true );
135		- }
	195	+ ] ) )
	196	+ ->set_label( __( 'Actions after submit', 'elementor' ) )
	197	+ ->set_meta( [ 'topDivider' => true ] ),
	198	+ ];
136	199
137	200	return [
138	201	Section::make()
139	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' ) )
140	208	->set_items( [
141		- Text_Control::bind_to( 'form-name' )
142		- ->set_label( __( 'Form name', 'elementor' ) ),
143		- $state_control,
144		- Chips_Control::bind_to( 'actions-after-submit' )
145		- ->set_label( __( 'Actions after submit', 'elementor' ) )
146		- ->set_meta( [ 'topDivider' => true ] )
147		- ->set_options( [
148		- [
149		- 'label' => __( 'Collect submissions', 'elementor' ),
150		- 'value' => self::ACTION_COLLECT_SUBMISSIONS,
151		- ],
152		- [
153		- 'label' => __( 'Email', 'elementor' ),
154		- 'value' => 'email',
155		- ],
156		- ] ),
157	209	Chips_Control::bind_to( 'submissions_metadata' )
158		- ->set_label( __( 'Include metadata', 'elementor' ) )
159		- ->set_meta( [ 'topDivider' => true ] )
160	210	->set_options( [
161	211	[
162	212	'label' => __( 'User IP', 'elementor' ),
163	213	'value' => self::METADATA_REMOTE_IP,
		@@ -165,15 +215,19 @@
165	215	[
166	216	'label' => __( 'User Agent', 'elementor' ),
167	217	'value' => self::METADATA_USER_AGENT,
168	218	],
169		- ] ),
170		- Email_Form_Action_Control::bind_to( 'email' )
171		- ->set_meta( [
172		- 'topDivider' => true,
173		- ] ),
	219	+ ] )
	220	+ ->set_label( __( 'Include metadata', 'elementor' ) ),
174	221	] ),
175	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()
176	230	->set_label( __( 'Settings', 'elementor' ) )
177	231	->set_id( 'settings' )
178	232	->set_items( [
179	233	Text_Control::bind_to( '_cssid' )
		@@ -178,12 +232,24 @@
178	232	->set_items( [
179	233	Text_Control::bind_to( '_cssid' )
180	234	->set_label( __( 'ID', 'elementor' ) )
181	235	->set_meta( $this->get_css_id_control_meta() ),
	236	+ Switch_Control::bind_to( 'webmcp-autosubmit' )
	237	+ ->set_label( __( 'Agent auto-submit', 'elementor' ) ),
182	238	] ),
183	239	];
184	240	}
185	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	+
186	252	protected function define_base_styles(): array {
187	253	return [
188	254	static::BASE_STYLE_KEY => Style_Definition::make()
189	255	->add_variant(
		@@ -223,17 +289,13 @@
223	289	protected function define_panel_categories(): array {
224	290	return [ 'atomic-form' ];
225	291	}
226	292
227		- protected function define_default_html_tag() {
228		- return 'form';
229		- }
230		-
231	293	protected function define_default_children() {
232	294
233	295	$prefix = 'e-form-';
234	296
235		- return [
	297	+ $children = [
236	298	$this->build_label( __( 'First name', 'elementor' ), $prefix . 'first-name' ),
237	299	$this->build_input( __( 'First name', 'elementor' ), 'text', $prefix . 'first-name' ),
238	300
239	301	$this->build_label( __( 'Last name', 'elementor' ), $prefix . 'last-name' ),
		@@ -243,30 +305,29 @@
243	305	$this->build_input( __( '[email protected]', 'elementor' ), 'email', $prefix . 'email' ),
244	306
245	307	$this->build_label( __( 'Message', 'elementor' ), $prefix . 'message' ),
246	308	$this->build_input( __( 'Your message', 'elementor' ), 'textarea', $prefix . 'message' ),
	309	+ ];
247	310
248		- $this->build_checkbox_row( __( 'Checkbox', 'elementor' ), $prefix . 'checkbox' ),
	311	+ $children[] = $this->build_checkbox_row( __( 'Checkbox', 'elementor' ), $prefix . 'checkbox' );
249	312
250		- Widget_Builder::make( 'e-form-submit-button' )
251		- ->settings( [
252		- 'text' => Html_V3_Prop_Type::generate( [
253		- 'content' => String_Prop_Type::generate( __( 'Submit', 'elementor' ) ),
254		- 'children' => [],
255		- ] ),
256		- ] )
257		- ->build(),
258		- $this->build_status_message(
259		- __( 'Great! We’ve received your information.', 'elementor' ),
260		- 'success',
261		- __( 'Success message', 'elementor' )
262		- ),
263		- $this->build_status_message(
264		- __( 'We couldn’t process your submission. Please retry', 'elementor' ),
265		- 'error',
266		- __( 'Error message', 'elementor' )
267		- ),
268		- ];
	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;
269	330	}
270	331
271	332	private function build_checkbox_row( string $label_text, string $checkbox_id ): array {
272	333	$checkbox = Widget_Builder::make( 'e-form-checkbox' )
		@@ -287,12 +348,9 @@
287	348
288	349	private function build_label( string $text, string $input_id ): array {
289	350	return Widget_Builder::make( 'e-form-label' )
290	351	->settings( [
291		- 'text' => Html_V3_Prop_Type::generate( [
292		- 'content' => String_Prop_Type::generate( $text ),
293		- 'children' => [],
294		- ] ),
	352	+ 'text' => Escaped_Html_Prop_Type::generate( $text ),
295	353	'input-id' => String_Prop_Type::generate( $input_id ),
296	354	] )
297	355	->build();
298	356	}
		@@ -317,12 +375,9 @@
317	375	->build();
318	376	}
319	377
320	378	private function build_status_message( string $message, string $state, string $title ): array {
321		- $paragraph_value = Html_V3_Prop_Type::generate( [
322		- 'content' => String_Prop_Type::generate( $message ),
323		- 'children' => [],
324		- ] );
	379	+ $paragraph_value = Escaped_Html_Prop_Type::generate( $message );
325	380
326	381	$element_type = 'success' === $state
327	382	? Form_Success_Message::get_element_type()
328	383	: Form_Error_Message::get_element_type();
		@@ -327,8 +382,9 @@
327	382	? Form_Success_Message::get_element_type()
328	383	: Form_Error_Message::get_element_type();
329	384
330	385	return Element_Builder::make( $element_type )
	386	+ ->meta( [ 'required' => true ] )
331	387	->settings( [
332	388	'attributes' => Attributes_Prop_Type::generate( [
333	389	Key_Value_Prop_Type::generate( [] ),
334	390	] ),
		@@ -342,9 +398,8 @@
342	398	'paragraph' => $paragraph_value,
343	399	] )
344	400	->build(),
345	401	] )
346		- ->is_locked( true )
347	402	->build();
348	403	}
349	404
350	405	protected function get_templates(): array {
		@@ -357,7 +412,121 @@
357	412	$context = $this->build_base_template_context();
358	413
359	414	$context['form_state'] = 'default';
360	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	+
361	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 );
362	531	}
363	532	}