gamipress / integrations / everest-forms / includes / triggers.php

triggers.php in GamiPress – Gamification plugin to reward points, badges & ranks in WordPress, now with AI 8.0.3, at integrations/everest-forms/includes/triggers.php

233 lines 8.0 KB

Raw Download Zip

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