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

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

201 lines 6.8 KB

Raw Download Zip

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