-
Notifications
You must be signed in to change notification settings - Fork 6
/
externallib.php
318 lines (282 loc) · 11.8 KB
/
externallib.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
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* credit enrol plugin external functions
*
* @package enrol_credit
* @copyright 2013 Rajesh Taneja <[email protected]>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once("$CFG->libdir/externallib.php");
/**
* credit enrolment external functions.
*
* @package enrol_credit
* @copyright 2020 Derick Turner [email protected]
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.6
*/
class enrol_credit_external extends external_api {
/**
* Returns description of get_instance_info() parameters.
*
* @return external_function_parameters
*/
public static function get_instance_info_parameters() {
return new external_function_parameters(
array('instanceid' => new external_value(PARAM_INT, 'instance id of credit enrolment plugin.'))
);
}
/**
* Return credit-enrolment instance information.
*
* @param int $instanceid instance id of credit enrolment plugin.
* @return array instance information.
* @throws moodle_exception
*/
public static function get_instance_info($instanceid) {
global $DB, $CFG;
require_once($CFG->libdir . '/enrollib.php');
$params = self::validate_parameters(self::get_instance_info_parameters(), array('instanceid' => $instanceid));
// Retrieve credit enrolment plugin.
$enrolplugin = enrol_get_plugin('credit');
if (empty($enrolplugin)) {
throw new moodle_exception('invaliddata', 'error');
}
self::validate_context(context_system::instance());
$enrolinstance = $DB->get_record('enrol', array('id' => $params['instanceid']), '*', MUST_EXIST);
$course = $DB->get_record('course', array('id' => $enrolinstance->courseid), '*', MUST_EXIST);
if (!core_course_category::can_view_course_info($course) && !can_access_course($course)) {
throw new moodle_exception('coursehidden');
}
$instanceinfo = (array) $enrolplugin->get_enrol_info($enrolinstance);
if (isset($instanceinfo['requiredparam']->enrolpassword)) {
$instanceinfo['enrolpassword'] = $instanceinfo['requiredparam']->enrolpassword;
}
unset($instanceinfo->requiredparam);
return $instanceinfo;
}
/**
* Returns description of get_instance_info() result value.
*
* @return external_description
*/
public static function get_instance_info_returns() {
return new external_single_structure(
array(
'id' => new external_value(PARAM_INT, 'id of course enrolment instance'),
'courseid' => new external_value(PARAM_INT, 'id of course'),
'type' => new external_value(PARAM_PLUGIN, 'type of enrolment plugin'),
'name' => new external_value(PARAM_RAW, 'name of enrolment plugin'),
'status' => new external_value(PARAM_RAW, 'status of enrolment plugin'),
'enrolpassword' => new external_value(PARAM_RAW, 'password required for enrolment', VALUE_OPTIONAL),
)
);
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function enrol_user_parameters() {
return new external_function_parameters(
array(
'courseid' => new external_value(PARAM_INT, 'Id of the course'),
'password' => new external_value(PARAM_RAW, 'Enrolment key', VALUE_DEFAULT, ''),
'instanceid' => new external_value(PARAM_INT, 'Instance id of credit enrolment plugin.', VALUE_DEFAULT, 0)
)
);
}
/**
* credit enrol the current user in the given course.
*
* @param int $courseid id of course
* @param string $password enrolment key
* @param int $instanceid instance id of credit enrolment plugin
* @return array of warnings and status result
* @since Moodle 3.0
* @throws moodle_exception
*/
public static function enrol_user($courseid, $password = '', $instanceid = 0) {
global $CFG;
require_once($CFG->libdir . '/enrollib.php');
$params = self::validate_parameters(self::enrol_user_parameters(),
array(
'courseid' => $courseid,
'password' => $password,
'instanceid' => $instanceid
));
$warnings = array();
$course = get_course($params['courseid']);
$context = context_course::instance($course->id);
self::validate_context(context_system::instance());
if (!core_course_category::can_view_course_info($course)) {
throw new moodle_exception('coursehidden');
}
// Retrieve the credit enrolment plugin.
$enrol = enrol_get_plugin('credit');
if (empty($enrol)) {
throw new moodle_exception('canntenrol', 'enrol_credit');
}
// We can expect multiple credit-enrolment instances.
$instances = array();
$enrolinstances = enrol_get_instances($course->id, true);
foreach ($enrolinstances as $courseenrolinstance) {
if ($courseenrolinstance->enrol == "credit") {
// Instance specified.
if (!empty($params['instanceid'])) {
if ($courseenrolinstance->id == $params['instanceid']) {
$instances[] = $courseenrolinstance;
break;
}
} else {
$instances[] = $courseenrolinstance;
}
}
}
if (empty($instances)) {
throw new moodle_exception('canntenrol', 'enrol_credit');
}
// Try to enrol the user in the instance/s.
$enrolled = false;
foreach ($instances as $instance) {
$enrolstatus = $enrol->can_credit_enrol($instance);
if ($enrolstatus === true) {
if ($instance->password and $params['password'] !== $instance->password) {
// Check if we are using group enrolment keys.
if ($instance->customint1) {
require_once($CFG->dirroot . "/enrol/credit/locallib.php");
if (!enrol_credit_check_group_enrolment_key($course->id, $params['password'])) {
$warnings[] = array(
'item' => 'instance',
'itemid' => $instance->id,
'warningcode' => '2',
'message' => get_string('passwordinvalid', 'enrol_credit')
);
continue;
}
} else {
if ($enrol->get_config('showhint')) {
$hint = core_text::substr($instance->password, 0, 1);
$warnings[] = array(
'item' => 'instance',
'itemid' => $instance->id,
'warningcode' => '3',
'message' => s(get_string('passwordinvalidhint', 'enrol_credit', $hint)) // message is PARAM_TEXT.
);
continue;
} else {
$warnings[] = array(
'item' => 'instance',
'itemid' => $instance->id,
'warningcode' => '4',
'message' => get_string('passwordinvalid', 'enrol_credit')
);
continue;
}
}
}
// Do the enrolment.
$data = array('enrolpassword' => $params['password']);
$enrol->enrol_credit($instance, (object) $data);
$enrolled = true;
break;
} else {
$warnings[] = array(
'item' => 'instance',
'itemid' => $instance->id,
'warningcode' => '1',
'message' => $enrolstatus
);
}
}
$result = array();
$result['status'] = $enrolled;
$result['warnings'] = $warnings;
return $result;
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 3.0
*/
public static function enrol_user_returns() {
return new external_single_structure(
array(
'status' => new external_value(PARAM_BOOL, 'status: true if the user is enrolled, false otherwise'),
'warnings' => new external_warnings()
)
);
}
/**
* Returns description of method parameters.
*
* @return external_function_parameters
* @since Moodle 2.2
*/
public static function credit_users_parameters() {
return new external_function_parameters(
array(
'credits' => new external_multiple_structure(
new external_single_structure(
array(
'userid' => new external_value(PARAM_INT, 'The user that is going to be given new course credits'),
'credit' => new external_value(PARAM_INT, 'The amount of credit to be added'),
'quantity' => new external_value(PARAM_INT, 'The quantity of credits to be added'),
)
)
)
)
);
}
/**
* Enrolment of users.
*
* Function throw an exception at the first error encountered.
* @param array $enrolments An array of user enrolment
* @since Moodle 2.2
*/
public static function credit_users($course_credits) {
global $DB, $CFG;
require_once($CFG->dirroot . '/enrol/credit/lib.php');
$params = self::validate_parameters(self::credit_users_parameters(),
array('credits' => $course_credits));
foreach ($course_credits as $course_credit) {
enrol_credit_plugin::add_credits($course_credit['userid'], $course_credit['credit'] * $course_credit['quantity']);
}
$result = array();
$result['status'] = true;
$result['warnings'] = array();
return $result;
}
/**
* Returns description of method result value.
*
* @return null
* @since Moodle 2.2
*/
public static function credit_users_returns() {
return new external_single_structure(
array(
'status' => new external_value(PARAM_BOOL, 'Status: true only if token is valid'),
'warnings' => new external_warnings()
)
);
}
}