gamipress / integrations / digimember / includes / triggers.php

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

264 lines 10.8 KB

Raw Download Zip

1	<?php
2	/**
3	* Triggers
4	*
5	* @package GamiPress\Digimember\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_digimember_activity_triggers( $triggers ) {
21
22	$triggers[__( 'Digimember', 'gamipress' )] = array(
23
24	// Purchase product
25	'gamipress_digimember_purchase_product' => __( 'Purchase any product', 'gamipress' ),
26	'gamipress_digimember_purchase_specific_product' => __( 'Purchase a specific product', 'gamipress' ),
27	'gamipress_digimember_purchase_membership_product' => __( 'Purchase any membership product', 'gamipress' ),
28	'gamipress_digimember_purchase_specific_membership_product' => __( 'Purchase a specific membership product', 'gamipress' ),
29	'gamipress_digimember_purchase_download_product' => __( 'Purchase any download product', 'gamipress' ),
30	'gamipress_digimember_purchase_specific_download_product' => __( 'Purchase a specific download product', 'gamipress' ),
31	// Cancel product
32	'gamipress_digimember_cancel_product' => __( 'Cancel any product', 'gamipress' ),
33	'gamipress_digimember_cancel_specific_product' => __( 'Cancel a specific product', 'gamipress' ),
34	'gamipress_digimember_cancel_membership_product' => __( 'Cancel any membership product', 'gamipress' ),
35	'gamipress_digimember_cancel_specific_membership_product' => __( 'Cancel a specific membership product', 'gamipress' ),
36	'gamipress_digimember_cancel_download_product' => __( 'Cancel any download product', 'gamipress' ),
37	'gamipress_digimember_cancel_specific_download_product' => __( 'Cancel a specific download product', 'gamipress' ),
38
39	);
40
41	return $triggers;
42
43	}
44	add_filter( 'gamipress_activity_triggers', 'gamipress_digimember_activity_triggers' );
45
46	/**
47	* Register plugin specific activity triggers
48	*
49	* @since 1.0.0
50	*
51	* @param array $specific_activity_triggers
52	* @return array
53	*/
54	function gamipress_digimember_specific_activity_triggers( $specific_activity_triggers ) {
55
56	// Purchase product
57	$specific_activity_triggers['gamipress_digimember_purchase_specific_product'] = array( 'digimember_product' );
58	$specific_activity_triggers['gamipress_digimember_purchase_specific_membership_product'] = array( 'digimember_membership_product' );
59	$specific_activity_triggers['gamipress_digimember_purchase_specific_download_product'] = array( 'digimember_download_product' );
60	// Cancel product
61	$specific_activity_triggers['gamipress_digimember_cancel_specific_product'] = array( 'digimember_product' );
62	$specific_activity_triggers['gamipress_digimember_cancel_specific_membership_product'] = array( 'digimember_membership_product' );
63	$specific_activity_triggers['gamipress_digimember_cancel_specific_download_product'] = array( 'digimember_download_product' );
64
65	return $specific_activity_triggers;
66
67	}
68	add_filter( 'gamipress_specific_activity_triggers', 'gamipress_digimember_specific_activity_triggers' );
69
70	/**
71	* Register plugin specific activity triggers labels
72	*
73	* @since 1.0.0
74	*
75	* @param array $specific_activity_trigger_labels
76	* @return array
77	*/
78	function gamipress_digimember_specific_activity_trigger_label( $specific_activity_trigger_labels ) {
79
80	// Purchase product
81	$specific_activity_trigger_labels['gamipress_digimember_purchase_specific_product'] = __( 'Purchase %s', 'gamipress' );
82	$specific_activity_trigger_labels['gamipress_digimember_purchase_specific_membership_product'] = __( 'Purchase %s', 'gamipress' );
83	$specific_activity_trigger_labels['gamipress_digimember_purchase_specific_download_product'] = __( 'Purchase %s', 'gamipress' );
84	// Cancel product
85	$specific_activity_trigger_labels['gamipress_digimember_cancel_specific_product'] = __( 'Cancel %s', 'gamipress' );
86	$specific_activity_trigger_labels['gamipress_digimember_cancel_specific_membership_product'] = __( 'Cancel %s', 'gamipress' );
87	$specific_activity_trigger_labels['gamipress_digimember_cancel_specific_download_product'] = __( 'Cancel %s', 'gamipress' );
88
89	return $specific_activity_trigger_labels;
90	}
91	add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_digimember_specific_activity_trigger_label' );
92
93	/**
94	* Get plugin specific activity trigger post title
95	*
96	* @since 1.0.0
97	*
98	* @param string $post_title
99	* @param integer $specific_id
100	* @param string $trigger_type
101	*
102	* @return string
103	*/
104	function gamipress_digimember_specific_activity_trigger_post_title( $post_title, $specific_id, $trigger_type ) {
105
106	switch( $trigger_type ) {
107	// Purchase product
108	case 'gamipress_digimember_purchase_specific_product':
109	case 'gamipress_digimember_purchase_specific_membership_product':
110	case 'gamipress_digimember_purchase_specific_download_product':
111	// Cancel product
112	case 'gamipress_digimember_cancel_specific_product':
113	case 'gamipress_digimember_cancel_specific_membership_product':
114	case 'gamipress_digimember_cancel_specific_download_product':
115	if( absint( $specific_id ) !== 0 ) {
116
117	// Get the product title
118	$post_title = gamipress_digimember_get_product_title( $specific_id );
119	}
120	break;
121	}
122
123	return $post_title;
124
125	}
126	add_filter( 'gamipress_specific_activity_trigger_post_title', 'gamipress_digimember_specific_activity_trigger_post_title', 10, 3 );
127
128	/**
129	* Get plugin specific activity trigger permalink
130	*
131	* @since 1.0.0
132	*
133	* @param string $permalink
134	* @param integer $specific_id
135	* @param string $trigger_type
136	* @param integer $site_id
137	*
138	* @return string
139	*/
140	function gamipress_digimember_specific_activity_trigger_permalink( $permalink, $specific_id, $trigger_type, $site_id ) {
141
142	switch( $trigger_type ) {
143	// Purchase product
144	case 'gamipress_digimember_purchase_specific_product':
145	case 'gamipress_digimember_purchase_specific_membership_product':
146	case 'gamipress_digimember_purchase_specific_download_product':
147	// Cancel product
148	case 'gamipress_digimember_cancel_specific_product':
149	case 'gamipress_digimember_cancel_specific_membership_product':
150	case 'gamipress_digimember_cancel_specific_download_product':
151	$permalink = '';
152	break;
153	}
154
155	return $permalink;
156
157	}
158	add_filter( 'gamipress_specific_activity_trigger_permalink', 'gamipress_digimember_specific_activity_trigger_permalink', 10, 4 );
159
160	/**
161	* Get user for a digimembern trigger action.
162	*
163	* @since 1.0.0
164	*
165	* @param integer $user_id user ID to override.
166	* @param string $trigger Trigger name.
167	* @param array $args Passed trigger args.
168	* @return integer User ID.
169	*/
170	function gamipress_digimember_trigger_get_user_id( $user_id, $trigger, $args ) {
171
172	switch ( $trigger ) {
173	// Purchase product
174	case 'gamipress_digimember_purchase_product':
175	case 'gamipress_digimember_purchase_specific_product':
176	case 'gamipress_digimember_purchase_membership_product':
177	case 'gamipress_digimember_purchase_specific_membership_product':
178	case 'gamipress_digimember_purchase_download_product':
179	case 'gamipress_digimember_purchase_specific_download_product':
180	// Cancel product
181	case 'gamipress_digimember_cancel_product':
182	case 'gamipress_digimember_cancel_specific_product':
183	case 'gamipress_digimember_cancel_membership_product':
184	case 'gamipress_digimember_cancel_specific_membership_product':
185	case 'gamipress_digimember_cancel_download_product':
186	case 'gamipress_digimember_cancel_specific_download_product':
187	$user_id = $args[1];
188	break;
189	}
190
191	return $user_id;
192
193	}
194	add_filter( 'gamipress_trigger_get_user_id', 'gamipress_digimember_trigger_get_user_id', 10, 3 );
195
196	/**
197	* Get the id for a digimembern specific trigger action.
198	*
199	* @since 1.0.0
200	*
201	* @param integer $specific_id Specific ID.
202	* @param string $trigger Trigger name.
203	* @param array $args Passed trigger args.
204	*
205	* @return integer Specific ID.
206	*/
207	function gamipress_digimember_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) {
208
209	switch ( $trigger ) {
210	case 'gamipress_digimember_purchase_specific_product':
211	case 'gamipress_digimember_purchase_specific_membership_product':
212	case 'gamipress_digimember_purchase_specific_download_product':
213	case 'gamipress_digimember_cancel_specific_product':
214	case 'gamipress_digimember_cancel_specific_membership_product':
215	case 'gamipress_digimember_cancel_specific_download_product':
216	$specific_id = $args[2];
217	break;
218	}
219
220	return $specific_id;
221	}
222	add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_digimember_specific_trigger_get_id', 10, 3 );
223
224	/**
225	* Extended meta data for event trigger logging
226	*
227	* @since 1.0.0
228	*
229	* @param array $log_meta
230	* @param integer $user_id
231	* @param string $trigger
232	* @param integer $site_id
233	* @param array $args
234	*
235	* @return array
236	*/
237	function gamipress_digimember_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) {
238
239	switch ( $trigger ) {
240	// Purchase product
241	case 'gamipress_digimember_purchase_product':
242	case 'gamipress_digimember_purchase_specific_product':
243	case 'gamipress_digimember_purchase_membership_product':
244	case 'gamipress_digimember_purchase_specific_membership_product':
245	case 'gamipress_digimember_purchase_download_product':
246	case 'gamipress_digimember_purchase_specific_download_product':
247	// Cancel product
248	case 'gamipress_digimember_cancel_product':
249	case 'gamipress_digimember_cancel_specific_product':
250	case 'gamipress_digimember_cancel_membership_product':
251	case 'gamipress_digimember_cancel_specific_membership_product':
252	case 'gamipress_digimember_cancel_download_product':
253	case 'gamipress_digimember_cancel_specific_download_product':
254	// Add the order ID, product ID, product type and the reason
255	$log_meta['order_id'] = $args[0];
256	$log_meta['product_id'] = $args[2];
257	$log_meta['product_type'] = $args[3];
258	$log_meta['reason'] = $args[5];
259	break;
260	}
261
262	return $log_meta;
263	}
264	add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_digimember_log_event_trigger_meta_data', 10, 5 );