← All changes | integrations/contact-form-7/includes/triggers/submit-form.php +216 -0 5.7.2 → 6.0.4 View file →

		@@ -1,0 +1,216 @@
	1	+<?php
	2	+/**
	3	+ * Submit Form
	4	+ *
	5	+ * @package AutomatorWP\Integrations\Contact_Form_7\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_Contact_Form_7_Submit_Form extends AutomatorWP_Integration_Trigger {
	13	+
	14	+ public $integration = 'contact_form_7';
	15	+ public $trigger = 'contact_form_7_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' => 'wpcf7_submit',
	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' => 'wpcf7_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_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 WPCF7_ContactForm $form
	65	+ * @param array $result
	66	+ */
	67	+ public function listener( $form, $result ) {
	68	+
	69	+ // Check if form was correctly filled
	70	+ if( ! in_array( $result['status'], array( 'mail_sent', 'mail_failed' ) ) ) {
	71	+ return;
	72	+ }
	73	+
	74	+ $form_id = ( version_compare( WPCF7_VERSION, '4.8', '<' ) ) ? $form->id : $form->id();
	75	+ $user_id = get_current_user_id();
	76	+
	77	+ // Login is required
	78	+ if ( $user_id === 0 ) {
	79	+ return;
	80	+ }
	81	+
	82	+ // Check if form submission is correctly setup
	83	+ $submission = WPCF7_Submission::get_instance();
	84	+
	85	+ if ( ! $submission ) {
	86	+ return;
	87	+ }
	88	+
	89	+ // Check if posted data is correctly setup
	90	+ $posted_data = $submission->get_posted_data();
	91	+
	92	+ if ( ! $posted_data ) {
	93	+ return;
	94	+ }
	95	+
	96	+ $form_fields = automatorwp_contact_form_7_get_form_fields_values( $form, $submission );
	97	+
	98	+ // Trigger submit form event
	99	+ automatorwp_trigger_event( array(
	100	+ 'trigger' => $this->trigger,
	101	+ 'user_id' => $user_id,
	102	+ 'post_id' => $form_id,
	103	+ 'form_fields' => $form_fields,
	104	+ ) );
	105	+
	106	+ }
	107	+
	108	+ /**
	109	+ * User deserves check
	110	+ *
	111	+ * @since 1.0.0
	112	+ *
	113	+ * @param bool $deserves_trigger True if user deserves trigger, false otherwise
	114	+ * @param stdClass $trigger The trigger object
	115	+ * @param int $user_id The user ID
	116	+ * @param array $event Event information
	117	+ * @param array $trigger_options The trigger's stored options
	118	+ * @param stdClass $automation The trigger's automation object
	119	+ *
	120	+ * @return bool True if user deserves trigger, false otherwise
	121	+ */
	122	+ public function user_deserves_trigger( $deserves_trigger, $trigger, $user_id, $event, $trigger_options, $automation ) {
	123	+
	124	+ // Don't deserve if post is not received
	125	+ if( ! isset( $event['post_id'] ) ) {
	126	+ return false;
	127	+ }
	128	+
	129	+ // Don't deserve if post doesn't match with the trigger option
	130	+ if( ! automatorwp_posts_matches( $event['post_id'], $trigger_options['post'] ) ) {
	131	+ return false;
	132	+ }
	133	+
	134	+ return $deserves_trigger;
	135	+
	136	+ }
	137	+
	138	+ /**
	139	+ * Register the required hooks
	140	+ *
	141	+ * @since 1.0.0
	142	+ */
	143	+ public function hooks() {
	144	+
	145	+ // Log meta data
	146	+ add_filter( 'automatorwp_user_completed_trigger_log_meta', array( $this, 'log_meta' ), 10, 6 );
	147	+
	148	+ // Log fields
	149	+ add_filter( 'automatorwp_log_fields', array( $this, 'log_fields' ), 10, 5 );
	150	+
	151	+ parent::hooks();
	152	+ }
	153	+
	154	+ /**
	155	+ * Trigger custom log meta
	156	+ *
	157	+ * @since 1.0.0
	158	+ *
	159	+ * @param array $log_meta Log meta data
	160	+ * @param stdClass $trigger The trigger object
	161	+ * @param int $user_id The user ID
	162	+ * @param array $event Event information
	163	+ * @param array $trigger_options The trigger's stored options
	164	+ * @param stdClass $automation The trigger's automation object
	165	+ *
	166	+ * @return array
	167	+ */
	168	+ function log_meta( $log_meta, $trigger, $user_id, $event, $trigger_options, $automation ) {
	169	+
	170	+ // Bail if action type don't match this action
	171	+ if( $trigger->type !== $this->trigger ) {
	172	+ return $log_meta;
	173	+ }
	174	+
	175	+ $log_meta['form_fields'] = ( isset( $event['form_fields'] ) ? $event['form_fields'] : array() );
	176	+
	177	+ return $log_meta;
	178	+
	179	+ }
	180	+
	181	+ /**
	182	+ * Action custom log fields
	183	+ *
	184	+ * @since 1.0.0
	185	+ *
	186	+ * @param array $log_fields The log fields
	187	+ * @param stdClass $log The log object
	188	+ * @param stdClass $object The trigger/action/automation object attached to the log
	189	+ *
	190	+ * @return array
	191	+ */
	192	+ public function log_fields( $log_fields, $log, $object ) {
	193	+
	194	+ // Bail if log is not assigned to an trigger
	195	+ if( $log->type !== 'trigger' ) {
	196	+ return $log_fields;
	197	+ }
	198	+
	199	+ // Bail if trigger type don't match this trigger
	200	+ if( $object->type !== $this->trigger ) {
	201	+ return $log_fields;
	202	+ }
	203	+
	204	+ $log_fields['form_fields'] = array(
	205	+ 'name' => __( 'Fields Submitted', 'automatorwp' ),
	206	+ 'desc' => __( 'Information about the fields values sent on this form submission.', 'automatorwp' ),
	207	+ 'type' => 'text',
	208	+ );
	209	+
	210	+ return $log_fields;
	211	+
	212	+ }
	213	+
	214	+}
	215	+
	216	+new AutomatorWP_Contact_Form_7_Submit_Form();