← All changes | integrations/divi/includes/triggers.php +273 -0 7.9.2 → 8.0.3 View file →

		@@ -1,0 +1,273 @@
	1	+<?php
	2	+/**
	3	+ * Triggers
	4	+ *
	5	+ * @package GamiPress\Divi\Triggers
	6	+ * @since 1.0.0
	7	+ */
	8	+
	9	+// Exit if accessed directly
	10	+if( !defined( 'ABSPATH' ) ) exit;
	11	+
	12	+/**
	13	+ * Register plugin specific triggers
	14	+ *
	15	+ * @since 1.0.0
	16	+ *
	17	+ * @param array $triggers
	18	+ * @return mixed
	19	+ */
	20	+function gamipress_divi_activity_triggers( $triggers ) {
	21	+
	22	+ $triggers[__( 'Divi', 'gamipress' )] = array(
	23	+ 'gamipress_divi_new_form_submission' => __( 'Successful submit a form', 'gamipress' ),
	24	+ 'gamipress_divi_specific_new_form_submission' => __( 'Successful submit a specific form', 'gamipress' ),
	25	+ 'gamipress_divi_field_value_submission' => __( 'Submit a specific field value', 'gamipress' ),
	26	+ 'gamipress_divi_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_divi_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_divi_activity_trigger_label( $title, $requirement_id, $requirement ) {
	46	+
	47	+ $form_id = ( isset( $requirement['divi_form_id'] ) ) ? $requirement['divi_form_id'] : '';
	48	+ $field_name = ( isset( $requirement['divi_field_name'] ) ) ? $requirement['divi_field_name'] : '';
	49	+ $field_value = ( isset( $requirement['divi_field_value'] ) ) ? $requirement['divi_field_value'] : '';
	50	+
	51	+ switch( $requirement['trigger_type'] ) {
	52	+ // Specific form
	53	+ // Specific field value on a specific form
	54	+ case 'gamipress_divi_specific_new_form_submission':
	55	+ return sprintf( __( 'Submit %s form', 'gamipress' ), $form_id );
	56	+ break;
	57	+ // Specific field value
	58	+ case 'gamipress_divi_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_divi_specific_field_value_submission':
	63	+ return sprintf( __( 'Submit %s form setting field "%s" to "%s" value', 'gamipress' ), $form_id, $field_name, $field_value );
	64	+ break;
	65	+ }
	66	+
	67	+ return $title;
	68	+}
	69	+add_filter( 'gamipress_activity_trigger_label', 'gamipress_divi_activity_trigger_label', 10, 3 );
	70	+
	71	+/**
	72	+ * Get user for a given trigger action.
	73	+ *
	74	+ * @since 1.0.0
	75	+ *
	76	+ * @param integer $user_id user ID to override.
	77	+ * @param string $trigger Trigger name.
	78	+ * @param array $args Passed trigger args.
	79	+ * @return integer User ID.
	80	+ */
	81	+function gamipress_divi_trigger_get_user_id( $user_id, $trigger, $args ) {
	82	+
	83	+ switch ( $trigger ) {
	84	+ case 'gamipress_divi_new_form_submission':
	85	+ case 'gamipress_divi_specific_new_form_submission':
	86	+ case 'gamipress_divi_field_value_submission':
	87	+ case 'gamipress_divi_specific_field_value_submission':
	88	+ $user_id = $args[1];
	89	+ break;
	90	+ }
	91	+
	92	+ return $user_id;
	93	+
	94	+}
	95	+add_filter( 'gamipress_trigger_get_user_id', 'gamipress_divi_trigger_get_user_id', 10, 3);
	96	+
	97	+/**
	98	+ * Extended meta data for event trigger logging
	99	+ *
	100	+ * @since 1.0.0
	101	+ *
	102	+ * @param array $log_meta
	103	+ * @param integer $user_id
	104	+ * @param string $trigger
	105	+ * @param integer $site_id
	106	+ * @param array $args
	107	+ *
	108	+ * @return array
	109	+ */
	110	+function gamipress_divi_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) {
	111	+
	112	+ switch ( $trigger ) {
	113	+ case 'gamipress_divi_new_form_submission':
	114	+ case 'gamipress_divi_specific_new_form_submission':
	115	+ // Add the form name
	116	+ $log_meta['form_id'] = $args[0];
	117	+ break;
	118	+ case 'gamipress_divi_field_value_submission':
	119	+ case 'gamipress_divi_specific_field_value_submission':
	120	+ // Add the form name, field name and value
	121	+ $log_meta['form_id'] = $args[0];
	122	+ $log_meta['field_name'] = $args[2];
	123	+ $log_meta['field_value'] = $args[3];
	124	+ break;
	125	+ }
	126	+
	127	+ return $log_meta;
	128	+}
	129	+add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_divi_log_event_trigger_meta_data', 10, 5 );
	130	+
	131	+/**
	132	+ * Override the meta data to filter the logs count
	133	+ *
	134	+ * @since 1.0.0
	135	+ *
	136	+ * @param array $log_meta The meta data to filter the logs count
	137	+ * @param int $user_id The given user's ID
	138	+ * @param string $trigger The given trigger we're checking
	139	+ * @param int $since The since timestamp where retrieve the logs
	140	+ * @param int $site_id The desired Site ID to check
	141	+ * @param array $args The triggered args or requirement object
	142	+ *
	143	+ * @return array The meta data to filter the logs count
	144	+ */
	145	+function gamipress_divi_get_user_trigger_count_log_meta( $log_meta, $user_id, $trigger, $since, $site_id, $args ) {
	146	+
	147	+ switch( $trigger ) {
	148	+ case 'gamipress_divi_field_value_submission':
	149	+ case 'gamipress_divi_specific_field_value_submission':
	150	+ if( isset( $args[2] ) && isset( $args[3] ) ) {
	151	+ // Add the field name and value
	152	+ $log_meta['field_name'] = $args[2];
	153	+ $log_meta['field_value'] = $args[3];
	154	+ }
	155	+
	156	+ // $args could be a requirement object
	157	+ if( isset( $args['divi_field_name'] ) && isset( $args['divi_field_value'] ) ) {
	158	+ // Add the field name and value
	159	+ $log_meta['field_name'] = $args['divi_field_name'];
	160	+ $log_meta['field_value'] = $args['divi_field_value'];
	161	+ }
	162	+ break;
	163	+ }
	164	+
	165	+ return $log_meta;
	166	+
	167	+}
	168	+add_filter( 'gamipress_get_user_trigger_count_log_meta', 'gamipress_divi_get_user_trigger_count_log_meta', 10, 6 );
	169	+
	170	+/**
	171	+ * Override the count log for array fields
	172	+ *
	173	+ * @since 1.0.0
	174	+ *
	175	+ * @param int $trigger_count The total number of times a user has triggered the trigger
	176	+ * @param int $user_id The given user's ID
	177	+ * @param string $trigger The given trigger we're checking
	178	+ * @param int $since The since timestamp where retrieve the logs
	179	+ * @param int $site_id The desired Site ID to check
	180	+ * @param array $args The triggered args or requirement object
	181	+ *
	182	+ * @return int The total number of times a user has triggered the trigger
	183	+ */
	184	+function gamipress_divi_get_user_trigger_count( $trigger_count, $user_id, $trigger, $since, $site_id, $args ) {
	185	+
	186	+ switch( $trigger ) {
	187	+ case 'gamipress_divi_field_value_submission':
	188	+ case 'gamipress_divi_specific_field_value_submission':
	189	+
	190	+ if( $trigger_count === 0 ) {
	191	+
	192	+ $log_meta = array(
	193	+ 'type' => 'event_trigger',
	194	+ 'trigger_type' => $trigger,
	195	+ );
	196	+
	197	+ $log_meta = apply_filters( 'gamipress_get_user_trigger_count_log_meta', $log_meta, $user_id, $trigger, $since, $site_id, $args );
	198	+
	199	+ if( isset( $log_meta['field_value'] ) ) {
	200	+ $log_meta[] = array(
	201	+ 'key' => 'field_value',
	202	+ 'value' => '%"' . $log_meta['field_value'] . '"%',
	203	+ 'compare' => 'LIKE',
	204	+ );
	205	+
	206	+ unset( $log_meta['field_value'] );
	207	+
	208	+ $trigger_count = absint( gamipress_get_user_log_count( absint( $user_id ), $log_meta, $since ) );
	209	+ }
	210	+ }
	211	+ break;
	212	+ }
	213	+
	214	+ return $trigger_count;
	215	+
	216	+}
	217	+add_filter( 'gamipress_get_user_trigger_count', 'gamipress_divi_get_user_trigger_count', 10, 6 );
	218	+
	219	+/**
	220	+ * Extra data fields
	221	+ *
	222	+ * @since 1.0.5
	223	+ *
	224	+ * @param array $fields
	225	+ * @param int $log_id
	226	+ * @param string $type
	227	+ *
	228	+ * @return array
	229	+ */
	230	+function gamipress_divi_log_extra_data_fields( $fields, $log_id, $type ) {
	231	+
	232	+ $prefix = '_gamipress_';
	233	+
	234	+ $log = ct_get_object( $log_id );
	235	+ $trigger = $log->trigger_type;
	236	+
	237	+ if( $type !== 'event_trigger' ) {
	238	+ return $fields;
	239	+ }
	240	+
	241	+ switch( $trigger ) {
	242	+ case 'gamipress_divi_field_value_submission':
	243	+ case 'gamipress_divi_specific_field_value_submission':
	244	+
	245	+ $field_value = ct_get_object_meta( $log_id, $prefix . 'field_value', true );
	246	+
	247	+ $fields[] = array(
	248	+ 'name' => __( 'Form name', 'gamipress' ),
	249	+ 'desc' => __( 'The submitted form name.', 'gamipress' ),
	250	+ 'id' => $prefix . 'form_id',
	251	+ 'type' => 'text',
	252	+ );
	253	+ $fields[] = array(
	254	+ 'name' => __( 'Field name', 'gamipress' ),
	255	+ 'desc' => __( 'Field name attached to this log.', 'gamipress' ),
	256	+ 'id' => $prefix . 'field_name',
	257	+ 'type' => 'text',
	258	+ );
	259	+ $fields[] = array(
	260	+ 'name' => __( 'Field value', 'gamipress' ),
	261	+ 'desc' => __( 'Field value attached to this log.', 'gamipress' ),
	262	+ 'id' => $prefix . 'field_value',
	263	+ 'type' => ( is_array( $field_value ) ? 'advanced_select' : 'text' ),
	264	+ 'multiple' => ( is_array( $field_value ) && count( $field_value ) > 1 ? true : false ),
	265	+ 'options' => ( is_array( $field_value ) ? $field_value : array() ),
	266	+ );
	267	+ break;
	268	+ }
	269	+
	270	+ return $fields;
	271	+
	272	+}
	273	+add_filter( 'gamipress_log_extra_data_fields', 'gamipress_divi_log_extra_data_fields', 10, 3 );