event_merge_tag_groups = array( 'learndash_course', 'learndash_user', 'learndash_topic', 'bwf_contact' );
$this->event_name = __( 'User Completes a Topic', 'wp-marketing-automations-pro' );
$this->event_desc = esc_html__( 'This event runs when the user completes a topic.', 'wp-marketing-automations-pro' );
$this->event_rule_groups = array(
'learndash_lesson',
'learndash_course',
'learndash_topic',
'bwf_contact_segments',
'bwf_contact',
'bwf_contact_fields',
'bwf_contact_user',
'bwf_contact_wc',
'bwf_contact_geo',
'bwf_engagement',
'bwf_broadcast'
);
$this->optgroup_label = __( 'LearnDash', 'wp-marketing-automations-pro' );
$this->priority = 50;
$this->v2 = true;
$this->automation_add = true;
}
public static function get_instance() {
if ( null === self::$instance ) {
self::$instance = new self();
}
return self::$instance;
}
public function load_hooks() {
add_action( 'learndash_topic_completed', [ $this, 'process' ] );
}
/**
* Make the required data for the current event and send it asynchronously.
*
* @param $lesson : is an array with 4 keys
* 1) user: user object
* 2) course: course object
* 3) lesson: lesson object
* 4) topic: topic object
* 5) progress: course progress array
*/
public function process( $lesson ) {
$data = $this->get_default_data();
$data['user_id'] = $lesson['user']->ID;
$data['course_id'] = $lesson['course']->ID;
$data['lesson_id'] = $lesson['lesson']->ID;
$data['topic_id'] = $lesson['topic']->ID;
$data['progress'] = $lesson['progress'];
$user = get_user_by( 'id', absint( $lesson['user']->ID ) );
$data['email'] = $user instanceof WP_User && is_email( $user->user_email ) ? $user->user_email : '';
$this->send_async_call( $data );
}
/**
* Set up rules data
*
* @param $automation_data
*/
public function pre_executable_actions( $automation_data ) {
BWFAN_Core()->rules->setRulesData( $this->user->ID, 'user_id' );
BWFAN_Core()->rules->setRulesData( $this->user, 'user' );
BWFAN_Core()->rules->setRulesData( $this->course, 'course' );
BWFAN_Core()->rules->setRulesData( $this->course->ID, 'course_id' );
BWFAN_Core()->rules->setRulesData( $this->lesson, 'lesson' );
BWFAN_Core()->rules->setRulesData( $this->lesson->ID, 'lesson_id' );
BWFAN_Core()->rules->setRulesData( $this->topic, 'topic' );
BWFAN_Core()->rules->setRulesData( $this->topic->ID, 'topic_id' );
BWFAN_Core()->rules->setRulesData( $this->progress, 'progress' );
BWFAN_Core()->rules->setRulesData( $this->email, 'email' );
}
/**
* Registers the tasks for current event.
*
* @param $automation_id
* @param $integration_data
* @param $event_data
*/
public function register_tasks( $automation_id, $integration_data, $event_data ) {
if ( ! is_array( $integration_data ) ) {
return;
}
$data_to_send = $this->get_event_data();
$this->create_tasks( $automation_id, $integration_data, $event_data, $data_to_send );
}
public function get_event_data() {
$data_to_send = [ 'global' => [] ];
$data_to_send['global']['user_id'] = $this->user->ID;
$data_to_send['global']['user'] = $this->user;
$data_to_send['global']['course_id'] = $this->course->ID;
$data_to_send['global']['course'] = $this->course;
$data_to_send['global']['lesson_id'] = $this->lesson->ID;
$data_to_send['global']['lesson'] = $this->lesson;
$data_to_send['global']['topic'] = $this->topic;
$data_to_send['global']['topic_id'] = $this->topic->ID;
$data_to_send['global']['progress'] = $this->progress;
$data_to_send['global']['email'] = $this->email;
return $data_to_send;
}
/**
* Make the view data for the current event which will be shown in task listing screen.
*
* @param $global_data
*
* @return false|string
*/
public function get_task_view( $global_data ) {
$user = get_user_by( 'ID', $global_data['user_id'] );
$course = get_post( $global_data['course_id'] );
$lesson = get_post( $global_data['lesson_id'] );
$topic = get_post( $global_data['topic_id'] );
ob_start();
?>
user_nicename ); ?>
post_title ); ?>
post_title ); ?>
post_title ); ?>
$task_meta['global']['user_id'],
'email' => $task_meta['global']['email'],
'user' => $task_meta['global']['user'],
'course' => $task_meta['global']['course'],
'course_id' => $task_meta['global']['course_id'],
'lesson' => $task_meta['global']['lesson'],
'lesson_id' => $task_meta['global']['lesson_id'],
'topic' => $task_meta['global']['topic'],
'topic_id' => $task_meta['global']['topic_id'],
'progress' => $task_meta['global']['progress'],
);
BWFAN_Merge_Tag_Loader::set_data( $set_data );
}
}
public function get_email_event() {
return $this->email;
}
public function get_user_id_event() {
return $this->user->ID;
}
/**
* Capture the async data for the current event.
* @return array|bool
*/
public function capture_async_data() {
$this->user = get_user_by( 'ID', BWFAN_Common::$events_async_data['user_id'] );
$this->course = get_post( BWFAN_Common::$events_async_data['course_id'] );
$this->lesson = get_post( BWFAN_Common::$events_async_data['lesson_id'] );
$this->topic = get_post( BWFAN_Common::$events_async_data['topic_id'] );
$this->progress = BWFAN_Common::$events_async_data['progress'];
$this->email = BWFAN_Common::$events_async_data['email'];
return $this->run_automations();
}
/**
* v2 Method: Validate event settings
*
* @param $automation_data
*
* @return bool
*/
public function validate_v2_event_settings( $automation_data ) {
/** check any topic case */
if ( ! isset( $automation_data['event_meta'] ) || ! isset( $automation_data['event_meta']['topics'] ) || 'any' === $automation_data['event_meta']['topics'] ) {
return true;
}
/** check if specific topic selected */
if ( ! is_array( $automation_data['event_meta']['topic_id'] ) || 0 === count( $automation_data['event_meta']['topic_id'] ) ) {
return false;
}
$ids = array_column( $automation_data['event_meta']['topic_id'], 'id' );
return in_array( intval( $automation_data['topic_id'] ), array_map( 'intval', $ids ), true );
}
/**
* Capture the async data for the current event.
*
* @return array|bool
*/
public function capture_v2_data( $automation_data ) {
$this->user = get_user_by( 'ID', BWFAN_Common::$events_async_data['user_id'] );
$this->course = get_post( BWFAN_Common::$events_async_data['course_id'] );
$this->lesson = get_post( BWFAN_Common::$events_async_data['lesson_id'] );
$this->topic = get_post( BWFAN_Common::$events_async_data['topic_id'] );
$this->progress = BWFAN_Common::$events_async_data['progress'];
$this->email = BWFAN_Common::$events_async_data['email'];
$automation_data['user'] = $this->user;
$automation_data['course'] = $this->course;
$automation_data['lesson'] = $this->lesson;
$automation_data['topic'] = $this->topic;
$automation_data['progress'] = $this->progress;
$automation_data['email'] = $this->email;
return $automation_data;
}
public function get_fields_schema() {
return [
[
'id' => 'topics',
'label' => __( 'Topics', 'wp-marketing-automations-pro' ),
'type' => 'radio',
'options' => [
[
'label' => __( 'Any Topic', 'wp-marketing-automations-pro' ),
'value' => 'any'
],
[
'label' => __( 'Specific Topics', 'wp-marketing-automations-pro' ),
'value' => 'selected_topic'
],
],
"class" => 'bwfan-input-wrapper',
"tip" => "",
"required" => false,
"description" => "",
],
[
"id" => 'topic_id',
"label" => __( 'Select Topic', 'wp-marketing-automations-pro' ),
"type" => 'custom_search',
'autocompleterOption' => [
'path' => 'ld_topics',
'slug' => 'ld_topics',
'labelText' => 'topic'
],
"allowFreeTextSearch" => false,
"required" => true,
"errorMsg" => __( "Topic is required", 'wp-marketing-automations-pro' ),
"multiple" => true,
'toggler' => [
'fields' => [
[
'id' => 'topics',
'value' => 'selected_topic',
]
]
],
]
];
}
/** set default values */
public function get_default_values() {
return array( "topics" => "any" );
}
/**
* get contact automation data
*
* @param $automation_data
* @param $cid
*
* @return array|null[]
*/
public function get_manually_added_contact_automation_data( $automation_data, $cid ) {
$contact = new WooFunnels_Contact( '', '', '', $cid );
/** Check if contact exists */
if ( ! $contact instanceof WooFunnels_Contact || empty( $contact->get_id() ) ) {
return [ 'status' => 0, 'type' => 'contact_not_found' ];
}
if ( 0 === intval( $contact->get_wpid() ) ) {
return [ 'status' => 0, 'type' => 'user_not_found' ];
}
/** fetching last topic id */
$topic_id = BWFAN_Learndash_Common::get_last_user_activity_by_type( $contact->get_wpid(), 'topic' );
/** return if no topic available as event is completed a topic */
if ( empty( $topic_id ) ) {
return [ 'status' => 0, 'type' => '', 'message' => __( 'User has not completed any topic', 'wp-marketing-automations-pro' ) ];
}
/** handling if selected_topic is selected */
if ( isset( $automation_data['event_meta']['topics'] ) && 'selected_topic' === $automation_data['event_meta']['topics'] ) {
$event_topic_ids = array_column( $automation_data['event_meta']['topic_id'], 'id' );
if ( ! in_array( $topic_id, $event_topic_ids ) ) {
return [ 'status' => 0, 'type' => '', 'message' => __( 'No topics are matching with event topics', 'wp-marketing-automations-pro' ) ];
}
}
$this->email = $contact->get_email();
$this->contact_id = $cid;
$this->user_id = $contact->get_wpid();
$this->user = get_user_by( 'ID', $contact->get_wpid() );
$this->topic_id = $topic_id;
$this->topic = get_post( $topic_id );
$this->lesson_id = learndash_get_lesson_id( $topic_id );
$this->lesson = get_post( $this->lesson_id );
$this->course_id = learndash_get_course_id( $this->lesson_id );
$this->course = get_post( $this->course_id );
$course_progress = learndash_user_get_course_progress( $contact->get_wpid(), $this->course_id, 'legacy' );
$this->progress = array( $this->course_id => $course_progress );
return array_merge( $automation_data, [
'contact_id' => $this->contact_id,
'email' => $this->email,
'user_id' => $this->user_id,
'user' => $this->user,
'topic_id' => $this->topic_id,
'topic' => $this->topic,
'lesson_id' => $this->lesson_id,
'lesson' => $this->lesson,
'course_id' => $this->course_id,
'course' => $this->course,
'progress' => $this->progress
] );
}
}
/**
* Register this event to a source.
* This will show the current event in dropdown in single automation screen.
*/
if ( bwfan_is_learndash_active() ) {
return 'BWFAN_LD_User_Completes_Topic';
}