triggers.php
10.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
<?php
/**
* Ranks Triggers.
*
* @package Badgeos
* @subpackage Ranks
* @author LearningTimes
* @license http://www.gnu.org/licenses/agpl.txt GNU AGPL v3.0
* @link https://credly.com/
*/
/**
* Helper function for returning our available ranks actvity triggers.
*
* @return array An array of all our activity triggers stored as 'value' => 'Display Name'.
*/
function get_badgeos_ranks_req_activity_triggers() {
$GLOBALS['badgeos']->badgeos_ranks_req_activity_triggers = apply_filters(
'badgeos_ranks_req_activity_triggers',
array(
'badgeos_wp_login' => __( 'Log in to Website', 'badgeos' ),
'badgeos_new_comment' => __( 'Comment on a post', 'badgeos' ),
'badgeos_specific_new_comment' => __( 'Comment on a specific post', 'badgeos' ),
'badgeos_new_post' => __( 'Publish a new post', 'badgeos' ),
'badgeos_visit_a_post' => __( 'Visit a Post', 'badgeos' ),
'badgeos_award_author_on_visit_post' => __( 'Award author when a user visits post', 'badgeos' ),
'badgeos_new_page' => __( 'Publish a new page', 'badgeos' ),
'badgeos_visit_a_page' => __( 'Visit a Page', 'badgeos' ),
'badgeos_points_on_birthday' => __( 'On User Birthday', 'badgeos' ),
'badgeos_award_author_on_visit_page' => __( 'Award author when a user visits page', 'badgeos' ),
'user_register' => __( 'Register to the website', 'badgeos' ),
'badgeos_daily_visit' => __( 'Daily visit website', 'badgeos' ),
'badgeos_on_completing_num_of_year' => __( 'After completing the number of years', 'badgeos' ),
'badgeos_on_completing_num_of_month' => __( 'After completing the number of month', 'badgeos' ),
'badgeos_on_completing_num_of_day' => __( 'After completing the number of day', 'badgeos' ),
'badgeos_on_the_first_x_users' => __( 'Rank to the first X users', 'badgeos' ),
)
);
return apply_filters( 'badgeos_activity_triggers_for_all', $GLOBALS['badgeos']->badgeos_ranks_req_activity_triggers );
}
/**
* Load up our activity triggers so we can add actions to them.
*
* @return void
*/
function badgeos_ranks_load_activity_triggers() {
/**
* Grab our activity triggers
*/
$activity_triggers = get_badgeos_ranks_req_activity_triggers();
/**
* Loop through each trigger and add our trigger event to the hook.
*/
foreach ( $activity_triggers as $trigger => $trigger_data ) {
if ( is_array( $trigger_data ) ) {
if ( count( $trigger_data['sub_triggers'] ) > 0 ) {
foreach ( $trigger_data['sub_triggers'] as $tdata ) {
add_action( trim( $tdata['trigger'] ), 'badgeos_dynamic_ranks_req_trigger_event', 10, 20 );
}
}
} else {
add_action( $trigger, 'badgeos_ranks_req_trigger_event', 10, 20 );
}
}
}
add_action( 'init', 'badgeos_ranks_load_activity_triggers' );
/**
* Handle each of our dynamic activity triggers.
*
* @since 1.0.0
* @return mixed.
*/
function badgeos_dynamic_ranks_req_trigger_event() {
/**
* Setup all our globals
*/
global $blog_id, $wpdb;
$site_id = $blog_id;
$args = func_get_args();
/**
* Grab our current trigger
*/
$this_trigger = current_filter();
/**
* Grab the user ID
*/
$user_id = $args[0];
if ( intval( $user_id ) < 1 ) {
$user_id = get_current_user_id();
}
$user_data = get_user_by( 'id', $user_id );
/**
* Sanity check, if we don't have a user object, bail here
*/
if ( ! is_object( $user_data ) ) {
return $args[0];
}
/**
* If the user doesn't satisfy the trigger requirements, bail here
*/
if ( ! apply_filters( 'badgeos_user_rank_deserves_trigger', true, $user_id, $this_trigger, $site_id, $args ) ) {
return $args[0];
}
/**
* Now determine if any Achievements are earned based on this trigger event
*/
$triggered_ranks = $wpdb->get_results(
$wpdb->prepare(
"SELECT p.ID as post_id
FROM $wpdb->postmeta AS pm
INNER JOIN $wpdb->posts AS p ON ( p.ID = pm.post_id AND pm.meta_key = '_badgeos_rank_subtrigger_value' ) where p.post_status = 'publish' AND pm.meta_value = %s
",
$this_trigger
)
);
if ( ! empty( $triggered_ranks ) ) {
foreach ( $triggered_ranks as $rank ) {
$parent_id = badgeos_get_parent_id( $rank->post_id );
if ( absint( $parent_id ) > 0 ) {
$step_params = badgeos_utilities::get_post_meta( $rank->post_id, '_badgeos_fields_data', true );
$step_params = badgeos_extract_array_from_query_params( $step_params );
if ( apply_filters( 'badgeos_check_dynamic_trigger_filter', true, 'ranks', $this_trigger, $step_params, $args[1] ) ) {
$new_count = badgeos_ranks_update_user_trigger_count( $rank->post_id, $parent_id, $user_id, $this_trigger, $site_id, $args );
badgeos_maybe_award_rank( $rank->post_id, $parent_id, $user_id, $this_trigger, $site_id, $args );
}
}
}
}
return $args[0];
}
/**
* Handle each of our ranks activity triggers.
*
* @return mixed
*/
function badgeos_ranks_req_trigger_event() {
/**
* Setup all our globals.
*/
global $blog_id, $wpdb;
$site_id = $blog_id;
$args = func_get_args();
/**
* Grab our current trigger.
*/
$this_trigger = current_filter();
/**
* Grab the user ID.
*/
$user_id = badgeos_trigger_get_user_id( $this_trigger, $args );
$user_data = get_user_by( 'id', $user_id );
/**
* Sanity check, if we don't have a user object, bail here.
*/
if ( ! is_object( $user_data ) ) {
return $args[0];
}
/**
* If the user doesn't satisfy the trigger requirements, bail here.
*/
if ( ! apply_filters( 'badgeos_user_rank_deserves_trigger', true, $user_id, $this_trigger, $site_id, $args ) ) {
return $args[0];
}
/**
* Now determine if any Achievements are earned based on this trigger event.
*/
$triggered_ranks = $wpdb->get_results(
$wpdb->prepare(
"SELECT p.ID as post_id
FROM $wpdb->postmeta AS pm
INNER JOIN $wpdb->posts AS p ON ( p.ID = pm.post_id AND pm.meta_key = '_rank_trigger_type' ) where p.post_status = 'publish' AND pm.meta_value = %s
",
$this_trigger
)
);
if ( ! empty( $triggered_ranks ) ) {
foreach ( $triggered_ranks as $rank ) {
$parent_id = badgeos_get_parent_id( $rank->post_id );
if ( absint( $parent_id ) > 0 ) {
if ( apply_filters( 'badgeos_user_rank_trigger', true, $rank->post_id, $parent_id, $user_id, $this_trigger, $site_id, $args ) ) {
$new_count = badgeos_ranks_update_user_trigger_count( $rank->post_id, $parent_id, $user_id, $this_trigger, $site_id, $args );
}
badgeos_maybe_award_rank( $rank->post_id, $parent_id, $user_id, $this_trigger, $site_id, $args );
}
}
}
return $args[0];
}
/**
* Wrapper function for returning a user's array of credit triggers.
*
* @param integer $step_id The given step ID.
* @param integer $user_id The desired User's ID to check.
* @param integer $site_id The desired Site ID to check.
* @return array An array of the triggers a user has triggered.
*/
function badgeos_ranks_get_user_triggers( $step_id, $user_id = 0, $site_id = 0 ) {
/**
* Grab all of the user's triggers
*/
$user_triggers = ! empty( badgeos_utilities::get_user_meta( $user_id, '_badgeos_ranks_triggers', true ) ) ? badgeos_utilities::get_user_meta( $user_id, '_badgeos_ranks_triggers', true ) : array();
/**
* Use current site ID if site ID is not set, AND not explicitly set to false.
*/
if ( ! $site_id && false !== $site_id ) {
$site_id = get_current_blog_id();
}
/**
* Return only the triggers that are relevant to the provided $site_id.
*/
if ( $site_id && isset( $user_triggers[ $site_id ] ) ) {
return $user_triggers[ $site_id ];
} else {
return $user_triggers;
}
}
/**
* Get the count for the number of times a user has triggered a particular credit trigger.
*
* @param integer $step_id The given step ID.
* @param integer $user_id The given user's ID.
* @param string $trigger The given trigger we're checking.
* @param integer $site_id The desired Site ID to check.
* @param array $args The triggered args.
* @return integer The total number of times a user has triggered the trigger.
*/
function ranks_get_user_trigger_count( $step_id, $user_id, $trigger, $site_id = 0, $args = array() ) {
/**
* Set to current site id.
*/
if ( ! $site_id ) {
$site_id = get_current_blog_id();
}
/**
* Grab the user's logged triggers.
*/
$user_triggers = badgeos_ranks_get_user_triggers( $step_id, $user_id, $site_id );
$trigger = apply_filters( 'ranks_get_user_trigger_name', $trigger, $user_id, $site_id, $step_id, $args );
/**
* If we have any triggers, return the current count for the given trigger.
*/
if ( ! empty( $user_triggers ) && isset( $user_triggers[ $trigger . '_' . $step_id ] ) ) {
return absint( $user_triggers[ $trigger . '_' . $step_id ] );
} else {
return 0;
}
}
/**
* Update the user's credit trigger count for a given trigger by 1.
*
* @param integer $step_id The given step ID.
* @param integer $rank_id The given rank ID.
* @param integer $user_id The given user's ID.
* @param string $trigger The trigger we're updating.
* @param integer $site_id The desired Site ID to update.
* @param array $args The triggered args.
* @return integer The updated trigger count.
*/
function badgeos_ranks_update_user_trigger_count( $step_id, $rank_id, $user_id, $trigger, $site_id = 0, $args = array() ) {
/**
* Set to current site id.
*/
if ( ! $site_id ) {
$site_id = get_current_blog_id();
}
/**
* Grab the current count and increase it by 1.
*/
$trigger_count = absint( ranks_get_user_trigger_count( $step_id, $user_id, $trigger, $site_id, $args ) );
$increment = 1;
$filter = apply_filters( 'badgeos_ranks_update_user_trigger_count', $increment, $user_id, $step_id, $rank_id, $trigger, $site_id, $args );
if ( $increment === $filter ) {
$trigger_count += (int) $increment;
} else {
return $increment;
}
/**
* Update the triggers arary with the new count.
*/
$user_triggers = badgeos_ranks_get_user_triggers( $step_id, $user_id, false );
$user_triggers[ $site_id ][ $trigger . '_' . $step_id ] = $trigger_count;
badgeos_utilities::update_user_meta( $user_id, '_badgeos_ranks_triggers', $user_triggers );
/**
* Send back our trigger count for other purposes.
*/
return $trigger_count;
}