automatorwp / integrations / wpforms / includes / triggers / submit-form.php

submit-form.php in AutomatorWP – No-Code Workflow Automation, Integration & Webhooks Plugin, now with AI 5.8.6, at integrations/wpforms/includes/triggers/submit-form.php

198 lines 6.5 KB

Raw Download Zip

1	<?php
2	/**
3	* Submit Form
4	*
5	* @package AutomatorWP\Integrations\WPForms\Triggers\Submit_Form
6	* @author AutomatorWP <[email protected]>, Ruben Garcia <[email protected]>
7	* @since 1.0.0
8	*/
9	// Exit if accessed directly
10	if( !defined( 'ABSPATH' ) ) exit;
11
12	class AutomatorWP_WPForms_Submit_Form extends AutomatorWP_Integration_Trigger {
13
14	public $integration = 'wpforms';
15	public $trigger = 'wpforms_submit_form';
16
17	/**
18	* Register the trigger
19	*
20	* @since 1.0.0
21	*/
22	public function register() {
23
24	automatorwp_register_trigger( $this->trigger, array(
25	'integration' => $this->integration,
26	'label' => __( 'User submits a form', 'automatorwp' ),
27	'select_option' => __( 'User submits <strong>a form</strong>', 'automatorwp' ),
28	/* translators: %1$s: Post title. %2$s: Number of times. */
29	'edit_label' => sprintf( __( 'User submits %1$s %2$s time(s)', 'automatorwp' ), '{post}', '{times}' ),
30	/* translators: %1$s: Post title. */
31	'log_label' => sprintf( __( 'User submits %1$s', 'automatorwp' ), '{post}' ),
32	'action' => 'wpforms_process_complete',
33	'function' => array( $this, 'listener' ),
34	'priority' => 10,
35	'accepted_args' => 4,
36	'options' => array(
37	'post' => automatorwp_utilities_post_option( array(
38	'name' => __( 'Form:', 'automatorwp' ),
39	'option_none_label' => __( 'any form', 'automatorwp' ),
40	'post_type' => 'wpforms'
41	) ),
42	'times' => automatorwp_utilities_times_option(),
43	),
44	'tags' => array_merge(
45	array(
46	'form_field:FIELD_NAME' => array(
47	'label' => __( 'Form field value', 'automatorwp' ),
48	'type' => 'text',
49	'preview' => __( 'Form field value, replace "FIELD_NAME" by the field name', 'automatorwp' ),
50	),
51	),
52	automatorwp_utilities_post_tags(),
53	automatorwp_utilities_times_tag()
54	)
55	) );
56
57	}
58
59	/**
60	* Trigger listener
61	*
62	* @since 1.0.0
63	*
64	* @param $fields
65	* @param $entry
66	* @param $form_data
67	* @param $entry_id
68	*/
69	public function listener( $fields, $entry, $form_data, $entry_id ) {
70
71	// Login is required
72	if ( ! is_user_logged_in() ) {
73	return;
74	}
75
76	$user_id = get_current_user_id();
77	$form_id = absint( $form_data['id'] );
78	$form_fields = automatorwp_wpforms_get_form_fields_values( $fields );
79
80	// Trigger submit form event
81	automatorwp_trigger_event( array(
82	'trigger' => $this->trigger,
83	'user_id' => $user_id,
84	'post_id' => $form_id,
85	'form_fields' => $form_fields,
86	) );
87
88	}
89
90	/**
91	* User deserves check
92	*
93	* @since 1.0.0
94	*
95	* @param bool $deserves_trigger True if user deserves trigger, false otherwise
96	* @param stdClass $trigger The trigger object
97	* @param int $user_id The user ID
98	* @param array $event Event information
99	* @param array $trigger_options The trigger's stored options
100	* @param stdClass $automation The trigger's automation object
101	*
102	* @return bool True if user deserves trigger, false otherwise
103	*/
104	public function user_deserves_trigger( $deserves_trigger, $trigger, $user_id, $event, $trigger_options, $automation ) {
105
106	// Don't deserve if post is not received
107	if( ! isset( $event['post_id'] ) ) {
108	return false;
109	}
110
111	// Don't deserve if post doesn't match with the trigger option
112	if( ! automatorwp_posts_matches( $event['post_id'], $trigger_options['post'] ) ) {
113	return false;
114	}
115
116	return $deserves_trigger;
117
118	}
119
120	/**
121	* Register the required hooks
122	*
123	* @since 1.0.0
124	*/
125	public function hooks() {
126
127	// Log meta data
128	add_filter( 'automatorwp_user_completed_trigger_log_meta', array( $this, 'log_meta' ), 10, 6 );
129
130	// Log fields
131	add_filter( 'automatorwp_log_fields', array( $this, 'log_fields' ), 10, 5 );
132
133	parent::hooks();
134	}
135
136	/**
137	* Trigger custom log meta
138	*
139	* @since 1.0.0
140	*
141	* @param array $log_meta Log meta data
142	* @param stdClass $trigger The trigger object
143	* @param int $user_id The user ID
144	* @param array $event Event information
145	* @param array $trigger_options The trigger's stored options
146	* @param stdClass $automation The trigger's automation object
147	*
148	* @return array
149	*/
150	function log_meta( $log_meta, $trigger, $user_id, $event, $trigger_options, $automation ) {
151
152	// Bail if action type don't match this action
153	if( $trigger->type !== $this->trigger ) {
154	return $log_meta;
155	}
156
157	$log_meta['form_fields'] = ( isset( $event['form_fields'] ) ? $event['form_fields'] : array() );
158
159	return $log_meta;
160
161	}
162
163	/**
164	* Action custom log fields
165	*
166	* @since 1.0.0
167	*
168	* @param array $log_fields The log fields
169	* @param stdClass $log The log object
170	* @param stdClass $object The trigger/action/automation object attached to the log
171	*
172	* @return array
173	*/
174	public function log_fields( $log_fields, $log, $object ) {
175
176	// Bail if log is not assigned to an trigger
177	if( $log->type !== 'trigger' ) {
178	return $log_fields;
179	}
180
181	// Bail if trigger type don't match this trigger
182	if( $object->type !== $this->trigger ) {
183	return $log_fields;
184	}
185
186	$log_fields['form_fields'] = array(
187	'name' => __( 'Fields Submitted', 'automatorwp' ),
188	'desc' => __( 'Information about the fields values sent on this form submission.', 'automatorwp' ),
189	'type' => 'text',
190	);
191
192	return $log_fields;
193
194	}
195
196	}
197
198	new AutomatorWP_WPForms_Submit_Form();