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

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