automatorwp / integrations / tutor / includes / triggers / complete-quiz.php

complete-quiz.php in AutomatorWP – No-Code Workflow Automation, Integration & Webhooks Plugin, now with AI 5.8.6, at integrations/tutor/includes/triggers/complete-quiz.php

121 lines 4.1 KB

Raw Download Zip

1	<?php
2	/**
3	* Complete Quiz
4	*
5	* @package AutomatorWP\Integrations\Tutor_LMS\Triggers\Complete_Quiz
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_Tutor_LMS_Complete_Quiz extends AutomatorWP_Integration_Trigger {
13
14	public $integration = 'tutor';
15	public $trigger = 'tutor_complete_quiz';
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 attempts a quiz', 'automatorwp' ),
27	'select_option' => __( 'User <strong>attempts</strong> a quiz', 'automatorwp' ),
28	/* translators: %1$s: Post title. %2$s: Number of times. */
29	'edit_label' => sprintf( __( 'User attempts %1$s %2$s time(s)', 'automatorwp' ), '{post}', '{times}' ),
30	/* translators: %1$s: Post title. */
31	'log_label' => sprintf( __( 'User attempts %1$s', 'automatorwp' ), '{post}' ),
32	'action' => 'tutor_quiz/attempt_ended',
33	'function' => array( $this, 'listener' ),
34	'priority' => 10,
35	'accepted_args' => 1,
36	'options' => array(
37	'post' => automatorwp_utilities_post_option( array(
38	'name' => __( 'Quiz:', 'automatorwp' ),
39	'option_none_label' => __( 'any quiz', 'automatorwp' ),
40	'post_type' => apply_filters( 'tutor_quiz_post_type', 'tutor_quiz' )
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 int $attempt_id
58	* @param int $quiz_id
59	* @param int $user_id
60	*/
61	public function listener( $attempt_id ) {
62
63	$attempt = tutor_utils()->get_attempt( $attempt_id );
64	$user_id = get_current_user_id();
65	$quiz_id = $attempt->quiz_id;
66
67	// Bail if is not a quiz
68	if ( 'tutor_quiz' !== get_post_type( $quiz_id ) ) {
69	return;
70	}
71
72	// Bail if attempt isn't finished yet
73	if ( ! in_array( $attempt->attempt_status, array( 'attempt_ended', 'review_required' ) ) ) {
74	return;
75	}
76
77	$course = tutor_utils()->get_course_by_quiz( $quiz_id );
78	$course_id = $course->ID;
79
80	automatorwp_trigger_event( array(
81	'trigger' => $this->trigger,
82	'user_id' => $user_id,
83	'post_id' => $quiz_id,
84	'course_id' => $course_id,
85	) );
86
87	}
88
89	/**
90	* User deserves check
91	*
92	* @since 1.0.0
93	*
94	* @param bool $deserves_trigger True if user deserves trigger, false otherwise
95	* @param stdClass $trigger The trigger object
96	* @param int $user_id The user ID
97	* @param array $event Event information
98	* @param array $trigger_options The trigger's stored options
99	* @param stdClass $automation The trigger's automation object
100	*
101	* @return bool True if user deserves trigger, false otherwise
102	*/
103	public function user_deserves_trigger( $deserves_trigger, $trigger, $user_id, $event, $trigger_options, $automation ) {
104
105	// Don't deserve if post is not received
106	if( ! isset( $event['post_id'] ) ) {
107	return false;
108	}
109
110	// Don't deserve if post doesn't match with the trigger option
111	if( ! automatorwp_posts_matches( $event['post_id'], $trigger_options['post'] ) ) {
112	return false;
113	}
114
115	return $deserves_trigger;
116
117	}
118
119	}
120
121	new AutomatorWP_Tutor_LMS_Complete_Quiz();