← All changes | integrations/forminator/includes/triggers/submit-form.php +197 -0 5.7.6 → 6.0.3 View file →

		@@ -1,0 +1,197 @@
	1	+<?php
	2	+/**
	3	+ * Submit Form
	4	+ *
	5	+ * @package AutomatorWP\Integrations\Forminator\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_Forminator_Submit_Form extends AutomatorWP_Integration_Trigger {
	13	+
	14	+ public $integration = 'forminator';
	15	+ public $trigger = 'forminator_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' => 'forminator_custom_form_submit_before_set_fields',
	33	+ 'function' => array( $this, 'listener' ),
	34	+ 'priority' => 10,
	35	+ 'accepted_args' => 3,
	36	+ 'options' => array(
	37	+ 'post' => automatorwp_utilities_post_option( array(
	38	+ 'name' => __( 'Form:', 'automatorwp' ),
	39	+ 'option_none_label' => __( 'any form', 'automatorwp' ),
	40	+ 'post_type' => 'forminator_forms'
	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 Forminator_Form_Entry_Model $entry - the entry model
	65	+ * @param int $form_id - the form id
	66	+ * @param array $field_data - the entry data
	67	+ */
	68	+ public function listener( $entry, $form_id, $field_data ) {
	69	+
	70	+ $user_id = get_current_user_id();
	71	+
	72	+ // Bail if user is not logged in
	73	+ if( $user_id === 0 ) {
	74	+ return;
	75	+ }
	76	+
	77	+ $form_fields = automatorwp_forminator_get_form_fields_values( $field_data, 'name', 'value' );
	78	+
	79	+ // Trigger submit form event
	80	+ automatorwp_trigger_event( array(
	81	+ 'trigger' => $this->trigger,
	82	+ 'user_id' => $user_id,
	83	+ 'post_id' => $form_id,
	84	+ 'form_fields' => $form_fields,
	85	+ ) );
	86	+
	87	+ }
	88	+
	89	+ /**
	90	+ * User deserves check
	91	+ *
	92	+ * @since 1.0.0
	93	+ *
	94	+ * @param bool $deserves_trigger True if user deserves trigger, false otherwise
	95	+ * @param stdClass $trigger The trigger object
	96	+ * @param int $user_id The user ID
	97	+ * @param array $event Event information
	98	+ * @param array $trigger_options The trigger's stored options
	99	+ * @param stdClass $automation The trigger's automation object
	100	+ *
	101	+ * @return bool True if user deserves trigger, false otherwise
	102	+ */
	103	+ public function user_deserves_trigger( $deserves_trigger, $trigger, $user_id, $event, $trigger_options, $automation ) {
	104	+
	105	+ // Don't deserve if post is not received
	106	+ if( ! isset( $event['post_id'] ) ) {
	107	+ return false;
	108	+ }
	109	+
	110	+ // Don't deserve if post doesn't match with the trigger option
	111	+ if( ! automatorwp_posts_matches( $event['post_id'], $trigger_options['post'] ) ) {
	112	+ return false;
	113	+ }
	114	+
	115	+ return $deserves_trigger;
	116	+
	117	+ }
	118	+
	119	+ /**
	120	+ * Register the required hooks
	121	+ *
	122	+ * @since 1.0.0
	123	+ */
	124	+ public function hooks() {
	125	+
	126	+ // Log meta data
	127	+ add_filter( 'automatorwp_user_completed_trigger_log_meta', array( $this, 'log_meta' ), 10, 6 );
	128	+
	129	+ // Log fields
	130	+ add_filter( 'automatorwp_log_fields', array( $this, 'log_fields' ), 10, 5 );
	131	+
	132	+ parent::hooks();
	133	+ }
	134	+
	135	+ /**
	136	+ * Trigger custom log meta
	137	+ *
	138	+ * @since 1.0.0
	139	+ *
	140	+ * @param array $log_meta Log meta data
	141	+ * @param stdClass $trigger The trigger object
	142	+ * @param int $user_id The user ID
	143	+ * @param array $event Event information
	144	+ * @param array $trigger_options The trigger's stored options
	145	+ * @param stdClass $automation The trigger's automation object
	146	+ *
	147	+ * @return array
	148	+ */
	149	+ function log_meta( $log_meta, $trigger, $user_id, $event, $trigger_options, $automation ) {
	150	+
	151	+ // Bail if action type don't match this action
	152	+ if( $trigger->type !== $this->trigger ) {
	153	+ return $log_meta;
	154	+ }
	155	+
	156	+ $log_meta['form_fields'] = ( isset( $event['form_fields'] ) ? $event['form_fields'] : array() );
	157	+
	158	+ return $log_meta;
	159	+
	160	+ }
	161	+
	162	+ /**
	163	+ * Action custom log fields
	164	+ *
	165	+ * @since 1.0.0
	166	+ *
	167	+ * @param array $log_fields The log fields
	168	+ * @param stdClass $log The log object
	169	+ * @param stdClass $object The trigger/action/automation object attached to the log
	170	+ *
	171	+ * @return array
	172	+ */
	173	+ public function log_fields( $log_fields, $log, $object ) {
	174	+
	175	+ // Bail if log is not assigned to an trigger
	176	+ if( $log->type !== 'trigger' ) {
	177	+ return $log_fields;
	178	+ }
	179	+
	180	+ // Bail if trigger type don't match this trigger
	181	+ if( $object->type !== $this->trigger ) {
	182	+ return $log_fields;
	183	+ }
	184	+
	185	+ $log_fields['form_fields'] = array(
	186	+ 'name' => __( 'Fields Submitted', 'automatorwp' ),
	187	+ 'desc' => __( 'Information about the fields values sent on this form submission.', 'automatorwp' ),
	188	+ 'type' => 'text',
	189	+ );
	190	+
	191	+ return $log_fields;
	192	+
	193	+ }
	194	+
	195	+}
	196	+
	197	+new AutomatorWP_Forminator_Submit_Form();