← All changes | integrations/caldera-forms/includes/triggers.php +198 -0 7.9.9.3 → 8.0.5 View file →

		@@ -1,0 +1,198 @@
	1	+<?php
	2	+/**
	3	+ * Triggers
	4	+ *
	5	+ * @package GamiPress\Caldera_Forms\Triggers
	6	+ * @since 1.0.0
	7	+ */
	8	+
	9	+// Exit if accessed directly
	10	+if( !defined( 'ABSPATH' ) ) exit;
	11	+
	12	+/**
	13	+ * Register Caldera Forms specific triggers
	14	+ *
	15	+ * @since 1.0.0
	16	+ *
	17	+ * @param array $triggers
	18	+ * @return mixed
	19	+ */
	20	+function gamipress_cf_activity_triggers( $triggers ) {
	21	+
	22	+ $triggers[__( 'Caldera Forms', 'gamipress' )] = array(
	23	+ 'gamipress_cf_new_form_submission' => __( 'Successful submit a form', 'gamipress' ),
	24	+ 'gamipress_cf_specific_new_form_submission' => __( 'Successful submit a specific form', 'gamipress' ),
	25	+ 'gamipress_cf_field_value_submission' => __( 'Submit a specific field value', 'gamipress' ),
	26	+ 'gamipress_cf_specific_field_value_submission' => __( 'Submit a specific field value on a specific form', 'gamipress' ),
	27	+ );
	28	+
	29	+ return $triggers;
	30	+
	31	+}
	32	+add_filter( 'gamipress_activity_triggers', 'gamipress_cf_activity_triggers' );
	33	+
	34	+/**
	35	+ * Build custom activity trigger label
	36	+ *
	37	+ * @since 1.0.0
	38	+ *
	39	+ * @param string $title
	40	+ * @param integer $requirement_id
	41	+ * @param array $requirement
	42	+ *
	43	+ * @return string
	44	+ */
	45	+function gamipress_cf_activity_trigger_label( $title, $requirement_id, $requirement ) {
	46	+
	47	+ $field_name = ( isset( $requirement['cf_field_name'] ) ) ? $requirement['cf_field_name'] : '';
	48	+ $field_value = ( isset( $requirement['cf_field_value'] ) ) ? $requirement['cf_field_value'] : '';
	49	+
	50	+ switch( $requirement['trigger_type'] ) {
	51	+ case 'gamipress_cf_specific_new_form_submission':
	52	+ $form = Caldera_Forms::get_form( $requirement['caldera_form'] );
	53	+
	54	+ if( is_array( $form ) && isset( $form['name'] ) )
	55	+ return sprintf( __( 'Submit %s', 'gamipress' ), $form['name'] );
	56	+ break;
	57	+ // Specific field value
	58	+ case 'gamipress_cf_field_value_submission':
	59	+ return sprintf( __( 'Submit a form setting field "%s" to "%s" value', 'gamipress' ), $field_name, $field_value );
	60	+ break;
	61	+ // Specific field value on a specific form
	62	+ case 'gamipress_cf_specific_field_value_submission':
	63	+ $form = Caldera_Forms::get_form( $requirement['caldera_form'] );
	64	+ $form_title = ( ( is_array( $form ) && isset( $form['name'] ) ) ? $form['name'] : '' );
	65	+ return sprintf( __( 'Submit %s form setting field "%s" to "%s" value', 'gamipress' ), $form_title, $field_name, $field_value );
	66	+ break;
	67	+ }
	68	+
	69	+ return $title;
	70	+}
	71	+add_filter( 'gamipress_activity_trigger_label', 'gamipress_cf_activity_trigger_label', 10, 3 );
	72	+
	73	+/**
	74	+ * Register Caldera Forms specific activity triggers labels
	75	+ *
	76	+ * @since 1.0.0
	77	+ *
	78	+ * @param array $specific_activity_trigger_labels
	79	+ * @return array
	80	+ */
	81	+function gamipress_cf_specific_activity_trigger_label( $specific_activity_trigger_labels ) {
	82	+
	83	+ $specific_activity_trigger_labels['gamipress_cf_specific_new_form_submission'] = __( 'Submit %s', 'gamipress' );
	84	+ $specific_activity_trigger_labels['gamipress_cf_specific_field_value_submission'] = __( 'Submit a specific field value on %s', 'gamipress' );
	85	+
	86	+ return $specific_activity_trigger_labels;
	87	+}
	88	+add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_cf_specific_activity_trigger_label' );
	89	+
	90	+/**
	91	+ * Get user for a given trigger action.
	92	+ *
	93	+ * @since 1.0.0
	94	+ *
	95	+ * @param integer $user_id user ID to override.
	96	+ * @param string $trigger Trigger name.
	97	+ * @param array $args Passed trigger args.
	98	+ * @return integer User ID.
	99	+ */
	100	+function gamipress_cf_trigger_get_user_id( $user_id, $trigger, $args ) {
	101	+
	102	+ switch ( $trigger ) {
	103	+ case 'gamipress_cf_new_form_submission':
	104	+ case 'gamipress_cf_specific_new_form_submission':
	105	+ case 'gamipress_cf_field_value_submission':
	106	+ case 'gamipress_cf_specific_field_value_submission':
	107	+ $user_id = $args[1];
	108	+ break;
	109	+ }
	110	+
	111	+ return $user_id;
	112	+
	113	+}
	114	+add_filter( 'gamipress_trigger_get_user_id', 'gamipress_cf_trigger_get_user_id', 10, 3);
	115	+
	116	+/**
	117	+ * Extended meta data for event trigger logging
	118	+ *
	119	+ * @since 1.0.0
	120	+ *
	121	+ * @param array $log_meta
	122	+ * @param integer $user_id
	123	+ * @param string $trigger
	124	+ * @param integer $site_id
	125	+ * @param array $args
	126	+ *
	127	+ * @return array
	128	+ */
	129	+function gamipress_cf_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) {
	130	+
	131	+ switch ( $trigger ) {
	132	+ case 'gamipress_cf_new_form_submission':
	133	+ case 'gamipress_cf_specific_new_form_submission':
	134	+ // Add the form ID
	135	+ $log_meta['form_id'] = $args[0];
	136	+ break;
	137	+ case 'gamipress_cf_field_value_submission':
	138	+ case 'gamipress_cf_specific_field_value_submission':
	139	+ // Add the form ID, field name and value
	140	+ $log_meta['form_id'] = $args[0];
	141	+ $log_meta['field_name'] = $args[2];
	142	+ $log_meta['field_value'] = $args[3];
	143	+ break;
	144	+ }
	145	+
	146	+ return $log_meta;
	147	+}
	148	+add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_cf_log_event_trigger_meta_data', 10, 5 );
	149	+
	150	+/**
	151	+ * Extra data fields
	152	+ *
	153	+ * @since 1.1.0
	154	+ *
	155	+ * @param array $fields
	156	+ * @param int $log_id
	157	+ * @param string $type
	158	+ *
	159	+ * @return array
	160	+ */
	161	+function gamipress_cf_log_extra_data_fields( $fields, $log_id, $type ) {
	162	+
	163	+ $prefix = '_gamipress_';
	164	+
	165	+ $log = ct_get_object( $log_id );
	166	+ $trigger = $log->trigger_type;
	167	+
	168	+ if( $type !== 'event_trigger' ) {
	169	+ return $fields;
	170	+ }
	171	+
	172	+ switch( $trigger ) {
	173	+ case 'gamipress_cf_field_value_submission':
	174	+ case 'gamipress_cf_specific_field_value_submission':
	175	+
	176	+ $field_value = ct_get_object_meta( $log_id, $prefix . 'field_value', true );
	177	+
	178	+ $fields[] = array(
	179	+ 'name' => __( 'Field name', 'gamipress' ),
	180	+ 'desc' => __( 'Field name attached to this log.', 'gamipress' ),
	181	+ 'id' => $prefix . 'field_name',
	182	+ 'type' => 'text',
	183	+ );
	184	+ $fields[] = array(
	185	+ 'name' => __( 'Field value', 'gamipress' ),
	186	+ 'desc' => __( 'Field value attached to this log.', 'gamipress' ),
	187	+ 'id' => $prefix . 'field_value',
	188	+ 'type' => ( is_array( $field_value ) ? 'advanced_select' : 'text' ),
	189	+ 'multiple' => ( is_array( $field_value ) && count( $field_value ) > 1 ? true : false ),
	190	+ 'options' => ( is_array( $field_value ) ? $field_value : array() ),
	191	+ );
	192	+ break;
	193	+ }
	194	+
	195	+ return $fields;
	196	+
	197	+}
	198	+add_filter( 'gamipress_log_extra_data_fields', 'gamipress_cf_log_extra_data_fields', 10, 3 );