-
Notifications
You must be signed in to change notification settings - Fork 0
/
externallib.php
360 lines (305 loc) · 12.4 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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
<?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/>.
/**
* External Page format control
*
* Tool Sync API allows external applications to program and change settings
* in the tool sync engine to control its behaviour and resources that will be used
* for synchronisation.
*
* @package format_page
* @category external
* @copyright 2016 Valery Fremaux
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die;
require_once($CFG->libdir.'/externallib.php');
require_once($CFG->dirroot.'/admin/tool/sync/lib.php');
class format_page_external extends external_api {
protected static function validate_block_parameters($configparamdefs, $inputs) {
global $DB;
$status = self::validate_parameters($configparamdefs, $inputs);
switch ($inputs['blockidsource']) {
case 'idnumber':
if (!$DB->record_exists('format_page_items', array('idnumber' => $inputs['blockid']))) {
throw new moodle_exception('No block format page item with idnumber '.$inputs['blockid']);
}
break;
case 'id':
if (!$DB->record_exists('block_instances', array('id' => $inputs['blockid']))) {
throw new moodle_exception('No block with idnumber '.$inputs['blockid']);
}
default:
throw new moodle_exception('Bad block identification source');
}
return $status;
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 2.2
*/
public static function get_block_config_parameters() {
return new external_function_parameters(
array('blockidsource' => new external_value(PARAM_TEXT, 'Block ID source'),
'blockid' => new external_value(PARAM_TEXT, ''),
'configkey' => new external_value(PARAM_TEXT, '', VALUE_DEFAULT, '', true),
)
);
}
/**
* Retrieving a configuration of a block instance
*
* @param string $blockidsource source for the block id. Might be idnumber or id
* @param string $blockid blockid
* @param string $configkey Configuration key
* @return single value
*/
public static function get_block_config($blockidsource, $blockid, $configkey) {
global $DB, $USER;
// Validate parameters.
$params = self::validate_block_parameters(self::get_block_config_parameters(),
array('blockidsource' => $blockidsource, 'blockid' => $blockid, 'configkey' => $configkey));
switch ($blockidsource) {
case 'idnumber':
$pageitem = $DB->get_record('format_page_items', array('idnumber' => $blockid));
$blockid = $pageitem->blockinstance;
break;
case 'id':
// nothing to do.
assert(1);
}
if (!$blockrec = $DB->get_record('block_instances', array('id' => $blockid))) {
throw new moodle_exception('No block with id '.$blockid);
}
$blockinstance = block_instance($blockrec->blockname, $blockrec);
if (!isset($blockinstance->config->$configkey)) {
throw new moodle_exception('Inexistant config '.$configkey.' in block '.$blockrec->blockname);
}
return $blockinstance->config->$configkey;
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 2.2
*/
public static function get_block_config_returns() {
return new external_value(PARAM_RAW, 'Config value');
}
// Set config in blocks
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 2.2
*/
public static function set_block_config_parameters() {
return new external_function_parameters(
array('blockidsource' => new external_value(PARAM_TEXT, 'block id source'),
'blockid' => new external_value(PARAM_TEXT, '', VALUE_DEFAULT, 0, true),
'configkey' => new external_value(PARAM_TEXT, '', VALUE_DEFAULT, '', true),
'value' => new external_value(PARAM_RAW, '', VALUE_DEFAULT, '', true),
)
);
}
/**
* Retrieving a configuration of a block instance
*
* @param string $blockidsource source of the block id
* @param string $blockid configuration block id
* @param string $configkey Configuration key
* @return array
* @since Moodle 2.2
*/
public static function set_block_config($blockidsource, $blockid, $configkey, $value) {
global $DB;
// Validate parameters.
$params = self::validate_block_parameters(self::set_block_config_parameters(),
array('blockidsource' => $blockidsource,
'blockid' => $blockid,
'configkey' => $configkey,
'value' => $value));
switch ($blockidsource) {
case 'idnumber':
$pageitem = $DB->get_record('format_page_items', array('idnumber' => $blockid));
$blockid = $pageitem->blockinstance;
break;
case 'id':
// nothing to do.
assert(1);
}
if (!$blockrec = $DB->get_record('block_instances', array('id' => $blockid))) {
throw new moodle_exception('No block with id '.$blockid);
}
$blockinstance = block_instance($blockrec->blockname, $blockrec);
if (!isset($blockinstance->config->$configkey)) {
throw new moodle_exception('Inexistant config '.$configkey.' in block '.$blockrec->blockname);
}
$blockinstance->config->$configkey = $value;
$DB->set_field('block_instances', 'configdata', base64_encode(serialize($blockinstance->config)), array('id' => $blockid));
$DB->set_field('block_instances', 'timemodified', time(), array('id' => $blockid));
return true;
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 2.2
*/
public static function set_block_config_returns() {
return new external_value(PARAM_BOOL, 'Change status');
}
// Module config ---------------------------------------------------------------.
protected static function validate_module_parameters($configparamdefs, $inputs) {
global $DB;
$status = self::validate_parameters($configparamdefs, $inputs);
switch ($inputs['moduleidsource']) {
case 'idnumber':
if (!$DB->record_exists('course_modules', array('idnumber' => $inputs['moduleid']))) {
throw new moodle_exception('Invalid cm idnumber '.$inputs['moduleid']);
}
break;
case 'id':
if (!$DB->record_exists('course_modules', array('id' => $inputs['moduleid']))) {
throw new moodle_exception('Invalid cm id '.$inputs['moduleid']);
}
break;
default:
throw new moodle_exception('Invalid cm id source');
}
return $status;
}
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 2.2
*/
public static function get_module_config_parameters() {
return new external_function_parameters(
array('moduleidsource' => new external_value(PARAM_TEXT, 'Module ID source'),
'moduleid' => new external_value(PARAM_TEXT, ''),
'configkey' => new external_value(PARAM_TEXT, '', VALUE_DEFAULT, '', true),
)
);
}
/**
* Retrieving a configuration of a module instance
*
* @param string $moduleidsource
* @param string $moduleid
* @param string $configkey
* @return array
*/
public static function get_module_config($moduleidsource, $moduleid, $configkey) {
global $DB;
// Validate parameters.
$params = self::validate_module_parameters(self::get_module_config_parameters(),
array('moduleidsource' => $moduleidsource,
'moduleid' => $moduleid,
'configkey' => $configkey));
switch ($moduleidsource) {
case 'idnumber':
$cm = $DB->get_record('course_modules', array('idnumber' => $moduleid));
break;
case 'id':
$cm = $DB->get_record('course_modules', array('id' => $moduleid));
break;
}
if (!$module = $DB->get_record('modules', array('id' => $cm->module))) {
throw new moodle_exception("Invalid module $cm->module ");
}
$instance = $DB->get_record($module->name, array('id' => $cm->instance));
if (!isset($instance->$configkey)) {
throw new moodle_exception("Inexistant config $configkey in module ");
}
return $instance->$configkey;
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 2.2
*/
public static function get_module_config_returns() {
return new external_value(PARAM_RAW, 'Config value');
}
// Set config in module -----------------------------------------------.
/**
* Returns description of method parameters
*
* @return external_function_parameters
* @since Moodle 2.2
*/
public static function set_module_config_parameters() {
return new external_function_parameters(
array('moduleidsource' => new external_value(PARAM_TEXT, 'block id source'),
'moduleid' => new external_value(PARAM_TEXT, ''),
'configkey' => new external_value(PARAM_TEXT, ''),
'value' => new external_value(PARAM_RAW, ''),
)
);
}
/**
* Retrieving a configuration of a block instance
*
* @param string $blockidsource source of the module id
* @param string $blockid configuration block id
* @param string $configkey Configuration key
* @return array
* @since Moodle 2.2
*/
public static function set_module_config($moduleidsource, $moduleid, $configkey, $value) {
global $DB, $USER;
// Validate parameters.
$params = self::validate_module_parameters(self::set_module_config_parameters(),
array('moduleidsource' => $moduleidsource,
'moduleid' => $blockid,
'configkey' => $configkey,
'value' => $value));
switch ($moduleidsource) {
case 'idnumber':
$cm = $DB->get_record('course_modules', array('idnumber' => $moduleid));
break;
case 'id':
$cm = $DB->get_record('course_modules', array('id' => $moduleid));
break;
}
if (!$module = $DB->get_record('modules', array('id' => $cm->module))) {
throw new moodle_exception("Unkown module type with id $cm->module");
}
if (!$instance = $DB->get_record($module->name, array('id' => $cm->instance))) {
throw new moodle_exception("Module $module->name instance not found with id $cm->instance");
}
if (!isset($instance->$configkey)) {
throw new moodle_exception('Inexistant config in module ');
}
$instance->$configkey = $value;
$DB->update_record($module->name, $instance);
return true;
}
/**
* Returns description of method result value
*
* @return external_description
* @since Moodle 2.2
*/
public static function set_module_config_returns() {
return new external_value(PARAM_BOOL, 'Change status');
}
}