← All changes | integrations/weforms/includes/triggers/submit-form.php +199 -0 5.8.4 → 6.0.3 View file →

		@@ -1,0 +1,199 @@
	1	+<?php
	2	+/**
	3	+ * Submit Form
	4	+ *
	5	+ * @package AutomatorWP\Integrations\weForms\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_weForms_Submit_Form extends AutomatorWP_Integration_Trigger {
	13	+
	14	+ public $integration = 'weforms';
	15	+ public $trigger = 'weforms_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' => 'weforms_entry_submission',
	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' => 'wpuf_contact_form',
	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_times_tag()
	53	+ )
	54	+ ) );
	55	+
	56	+ }
	57	+
	58	+ /**
	59	+ * Trigger listener
	60	+ *
	61	+ * @since 1.0.0
	62	+ *
	63	+ * @param int $entry_id
	64	+ * @param array $form_id
	65	+ * @param int $page_id
	66	+ * @param array $form_settings
	67	+ */
	68	+ public function listener( $entry_id, $form_id, $page_id, $form_settings ) {
	69	+
	70	+ $user_id = get_current_user_id();
	71	+
	72	+ // Login is required
	73	+ if ( $user_id === 0 ) {
	74	+ return;
	75	+ }
	76	+
	77	+ $form = get_post( $form_id);
	78	+
	79	+ $form_fields = automatorwp_weforms_get_form_fields_values( $form, $entry_id );
	80	+
	81	+ // Trigger submit form field value event
	82	+ automatorwp_trigger_event( array(
	83	+ 'trigger' => $this->trigger,
	84	+ 'user_id' => $user_id,
	85	+ 'form_id' => $form_id,
	86	+ 'form_fields' => $form_fields,
	87	+ ) );
	88	+
	89	+ }
	90	+
	91	+ /**
	92	+ * User deserves check
	93	+ *
	94	+ * @since 1.0.0
	95	+ *
	96	+ * @param bool $deserves_trigger True if user deserves trigger, false otherwise
	97	+ * @param stdClass $trigger The trigger object
	98	+ * @param int $user_id The user ID
	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 user deserves trigger, false otherwise
	104	+ */
	105	+ public function user_deserves_trigger( $deserves_trigger, $trigger, $user_id, $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' && absint( $event['form_id'] ) !== absint( $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_weForms_Submit_Form();