__( 'Successful submit a form', 'gamipress' ), 'gamipress_forminator_specific_form_submission' => __( 'Successful submit a specific form', 'gamipress' ), 'gamipress_forminator_form_field_value_submission' => __( 'Submit a specific field value on any form', 'gamipress' ), 'gamipress_forminator_specific_form_field_value_submission' => __( 'Submit a specific field value on a specific form', 'gamipress' ), // Quiz 'gamipress_forminator_quiz_submission' => __( 'Successful submit a quiz', 'gamipress' ), 'gamipress_forminator_specific_quiz_submission' => __( 'Successful submit a specific quiz', 'gamipress' ), 'gamipress_forminator_pass_quiz' => __( 'Pass a quiz', 'gamipress' ), 'gamipress_forminator_pass_specific_quiz' => __( 'Pass a specific quiz', 'gamipress' ), 'gamipress_forminator_fail_quiz' => __( 'Fail a quiz', 'gamipress' ), 'gamipress_forminator_fail_specific_quiz' => __( 'Fail a specific quiz', 'gamipress' ), 'gamipress_forminator_quiz_field_value_submission' => __( 'Submit a specific field value on any quiz', 'gamipress' ), 'gamipress_forminator_specific_quiz_field_value_submission' => __( 'Submit a specific field value on a specific quiz', 'gamipress' ), // Poll 'gamipress_forminator_poll_submission' => __( 'Successful vote on a poll', 'gamipress' ), 'gamipress_forminator_specific_poll_submission' => __( 'Successful vote on a specific poll', 'gamipress' ), 'gamipress_forminator_poll_field_value_submission' => __( 'Submit a specific field value on any poll', 'gamipress' ), 'gamipress_forminator_specific_poll_field_value_submission' => __( 'Submit a specific field value on a specific poll', 'gamipress' ), ); return $triggers; } add_filter( 'gamipress_activity_triggers', 'gamipress_forminator_activity_triggers' ); /** * Register Forminator specific activity triggers * * @since 1.0.0 * * @param array $specific_activity_triggers * @return array */ function gamipress_forminator_specific_activity_triggers( $specific_activity_triggers ) { // Poll $specific_activity_triggers['gamipress_forminator_specific_form_submission'] = array( 'forminator_forms' ); $specific_activity_triggers['gamipress_forminator_specific_form_field_value_submission'] = array( 'forminator_forms' ); // Quiz $specific_activity_triggers['gamipress_forminator_specific_quiz_submission'] = array( 'forminator_quizzes' ); $specific_activity_triggers['gamipress_forminator_pass_specific_quiz'] = array( 'forminator_quizzes' ); $specific_activity_triggers['gamipress_forminator_fail_specific_quiz'] = array( 'forminator_quizzes' ); $specific_activity_triggers['gamipress_forminator_specific_quiz_field_value_submission'] = array( 'forminator_quizzes' ); // Poll $specific_activity_triggers['gamipress_forminator_specific_poll_submission'] = array( 'forminator_polls' ); $specific_activity_triggers['gamipress_forminator_specific_poll_field_value_submission'] = array( 'forminator_polls' ); return $specific_activity_triggers; } add_filter( 'gamipress_specific_activity_triggers', 'gamipress_forminator_specific_activity_triggers' ); /** * Build custom activity trigger label * * @since 1.0.0 * * @param string $title * @param integer $requirement_id * @param array $requirement * * @return string */ function gamipress_forminator_activity_trigger_label( $title, $requirement_id, $requirement ) { $field_name = ( isset( $requirement['forminator_field_name'] ) ) ? $requirement['forminator_field_name'] : ''; $field_value = ( isset( $requirement['forminator_field_value'] ) ) ? $requirement['forminator_field_value'] : ''; switch( $requirement['trigger_type'] ) { // Specific field value on any form case 'gamipress_forminator_form_field_value_submission': return sprintf( __( 'Submit a form setting field "%s" to "%s" value', 'gamipress' ), $field_name, $field_value ); break; // Specific field value on a specific form case 'gamipress_forminator_specific_form_field_value_submission': $achievement_post_id = absint( $requirement['achievement_post'] ); $form_title = gamipress_get_specific_activity_trigger_post_title( $achievement_post_id, $requirement['trigger_type'], get_current_blog_id() ); return sprintf( __( 'Submit %s form setting field "%s" to "%s" value', 'gamipress' ), $form_title, $field_name, $field_value ); break; // Specific field value on any quiz case 'gamipress_forminator_quiz_field_value_submission': return sprintf( __( 'Submit a quiz setting field "%s" to "%s" value', 'gamipress' ), $field_name, $field_value ); break; // Specific field value on a specific quiz case 'gamipress_forminator_specific_quiz_field_value_submission': $achievement_post_id = absint( $requirement['achievement_post'] ); $quiz_title = gamipress_get_specific_activity_trigger_post_title( $achievement_post_id, $requirement['trigger_type'], get_current_blog_id() ); return sprintf( __( 'Submit %s quiz setting field "%s" to "%s" value', 'gamipress' ), $quiz_title, $field_name, $field_value ); break; // Specific field value on any poll case 'gamipress_forminator_poll_field_value_submission': return sprintf( __( 'Submit a poll setting field "%s" to "%s" value', 'gamipress' ), $field_name, $field_value ); break; // Specific field value on a specific poll case 'gamipress_forminator_specific_poll_field_value_submission': $achievement_post_id = absint( $requirement['achievement_post'] ); $poll_title = gamipress_get_specific_activity_trigger_post_title( $achievement_post_id, $requirement['trigger_type'], get_current_blog_id() ); return sprintf( __( 'Submit %s poll setting field "%s" to "%s" value', 'gamipress' ), $poll_title, $field_name, $field_value ); break; } return $title; } add_filter( 'gamipress_activity_trigger_label', 'gamipress_forminator_activity_trigger_label', 10, 3 ); /** * Register Forminator specific activity triggers labels * * @since 1.0.0 * * @param array $specific_activity_trigger_labels * @return array */ function gamipress_forminator_specific_activity_trigger_label( $specific_activity_trigger_labels ) { $specific_activity_trigger_labels['gamipress_forminator_specific_form_submission'] = __( 'Submit %s form', 'gamipress' ); $specific_activity_trigger_labels['gamipress_forminator_specific_form_field_value_submission'] = __( 'Submit a specific field value on %s form', 'gamipress' ); $specific_activity_trigger_labels['gamipress_forminator_specific_quiz_submission'] = __( 'Submit %s quiz', 'gamipress' ); $specific_activity_trigger_labels['gamipress_forminator_pass_specific_quiz'] = __( 'Pass %s quiz', 'gamipress' ); $specific_activity_trigger_labels['gamipress_forminator_fail_specific_quiz'] = __( 'Fail %s quiz', 'gamipress' ); $specific_activity_trigger_labels['gamipress_forminator_specific_quiz_field_value_submission'] = __( 'Submit a specific field value on %s quiz', 'gamipress' ); $specific_activity_trigger_labels['gamipress_forminator_specific_poll_submission'] = __( 'Vote on %s poll', 'gamipress' ); $specific_activity_trigger_labels['gamipress_forminator_specific_poll_field_value_submission'] = __( 'Submit a specific field value on %s poll', 'gamipress' ); return $specific_activity_trigger_labels; } add_filter( 'gamipress_specific_activity_trigger_label', 'gamipress_forminator_specific_activity_trigger_label' ); /** * Get user for a given trigger action. * * @since 1.0.0 * * @param integer $user_id user ID to override. * @param string $trigger Trigger name. * @param array $args Passed trigger args. * @return integer User ID. */ function gamipress_forminator_trigger_get_user_id( $user_id, $trigger, $args ) { switch ( $trigger ) { // Form case 'gamipress_forminator_form_submission': case 'gamipress_forminator_specific_form_submission': case 'gamipress_forminator_form_field_value_submission': case 'gamipress_forminator_specific_form_field_value_submission': // Quiz case 'gamipress_forminator_quiz_submission': case 'gamipress_forminator_specific_quiz_submission': case 'gamipress_forminator_pass_quiz': case 'gamipress_forminator_pass_specific_quiz': case 'gamipress_forminator_fail_quiz': case 'gamipress_forminator_fail_specific_quiz': case 'gamipress_forminator_quiz_field_value_submission': case 'gamipress_forminator_specific_quiz_field_value_submission': // Poll case 'gamipress_forminator_poll_submission': case 'gamipress_forminator_specific_poll_submission': case 'gamipress_forminator_poll_field_value_submission': case 'gamipress_forminator_specific_poll_field_value_submission': $user_id = $args[1]; break; } return $user_id; } add_filter( 'gamipress_trigger_get_user_id', 'gamipress_forminator_trigger_get_user_id', 10, 3 ); /** * Get the id for a given specific trigger action. * * @since 1.0.0 * * @param integer $specific_id Specific ID. * @param string $trigger Trigger name. * @param array $args Passed trigger args. * * @return integer Specific ID. */ function gamipress_forminator_specific_trigger_get_id( $specific_id, $trigger = '', $args = array() ) { switch ( $trigger ) { // Form case 'gamipress_forminator_specific_form_submission': case 'gamipress_forminator_specific_form_field_value_submission': // Quiz case 'gamipress_forminator_specific_quiz_submission': case 'gamipress_forminator_pass_specific_quiz': case 'gamipress_forminator_fail_specific_quiz': case 'gamipress_forminator_specific_quiz_field_value_submission': // Poll case 'gamipress_forminator_specific_poll_submission': case 'gamipress_forminator_specific_poll_field_value_submission': $specific_id = $args[0]; break; } return $specific_id; } add_filter( 'gamipress_specific_trigger_get_id', 'gamipress_forminator_specific_trigger_get_id', 10, 3 ); /** * Extended meta data for event trigger logging * * @since 1.0.0 * * @param array $log_meta * @param integer $user_id * @param string $trigger * @param integer $site_id * @param array $args * * @return array */ function gamipress_forminator_log_event_trigger_meta_data( $log_meta, $user_id, $trigger, $site_id, $args ) { switch ( $trigger ) { // Form case 'gamipress_forminator_form_submission': case 'gamipress_forminator_specific_form_submission': // Quiz case 'gamipress_forminator_quiz_submission': case 'gamipress_forminator_specific_quiz_submission': case 'gamipress_forminator_pass_quiz': case 'gamipress_forminator_pass_specific_quiz': case 'gamipress_forminator_fail_quiz': case 'gamipress_forminator_fail_specific_quiz': // Poll case 'gamipress_forminator_poll_submission': case 'gamipress_forminator_specific_poll_submission': // Add the post ID $log_meta['post_id'] = $args[0]; break; // Form case 'gamipress_forminator_form_field_value_submission': case 'gamipress_forminator_specific_form_field_value_submission': // Quiz case 'gamipress_forminator_quiz_field_value_submission': case 'gamipress_forminator_specific_quiz_field_value_submission': // Poll case 'gamipress_forminator_poll_field_value_submission': case 'gamipress_forminator_specific_poll_field_value_submission': // Add the post ID $log_meta['post_id'] = $args[0]; $log_meta['field_name'] = $args[2]; $log_meta['field_value'] = $args[3]; break; } return $log_meta; } add_filter( 'gamipress_log_event_trigger_meta_data', 'gamipress_forminator_log_event_trigger_meta_data', 10, 5 ); /** * Override the meta data to filter the logs count * * @since 1.0.0 * * @param array $log_meta The meta data to filter the logs count * @param int $user_id The given user's ID * @param string $trigger The given trigger we're checking * @param int $since The since timestamp where retrieve the logs * @param int $site_id The desired Site ID to check * @param array $args The triggered args or requirement object * * @return array The meta data to filter the logs count */ function gamipress_forminator_get_user_trigger_count_log_meta( $log_meta, $user_id, $trigger, $since, $site_id, $args ) { switch( $trigger ) { // Form case 'gamipress_forminator_form_field_value_submission': case 'gamipress_forminator_specific_form_field_value_submission': // Quiz case 'gamipress_forminator_quiz_field_value_submission': case 'gamipress_forminator_specific_quiz_field_value_submission': // Poll case 'gamipress_forminator_poll_field_value_submission': case 'gamipress_forminator_specific_poll_field_value_submission': if( isset( $args[2] ) && isset( $args[3] ) ) { // Add the field name and value $log_meta['field_name'] = $args[2]; $log_meta['field_value'] = $args[3]; } // $args could be a requirement object if( isset( $args['forminator_field_name'] ) && isset( $args['forminator_field_value'] ) ) { // Add the field name and value $log_meta['field_name'] = $args['forminator_field_name']; $log_meta['field_value'] = $args['forminator_field_value']; } break; } return $log_meta; } add_filter( 'gamipress_get_user_trigger_count_log_meta', 'gamipress_forminator_get_user_trigger_count_log_meta', 10, 6 ); /** * Override the count log for array fields * * @since 1.0.0 * * @param int $trigger_count The total number of times a user has triggered the trigger * @param int $user_id The given user's ID * @param string $trigger The given trigger we're checking * @param int $since The since timestamp where retrieve the logs * @param int $site_id The desired Site ID to check * @param array $args The triggered args or requirement object * * @return int The total number of times a user has triggered the trigger */ function gamipress_forminator_get_user_trigger_count( $trigger_count, $user_id, $trigger, $since, $site_id, $args ) { switch( $trigger ) { // Form case 'gamipress_forminator_form_field_value_submission': case 'gamipress_forminator_specific_form_field_value_submission': // Quiz case 'gamipress_forminator_quiz_field_value_submission': case 'gamipress_forminator_specific_quiz_field_value_submission': // Poll case 'gamipress_forminator_poll_field_value_submission': case 'gamipress_forminator_specific_poll_field_value_submission': if( $trigger_count === 0 ) { $log_meta = array( 'type' => 'event_trigger', 'trigger_type' => $trigger, ); $log_meta = apply_filters( 'gamipress_get_user_trigger_count_log_meta', $log_meta, $user_id, $trigger, $since, $site_id, $args ); if( isset( $log_meta['field_value'] ) ) { if( is_array( $log_meta['field_value'] ) ) { $log_meta[] = array( 'key' => 'field_value', 'value' => $log_meta['field_value'], 'compare' => 'IN', ); } else { $log_meta[] = array( 'key' => 'field_value', 'value' => '%"' . $log_meta['field_value'] . '"%', 'compare' => 'LIKE', ); } unset( $log_meta['field_value'] ); $trigger_count = absint( gamipress_get_user_log_count( absint( $user_id ), $log_meta, $since ) ); } } break; } return $trigger_count; } add_filter( 'gamipress_get_user_trigger_count', 'gamipress_forminator_get_user_trigger_count', 10, 6 ); /** * Extra data fields * * @since 1.1.0 * * @param array $fields * @param int $log_id * @param string $type * * @return array */ function gamipress_forminator_log_extra_data_fields( $fields, $log_id, $type ) { $prefix = '_gamipress_'; $log = ct_get_object( $log_id ); $trigger = $log->trigger_type; if( $type !== 'event_trigger' ) { return $fields; } switch( $trigger ) { // Form case 'gamipress_forminator_form_field_value_submission': case 'gamipress_forminator_specific_form_field_value_submission': // Quiz case 'gamipress_forminator_quiz_field_value_submission': case 'gamipress_forminator_specific_quiz_field_value_submission': // Poll case 'gamipress_forminator_poll_field_value_submission': case 'gamipress_forminator_specific_poll_field_value_submission': $field_value = ct_get_object_meta( $log_id, $prefix . 'field_value', true ); $fields[] = array( 'name' => __( 'Field name', 'gamipress' ), 'desc' => __( 'Field name attached to this log.', 'gamipress' ), 'id' => $prefix . 'field_name', 'type' => 'text', ); $fields[] = array( 'name' => __( 'Field value', 'gamipress' ), 'desc' => __( 'Field value attached to this log.', 'gamipress' ), 'id' => $prefix . 'field_value', 'type' => ( is_array( $field_value ) ? 'advanced_select' : 'text' ), 'multiple' => ( is_array( $field_value ) && count( $field_value ) > 1 ? true : false ), 'options' => ( is_array( $field_value ) ? $field_value : array() ), ); break; } return $fields; } add_filter( 'gamipress_log_extra_data_fields', 'gamipress_forminator_log_extra_data_fields', 10, 3 );