gamipress / integrations / arforms / includes / triggers.php

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

263 lines 8.7 KB

Raw Download Zip

1	<?php
2	/**
3	* Triggers
4	*
5	* @package GamiPress\ARForms\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_arforms_activity_triggers( $triggers ) {
21
22	$triggers[__( 'ARForms', 'gamipress' )] = array(
23	'gamipress_arforms_new_form_submission' => __( 'Successful submit a form', 'gamipress' ),
24	'gamipress_arforms_specific_new_form_submission' => __( 'Successful submit a specific form', 'gamipress' ),
25	'gamipress_arforms_field_value_submission' => __( 'Submit a specific field value', 'gamipress' ),
26	'gamipress_arforms_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_arforms_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_arforms_specific_activity_triggers( $specific_activity_triggers ) {
43
44	$specific_activity_triggers['gamipress_arforms_specific_new_form_submission'] = array( 'arforms_form' );
45	$specific_activity_triggers['gamipress_arforms_specific_field_value_submission'] = array( 'arforms_form' );
46
47	return $specific_activity_triggers;
48	}
49	add_filter( 'gamipress_specific_activity_triggers', 'gamipress_arforms_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_arforms_activity_trigger_label( $title, $requirement_id, $requirement ) {
63
64	$field_name = ( isset( $requirement['arforms_field_name'] ) ) ? $requirement['arforms_field_name'] : '';
65	$field_value = ( isset( $requirement['arforms_field_value'] ) ) ? $requirement['arforms_field_value'] : '';
66
67	switch( $requirement['trigger_type'] ) {
68	// Specific field value
69	case 'gamipress_arforms_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_arforms_specific_field_value_submission':
74	$achievement_post_id = absint( $requirement['achievement_post'] );
75	$form_title = gamipress_arforms_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_arforms_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_arforms_specific_activity_trigger_label( $specific_activity_trigger_labels ) {
93
94	$specific_activity_trigger_labels['gamipress_arforms_specific_new_form_submission'] = __( 'Submit %s', 'gamipress' );
95	$specific_activity_trigger_labels['gamipress_arforms_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_arforms_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_arforms_specific_activity_trigger_post_title( $post_title, $specific_id, $trigger_type ) {
112
113	global $wpdb;
114
115	switch( $trigger_type ) {
116	case 'gamipress_arforms_specific_new_form_submission':
117	case 'gamipress_arforms_specific_field_value_submission':
118	if( absint( $specific_id ) !== 0 ) {
119	$form = gamipress_arforms_get_form_name( $specific_id );
120	$post_title = $form;
121	}
122	break;
123	}
124
125	return $post_title;
126
127	}
128	add_filter( 'gamipress_specific_activity_trigger_post_title', 'gamipress_arforms_specific_activity_trigger_post_title', 10, 3 );
129
130	/**
131	* Get user for a given trigger action.
132	*
133	* @since 1.0.0
134	*
135	* @param integer $user_id user ID to override.
136	* @param string $trigger Trigger name.
137	* @param array $args Passed trigger args.
138	* @return integer User ID.
139	*/
140	function gamipress_arforms_trigger_get_user_id( $user_id, $trigger, $args ) {
141
142	switch ( $trigger ) {
143	case 'gamipress_arforms_new_form_submission':
144	case 'gamipress_arforms_specific_new_form_submission':
145	case 'gamipress_arforms_field_value_submission':
146	case 'gamipress_arforms_specific_field_value_submission':
147	$user_id = $args[1];
148	break;
149	}
150
151	return $user_id;
152
153	}
154	add_filter( 'gamipress_trigger_get_user_id', 'gamipress_arforms_trigger_get_user_id', 10, 3);
155
156
157	/**
158	* Get the id for a given specific trigger action.
159	*
160	* @since 1.0.0
161	*
162	* @param integer $specific_id Specific ID.
163	* @param string $trigger Trigger name.
164	* @param array $args Passed trigger args.
165	*
166	* @return integer Specific ID.
167	*/
168	function gamipress_arforms_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) {
169
170	switch ( $trigger ) {
171	case 'gamipress_arforms_specific_new_form_submission':
172	case 'gamipress_arforms_specific_field_value_submission':
173	$specific_id = $args[0];
174	break;
175	}
176
177	return $specific_id;
178	}
179	add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_arforms_specific_trigger_get_id', 10, 3 );
180
181	/**
182	* Extended meta data for event trigger logging
183	*
184	* @since 1.0.1
185	*
186	* @param array $log_meta
187	* @param integer $user_id
188	* @param string $trigger
189	* @param integer $site_id
190	* @param array $args
191	*
192	* @return array
193	*/
194	function gamipress_arforms_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) {
195
196	switch ( $trigger ) {
197	case 'gamipress_arforms_new_form_submission':
198	case 'gamipress_arforms_specific_new_form_submission':
199	// Add the form ID
200	$log_meta['form_id'] = $args[0];
201	break;
202	case 'gamipress_arforms_field_value_submission':
203	case 'gamipress_arforms_specific_field_value_submission':
204	// Add the form ID, field name and value
205	$log_meta['form_id'] = $args[0];
206	$log_meta['field_name'] = $args[2];
207	$log_meta['field_value'] = $args[3];
208	break;
209	}
210
211	return $log_meta;
212	}
213	add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_arforms_log_event_trigger_meta_data', 10, 5 );
214
215	/**
216	* Extra data fields
217	*
218	* @since 1.1.0
219	*
220	* @param array $fields
221	* @param int $log_id
222	* @param string $type
223	*
224	* @return array
225	*/
226	function gamipress_arforms_log_extra_data_fields( $fields, $log_id, $type ) {
227
228	$prefix = '_gamipress_';
229
230	$log = ct_get_object( $log_id );
231	$trigger = $log->trigger_type;
232
233	if( $type !== 'event_trigger' ) {
234	return $fields;
235	}
236
237	switch( $trigger ) {
238	case 'gamipress_arforms_field_value_submission':
239	case 'gamipress_arforms_specific_field_value_submission':
240
241	$field_value = ct_get_object_meta( $log_id, $prefix . 'field_value', true );
242
243	$fields[] = array(
244	'name' => __( 'Field name', 'gamipress' ),
245	'desc' => __( 'Field name attached to this log.', 'gamipress' ),
246	'id' => $prefix . 'field_name',
247	'type' => 'text',
248	);
249	$fields[] = array(
250	'name' => __( 'Field value', 'gamipress' ),
251	'desc' => __( 'Field value attached to this log.', 'gamipress' ),
252	'id' => $prefix . 'field_value',
253	'type' => ( is_array( $field_value ) ? 'advanced_select' : 'text' ),
254	'multiple' => ( is_array( $field_value ) && count( $field_value ) > 1 ? true : false ),
255	'options' => ( is_array( $field_value ) ? $field_value : array() ),
256	);
257	break;
258	}
259
260	return $fields;
261
262	}
263	add_filter( 'gamipress_log_extra_data_fields', 'gamipress_arforms_log_extra_data_fields', 10, 3 );