MDL-32233 Added WS method core_course_duplicate_course
[moodle.git] / lib / db / services.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Core external functions and service definitions.
20  *
21  * The functions and services defined on this file are
22  * processed and registered into the Moodle DB after any
23  * install or upgrade operation. All plugins support this.
24  *
25  * For more information, take a look to the documentation available:
26  *     - Webservices API: {@link http://docs.moodle.org/dev/Web_services_API}
27  *     - External API: {@link http://docs.moodle.org/dev/External_functions_API}
28  *     - Upgrade API: {@link http://docs.moodle.org/dev/Upgrade_API}
29  *
30  * @package    core_webservice
31  * @category   webservice
32  * @copyright  2009 Petr Skodak
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
36 $functions = array(
38     // === group related functions ===
40     'moodle_group_create_groups' => array(
41         'classname'   => 'core_group_external',
42         'methodname'  => 'create_groups',
43         'classpath'   => 'group/externallib.php',
44         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_create_groups(). ',
45         'type'        => 'write',
46         'capabilities'=> 'moodle/course:managegroups',
47     ),
49     'core_group_create_groups' => array(
50         'classname'   => 'core_group_external',
51         'methodname'  => 'create_groups',
52         'classpath'   => 'group/externallib.php',
53         'description' => 'Creates new groups.',
54         'type'        => 'write',
55         'capabilities'=> 'moodle/course:managegroups',
56     ),
58     'moodle_group_get_groups' => array(
59         'classname'   => 'core_group_external',
60         'methodname'  => 'get_groups',
61         'classpath'   => 'group/externallib.php',
62         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_get_groups()',
63         'type'        => 'read',
64         'capabilities'=> 'moodle/course:managegroups',
65     ),
67     'core_group_get_groups' => array(
68         'classname'   => 'core_group_external',
69         'methodname'  => 'get_groups',
70         'classpath'   => 'group/externallib.php',
71         'description' => 'Returns group details.',
72         'type'        => 'read',
73         'capabilities'=> 'moodle/course:managegroups',
74     ),
76     'moodle_group_get_course_groups' => array(
77         'classname'   => 'core_group_external',
78         'methodname'  => 'get_course_groups',
79         'classpath'   => 'group/externallib.php',
80         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_get_course_groups()',
81         'type'        => 'read',
82         'capabilities'=> 'moodle/course:managegroups',
83     ),
85     'core_group_get_course_groups' => array(
86         'classname'   => 'core_group_external',
87         'methodname'  => 'get_course_groups',
88         'classpath'   => 'group/externallib.php',
89         'description' => 'Returns all groups in specified course.',
90         'type'        => 'read',
91         'capabilities'=> 'moodle/course:managegroups',
92     ),
94     'moodle_group_delete_groups' => array(
95         'classname'   => 'core_group_external',
96         'methodname'  => 'delete_groups',
97         'classpath'   => 'group/externallib.php',
98         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_delete_groups()',
99         'type'        => 'delete',
100         'capabilities'=> 'moodle/course:managegroups',
101     ),
103     'core_group_delete_groups' => array(
104         'classname'   => 'core_group_external',
105         'methodname'  => 'delete_groups',
106         'classpath'   => 'group/externallib.php',
107         'description' => 'Deletes all specified groups.',
108         'type'        => 'delete',
109         'capabilities'=> 'moodle/course:managegroups',
110     ),
112     'moodle_group_get_groupmembers' => array(
113         'classname'   => 'core_group_external',
114         'methodname'  => 'get_group_members',
115         'classpath'   => 'group/externallib.php',
116         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_get_group_members()',
117         'type'        => 'read',
118         'capabilities'=> 'moodle/course:managegroups',
119     ),
121     'core_group_get_group_members' => array(
122         'classname'   => 'core_group_external',
123         'methodname'  => 'get_group_members',
124         'classpath'   => 'group/externallib.php',
125         'description' => 'Returns group members.',
126         'type'        => 'read',
127         'capabilities'=> 'moodle/course:managegroups',
128     ),
130     'moodle_group_add_groupmembers' => array(
131         'classname'   => 'core_group_external',
132         'methodname'  => 'add_group_members',
133         'classpath'   => 'group/externallib.php',
134         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_add_group_members()',
135         'type'        => 'write',
136         'capabilities'=> 'moodle/course:managegroups',
137     ),
139     'core_group_add_group_members' => array(
140         'classname'   => 'core_group_external',
141         'methodname'  => 'add_group_members',
142         'classpath'   => 'group/externallib.php',
143         'description' => 'Adds group members.',
144         'type'        => 'write',
145         'capabilities'=> 'moodle/course:managegroups',
146     ),
148     'moodle_group_delete_groupmembers' => array(
149         'classname'   => 'core_group_external',
150         'methodname'  => 'delete_group_members',
151         'classpath'   => 'group/externallib.php',
152         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_group_delete_group_members()',
153         'type'        => 'delete',
154         'capabilities'=> 'moodle/course:managegroups',
155     ),
157     'core_group_delete_group_members' => array(
158         'classname'   => 'core_group_external',
159         'methodname'  => 'delete_group_members',
160         'classpath'   => 'group/externallib.php',
161         'description' => 'Deletes group members.',
162         'type'        => 'delete',
163         'capabilities'=> 'moodle/course:managegroups',
164     ),
166     // === file related functions ===
168     'moodle_file_get_files' => array(
169         'classname'   => 'core_files_external',
170         'methodname'  => 'get_files',
171         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_files_get_files()',
172         'type'        => 'read',
173         'classpath'   => 'files/externallib.php',
174     ),
176     'core_files_get_files' => array(
177         'classname'   => 'core_files_external',
178         'methodname'  => 'get_files',
179         'description' => 'browse moodle files',
180         'type'        => 'read',
181         'classpath'   => 'files/externallib.php',
182     ),
184     'moodle_file_upload' => array(
185         'classname'   => 'core_files_external',
186         'methodname'  => 'upload',
187         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_files_upload()',
188         'type'        => 'write',
189         'classpath'   => 'files/externallib.php',
190     ),
192     'core_files_upload' => array(
193         'classname'   => 'core_files_external',
194         'methodname'  => 'upload',
195         'description' => 'upload a file to moodle',
196         'type'        => 'write',
197         'classpath'   => 'files/externallib.php',
198     ),
200     // === user related functions ===
202     'moodle_user_create_users' => array(
203         'classname'   => 'core_user_external',
204         'methodname'  => 'create_users',
205         'classpath'   => 'user/externallib.php',
206         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_create_users()',
207         'type'        => 'write',
208         'capabilities'=> 'moodle/user:create',
209     ),
211     'core_user_create_users' => array(
212         'classname'   => 'core_user_external',
213         'methodname'  => 'create_users',
214         'classpath'   => 'user/externallib.php',
215         'description' => 'Create users.',
216         'type'        => 'write',
217         'capabilities'=> 'moodle/user:create',
218     ),
220     'moodle_user_get_users_by_id' => array(
221         'classname'   => 'core_user_external',
222         'methodname'  => 'get_users_by_id',
223         'classpath'   => 'user/externallib.php',
224         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_get_users_by_id()',
225         'type'        => 'read',
226         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
227     ),
229     'core_user_get_users_by_id' => array(
230         'classname'   => 'core_user_external',
231         'methodname'  => 'get_users_by_id',
232         'classpath'   => 'user/externallib.php',
233         'description' => 'Get users by id.',
234         'type'        => 'read',
235         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update',
236     ),
238     'moodle_user_get_users_by_courseid' => array(
239         'classname'   => 'core_enrol_external',
240         'methodname'  => 'get_enrolled_users',
241         'classpath'   => 'enrol/externallib.php',
242         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_enrol_get_enrolled_users()',
243         'type'        => 'read',
244         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
245     ),
247     'moodle_user_get_course_participants_by_id' => array(
248         'classname'   => 'core_user_external',
249         'methodname'  => 'get_course_user_profiles',
250         'classpath'   => 'user/externallib.php',
251         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_get_course_user_profiles()',
252         'type'        => 'read',
253         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
254     ),
256     'core_user_get_course_user_profiles' => array(
257         'classname'   => 'core_user_external',
258         'methodname'  => 'get_course_user_profiles',
259         'classpath'   => 'user/externallib.php',
260         'description' => 'Get course user profiles (each of the profils matching a course id and a user id).',
261         'type'        => 'read',
262         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
263     ),
265     'moodle_user_delete_users' => array(
266         'classname'   => 'core_user_external',
267         'methodname'  => 'delete_users',
268         'classpath'   => 'user/externallib.php',
269         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_delete_users()',
270         'type'        => 'write',
271         'capabilities'=> 'moodle/user:delete',
272     ),
274     'core_user_delete_users' => array(
275         'classname'   => 'core_user_external',
276         'methodname'  => 'delete_users',
277         'classpath'   => 'user/externallib.php',
278         'description' => 'Delete users.',
279         'type'        => 'write',
280         'capabilities'=> 'moodle/user:delete',
281     ),
283     'moodle_user_update_users' => array(
284         'classname'   => 'core_user_external',
285         'methodname'  => 'update_users',
286         'classpath'   => 'user/externallib.php',
287         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_user_update_users()',
288         'type'        => 'write',
289         'capabilities'=> 'moodle/user:update',
290     ),
292     'core_user_update_users' => array(
293         'classname'   => 'core_user_external',
294         'methodname'  => 'update_users',
295         'classpath'   => 'user/externallib.php',
296         'description' => 'Update users.',
297         'type'        => 'write',
298         'capabilities'=> 'moodle/user:update',
299     ),
301     // === enrol related functions ===
303     'moodle_enrol_get_enrolled_users' => array(
304         'classname'   => 'moodle_enrol_external',
305         'methodname'  => 'get_enrolled_users',
306         'classpath'   => 'enrol/externallib.php',
307         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. Please use core_enrol_get_enrolled_users() (previously known as moodle_user_get_users_by_courseid).',
308         'type'        => 'read',
309         'capabilities'=> 'moodle/site:viewparticipants, moodle/course:viewparticipants,
310             moodle/role:review, moodle/site:accessallgroups, moodle/course:enrolreview',
311     ),
313     'core_enrol_get_enrolled_users' => array(
314         'classname'   => 'core_enrol_external',
315         'methodname'  => 'get_enrolled_users',
316         'classpath'   => 'enrol/externallib.php',
317         'description' => 'Get enrolled users by course id.',
318         'type'        => 'read',
319         'capabilities'=> 'moodle/user:viewdetails, moodle/user:viewhiddendetails, moodle/course:useremail, moodle/user:update, moodle/site:accessallgroups',
320     ),
322     'moodle_enrol_get_users_courses' => array(
323         'classname'   => 'core_enrol_external',
324         'methodname'  => 'get_users_courses',
325         'classpath'   => 'enrol/externallib.php',
326         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_enrol_get_users_courses()',
327         'type'        => 'read',
328         'capabilities'=> 'moodle/course:viewparticipants',
329     ),
331     'core_enrol_get_users_courses' => array(
332         'classname'   => 'core_enrol_external',
333         'methodname'  => 'get_users_courses',
334         'classpath'   => 'enrol/externallib.php',
335         'description' => 'Get the list of courses where a user is enrolled in',
336         'type'        => 'read',
337         'capabilities'=> 'moodle/course:viewparticipants',
338     ),
340     // === Role related functions ===
342     'moodle_role_assign' => array(
343         'classname'   => 'core_role_external',
344         'methodname'  => 'assign_roles',
345         'classpath'   => 'enrol/externallib.php',
346         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_role_assign_role()',
347         'type'        => 'write',
348         'capabilities'=> 'moodle/role:assign',
349     ),
351     'core_role_assign_roles' => array(
352         'classname'   => 'core_role_external',
353         'methodname'  => 'assign_roles',
354         'classpath'   => 'enrol/externallib.php',
355         'description' => 'Manual role assignments.',
356         'type'        => 'write',
357         'capabilities'=> 'moodle/role:assign',
358     ),
360     'moodle_role_unassign' => array(
361         'classname'   => 'core_role_external',
362         'methodname'  => 'unassign_roles',
363         'classpath'   => 'enrol/externallib.php',
364         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_role_unassign_role()',
365         'type'        => 'write',
366         'capabilities'=> 'moodle/role:assign',
367     ),
369     'core_role_unassign_roles' => array(
370         'classname'   => 'core_role_external',
371         'methodname'  => 'unassign_roles',
372         'classpath'   => 'enrol/externallib.php',
373         'description' => 'Manual role unassignments.',
374         'type'        => 'write',
375         'capabilities'=> 'moodle/role:assign',
376     ),
378     // === course related functions ===
380     'moodle_course_get_courses' => array(
381         'classname'   => 'core_course_external',
382         'methodname'  => 'get_courses',
383         'classpath'   => 'course/externallib.php',
384         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_course_get_courses()',
385         'type'        => 'read',
386         'capabilities'=> 'moodle/course:view,moodle/course:update,moodle/course:viewhiddencourses',
387     ),
389     'core_course_get_courses' => array(
390         'classname'   => 'core_course_external',
391         'methodname'  => 'get_courses',
392         'classpath'   => 'course/externallib.php',
393         'description' => 'Return course details',
394         'type'        => 'read',
395         'capabilities'=> 'moodle/course:view,moodle/course:update,moodle/course:viewhiddencourses',
396     ),
398     'moodle_course_create_courses' => array(
399         'classname'   => 'core_course_external',
400         'methodname'  => 'create_courses',
401         'classpath'   => 'course/externallib.php',
402         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_course_create_courses()',
403         'type'        => 'write',
404         'capabilities'=> 'moodle/course:create,moodle/course:visibility',
405     ),
407     'core_course_create_courses' => array(
408         'classname'   => 'core_course_external',
409         'methodname'  => 'create_courses',
410         'classpath'   => 'course/externallib.php',
411         'description' => 'Create new courses',
412         'type'        => 'write',
413         'capabilities'=> 'moodle/course:create,moodle/course:visibility',
414     ),
416     'core_course_get_contents' => array(
417         'classname'   => 'core_course_external',
418         'methodname'  => 'get_course_contents',
419         'classpath'   => 'course/externallib.php',
420         'description' => 'Get course contents',
421         'type'        => 'read',
422         'capabilities'=> 'moodle/course:update,moodle/course:viewhiddencourses',
423     ),
425     'core_course_delete_courses' => array(
426         'classname'   => 'core_course_external',
427         'methodname'  => 'delete_courses',
428         'classpath'   => 'course/externallib.php',
429         'description' => 'Deletes all specified courses',
430         'type'        => 'write',
431         'capabilities'=> 'moodle/course:delete',
432     ),
434     'core_course_duplicate_course' => array(
435         'classname'   => 'core_course_external',
436         'methodname'  => 'duplicate_course',
437         'classpath'   => 'course/externallib.php',
438         'description' => 'Duplicate an existing course (creating a new one) without user data',
439         'type'        => 'write',
440         'capabilities'=> 'moodle/backup:backupcourse,moodle/restore:restorecourse,moodle/course:create',
441     ),
443     // === message related functions ===
445     'moodle_message_send_instantmessages' => array(
446         'classname'   => 'core_message_external',
447         'methodname'  => 'send_instant_messages',
448         'classpath'   => 'message/externallib.php',
449         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_message_send_instant_messages()',
450         'type'        => 'write',
451         'capabilities'=> 'moodle/site:sendmessage',
452     ),
454     'core_message_send_instant_messages' => array(
455         'classname'   => 'core_message_external',
456         'methodname'  => 'send_instant_messages',
457         'classpath'   => 'message/externallib.php',
458         'description' => 'Send instant messages',
459         'type'        => 'write',
460         'capabilities'=> 'moodle/site:sendmessage',
461     ),
463     // === notes related functions ===
465     'moodle_notes_create_notes' => array(
466         'classname'   => 'core_notes_external',
467         'methodname'  => 'create_notes',
468         'classpath'   => 'notes/externallib.php',
469         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_notes_create_notes()',
470         'type'        => 'write',
471         'capabilities'=> 'moodle/notes:manage',
472     ),
474     'core_notes_create_notes' => array(
475         'classname'   => 'core_notes_external',
476         'methodname'  => 'create_notes',
477         'classpath'   => 'notes/externallib.php',
478         'description' => 'Create notes',
479         'type'        => 'write',
480         'capabilities'=> 'moodle/notes:manage',
481     ),
483     // === webservice related functions ===
485     'moodle_webservice_get_siteinfo' => array(
486         'classname'   => 'core_webservice_external',
487         'methodname'  => 'get_site_info',
488         'classpath'   => 'webservice/externallib.php',
489         'description' => 'DEPRECATED: this deprecated function will be removed in a future version. This function has be renamed as core_webservice_get_site_info()',
490         'type'        => 'read',
491     ),
493     'core_webservice_get_site_info' => array(
494         'classname'   => 'core_webservice_external',
495         'methodname'  => 'get_site_info',
496         'classpath'   => 'webservice/externallib.php',
497         'description' => 'Return some site info / user info / list web service functions',
498         'type'        => 'read',
499     ),
501 );
503 $services = array(
504    'Moodle mobile web service'  => array(
505         'functions' => array (
506             'moodle_enrol_get_users_courses',
507             'moodle_enrol_get_enrolled_users',
508             'moodle_user_get_users_by_id',
509             'moodle_webservice_get_siteinfo',
510             'moodle_notes_create_notes',
511             'moodle_user_get_course_participants_by_id',
512             'moodle_user_get_users_by_courseid',
513             'moodle_message_send_instantmessages',
514             'core_course_get_contents'),
515         'enabled' => 0,
516         'restrictedusers' => 0,
517         'shortname' => MOODLE_OFFICIAL_MOBILE_SERVICE,
518         'downloadfiles' => 1
519     ),
520 );