| @@ -1,0 +1,232 @@ | ||
| 1 | +<?php | |
| 2 | +/** | |
| 3 | + * Triggers | |
| 4 | + * | |
| 5 | + * @package GamiPress\Kali-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_kali_forms_activity_triggers( $triggers ) { | |
| 21 | + | |
| 22 | + $triggers[__( 'Kali Forms', 'gamipress' )] = array( | |
| 23 | + 'gamipress_kali_forms_new_form_submission' => __( 'Submit a form', 'gamipress' ), | |
| 24 | + 'gamipress_kali_forms_specific_new_form_submission' => __( 'Submit a specific form', 'gamipress' ), | |
| 25 | + 'gamipress_kali_forms_field_value_submission' => __( 'Submit a specific field value', 'gamipress' ), | |
| 26 | + 'gamipress_kali_forms_specific_field_value_submission' => __( 'Submit a specific field value on a specifc form', 'gamipress' ), | |
| 27 | + ); | |
| 28 | + | |
| 29 | + return $triggers; | |
| 30 | + | |
| 31 | +} | |
| 32 | +add_filter( 'gamipress_activity_triggers', 'gamipress_kali_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_kali_forms_specific_activity_triggers( $specific_activity_triggers ) { | |
| 43 | + | |
| 44 | + $specific_activity_triggers['gamipress_kali_forms_specific_new_form_submission'] = array( 'kaliforms_forms' ); | |
| 45 | + $specific_activity_triggers['gamipress_kali_forms_specific_field_value_submission'] = array( 'kaliforms_forms' ); | |
| 46 | + | |
| 47 | + return $specific_activity_triggers; | |
| 48 | +} | |
| 49 | +add_filter( 'gamipress_specific_activity_triggers', 'gamipress_kali_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_kali_forms_activity_trigger_label( $title, $requirement_id, $requirement ) { | |
| 63 | + | |
| 64 | + $field_name = ( isset( $requirement['kali_forms_field_name'] ) ) ? $requirement['kali_forms_field_name'] : ''; | |
| 65 | + $field_value = ( isset( $requirement['kali_forms_field_value'] ) ) ? $requirement['kali_forms_field_value'] : ''; | |
| 66 | + | |
| 67 | + switch( $requirement['trigger_type'] ) { | |
| 68 | + // Specifc field value | |
| 69 | + case 'gamipress_kali_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_kali_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' ), $form_title, $field_name, $field_value ); | |
| 76 | + break; | |
| 77 | + } | |
| 78 | + | |
| 79 | + return $title; | |
| 80 | + | |
| 81 | +} | |
| 82 | +add_filter( 'gamipress_activity_trigger_label', 'gamipress_kali_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_kali_forms_specific_activity_trigger_label( $specific_activity_trigger_labels ) { | |
| 93 | + $specific_activity_trigger_labels['gamipress_kali_forms_specific_new_form_submission'] = __( 'Submit %s', 'gamipress' ); | |
| 94 | + $specific_activity_trigger_labels['gamipress_kali_forms_specific_field_value_submission'] = __( 'Submit a specific field value on %s', 'gamipress' ); | |
| 95 | + | |
| 96 | + return $specific_activity_trigger_labels; | |
| 97 | + | |
| 98 | +} | |
| 99 | +add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_kali_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_kali_forms_trigger_get_user_id( $user_id, $trigger, $args ) { | |
| 112 | + | |
| 113 | + switch( $trigger ) { | |
| 114 | + case 'gamipress_kali_forms_new_form_submission': | |
| 115 | + case 'gamipress_kali_forms_specific_new_form_submission': | |
| 116 | + case 'gamipress_kali_forms_field_value_submission': | |
| 117 | + case 'gamipress_kali_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_kali_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_kali_forms_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) { | |
| 139 | + switch ( $trigger ) { | |
| 140 | + case 'gamipress_kali_forms_specific_new_form_submission': | |
| 141 | + case 'gamipress_kali_forms_specific_field_value_submission': | |
| 142 | + $specific_id = $args[0]; | |
| 143 | + } | |
| 144 | + | |
| 145 | + return $specific_id; | |
| 146 | +} | |
| 147 | +add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_kali_forms_specific_trigger_get_id', 10, 3 ); | |
| 148 | + | |
| 149 | +/** | |
| 150 | + * Extended meta data for event trigger logging | |
| 151 | + * | |
| 152 | + * @since 1.0.0 | |
| 153 | + * | |
| 154 | + * @param array $log_meta | |
| 155 | + * @param integer $user_id | |
| 156 | + * @param string $trigger | |
| 157 | + * @param integer $site_id | |
| 158 | + * @param array $args | |
| 159 | + * | |
| 160 | + * @return array | |
| 161 | + */ | |
| 162 | +function gamipress_kali_forms_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) { | |
| 163 | + | |
| 164 | + switch ( $trigger ) { | |
| 165 | + case 'gamipress_kali_forms_new_form_submission': | |
| 166 | + case 'gamipress_kali_forms_specific_new_form_submission': | |
| 167 | + // Add the form ID | |
| 168 | + $log_meta['form_id'] = $args[0]; | |
| 169 | + break; | |
| 170 | + case 'gamipress_kali_forms_field_value_submission': | |
| 171 | + case 'gamipress_kali_forms_specific_field_value_submission': | |
| 172 | + // Add the form ID, field name and value | |
| 173 | + $log_meta['form_id'] = $args[0]; | |
| 174 | + $log_meta['field_name'] = $args[2]; | |
| 175 | + $log_meta['field_value'] = $args[3]; | |
| 176 | + break; | |
| 177 | + } | |
| 178 | + | |
| 179 | + return $log_meta; | |
| 180 | + | |
| 181 | +} | |
| 182 | +add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_kali_forms_log_event_trigger_meta_data', 10, 5 ); | |
| 183 | + | |
| 184 | +/** | |
| 185 | + * Extra data fields | |
| 186 | + * | |
| 187 | + * @since 1.0.0 | |
| 188 | + * | |
| 189 | + * @param array $fields | |
| 190 | + * @param int $log_id | |
| 191 | + * @param string $type | |
| 192 | + * | |
| 193 | + * @return array | |
| 194 | + */ | |
| 195 | +function gamipress_kali_forms_log_extra_data_fields( $fields, $log_id, $type ) { | |
| 196 | + | |
| 197 | + $prefix = '_gamipress_'; | |
| 198 | + | |
| 199 | + $log = ct_get_object( $log_id ); | |
| 200 | + $trigger = $log->trigger_type; | |
| 201 | + | |
| 202 | + if( $type !== 'event_trigger' ) { | |
| 203 | + return $fields; | |
| 204 | + } | |
| 205 | + | |
| 206 | + switch ( $trigger ) { | |
| 207 | + case 'gamipress_kali_forms_field_value_submission': | |
| 208 | + case 'gamipress_kali_forms_specific_field_value_submission': | |
| 209 | + | |
| 210 | + $field_value = ct_get_object_meta( $log_id, $prefix . 'field_value', true ); | |
| 211 | + | |
| 212 | + $fields[] = array( | |
| 213 | + 'name' => __( 'Field name', 'gamipress' ), | |
| 214 | + 'desc' => __( 'Field name attached to this log.', 'gamipress' ), | |
| 215 | + 'id' => $prefix . 'field_name', | |
| 216 | + 'type' => 'text', | |
| 217 | + ); | |
| 218 | + $fields[] = array( | |
| 219 | + 'name' => __( 'Field value', 'gamipress' ), | |
| 220 | + 'desc' => __( 'Field value attached to this log.', 'gamipress' ), | |
| 221 | + 'id' => $prefix . 'field_value', | |
| 222 | + 'type' => ( is_array( $field_value ) ? 'advanced_select' : 'text' ), | |
| 223 | + 'multiple' => ( is_array( $field_value ) && count( $field_value ) > 1 ? true : false ), | |
| 224 | + 'options' => ( is_array( $field_value ) ? $field_value : array() ), | |
| 225 | + ); | |
| 226 | + break; | |
| 227 | + } | |
| 228 | + | |
| 229 | + return $fields; | |
| 230 | + | |
| 231 | +} | |
| 232 | +add_filter( 'gamipress_log_extra_data_fields', 'gamipress_kali_forms_log_extra_data_fields', 10, 3 ); | |