Tc_Tokens
Class Tc_Tokens
Source Source
File: src/integrations/learndash/tokens/tc-tokens.php
class Tc_Tokens { /** * Integration code * @var string */ public static $integration = 'LD'; public function __construct() { //*************************************************************// // See this filter generator AT automator-get-data.php // in function recipe_trigger_tokens() //*************************************************************// add_filter( 'automator_maybe_trigger_ld_tcmoduleinteraction_tokens', [ $this, 'possible_tokens' ], 9999, 2 ); add_filter( 'automator_maybe_parse_token', [ $this, 'tc_token' ], 20, 6 ); } /** * Only load this integration and its triggers and actions if the related plugin is active * * @param $status * @param $plugin * * @return bool */ public function plugin_active( $status, $plugin ) { if ( self::$integration === $plugin ) { if ( defined( 'UNCANNY_REPORTING_VERSION' ) ) { $status = true; } else { $status = false; } } return $status; } /** * @param array $tokens * @param array $args * * @return array */ public function possible_tokens( $tokens = array(), $args = array() ) { if ( ! isset( $args['value'] ) || ! isset( $args['meta'] ) ) { return $tokens; } if ( empty( $args['value'] ) || empty( $args['meta'] ) ) { return $tokens; } $tc_module_id = $args['value']; $trigger_meta = $args['meta']; $new_tokens = array(); if ( ! empty( $tc_module_id ) && absint( $tc_module_id ) ) { $new_tokens[] = [ 'tokenId' => $tc_module_id, 'tokenName' => __( 'Course title', 'uncanny-automator' ), 'tokenType' => 'text', 'tokenIdentifier' => $trigger_meta . '_maybe_course', ]; $new_tokens[] = [ 'tokenId' => $tc_module_id, 'tokenName' => __( 'Course ID', 'uncanny-automator' ), 'tokenType' => 'text', 'tokenIdentifier' => $trigger_meta . '_maybe_course_id', ]; $new_tokens[] = [ 'tokenId' => $tc_module_id, 'tokenName' => __( 'Course URL', 'uncanny-automator' ), 'tokenType' => 'text', 'tokenIdentifier' => $trigger_meta . '_maybe_course_url', ]; $new_tokens[] = [ 'tokenId' => $tc_module_id, 'tokenName' => __( 'Lesson title', 'uncanny-automator' ), 'tokenType' => 'text', 'tokenIdentifier' => $trigger_meta . '_maybe_lesson', ]; $new_tokens[] = [ 'tokenId' => $tc_module_id, 'tokenName' => __( 'Lesson ID', 'uncanny-automator' ), 'tokenType' => 'text', 'tokenIdentifier' => $trigger_meta . '_maybe_lesson_id', ]; $new_tokens[] = [ 'tokenId' => $tc_module_id, 'tokenName' => __( 'Lesson URL', 'uncanny-automator' ), 'tokenType' => 'text', 'tokenIdentifier' => $trigger_meta . '_maybe_lesson_url', ]; $new_tokens[] = [ 'tokenId' => $tc_module_id, 'tokenName' => __( 'Topic title', 'uncanny-automator' ), 'tokenType' => 'text', 'tokenIdentifier' => $trigger_meta . '_maybe_topic', ]; $new_tokens[] = [ 'tokenId' => $tc_module_id, 'tokenName' => __( 'Topic ID', 'uncanny-automator' ), 'tokenType' => 'text', 'tokenIdentifier' => $trigger_meta . '_maybe_topic_id', ]; $new_tokens[] = [ 'tokenId' => $tc_module_id, 'tokenName' => __( 'Topic URL', 'uncanny-automator' ), 'tokenType' => 'text', 'tokenIdentifier' => $trigger_meta . '_maybe_topic_url', ]; $tokens = array_merge( $tokens, $new_tokens ); } return $tokens; } /** * @param $value * @param $pieces * @param $recipe_id * @param $trigger_data * @param $user_id * * @return string|null */ public function tc_token( $value, $pieces, $recipe_id, $trigger_data, $user_id, $replace_args = array() ) { if ( $pieces ) { if ( in_array( 'TCMODULEINTERACTION_maybe_course', $pieces, true ) || in_array( 'TCMODULEINTERACTION_maybe_course_id', $pieces, true ) || in_array( 'TCMODULEINTERACTION_maybe_course_url', $pieces, true ) || in_array( 'TCMODULEINTERACTION_maybe_lesson', $pieces, true ) || in_array( 'TCMODULEINTERACTION_maybe_lesson_id', $pieces, true ) || in_array( 'TCMODULEINTERACTION_maybe_lesson_url', $pieces, true ) || in_array( 'TCMODULEINTERACTION_maybe_topic', $pieces, true ) || in_array( 'TCMODULEINTERACTION_maybe_topic_id', $pieces, true ) || in_array( 'TCMODULEINTERACTION_maybe_topic_url', $pieces, true ) || in_array( 'TCVERB', $pieces, true ) || in_array( 'QUIZPERCENT', $pieces, true ) || in_array( 'LDQUIZ', $pieces, true ) || in_array( 'LDQUIZ_ID', $pieces, true ) || in_array( 'TCMODULEINTERACTION', $pieces, true ) ) { if ( ! absint( $user_id ) ) { return $value; } if ( ! absint( $recipe_id ) ) { return $value; } $replace_pieces = $replace_args['pieces']; $recipe_id = $replace_args['recipe_id']; $trigger_log_id = $replace_args['trigger_log_id']; $run_number = $replace_args['run_number']; $user_id = $replace_args['user_id']; $trigger_id = absint( $replace_pieces[0] ); // Verb can be found from trigger meta if ( in_array( 'TCVERB', $pieces ) ) { $value = Automator()->get->maybe_get_meta_value_from_trigger_log( 'TCVERB', $trigger_id, $trigger_log_id, $run_number, $user_id ); return $value; } // Verb can be found from trigger meta if ( in_array( 'QUIZPERCENT', $pieces ) ) { $value = Automator()->get->maybe_get_meta_value_from_trigger_log( 'QUIZPERCENT', $trigger_id, $trigger_log_id, $run_number, $user_id ); return $value; } // Otherwise get TC module id from trigger meta $module_id = Automator()->get->maybe_get_meta_value_from_trigger_log( 'TCMODULEINTERACTION', $trigger_id, $trigger_log_id, $run_number, $user_id ); if ( class_exists( '\UCTINCAN\Database' ) ) { // In case just module name required. if ( in_array( 'TCMODULEINTERACTION', $pieces ) ) { $module_info = \TINCANNYSNC\Database::get_item( $module_id ); $value = isset( $module_info['file_name'] ) ? $module_info['file_name'] : ''; return $value; } // For other tokens. global $wpdb; $table_name = $wpdb->prefix . Database::TABLE_REPORTING; $q = "SELECT * FROM {$table_name} WHERE user_id = {$user_id} AND module LIKE '%/uncanny-snc/{$module_id}/%' ORDER BY xstored DESC LIMIT 0,1"; $tin_can_data = $wpdb->get_row( $q ); if ( ! empty( $tin_can_data ) ) { if ( in_array( 'TCMODULEINTERACTION_maybe_course', $pieces, true ) && ! empty( $tin_can_data->course_id ) ) { $value = get_the_title( $tin_can_data->course_id ); } if ( in_array( 'TCMODULEINTERACTION_maybe_course_id', $pieces, true ) && ! empty( $tin_can_data->course_id ) ) { $value = $tin_can_data->course_id; } if ( in_array( 'TCMODULEINTERACTION_maybe_course_url', $pieces, true ) && ! empty( $tin_can_data->course_id ) ) { $value = get_the_permalink( $tin_can_data->course_id ); } $post_type = get_post_type( $tin_can_data->lesson_id ); if ( 'sfwd-lessons' === $post_type ) { if ( in_array( 'TCMODULEINTERACTION_maybe_lesson', $pieces, true ) && ! empty( $tin_can_data->lesson_id ) ) { $value = get_the_title( $tin_can_data->lesson_id ); } if ( in_array( 'TCMODULEINTERACTION_maybe_lesson_id', $pieces, true ) && ! empty( $tin_can_data->lesson_id ) ) { $value = $tin_can_data->lesson_id; } if ( in_array( 'TCMODULEINTERACTION_maybe_lesson_url', $pieces, true ) && ! empty( $tin_can_data->lesson_id ) ) { $value = get_the_permalink( $tin_can_data->lesson_id ); } } else { if ( in_array( 'TCMODULEINTERACTION_maybe_topic', $pieces, true ) && ! empty( $tin_can_data->lesson_id ) ) { $value = get_the_title( $tin_can_data->lesson_id ); } if ( in_array( 'TCMODULEINTERACTION_maybe_topic_id', $pieces, true ) && ! empty( $tin_can_data->lesson_id ) ) { $value = $tin_can_data->lesson_id; } if ( in_array( 'TCMODULEINTERACTION_maybe_topic_url', $pieces, true ) && ! empty( $tin_can_data->lesson_id ) ) { $value = get_the_permalink( $tin_can_data->lesson_id ); } if ( in_array( 'TCMODULEINTERACTION_maybe_lesson', $pieces, true ) || in_array( 'TCMODULEINTERACTION_maybe_lesson_id', $pieces, true ) || in_array( 'TCMODULEINTERACTION_maybe_lesson_url', $pieces, true ) ) { if ( ( ! empty( $tin_can_data->course_id ) ) && ( \LearnDash_Settings_Section::get_section_setting( 'LearnDash_Settings_Courses_Builder', 'shared_steps' ) == 'yes' ) ) { $lesson_id = learndash_course_get_single_parent_step( $tin_can_data->course_id, $tin_can_data->lesson_id ); if ( in_array( 'TCMODULEINTERACTION_maybe_lesson', $pieces, true ) && ! empty( $lesson_id ) ) { $value = get_the_title( $lesson_id ); } if ( in_array( 'TCMODULEINTERACTION_maybe_lesson_id', $pieces, true ) && ! empty( $lesson_id ) ) { $value = $lesson_id; } if ( in_array( 'TCMODULEINTERACTION_maybe_lesson_url', $pieces, true ) && ! empty( $lesson_id ) ) { $value = get_the_permalink( $lesson_id ); } } } } } } if ( $trigger_data ) { foreach ( $trigger_data as $trigger ) { $quiz_id = 0; if ( isset( $trigger['meta']['LDQUIZ'] ) ) { $quiz_id = $trigger['meta']['LDQUIZ']; } if ( intval( '-1' ) === intval( $quiz_id ) ) { if ( isset( $_REQUEST['quiz'] ) ) { $quiz_id = absint( $_REQUEST['quiz'] ); if ( $quiz_id > 0 ) { if ( in_array( 'LDQUIZ', $pieces, true ) ) { $value = get_the_title( $quiz_id ); } if ( in_array( 'LDQUIZ_ID', $pieces, true ) ) { $value = $quiz_id; } if ( in_array( 'LDQUIZ_URL', $pieces, true ) ) { $value = get_permalink( $quiz_id ); } } } } } } } } return $value; } }
Expand full source code Collapse full source code View on Github
Methods Methods
- __construct
- plugin_active — Only load this integration and its triggers and actions if the related plugin is active
- possible_tokens
- tc_token