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

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

200 lines 6.8 KB

Raw Download Zip

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