gamipress / integrations / fluentform / includes / triggers.php

triggers.php in GamiPress – Gamification plugin to reward points, badges & ranks in WordPress, now with AI 8.0.2, at integrations/fluentform/includes/triggers.php

267 lines 9.0 KB

Raw Download Zip

1	<?php
2	/**
3	* Triggers
4	*
5	* @package GamiPress\FluentForm\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_fluentform_activity_triggers( $triggers ) {
21
22	$triggers[__( 'WP Fluent Forms', 'gamipress' )] = array(
23	'gamipress_fluentform_new_form_submission' => __( 'Successful submit a form', 'gamipress' ),
24	'gamipress_fluentform_specific_new_form_submission' => __( 'Successful submit a specific form', 'gamipress' ),
25	'gamipress_fluentform_field_value_submission' => __( 'Submit a specific field value', 'gamipress' ),
26	'gamipress_fluentform_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_fluentform_activity_triggers' );
33
34	/**
35	* Register plugin specific activity triggers
36	*
37	* @since 1.0.0
38	*
39	* @param array $specific_activity_triggers
40	* @return array
41	*/
42	function gamipress_fluentform_specific_activity_triggers( $specific_activity_triggers ) {
43
44	$specific_activity_triggers['gamipress_fluentform_specific_new_form_submission'] = array( 'fluent_form' );
45	$specific_activity_triggers['gamipress_fluentform_specific_field_value_submission'] = array( 'fluent_form' );
46
47	return $specific_activity_triggers;
48	}
49	add_filter( 'gamipress_specific_activity_triggers', 'gamipress_fluentform_specific_activity_triggers' );
50
51	/**
52	* Build custom activity trigger label
53	*
54	* @since 1.0.0
55	*
56	* @param string $title
57	* @param integer $requirement_id
58	* @param array $requirement
59	*
60	* @return string
61	*/
62	function gamipress_fluentform_activity_trigger_label( $title, $requirement_id, $requirement ) {
63
64	$field_name = ( isset( $requirement['fluentform_field_name'] ) ) ? $requirement['fluentform_field_name'] : '';
65	$field_value = ( isset( $requirement['fluentform_field_value'] ) ) ? $requirement['fluentform_field_value'] : '';
66
67	switch( $requirement['trigger_type'] ) {
68	// Specific field value
69	case 'gamipress_fluentform_field_value_submission':
70	return sprintf( __( 'Submit a form setting field "%s" to "%s" value', 'gamipress' ), $field_name, $field_value );
71	break;
72	// Specific field value on a specific form
73	case 'gamipress_fluentform_specific_field_value_submission':
74	$achievement_post_id = absint( $requirement['achievement_post'] );
75	$form_title = gamipress_fluentform_specific_activity_trigger_post_title( '', $achievement_post_id, $requirement['trigger_type'] );
76	return sprintf( __( 'Submit %s form setting field "%s" to "%s" value', 'gamipress' ), $form_title, $field_name, $field_value );
77	break;
78	}
79
80	return $title;
81	}
82	add_filter( 'gamipress_activity_trigger_label', 'gamipress_fluentform_activity_trigger_label', 10, 3 );
83
84	/**
85	* Register plugin specific activity triggers labels
86	*
87	* @since 1.0.0
88	*
89	* @param array $specific_activity_trigger_labels
90	* @return array
91	*/
92	function gamipress_fluentform_specific_activity_trigger_label( $specific_activity_trigger_labels ) {
93
94	$specific_activity_trigger_labels['gamipress_fluentform_specific_new_form_submission'] = __( 'Submit %s', 'gamipress' );
95	$specific_activity_trigger_labels['gamipress_fluentform_specific_field_value_submission'] = __( 'Submit a specific field value on %s', 'gamipress' );
96
97	return $specific_activity_trigger_labels;
98	}
99	add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_fluentform_specific_activity_trigger_label' );
100
101	/**
102	* Get plugin specific activity trigger post title
103	*
104	* @since 1.0.6
105	*
106	* @param string $post_title
107	* @param integer $specific_id
108	* @param string $trigger_type
109	* @return string
110	*/
111	function gamipress_fluentform_specific_activity_trigger_post_title( $post_title, $specific_id, $trigger_type ) {
112
113	global $wpdb;
114
115	switch( $trigger_type ) {
116	case 'gamipress_fluentform_specific_new_form_submission':
117	case 'gamipress_fluentform_specific_field_value_submission':
118	if( absint( $specific_id ) !== 0 ) {
119	$form = wpFluent()->table( 'fluentform_forms' )
120	->select( array( 'id', 'title' ) )
121	->where( 'id', $specific_id )
122	->first();
123
124	$post_title = ( $form ? $form->title : '' );
125	}
126	break;
127	}
128
129	return $post_title;
130
131	}
132	add_filter( 'gamipress_specific_activity_trigger_post_title', 'gamipress_fluentform_specific_activity_trigger_post_title', 10, 3 );
133
134	/**
135	* Get user for a given trigger action.
136	*
137	* @since 1.0.0
138	*
139	* @param integer $user_id user ID to override.
140	* @param string $trigger Trigger name.
141	* @param array $args Passed trigger args.
142	* @return integer User ID.
143	*/
144	function gamipress_fluentform_trigger_get_user_id( $user_id, $trigger, $args ) {
145
146	switch ( $trigger ) {
147	case 'gamipress_fluentform_new_form_submission':
148	case 'gamipress_fluentform_specific_new_form_submission':
149	case 'gamipress_fluentform_field_value_submission':
150	case 'gamipress_fluentform_specific_field_value_submission':
151	$user_id = $args[1];
152	break;
153	}
154
155	return $user_id;
156
157	}
158	add_filter( 'gamipress_trigger_get_user_id', 'gamipress_fluentform_trigger_get_user_id', 10, 3);
159
160
161	/**
162	* Get the id for a given specific trigger action.
163	*
164	* @since 1.0.0
165	*
166	* @param integer $specific_id Specific ID.
167	* @param string $trigger Trigger name.
168	* @param array $args Passed trigger args.
169	*
170	* @return integer Specific ID.
171	*/
172	function gamipress_fluentform_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) {
173
174	switch ( $trigger ) {
175	case 'gamipress_fluentform_specific_new_form_submission':
176	case 'gamipress_fluentform_specific_field_value_submission':
177	$specific_id = $args[0];
178	break;
179	}
180
181	return $specific_id;
182	}
183	add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_fluentform_specific_trigger_get_id', 10, 3 );
184
185	/**
186	* Extended meta data for event trigger logging
187	*
188	* @since 1.0.1
189	*
190	* @param array $log_meta
191	* @param integer $user_id
192	* @param string $trigger
193	* @param integer $site_id
194	* @param array $args
195	*
196	* @return array
197	*/
198	function gamipress_fluentform_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) {
199
200	switch ( $trigger ) {
201	case 'gamipress_fluentform_new_form_submission':
202	case 'gamipress_fluentform_specific_new_form_submission':
203	// Add the form ID
204	$log_meta['form_id'] = $args[0];
205	break;
206	case 'gamipress_fluentform_field_value_submission':
207	case 'gamipress_fluentform_specific_field_value_submission':
208	// Add the form ID, field name and value
209	$log_meta['form_id'] = $args[0];
210	$log_meta['field_name'] = $args[2];
211	$log_meta['field_value'] = $args[3];
212	break;
213	}
214
215	return $log_meta;
216	}
217	add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_fluentform_log_event_trigger_meta_data', 10, 5 );
218
219	/**
220	* Extra data fields
221	*
222	* @since 1.1.0
223	*
224	* @param array $fields
225	* @param int $log_id
226	* @param string $type
227	*
228	* @return array
229	*/
230	function gamipress_fluentform_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_fluentform_field_value_submission':
243	case 'gamipress_fluentform_specific_field_value_submission':
244
245	$field_value = ct_get_object_meta( $log_id, $prefix . 'field_value', true );
246
247	$fields[] = array(
248	'name' => __( 'Field name', 'gamipress' ),
249	'desc' => __( 'Field name attached to this log.', 'gamipress' ),
250	'id' => $prefix . 'field_name',
251	'type' => 'text',
252	);
253	$fields[] = array(
254	'name' => __( 'Field value', 'gamipress' ),
255	'desc' => __( 'Field value attached to this log.', 'gamipress' ),
256	'id' => $prefix . 'field_value',
257	'type' => ( is_array( $field_value ) ? 'advanced_select' : 'text' ),
258	'multiple' => ( is_array( $field_value ) && count( $field_value ) > 1 ? true : false ),
259	'options' => ( is_array( $field_value ) ? $field_value : array() ),
260	);
261	break;
262	}
263
264	return $fields;
265
266	}
267	add_filter( 'gamipress_log_extra_data_fields', 'gamipress_fluentform_log_extra_data_fields', 10, 3 );