/
class.llms.notification.controller.lesson.complete.php
145 lines (115 loc) · 2.86 KB
/
class.llms.notification.controller.lesson.complete.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<?php
/**
* Notification Controller: Lesson Complete
*
* @package LifterLMS/Notifications/Controllers/Classes
*
* @since 3.8.0
* @version 3.30.3
*/
defined( 'ABSPATH' ) || exit;
/**
* Notification Controller: Lesson Complete
*
* @since 3.8.0
* @since 3.30.3 Explicitly define class properties.
*/
class LLMS_Notification_Controller_Lesson_Complete extends LLMS_Abstract_Notification_Controller {
/**
* Trigger Identifier
*
* @var [type]
*/
public $id = 'lesson_complete';
/**
* Number of accepted arguments passed to the callback function
*
* @var integer
*/
protected $action_accepted_args = 2;
/**
* Action hooks used to trigger sending of the notification
*
* @var array
*/
protected $action_hooks = array( 'lifterlms_lesson_completed' );
/**
* @var LLMS_Lesson
* @since 3.8.0
*/
public $lesson;
/**
* Callback function called when a lesson is completed by a student
*
* @param int $student_id WP User ID of a LifterLMS Student
* @param int $lesson_id WP Post ID of a LifterLMS Lesson
* @return void
* @since 3.8.0
* @version 3.8.0
*/
public function action_callback( $student_id = null, $lesson_id = null ) {
$this->user_id = $student_id;
$this->post_id = $lesson_id;
$this->lesson = llms_get_post( $lesson_id );
$this->course = $this->lesson->get_course();
$this->send();
}
/**
* Takes a subscriber type (student, author, etc) and retrieves a User ID
*
* @param string $subscriber subscriber type string
* @return int|false
* @since 3.8.0
* @version 3.8.0
*/
protected function get_subscriber( $subscriber ) {
switch ( $subscriber ) {
case 'course_author':
$uid = $this->course->get( 'author' );
break;
case 'lesson_author':
$uid = $this->lesson->get( 'author' );
break;
case 'student':
$uid = $this->user_id;
break;
default:
$uid = false;
}
return $uid;
}
/**
* Get the translatable title for the notification
* used on settings screens
*
* @return string
* @since 3.8.0
* @version 3.8.0
*/
public function get_title() {
return __( 'Lesson Complete', 'lifterlms' );
}
/**
* Setup the subscriber options for the notification
*
* @param string $type notification type id
* @return array
* @since 3.8.0
* @version 3.8.0
*/
protected function set_subscriber_options( $type ) {
$options = array();
switch ( $type ) {
case 'basic':
$options[] = $this->get_subscriber_option_array( 'student', 'yes' );
break;
case 'email':
$options[] = $this->get_subscriber_option_array( 'lesson_author', 'no' );
$options[] = $this->get_subscriber_option_array( 'course_author', 'no' );
$options[] = $this->get_subscriber_option_array( 'custom', 'no' );
break;
}
return $options;
}
}
return LLMS_Notification_Controller_Lesson_Complete::instance();