| @@ -1,0 +1,371 @@ | ||
| 1 | +<?php | |
| 2 | +/** | |
| 3 | + * Triggers | |
| 4 | + * | |
| 5 | + * @package GamiPress\WS_Form\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_ws_form_activity_triggers( $triggers ) { | |
| 21 | + | |
| 22 | + $triggers[__( 'WS Form', 'gamipress' )] = array( | |
| 23 | + 'gamipress_ws_form_new_form_submission' => __( 'Successful submit a form', 'gamipress' ), | |
| 24 | + 'gamipress_ws_form_specific_new_form_submission' => __( 'Successful submit a specific form', 'gamipress' ), | |
| 25 | + 'gamipress_ws_form_field_value_submission' => __( 'Submit a specific field value', 'gamipress' ), | |
| 26 | + 'gamipress_ws_form_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_ws_form_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_ws_form_specific_activity_triggers( $specific_activity_triggers ) { | |
| 43 | + | |
| 44 | + $specific_activity_triggers['gamipress_ws_form_specific_new_form_submission'] = array( 'ws_form' ); | |
| 45 | + $specific_activity_triggers['gamipress_ws_form_specific_field_value_submission'] = array( 'ws_form' ); | |
| 46 | + | |
| 47 | + return $specific_activity_triggers; | |
| 48 | +} | |
| 49 | +add_filter( 'gamipress_specific_activity_triggers', 'gamipress_ws_form_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_ws_form_activity_trigger_label( $title, $requirement_id, $requirement ) { | |
| 63 | + | |
| 64 | + $field_name = ( isset( $requirement['ws_form_field_name'] ) ) ? $requirement['ws_form_field_name'] : ''; | |
| 65 | + $field_value = ( isset( $requirement['ws_form_field_value'] ) ) ? $requirement['ws_form_field_value'] : ''; | |
| 66 | + | |
| 67 | + switch( $requirement['trigger_type'] ) { | |
| 68 | + // Specific field value | |
| 69 | + case 'gamipress_ws_form_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_ws_form_specific_field_value_submission': | |
| 74 | + $achievement_post_id = absint( $requirement['achievement_post'] ); | |
| 75 | + $form_title = gamipress_ws_form_specific_activity_trigger_post_title( '', $achievement_post_id, $requirement['trigger_type'], $requirement['achievement_post_site_id'] ); | |
| 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_ws_form_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_ws_form_specific_activity_trigger_label( $specific_activity_trigger_labels ) { | |
| 93 | + | |
| 94 | + $specific_activity_trigger_labels['gamipress_ws_form_specific_new_form_submission'] = __( 'Submit %s', 'gamipress' ); | |
| 95 | + $specific_activity_trigger_labels['gamipress_ws_form_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_ws_form_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 | + * @param string $site_id | |
| 110 | + * @return string | |
| 111 | + */ | |
| 112 | +function gamipress_ws_form_specific_activity_trigger_post_title( $post_title, $specific_id, $trigger_type, $site_id ) { | |
| 113 | + | |
| 114 | + switch( $trigger_type ) { | |
| 115 | + case 'gamipress_ws_form_specific_new_form_submission': | |
| 116 | + case 'gamipress_ws_form_specific_field_value_submission': | |
| 117 | + if( absint( $specific_id ) !== 0 ) { | |
| 118 | + | |
| 119 | + if( gamipress_is_network_wide_active() && $site_id !== get_current_blog_id() ) { | |
| 120 | + // Switch to site | |
| 121 | + switch_to_blog( $site_id ); | |
| 122 | + | |
| 123 | + $post_title = wsf_form_get_form_label( $specific_id ); | |
| 124 | + | |
| 125 | + // Restore current site | |
| 126 | + restore_current_blog(); | |
| 127 | + } else { | |
| 128 | + $post_title = wsf_form_get_form_label( $specific_id ); | |
| 129 | + } | |
| 130 | + | |
| 131 | + | |
| 132 | + } | |
| 133 | + break; | |
| 134 | + } | |
| 135 | + | |
| 136 | + return $post_title; | |
| 137 | + | |
| 138 | +} | |
| 139 | +add_filter( 'gamipress_specific_activity_trigger_post_title', 'gamipress_ws_form_specific_activity_trigger_post_title', 10, 4 ); | |
| 140 | + | |
| 141 | +/** | |
| 142 | + * Get user for a given trigger action. | |
| 143 | + * | |
| 144 | + * @since 1.0.0 | |
| 145 | + * | |
| 146 | + * @param integer $user_id user ID to override. | |
| 147 | + * @param string $trigger Trigger name. | |
| 148 | + * @param array $args Passed trigger args. | |
| 149 | + * @return integer User ID. | |
| 150 | + */ | |
| 151 | +function gamipress_ws_form_trigger_get_user_id( $user_id, $trigger, $args ) { | |
| 152 | + | |
| 153 | + switch ( $trigger ) { | |
| 154 | + case 'gamipress_ws_form_new_form_submission': | |
| 155 | + case 'gamipress_ws_form_specific_new_form_submission': | |
| 156 | + case 'gamipress_ws_form_field_value_submission': | |
| 157 | + case 'gamipress_ws_form_specific_field_value_submission': | |
| 158 | + $user_id = $args[1]; | |
| 159 | + break; | |
| 160 | + } | |
| 161 | + | |
| 162 | + return $user_id; | |
| 163 | + | |
| 164 | +} | |
| 165 | +add_filter( 'gamipress_trigger_get_user_id', 'gamipress_ws_form_trigger_get_user_id', 10, 3); | |
| 166 | + | |
| 167 | + | |
| 168 | +/** | |
| 169 | + * Get the id for a given specific trigger action. | |
| 170 | + * | |
| 171 | + * @since 1.0.0 | |
| 172 | + * | |
| 173 | + * @param integer $specific_id Specific ID. | |
| 174 | + * @param string $trigger Trigger name. | |
| 175 | + * @param array $args Passed trigger args. | |
| 176 | + * | |
| 177 | + * @return integer Specific ID. | |
| 178 | + */ | |
| 179 | +function gamipress_ws_form_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) { | |
| 180 | + | |
| 181 | + switch ( $trigger ) { | |
| 182 | + case 'gamipress_ws_form_specific_new_form_submission': | |
| 183 | + case 'gamipress_ws_form_specific_field_value_submission': | |
| 184 | + $specific_id = $args[0]; | |
| 185 | + break; | |
| 186 | + } | |
| 187 | + | |
| 188 | + return $specific_id; | |
| 189 | +} | |
| 190 | +add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_ws_form_specific_trigger_get_id', 10, 3 ); | |
| 191 | + | |
| 192 | +/** | |
| 193 | + * Extended meta data for event trigger logging | |
| 194 | + * | |
| 195 | + * @since 1.0.1 | |
| 196 | + * | |
| 197 | + * @param array $log_meta | |
| 198 | + * @param integer $user_id | |
| 199 | + * @param string $trigger | |
| 200 | + * @param integer $site_id | |
| 201 | + * @param array $args | |
| 202 | + * | |
| 203 | + * @return array | |
| 204 | + */ | |
| 205 | +function gamipress_ws_form_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) { | |
| 206 | + | |
| 207 | + switch ( $trigger ) { | |
| 208 | + case 'gamipress_ws_form_new_form_submission': | |
| 209 | + case 'gamipress_ws_form_specific_new_form_submission': | |
| 210 | + // Add the form ID | |
| 211 | + $log_meta['form_id'] = $args[0]; | |
| 212 | + break; | |
| 213 | + case 'gamipress_ws_form_field_value_submission': | |
| 214 | + case 'gamipress_ws_form_specific_field_value_submission': | |
| 215 | + // Add the form ID, field name and value | |
| 216 | + $log_meta['form_id'] = $args[0]; | |
| 217 | + $log_meta['field_name'] = $args[2]; | |
| 218 | + $log_meta['field_value'] = $args[3]; | |
| 219 | + break; | |
| 220 | + } | |
| 221 | + | |
| 222 | + return $log_meta; | |
| 223 | +} | |
| 224 | +add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_ws_form_log_event_trigger_meta_data', 10, 5 ); | |
| 225 | + | |
| 226 | +/** | |
| 227 | + * Override the meta data to filter the logs count | |
| 228 | + * | |
| 229 | + * @since 1.0.0 | |
| 230 | + * | |
| 231 | + * @param array $log_meta The meta data to filter the logs count | |
| 232 | + * @param int $user_id The given user's ID | |
| 233 | + * @param string $trigger The given trigger we're checking | |
| 234 | + * @param int $since The since timestamp where retrieve the logs | |
| 235 | + * @param int $site_id The desired Site ID to check | |
| 236 | + * @param array $args The triggered args or requirement object | |
| 237 | + * | |
| 238 | + * @return array The meta data to filter the logs count | |
| 239 | + */ | |
| 240 | +function gamipress_ws_form_get_user_trigger_count_log_meta( $log_meta, $user_id, $trigger, $since, $site_id, $args ) { | |
| 241 | + | |
| 242 | + switch( $trigger ) { | |
| 243 | + case 'gamipress_ws_form_field_value_submission': | |
| 244 | + case 'gamipress_ws_form_specific_field_value_submission': | |
| 245 | + if( isset( $args[2] ) && isset( $args[3] ) ) { | |
| 246 | + // Add the field name and value | |
| 247 | + $log_meta['field_name'] = $args[2]; | |
| 248 | + $log_meta['field_value'] = $args[3]; | |
| 249 | + } | |
| 250 | + | |
| 251 | + // $args could be a requirement object | |
| 252 | + if( isset( $args['ws_form_field_name'] ) && isset( $args['ws_form_field_value'] ) ) { | |
| 253 | + // Add the field name and value | |
| 254 | + $log_meta['field_name'] = $args['ws_form_field_name']; | |
| 255 | + $log_meta['field_value'] = $args['ws_form_field_value']; | |
| 256 | + } | |
| 257 | + break; | |
| 258 | + } | |
| 259 | + | |
| 260 | + return $log_meta; | |
| 261 | + | |
| 262 | +} | |
| 263 | +add_filter( 'gamipress_get_user_trigger_count_log_meta', 'gamipress_ws_form_get_user_trigger_count_log_meta', 10, 6 ); | |
| 264 | + | |
| 265 | +/** | |
| 266 | + * Override the count log for array fields | |
| 267 | + * | |
| 268 | + * @since 1.0.0 | |
| 269 | + * | |
| 270 | + * @param int $trigger_count The total number of times a user has triggered the trigger | |
| 271 | + * @param int $user_id The given user's ID | |
| 272 | + * @param string $trigger The given trigger we're checking | |
| 273 | + * @param int $since The since timestamp where retrieve the logs | |
| 274 | + * @param int $site_id The desired Site ID to check | |
| 275 | + * @param array $args The triggered args or requirement object | |
| 276 | + * | |
| 277 | + * @return int The total number of times a user has triggered the trigger | |
| 278 | + */ | |
| 279 | +function gamipress_ws_form_get_user_trigger_count( $trigger_count, $user_id, $trigger, $since, $site_id, $args ) { | |
| 280 | + | |
| 281 | + switch( $trigger ) { | |
| 282 | + case 'gamipress_ws_form_field_value_submission': | |
| 283 | + case 'gamipress_ws_form_specific_field_value_submission': | |
| 284 | + | |
| 285 | + if( $trigger_count === 0 ) { | |
| 286 | + | |
| 287 | + $log_meta = array( | |
| 288 | + 'type' => 'event_trigger', | |
| 289 | + 'trigger_type' => $trigger, | |
| 290 | + ); | |
| 291 | + | |
| 292 | + $log_meta = apply_filters( 'gamipress_get_user_trigger_count_log_meta', $log_meta, $user_id, $trigger, $since, $site_id, $args ); | |
| 293 | + | |
| 294 | + if( isset( $log_meta['field_value'] ) ) { | |
| 295 | + | |
| 296 | + if( is_array( $log_meta['field_value'] ) ) { | |
| 297 | + $log_meta[] = array( | |
| 298 | + 'key' => 'field_value', | |
| 299 | + 'value' => $log_meta['field_value'], | |
| 300 | + 'compare' => 'IN', | |
| 301 | + ); | |
| 302 | + } else { | |
| 303 | + $log_meta[] = array( | |
| 304 | + 'key' => 'field_value', | |
| 305 | + 'value' => '%"' . $log_meta['field_value'] . '"%', | |
| 306 | + 'compare' => 'LIKE', | |
| 307 | + ); | |
| 308 | + } | |
| 309 | + | |
| 310 | + unset( $log_meta['field_value'] ); | |
| 311 | + | |
| 312 | + $trigger_count = absint( gamipress_get_user_log_count( absint( $user_id ), $log_meta, $since ) ); | |
| 313 | + } | |
| 314 | + } | |
| 315 | + break; | |
| 316 | + } | |
| 317 | + | |
| 318 | + return $trigger_count; | |
| 319 | + | |
| 320 | +} | |
| 321 | +add_filter( 'gamipress_get_user_trigger_count', 'gamipress_ws_form_get_user_trigger_count', 10, 6 ); | |
| 322 | + | |
| 323 | +/** | |
| 324 | + * Extra data fields | |
| 325 | + * | |
| 326 | + * @since 1.1.0 | |
| 327 | + * | |
| 328 | + * @param array $fields | |
| 329 | + * @param int $log_id | |
| 330 | + * @param string $type | |
| 331 | + * | |
| 332 | + * @return array | |
| 333 | + */ | |
| 334 | +function gamipress_ws_form_log_extra_data_fields( $fields, $log_id, $type ) { | |
| 335 | + | |
| 336 | + $prefix = '_gamipress_'; | |
| 337 | + | |
| 338 | + $log = ct_get_object( $log_id ); | |
| 339 | + $trigger = $log->trigger_type; | |
| 340 | + | |
| 341 | + if( $type !== 'event_trigger' ) { | |
| 342 | + return $fields; | |
| 343 | + } | |
| 344 | + | |
| 345 | + switch( $trigger ) { | |
| 346 | + case 'gamipress_ws_form_field_value_submission': | |
| 347 | + case 'gamipress_ws_form_specific_field_value_submission': | |
| 348 | + | |
| 349 | + $field_value = ct_get_object_meta( $log_id, $prefix . 'field_value', true ); | |
| 350 | + | |
| 351 | + $fields[] = array( | |
| 352 | + 'name' => __( 'Field ID', 'gamipress' ), | |
| 353 | + 'desc' => __( 'Field ID attached to this log.', 'gamipress' ), | |
| 354 | + 'id' => $prefix . 'field_name', | |
| 355 | + 'type' => 'text', | |
| 356 | + ); | |
| 357 | + $fields[] = array( | |
| 358 | + 'name' => __( 'Field value', 'gamipress' ), | |
| 359 | + 'desc' => __( 'Field value attached to this log.', 'gamipress' ), | |
| 360 | + 'id' => $prefix . 'field_value', | |
| 361 | + 'type' => ( is_array( $field_value ) ? 'advanced_select' : 'text' ), | |
| 362 | + 'multiple' => ( is_array( $field_value ) && count( $field_value ) > 1 ), | |
| 363 | + 'options' => ( is_array( $field_value ) ? $field_value : array() ), | |
| 364 | + ); | |
| 365 | + break; | |
| 366 | + } | |
| 367 | + | |
| 368 | + return $fields; | |
| 369 | + | |
| 370 | +} | |
| 371 | +add_filter( 'gamipress_log_extra_data_fields', 'gamipress_ws_form_log_extra_data_fields', 10, 3 ); | |
