| 1 |
<?php |
| 2 |
/** |
| 3 |
* Complete Course |
| 4 |
* |
| 5 |
* @package AutomatorWP\Integrations\WPLMS\Triggers\Complete_Course |
| 6 |
* @author AutomatorWP <contact@automatorwp.com>, Ruben Garcia <rubengcdev@gmail.com> |
| 7 |
* @since 1.0.0 |
| 8 |
*/ |
| 9 |
// Exit if accessed directly |
| 10 |
if( !defined( 'ABSPATH' ) ) exit; |
| 11 |
|
| 12 |
class AutomatorWP_WPLMS_Complete_Course extends AutomatorWP_Integration_Trigger { |
| 13 |
|
| 14 |
public $integration = 'wplms'; |
| 15 |
public $trigger = 'wplms_complete_course'; |
| 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 course', 'automatorwp' ), |
| 27 |
'select_option' => __( 'User <strong>completes</strong> a course', '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' => 'wplms_submit_course', |
| 33 |
'function' => array( $this, 'listener' ), |
| 34 |
'priority' => 10, |
| 35 |
'accepted_args' => 2, |
| 36 |
'options' => array( |
| 37 |
'post' => automatorwp_utilities_post_option( array( |
| 38 |
'name' => __( 'Course:', 'automatorwp' ), |
| 39 |
'option_none_label' => __( 'any course', 'automatorwp' ), |
| 40 |
'post_type' => 'course' |
| 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 integer $course_id |
| 58 |
* @param integer $user_id |
| 59 |
*/ |
| 60 |
public function listener( $course_id, $user_id ) { |
| 61 |
|
| 62 |
automatorwp_trigger_event( array( |
| 63 |
'trigger' => $this->trigger, |
| 64 |
'user_id' => $user_id, |
| 65 |
'post_id' => $course_id, |
| 66 |
'operation' => 'complete', |
| 67 |
) ); |
| 68 |
|
| 69 |
} |
| 70 |
|
| 71 |
/** |
| 72 |
* User deserves check |
| 73 |
* |
| 74 |
* @since 1.0.0 |
| 75 |
* |
| 76 |
* @param bool $deserves_trigger True if user deserves trigger, false otherwise |
| 77 |
* @param stdClass $trigger The trigger object |
| 78 |
* @param int $user_id The user ID |
| 79 |
* @param array $event Event information |
| 80 |
* @param array $trigger_options The trigger's stored options |
| 81 |
* @param stdClass $automation The trigger's automation object |
| 82 |
* |
| 83 |
* @return bool True if user deserves trigger, false otherwise |
| 84 |
*/ |
| 85 |
public function user_deserves_trigger( $deserves_trigger, $trigger, $user_id, $event, $trigger_options, $automation ) { |
| 86 |
|
| 87 |
// Shorthand |
| 88 |
$operation = $trigger_options['operation']; |
| 89 |
|
| 90 |
// Ensure operation default value |
| 91 |
if( empty( $operation ) ) { |
| 92 |
$operation = 'complete'; |
| 93 |
} |
| 94 |
|
| 95 |
// Don't deserve if post is not received |
| 96 |
if( ! isset( $event['post_id'] ) && ! isset( $event['operation'] ) ) { |
| 97 |
return false; |
| 98 |
} |
| 99 |
|
| 100 |
// Don't deserve if post doesn't match with the trigger option |
| 101 |
if( ! automatorwp_posts_matches( $event['post_id'], $trigger_options['post'] ) ) { |
| 102 |
return false; |
| 103 |
} |
| 104 |
|
| 105 |
// Don't deserve if operation doesn't match with the trigger option |
| 106 |
if( $operation !== $event['operation'] ) { |
| 107 |
return false; |
| 108 |
} |
| 109 |
|
| 110 |
return $deserves_trigger; |
| 111 |
|
| 112 |
} |
| 113 |
|
| 114 |
} |
| 115 |
|
| 116 |
new AutomatorWP_WPLMS_Complete_Course(); |
