| 1 |
<?php |
| 2 |
/** |
| 3 |
* Triggers |
| 4 |
* |
| 5 |
* @package GamiPress\Formidable_Forms\Triggers |
| 6 |
* @since 1.0.0 |
| 7 |
*/ |
| 8 |
|
| 9 |
// Exit if accessed directly |
| 10 |
if( !defined( 'ABSPATH' ) ) exit; |
| 11 |
|
| 12 |
/** |
| 13 |
* Register Formidable Forms specific triggers |
| 14 |
* |
| 15 |
* @since 1.0.0 |
| 16 |
* |
| 17 |
* @param array $triggers |
| 18 |
* @return mixed |
| 19 |
*/ |
| 20 |
function gamipress_frm_activity_triggers( $triggers ) { |
| 21 |
|
| 22 |
$triggers[__( 'Formidable Forms', 'gamipress' )] = array( |
| 23 |
'gamipress_frm_new_form_submission' => __( 'Successful submit a form', 'gamipress' ), |
| 24 |
'gamipress_frm_specific_new_form_submission' => __( 'Successful submit a specific form', 'gamipress' ), |
| 25 |
'gamipress_frm_field_value_submission' => __( 'Submit a specific field value', 'gamipress' ), |
| 26 |
'gamipress_frm_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_frm_activity_triggers' ); |
| 33 |
|
| 34 |
/** |
| 35 |
* Register Formidable Forms specific activity triggers |
| 36 |
* |
| 37 |
* @since 1.0.0 |
| 38 |
* |
| 39 |
* @param array $specific_activity_triggers |
| 40 |
* @return array |
| 41 |
*/ |
| 42 |
function gamipress_frm_specific_activity_triggers( $specific_activity_triggers ) { |
| 43 |
|
| 44 |
$specific_activity_triggers['gamipress_frm_specific_new_form_submission'] = array( 'formidable_form' ); |
| 45 |
$specific_activity_triggers['gamipress_frm_specific_field_value_submission'] = array( 'formidable_form' ); |
| 46 |
|
| 47 |
return $specific_activity_triggers; |
| 48 |
} |
| 49 |
add_filter( 'gamipress_specific_activity_triggers', 'gamipress_frm_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_frm_activity_trigger_label( $title, $requirement_id, $requirement ) { |
| 63 |
|
| 64 |
$field_name = ( isset( $requirement['frm_field_name'] ) ) ? $requirement['frm_field_name'] : ''; |
| 65 |
$field_value = ( isset( $requirement['frm_field_value'] ) ) ? $requirement['frm_field_value'] : ''; |
| 66 |
|
| 67 |
switch( $requirement['trigger_type'] ) { |
| 68 |
case 'gamipress_frm_specific_new_form_submission': |
| 69 |
$form = FrmForm::getOne( $requirement['achievement_post'] ); |
| 70 |
if( $form ) { |
| 71 |
return sprintf( __( 'Submit %s', 'gamipress' ), $form->name ); |
| 72 |
} |
| 73 |
break; |
| 74 |
// Specific field value |
| 75 |
case 'gamipress_frm_field_value_submission': |
| 76 |
return sprintf( __( 'Submit a form setting field "%s" to "%s" value', 'gamipress' ), $field_name, $field_value ); |
| 77 |
break; |
| 78 |
// Specific field value on a specific form |
| 79 |
case 'gamipress_frm_specific_field_value_submission': |
| 80 |
$form = FrmForm::getOne( $requirement['achievement_post'] ); |
| 81 |
$form_title = ( $form ? $form->name : '' ); |
| 82 |
return sprintf( __( 'Submit %s form setting field "%s" to "%s" value', 'gamipress' ), $form_title, $field_name, $field_value ); |
| 83 |
break; |
| 84 |
} |
| 85 |
|
| 86 |
return $title; |
| 87 |
} |
| 88 |
add_filter( 'gamipress_activity_trigger_label', 'gamipress_frm_activity_trigger_label', 10, 3 ); |
| 89 |
|
| 90 |
/** |
| 91 |
* Get Formidable Forms specific activity trigger post title |
| 92 |
* |
| 93 |
* @since 1.0.1 |
| 94 |
* |
| 95 |
* @param string $post_title |
| 96 |
* @param integer $specific_id |
| 97 |
* @param string $trigger_type |
| 98 |
* @return string |
| 99 |
*/ |
| 100 |
function gamipress_frm_specific_activity_trigger_post_title( $post_title, $specific_id, $trigger_type ) { |
| 101 |
|
| 102 |
switch( $trigger_type ) { |
| 103 |
case 'gamipress_frm_specific_new_form_submission': |
| 104 |
case 'gamipress_frm_specific_field_value_submission': |
| 105 |
if( absint( $specific_id ) !== 0 ) { |
| 106 |
$form = FrmForm::getOne( $specific_id ); |
| 107 |
|
| 108 |
$post_title = $form->name; |
| 109 |
} |
| 110 |
break; |
| 111 |
} |
| 112 |
|
| 113 |
return $post_title; |
| 114 |
|
| 115 |
} |
| 116 |
add_filter( 'gamipress_specific_activity_trigger_post_title', 'gamipress_frm_specific_activity_trigger_post_title', 10, 3 ); |
| 117 |
|
| 118 |
/** |
| 119 |
* Register Formidable Forms specific activity triggers labels |
| 120 |
* |
| 121 |
* @since 1.0.0 |
| 122 |
* |
| 123 |
* @param array $specific_activity_trigger_labels |
| 124 |
* @return array |
| 125 |
*/ |
| 126 |
function gamipress_frm_specific_activity_trigger_label( $specific_activity_trigger_labels ) { |
| 127 |
|
| 128 |
$specific_activity_trigger_labels['gamipress_frm_specific_new_form_submission'] = __( 'Submit %s', 'gamipress' ); |
| 129 |
$specific_activity_trigger_labels['gamipress_frm_specific_field_value_submission'] = __( 'Submit a specific field value on %s', 'gamipress' ); |
| 130 |
|
| 131 |
return $specific_activity_trigger_labels; |
| 132 |
} |
| 133 |
add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_frm_specific_activity_trigger_label' ); |
| 134 |
|
| 135 |
/** |
| 136 |
* Get user for a given trigger action. |
| 137 |
* |
| 138 |
* @since 1.0.0 |
| 139 |
* |
| 140 |
* @param integer $user_id user ID to override. |
| 141 |
* @param string $trigger Trigger name. |
| 142 |
* @param array $args Passed trigger args. |
| 143 |
* @return integer User ID. |
| 144 |
*/ |
| 145 |
function gamipress_frm_trigger_get_user_id( $user_id, $trigger, $args ) { |
| 146 |
|
| 147 |
switch ( $trigger ) { |
| 148 |
case 'gamipress_frm_new_form_submission': |
| 149 |
case 'gamipress_frm_specific_new_form_submission': |
| 150 |
case 'gamipress_frm_field_value_submission': |
| 151 |
case 'gamipress_frm_specific_field_value_submission': |
| 152 |
$user_id = $args[1]; |
| 153 |
break; |
| 154 |
} |
| 155 |
|
| 156 |
return $user_id; |
| 157 |
|
| 158 |
} |
| 159 |
add_filter( 'gamipress_trigger_get_user_id', 'gamipress_frm_trigger_get_user_id', 10, 3); |
| 160 |
|
| 161 |
|
| 162 |
/** |
| 163 |
* Get the id for a given specific trigger action. |
| 164 |
* |
| 165 |
* @since 1.0.0 |
| 166 |
* |
| 167 |
* @param integer $specific_id Specific ID. |
| 168 |
* @param string $trigger Trigger name. |
| 169 |
* @param array $args Passed trigger args. |
| 170 |
* |
| 171 |
* @return integer Specific ID. |
| 172 |
*/ |
| 173 |
function gamipress_frm_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) { |
| 174 |
|
| 175 |
switch ( $trigger ) { |
| 176 |
case 'gamipress_frm_specific_new_form_submission': |
| 177 |
case 'gamipress_frm_specific_field_value_submission': |
| 178 |
$specific_id = $args[0]; |
| 179 |
break; |
| 180 |
} |
| 181 |
|
| 182 |
return $specific_id; |
| 183 |
} |
| 184 |
add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_frm_specific_trigger_get_id', 10, 3 ); |
| 185 |
|
| 186 |
/** |
| 187 |
* Extended meta data for event trigger logging |
| 188 |
* |
| 189 |
* @since 1.0.0 |
| 190 |
* |
| 191 |
* @param array $log_meta |
| 192 |
* @param integer $user_id |
| 193 |
* @param string $trigger |
| 194 |
* @param integer $site_id |
| 195 |
* @param array $args |
| 196 |
* |
| 197 |
* @return array |
| 198 |
*/ |
| 199 |
function gamipress_frm_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) { |
| 200 |
|
| 201 |
switch ( $trigger ) { |
| 202 |
case 'gamipress_frm_new_form_submission': |
| 203 |
case 'gamipress_frm_specific_new_form_submission': |
| 204 |
// Add the form ID |
| 205 |
$log_meta['form_id'] = $args[0]; |
| 206 |
break; |
| 207 |
case 'gamipress_frm_field_value_submission': |
| 208 |
case 'gamipress_frm_specific_field_value_submission': |
| 209 |
// Add the form ID, field name and value |
| 210 |
$log_meta['form_id'] = $args[0]; |
| 211 |
$log_meta['field_name'] = $args[2]; |
| 212 |
$log_meta['field_value'] = $args[3]; |
| 213 |
break; |
| 214 |
} |
| 215 |
|
| 216 |
return $log_meta; |
| 217 |
} |
| 218 |
add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_frm_log_event_trigger_meta_data', 10, 5 ); |
| 219 |
|
| 220 |
/** |
| 221 |
* Override the meta data to filter the logs count |
| 222 |
* |
| 223 |
* @since 1.0.0 |
| 224 |
* |
| 225 |
* @param array $log_meta The meta data to filter the logs count |
| 226 |
* @param int $user_id The given user's ID |
| 227 |
* @param string $trigger The given trigger we're checking |
| 228 |
* @param int $since The since timestamp where retrieve the logs |
| 229 |
* @param int $site_id The desired Site ID to check |
| 230 |
* @param array $args The triggered args or requirement object |
| 231 |
* |
| 232 |
* @return array The meta data to filter the logs count |
| 233 |
*/ |
| 234 |
function gamipress_frm_get_user_trigger_count_log_meta( $log_meta, $user_id, $trigger, $since, $site_id, $args ) { |
| 235 |
|
| 236 |
switch( $trigger ) { |
| 237 |
case 'gamipress_frm_field_value_submission': |
| 238 |
case 'gamipress_frm_specific_field_value_submission': |
| 239 |
if( isset( $args[2] ) && isset( $args[3] ) ) { |
| 240 |
// Add the field name and value |
| 241 |
$log_meta['field_name'] = $args[2]; |
| 242 |
$log_meta['field_value'] = $args[3]; |
| 243 |
} |
| 244 |
|
| 245 |
// $args could be a requirement object |
| 246 |
if( isset( $args['frm_field_name'] ) && isset( $args['frm_field_value'] ) ) { |
| 247 |
// Add the field name and value |
| 248 |
$log_meta['field_name'] = $args['frm_field_name']; |
| 249 |
$log_meta['field_value'] = $args['frm_field_value']; |
| 250 |
} |
| 251 |
break; |
| 252 |
} |
| 253 |
|
| 254 |
return $log_meta; |
| 255 |
|
| 256 |
} |
| 257 |
add_filter( 'gamipress_get_user_trigger_count_log_meta', 'gamipress_frm_get_user_trigger_count_log_meta', 10, 6 ); |
| 258 |
|
| 259 |
/** |
| 260 |
* Override the count log for array fields |
| 261 |
* |
| 262 |
* @since 1.0.0 |
| 263 |
* |
| 264 |
* @param int $trigger_count The total number of times a user has triggered the trigger |
| 265 |
* @param int $user_id The given user's ID |
| 266 |
* @param string $trigger The given trigger we're checking |
| 267 |
* @param int $since The since timestamp where retrieve the logs |
| 268 |
* @param int $site_id The desired Site ID to check |
| 269 |
* @param array $args The triggered args or requirement object |
| 270 |
* |
| 271 |
* @return int The total number of times a user has triggered the trigger |
| 272 |
*/ |
| 273 |
function gamipress_frm_get_user_trigger_count( $trigger_count, $user_id, $trigger, $since, $site_id, $args ) { |
| 274 |
|
| 275 |
switch( $trigger ) { |
| 276 |
case 'gamipress_frm_field_value_submission': |
| 277 |
case 'gamipress_frm_specific_field_value_submission': |
| 278 |
|
| 279 |
if( $trigger_count === 0 ) { |
| 280 |
|
| 281 |
$log_meta = array( |
| 282 |
'type' => 'event_trigger', |
| 283 |
'trigger_type' => $trigger, |
| 284 |
); |
| 285 |
|
| 286 |
$log_meta = apply_filters( 'gamipress_get_user_trigger_count_log_meta', $log_meta, $user_id, $trigger, $since, $site_id, $args ); |
| 287 |
|
| 288 |
if( isset( $log_meta['field_value'] ) ) { |
| 289 |
$log_meta[] = array( |
| 290 |
'key' => 'field_value', |
| 291 |
'value' => '%"' . $log_meta['field_value'] . '"%', |
| 292 |
'compare' => 'LIKE', |
| 293 |
); |
| 294 |
|
| 295 |
unset( $log_meta['field_value'] ); |
| 296 |
|
| 297 |
$trigger_count = absint( gamipress_get_user_log_count( absint( $user_id ), $log_meta, $since ) ); |
| 298 |
} |
| 299 |
} |
| 300 |
break; |
| 301 |
} |
| 302 |
|
| 303 |
return $trigger_count; |
| 304 |
|
| 305 |
} |
| 306 |
add_filter( 'gamipress_get_user_trigger_count', 'gamipress_frm_get_user_trigger_count', 10, 6 ); |
| 307 |
|
| 308 |
/** |
| 309 |
* Extra data fields |
| 310 |
* |
| 311 |
* @since 1.1.0 |
| 312 |
* |
| 313 |
* @param array $fields |
| 314 |
* @param int $log_id |
| 315 |
* @param string $type |
| 316 |
* |
| 317 |
* @return array |
| 318 |
*/ |
| 319 |
function gamipress_frm_log_extra_data_fields( $fields, $log_id, $type ) { |
| 320 |
|
| 321 |
$prefix = '_gamipress_'; |
| 322 |
|
| 323 |
$log = ct_get_object( $log_id ); |
| 324 |
$trigger = $log->trigger_type; |
| 325 |
|
| 326 |
if( $type !== 'event_trigger' ) { |
| 327 |
return $fields; |
| 328 |
} |
| 329 |
|
| 330 |
switch( $trigger ) { |
| 331 |
case 'gamipress_frm_field_value_submission': |
| 332 |
case 'gamipress_frm_specific_field_value_submission': |
| 333 |
|
| 334 |
$field_value = ct_get_object_meta( $log_id, $prefix . 'field_value', true ); |
| 335 |
|
| 336 |
$fields[] = array( |
| 337 |
'name' => __( 'Field name', 'gamipress' ), |
| 338 |
'desc' => __( 'Field name attached to this log.', 'gamipress' ), |
| 339 |
'id' => $prefix . 'field_name', |
| 340 |
'type' => 'text', |
| 341 |
); |
| 342 |
$fields[] = array( |
| 343 |
'name' => __( 'Field value', 'gamipress' ), |
| 344 |
'desc' => __( 'Field value attached to this log.', 'gamipress' ), |
| 345 |
'id' => $prefix . 'field_value', |
| 346 |
'type' => ( is_array( $field_value ) ? 'advanced_select' : 'text' ), |
| 347 |
'multiple' => ( is_array( $field_value ) && count( $field_value ) > 1 ? true : false ), |
| 348 |
'options' => ( is_array( $field_value ) ? $field_value : array() ), |
| 349 |
); |
| 350 |
break; |
| 351 |
} |
| 352 |
|
| 353 |
return $fields; |
| 354 |
|
| 355 |
} |
| 356 |
add_filter( 'gamipress_log_extra_data_fields', 'gamipress_frm_log_extra_data_fields', 10, 3 ); |
