LLMS_Notification_Controller_Student_Welcome

Notification Controller: Student Welcome


Source Source

File: includes/notifications/controllers/class.llms.notification.controller.student.welcome.php

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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
class LLMS_Notification_Controller_Student_Welcome extends LLMS_Abstract_Notification_Controller {
 
    /**
     * Trigger Identifier
     *
     * @var  [type]
     */
    public $id = 'student_welcome';
 
    /**
     * Number of accepted arguments passed to the callback function
     *
     * @var integer
     */
    protected $action_accepted_args = 1;
 
    /**
     * Action hooks used to trigger sending of the notification
     *
     * @var array
     */
    protected $action_hooks = array(
        'lifterlms_user_registered',
        'llms_rest_student_registered',
    );
 
    /**
     * Determines if test notifications can be sent
     *
     * @var bool
     */
    protected $testable = array(
        'basic' => false,
        'email' => true,
    );
 
    /**
     * Callback function called when a lesson is completed by a student
     *
     * @since 3.8.0
     *
     * @param int $user_id WP_User ID.
     * @return void
     */
    public function action_callback( $user_id = null ) {
 
        $this->user_id = $user_id;
        $this->post_id = null;
 
        $this->send();
 
    }
 
    /**
     * Takes a subscriber type (student, author, etc) and retrieves a User ID
     *
     * @since 3.8.0
     *
     * @param string $subscriber Subscriber type string.
     * @return int|false
     */
    protected function get_subscriber( $subscriber ) {
 
        switch ( $subscriber ) {
 
            case 'student':
                $uid = $this->user_id;
                break;
 
            default:
                $uid = false;
 
        }
 
        return $uid;
 
    }
 
    /**
     * Determine what types are supported
     *
     * Extending classes can override this function in order to add or remove support
     * 3rd parties should add support via filter on $this->get_supported_types().
     *
     * @since 3.8.0
     *
     * @return array Associative array, keys are the ID/db type, values should be translated display types.
     */
    protected function set_supported_types() {
        return array(
            'email' => __( 'Email', 'lifterlms' ),
        );
    }
 
    /**
     * Get an array of LifterLMS Admin Page settings to send test notifications
     *
     * @since 3.33.2
     *
     * @param string $type Notification type [basic|email]
     * @return array
     */
    public function get_test_settings( $type ) {
 
        $query = new WP_User_Query(
            array(
                'number' => 25,
            )
        );
 
        $options = array(
            '' => '',
        );
        foreach ( $query->get_results() as $user ) {
            $student = llms_get_student( $user );
            if ( $student ) {
                $options[ $student->get_id() ] = esc_attr( sprintf( __( '%1$s <%2$s>', 'lifterlms' ), $student->get_name(), $student->get( 'user_email' ) ) );
            }
        }
 
        return array(
            array(
                'class'             => 'llms-select2',
                'custom_attributes' => array(
                    'data-allow-clear' => true,
                    'data-placeholder' => __( 'Select a user', 'lifterlms' ),
                ),
                'default'           => '',
                'id'                => 'user_id',
                'desc'              => '<br/>' . __( 'Send yourself a test notification using information for the selected user.', 'lifterlms' ),
                'options'           => $options,
                'title'             => __( 'Send a Test', 'lifterlms' ),
                'type'              => 'select',
            ),
        );
 
    }
 
    /**
     * Get the translatable title for the notification used on settings screens
     *
     * @since 3.8.0
     *
     * @return string
     */
    public function get_title() {
        return __( 'Student Welcome', 'lifterlms' );
    }
 
    /**
     * Send a test notification to the currently logged in users
     *
     * Extending classes should redefine this in order to properly setup the controller with post_id and user_id data.
     *
     * @since 3.33.2
     *
     * @param string $type Notification type [basic|email].
     * @param array  $data Array of test notification data as specified by $this->get_test_data().
     *
     * @return int|false
     */
    public function send_test( $type, $data = array() ) {
 
        if ( empty( $data['user_id'] ) ) {
            return;
        }
 
        $this->user_id = $data['user_id'];
        $this->post_id = null;
 
        return parent::send_test( $type );
 
    }
 
    /**
     * Setup the subscriber options for the notification
     *
     * @since 3.8.0
     *
     * @param string $type Notification type id.
     * @return array
     */
    protected function set_subscriber_options( $type ) {
 
        $options = array();
 
        switch ( $type ) {
 
            case 'email':
                $options[] = $this->get_subscriber_option_array( 'student', 'yes' );
                $options[] = $this->get_subscriber_option_array( 'custom', 'no' );
                break;
 
        }
 
        return $options;
 
    }
 
}


Top ↑

Methods Methods

  • action_callback — Callback function called when a lesson is completed by a student
  • get_subscriber — Takes a subscriber type (student, author, etc) and retrieves a User ID
  • get_test_settings — Get an array of LifterLMS Admin Page settings to send test notifications
  • get_title — Get the translatable title for the notification used on settings screens
  • send_test — Send a test notification to the currently logged in users
  • set_subscriber_options — Setup the subscriber options for the notification
  • set_supported_types — Determine what types are supported

Top ↑

Changelog Changelog

Changelog
Version Description
3.8.0
3.39.0 Added llms_rest_student_registered as action hook.
3.33.2 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.