← All changes
|
integrations/learndash/includes/triggers/complete-topic.php
+114
-0
5.7.4
→
6.0.3
View file →
| @@ -1,0 +1,114 @@ | ||
| 1 | +<?php | |
| 2 | +/** | |
| 3 | + * Complete Topic | |
| 4 | + * | |
| 5 | + * @package AutomatorWP\Integrations\LearnDash\Triggers\Complete_Topic | |
| 6 | + * @author AutomatorWP <[email protected]>, Ruben Garcia <[email protected]> | |
| 7 | + * @since 1.0.0 | |
| 8 | + */ | |
| 9 | +// Exit if accessed directly | |
| 10 | +if( !defined( 'ABSPATH' ) ) exit; | |
| 11 | + | |
| 12 | +class AutomatorWP_LearnDash_Complete_Topic extends AutomatorWP_Integration_Trigger { | |
| 13 | + | |
| 14 | + public $integration = 'learndash'; | |
| 15 | + public $trigger = 'learndash_complete_topic'; | |
| 16 | + | |
| 17 | + /** | |
| 18 | + * Register the trigger | |
| 19 | + * | |
| 20 | + * @since 1.0.0 | |
| 21 | + */ | |
| 22 | + public function register() { | |
| 23 | + | |
| 24 | + automatorwp_register_trigger( $this->trigger, array( | |
| 25 | + 'integration' => $this->integration, | |
| 26 | + 'label' => __( 'User completes a topic', 'automatorwp' ), | |
| 27 | + 'select_option' => __( 'User completes <strong>a topic</strong>', 'automatorwp' ), | |
| 28 | + /* translators: %1$s: Post title. %2$s: Number of times. */ | |
| 29 | + 'edit_label' => sprintf( __( 'User completes %1$s %2$s time(s)', 'automatorwp' ), '{post}', '{times}' ), | |
| 30 | + /* translators: %1$s: Post title. */ | |
| 31 | + 'log_label' => sprintf( __( 'User completes %1$s', 'automatorwp' ), '{post}' ), | |
| 32 | + 'action' => 'learndash_topic_completed', | |
| 33 | + 'function' => array( $this, 'listener' ), | |
| 34 | + 'priority' => 10, | |
| 35 | + 'accepted_args' => 1, | |
| 36 | + 'options' => array( | |
| 37 | + 'post' => automatorwp_utilities_post_option( array( | |
| 38 | + 'name' => __( 'Topic:', 'automatorwp' ), | |
| 39 | + 'option_none_label' => __( 'any topic', 'automatorwp' ), | |
| 40 | + 'post_type' => 'sfwd-topic' | |
| 41 | + ) ), | |
| 42 | + 'times' => automatorwp_utilities_times_option(), | |
| 43 | + ), | |
| 44 | + 'tags' => array_merge( | |
| 45 | + automatorwp_utilities_post_tags(), | |
| 46 | + automatorwp_utilities_times_tag() | |
| 47 | + ) | |
| 48 | + ) ); | |
| 49 | + | |
| 50 | + } | |
| 51 | + | |
| 52 | + /** | |
| 53 | + * Trigger listener | |
| 54 | + * | |
| 55 | + * @since 1.0.0 | |
| 56 | + * | |
| 57 | + * @param array $args array( | |
| 58 | + * 'user' => WP_User, | |
| 59 | + * 'course' => WP_Post, | |
| 60 | + * 'lesson' => WP_Post, | |
| 61 | + * 'topic' => WP_Post, | |
| 62 | + * 'progress' => array, | |
| 63 | + * ) | |
| 64 | + */ | |
| 65 | + public function listener( $args ) { | |
| 66 | + | |
| 67 | + $user_id = $args['user']->ID; | |
| 68 | + $topic_id = automatorwp_learndash_get_post_id( $args['topic'] ); | |
| 69 | + $lesson_id = automatorwp_learndash_get_post_id( $args['lesson'] ); | |
| 70 | + $course_id = automatorwp_learndash_get_post_id( $args['course'] ); | |
| 71 | + | |
| 72 | + automatorwp_trigger_event( array( | |
| 73 | + 'trigger' => $this->trigger, | |
| 74 | + 'user_id' => $user_id, | |
| 75 | + 'post_id' => $topic_id, | |
| 76 | + 'lesson_id' => $lesson_id, | |
| 77 | + 'course_id' => $course_id, | |
| 78 | + ) ); | |
| 79 | + | |
| 80 | + } | |
| 81 | + | |
| 82 | + /** | |
| 83 | + * User deserves check | |
| 84 | + * | |
| 85 | + * @since 1.0.0 | |
| 86 | + * | |
| 87 | + * @param bool $deserves_trigger True if user deserves trigger, false otherwise | |
| 88 | + * @param stdClass $trigger The trigger object | |
| 89 | + * @param int $user_id The user ID | |
| 90 | + * @param array $event Event information | |
| 91 | + * @param array $trigger_options The trigger's stored options | |
| 92 | + * @param stdClass $automation The trigger's automation object | |
| 93 | + * | |
| 94 | + * @return bool True if user deserves trigger, false otherwise | |
| 95 | + */ | |
| 96 | + public function user_deserves_trigger( $deserves_trigger, $trigger, $user_id, $event, $trigger_options, $automation ) { | |
| 97 | + | |
| 98 | + // Don't deserve if post is not received | |
| 99 | + if( ! isset( $event['post_id'] ) ) { | |
| 100 | + return false; | |
| 101 | + } | |
| 102 | + | |
| 103 | + // Don't deserve if post doesn't match with the trigger option | |
| 104 | + if( ! automatorwp_posts_matches( $event['post_id'], $trigger_options['post'] ) ) { | |
| 105 | + return false; | |
| 106 | + } | |
| 107 | + | |
| 108 | + return $deserves_trigger; | |
| 109 | + | |
| 110 | + } | |
| 111 | + | |
| 112 | +} | |
| 113 | + | |
| 114 | +new AutomatorWP_LearnDash_Complete_Topic(); | |