gamipress / integrations / weforms / includes / triggers.php

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

235 lines 7.8 KB

Raw Download Zip

1	<?php
2	/**
3	* Triggers
4	*
5	* @package GamiPress\WeForms\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_weforms_activity_triggers( $triggers ) {
21
22	$triggers[__( 'WP WeForms', 'gamipress' )] = array(
23	'gamipress_weforms_new_form_submission' => __( 'Submit a form', 'gamipress' ),
24	'gamipress_weforms_specific_new_form_submission' => __( 'Submit a specific form', 'gamipress' ),
25	'gamipress_weforms_field_value_submission' => __( 'Submit a specific field value', 'gamipress' ),
26	'gamipress_weforms_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_weforms_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_weforms_specific_activity_triggers( $specific_activity_triggers ) {
43
44	$specific_activity_triggers['gamipress_weforms_specific_new_form_submission'] = array( 'wpuf_contact_form' );
45	$specific_activity_triggers['gamipress_weforms_specific_field_value_submission'] = array( 'wpuf_contact_form' );
46
47	return $specific_activity_triggers;
48
49	}
50	add_filter( 'gamipress_specific_activity_triggers', 'gamipress_weforms_specific_activity_triggers' );
51
52	/**
53	* Build custom activity trigger label
54	*
55	* @since 1.0.0
56	*
57	* @param string $title
58	* @param integer $requirement_id
59	* @param array $requirement
60	*
61	* @return string
62	*/
63	function gamipress_weforms_activity_trigger_label( $title, $requirement_id, $requirement ) {
64
65	$field_name = ( isset( $requirement['weforms_field_name'] ) ) ? $requirement['weforms_field_name'] : '';
66	$field_value = ( isset( $requirement['weforms_field_value'] ) ) ? $requirement['weforms_field_value'] : '';
67
68	switch( $requirement['trigger_type'] ) {
69	// Specific field value
70	case 'gamipress_weforms_field_value_submission':
71	return sprintf( __( 'Submit a form setting field %s to %s value', 'gamipress' ), $field_name, $field_value );
72	break;
73	// Specific field value on a specific form
74	case 'gamipress_weforms_specific_field_value_submission':
75	$achievement_post_id = absint( $requirement['achievement_post'] );
76	$form_title = gamipress_get_specific_activity_trigger_post_title( $achievement_post_id, $requirement['trigger_type'], get_current_blog_id() );
77	return sprintf( __( 'Submit %s form setting field "%s" to "%s" value' ), $form_title, $field_name, $field_value );
78	break;
79	}
80
81	return $title;
82	}
83	add_filter( 'gamipress_activity_trigger_label', 'gamipress_weforms_activity_trigger_label', 10, 3 );
84
85	/**
86	* Register plugin specific activity triggers labels
87	*
88	* @since 1.0.0
89	*
90	* @param array $specific_activity_trigger_labels
91	* @return array
92	*/
93	function gamipress_weforms_specific_activity_trigger_label( $specific_activity_trigger_labels ) {
94
95	$specific_activity_trigger_labels['gamipress_weforms_specific_new_form_submission'] = __( 'Submit %s', 'gamipress' );
96	$specific_activity_trigger_labels['gamipress_weforms_specific_field_value_submission'] = __( 'Submit a specific field value on %s', 'gamipress' );
97
98	return $specific_activity_trigger_labels;
99
100	}
101	add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_weforms_specific_activity_trigger_label' );
102
103	/**
104	* Get user for a given trigger action.
105	*
106	* @since 1.0.0
107	*
108	* @param integer $user_id user ID to override.
109	* @param string $trigger Trigger name.
110	* @param array $args Passed trigger args.
111	* @return integer User ID.
112	*/
113	function gamipress_weforms_trigger_get_user_id( $user_id, $trigger, $args ) {
114
115	switch ( $trigger ) {
116	case 'gamipress_weforms_new_form_submission':
117	case 'gamipress_weforms_specific_new_form_submission':
118	case 'gamipress_weforms_field_value_submission':
119	case 'gamipress_weforms_specific_field_value_submission':
120	$user_id = $args[1];
121	break;
122	}
123
124	return $user_id;
125
126	}
127	add_filter( 'gamipress_trigger_get_user_id', 'gamipress_weforms_trigger_get_user_id', 10, 3 );
128
129	/**
130	* Get the id for a given specific trigger action.
131	*
132	* @since 1.0.0
133	*
134	* @param integer $specific_id Specific ID.
135	* @param string $trigger Trigger name.
136	* @param array $args Passed trigger args.
137	*
138	* @return integer Specific ID.
139	*/
140	function gamipress_weforms_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) {
141
142	switch ( $trigger ) {
143	case 'gamipress_weforms_specific_new_form_submission':
144	case 'gamipress_weforms_specific_field_value_submission':
145	$specific_id = $args[0];
146	}
147
148	return $specific_id;
149
150	}
151	add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_weforms_specific_trigger_get_id', 10, 3 );
152
153	/**
154	* Extended meta data for event trigger logging
155	*
156	* @since 1.0.0
157	*
158	* @param array $log_meta
159	* @param integer $user_id
160	* @param string $trigger
161	* @param integer $site_id
162	* @param array $args
163	*
164	* @return array
165	*/
166	function gamipress_weforms_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) {
167
168	switch ( $trigger ) {
169	case 'gamipress_weforms_new_form_submission':
170	case 'gamipress_weforms_specific_new_form_submission':
171	// Add the form ID
172	$log_meta['form_id'] = $args[0];
173	break;
174	case 'gamipress_weforms_field_value_submission':
175	case 'gamipress_weforms_specific_field_value_submission':
176	$log_meta['form_id'] = $args[0];
177	$log_meta['field_name'] = $args[2];
178	$log_meta['field_value'] = $args[3];
179	break;
180	}
181
182	return $log_meta;
183
184	}
185	add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_weforms_log_event_trigger_meta_data', 10, 5 );
186
187	/**
188	* Extra data fields
189	*
190	* @since 1.0.0
191	*
192	* @param array $fields
193	* @param int $log_id
194	* @param string $type
195	*
196	* @return array
197	*/
198	function gamipress_weforms_log_extra_data_fields( $fields, $log_id, $type ) {
199
200	$prefix = '_gamipress_';
201
202	$log = ct_get_object( $log_id );
203	$trigger = $log->trigger_type;
204
205	if( $type !== 'event_trigger' ) {
206	return $fields;
207	}
208
209	switch( $trigger ) {
210	case 'gamipress_weforms_field_value_submission':
211	case 'gamipress_weforms_specific_field_value_submission':
212
213	$field_value = ct_get_object_meta( $log_id, $prefix . 'field_value', true );
214
215	$fields[] = array(
216	'name' => __( 'Field name', 'gamipress' ),
217	'desc' => __( 'Field name attached to this log.', 'gamipress' ),
218	'id' => $prefix . 'field_name',
219	'type' => 'text',
220	);
221	$fields[] = array(
222	'name' => __( 'Field value', 'gamipress' ),
223	'desc' => __( 'Field value attached to this log.', 'gamipress' ),
224	'id' => $prefix . 'field_value',
225	'type' => ( is_array( $field_value ) ? 'advanced_select' : 'text' ),
226	'multiple' => ( is_array( $field_value ) && count( $field_value ) > 1 ? true : false ),
227	'options' => ( is_array( $field_value ) ? $field_value : array() ),
228	);
229	break;
230	}
231
232	return $fields;
233
234	}
235	add_filter( 'gamipress_log_extra_data_fields', 'gamipress_weforms_log_extra_data_fields', 10, 3 );