automatorwp / integrations / caldera-forms / includes / triggers / anonymous-submit-form.php

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

199 lines 6.7 KB

Raw Download Zip

1	<?php
2	/**
3	* Submit Form
4	*
5	* @package AutomatorWP\Integrations\Caldera_Forms\Triggers\Anonymous_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_Caldera_Forms_Anonymous_Submit_Form extends AutomatorWP_Integration_Trigger {
13
14	public $integration = 'caldera_forms';
15	public $trigger = 'caldera_forms_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', 'automatorwp' ), '{post}' ),
31	/* translators: %1$s: Post title. */
32	'log_label' => sprintf( __( 'Guest submits %1$s', 'automatorwp' ), '{post}' ),
33	'action' => 'caldera_forms_submit_post_process',
34	'function' => array( $this, 'listener' ),
35	'priority' => 10,
36	'accepted_args' => 4,
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_caldera_forms_get_forms',
44	'options_cb' => 'automatorwp_caldera_forms_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 $form
69	* @param $referrer
70	* @param $process_id
71	* @param $entry_id
72	*/
73	public function listener( $form, $referrer, $process_id, $entry_id ) {
74
75	// Bail if user is logged in
76	if ( is_user_logged_in() ) {
77	return;
78	}
79
80	$form_id = $form['ID']; // Caldera Forms ID can be strings
81	$form_fields = automatorwp_caldera_forms_get_form_fields_values( $form, $entry_id );
82
83	// Trigger submit form event
84	automatorwp_trigger_event( array(
85	'trigger' => $this->trigger,
86	'form_id' => $form_id,
87	'form_fields' => $form_fields,
88	) );
89
90	}
91
92	/**
93	* Anonymous deserves check
94	*
95	* @since 1.0.0
96	*
97	* @param bool $deserves_trigger True if anonymous deserves trigger, false otherwise
98	* @param stdClass $trigger The trigger object
99	* @param array $event Event information
100	* @param array $trigger_options The trigger's stored options
101	* @param stdClass $automation The trigger's automation object
102	*
103	* @return bool True if anonymous deserves trigger, false otherwise
104	*/
105	public function anonymous_deserves_trigger( $deserves_trigger, $trigger, $event, $trigger_options, $automation ) {
106
107	// Don't deserve if post is not received
108	if( ! isset( $event['form_id'] ) ) {
109	return false;
110	}
111
112	// Bail if post doesn't match with the trigger option
113	if( $trigger_options['post'] !== 'any' && $event['form_id'] !== $trigger_options['post'] ) {
114	return false;
115	}
116
117	return $deserves_trigger;
118
119	}
120
121	/**
122	* Register the required hooks
123	*
124	* @since 1.0.0
125	*/
126	public function hooks() {
127
128	// Log meta data
129	add_filter( 'automatorwp_user_completed_trigger_log_meta', array( $this, 'log_meta' ), 10, 6 );
130
131	// Log fields
132	add_filter( 'automatorwp_log_fields', array( $this, 'log_fields' ), 10, 5 );
133
134	parent::hooks();
135	}
136
137	/**
138	* Trigger custom log meta
139	*
140	* @since 1.0.0
141	*
142	* @param array $log_meta Log meta data
143	* @param stdClass $trigger The trigger object
144	* @param int $user_id The user ID
145	* @param array $event Event information
146	* @param array $trigger_options The trigger's stored options
147	* @param stdClass $automation The trigger's automation object
148	*
149	* @return array
150	*/
151	function log_meta( $log_meta, $trigger, $user_id, $event, $trigger_options, $automation ) {
152
153	// Bail if action type don't match this action
154	if( $trigger->type !== $this->trigger ) {
155	return $log_meta;
156	}
157
158	$log_meta['form_fields'] = ( isset( $event['form_fields'] ) ? $event['form_fields'] : array() );
159
160	return $log_meta;
161
162	}
163
164	/**
165	* Action custom log fields
166	*
167	* @since 1.0.0
168	*
169	* @param array $log_fields The log fields
170	* @param stdClass $log The log object
171	* @param stdClass $object The trigger/action/automation object attached to the log
172	*
173	* @return array
174	*/
175	public function log_fields( $log_fields, $log, $object ) {
176
177	// Bail if log is not assigned to an trigger
178	if( $log->type !== 'trigger' ) {
179	return $log_fields;
180	}
181
182	// Bail if trigger type don't match this trigger
183	if( $object->type !== $this->trigger ) {
184	return $log_fields;
185	}
186
187	$log_fields['form_fields'] = array(
188	'name' => __( 'Fields Submitted', 'automatorwp' ),
189	'desc' => __( 'Information about the fields values sent on this form submission.', 'automatorwp' ),
190	'type' => 'text',
191	);
192
193	return $log_fields;
194
195	}
196
197	}
198
199	new AutomatorWP_Caldera_Forms_Anonymous_Submit_Form();