improved docs and license headers, adding direct access protection
[moodle.git] / lib / db / services.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Core external functions and service definitions.
20  *
21  * @package    core
22  * @subpackage webservice
23  * @copyright  2009 Petr Skoda (http://skodak.org)
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 $functions = array(
29     // === group related functions ===
31     'moodle_group_create_groups' => array(
32         'classname'   => 'moodle_group_external',
33         'methodname'  => 'create_groups',
34         'classpath'   => 'group/externallib.php',
35         'description' => 'Creates new groups.',
36         'type'        => 'write',
37         'capabilities'=> 'moodle/course:managegroups',
38     ),
40     'moodle_group_get_groups' => array(
41         'classname'   => 'moodle_group_external',
42         'methodname'  => 'get_groups',
43         'classpath'   => 'group/externallib.php',
44         'description' => 'Returns group details.',
45         'type'        => 'read',
46         'capabilities'=> 'moodle/course:managegroups',
47     ),
49     'moodle_group_get_course_groups' => array(
50         'classname'   => 'moodle_group_external',
51         'methodname'  => 'get_course_groups',
52         'classpath'   => 'group/externallib.php',
53         'description' => 'Returns all groups in specified course.',
54         'type'        => 'read',
55         'capabilities'=> 'moodle/course:managegroups',
56     ),
58     'moodle_group_delete_groups' => array(
59         'classname'   => 'moodle_group_external',
60         'methodname'  => 'delete_groups',
61         'classpath'   => 'group/externallib.php',
62         'description' => 'Deletes all specified groups.',
63         'type'        => 'delete',
64         'capabilities'=> 'moodle/course:managegroups',
65     ),
67     'moodle_group_get_groupmembers' => array(
68         'classname'   => 'moodle_group_external',
69         'methodname'  => 'get_groupmembers',
70         'classpath'   => 'group/externallib.php',
71         'description' => 'Returns group members.',
72         'type'        => 'read',
73         'capabilities'=> 'moodle/course:managegroups',
74     ),
76     'moodle_group_add_groupmembers' => array(
77         'classname'   => 'moodle_group_external',
78         'methodname'  => 'add_groupmembers',
79         'classpath'   => 'group/externallib.php',
80         'description' => 'Adds group members.',
81         'type'        => 'write',
82         'capabilities'=> 'moodle/course:managegroups',
83     ),
85     'moodle_group_delete_groupmembers' => array(
86         'classname'   => 'moodle_group_external',
87         'methodname'  => 'delete_groupmembers',
88         'classpath'   => 'group/externallib.php',
89         'description' => 'Deletes group members.',
90         'type'        => 'delete',
91         'capabilities'=> 'moodle/course:managegroups',
92     ),
95     // === file related functions ===
97     'moodle_file_get_files' => array(
98         'classname'   => 'moodle_file_external',
99         'methodname'  => 'get_files',
100         'description' => 'browse moodle files',
101         'type'        => 'read',
102         'classpath'   => 'files/externallib.php',
103     ),
104     'moodle_file_upload' => array(
105         'classname'   => 'moodle_file_external',
106         'methodname'  => 'upload',
107         'description' => 'upload a file to moodle',
108         'type'        => 'write',
109         'classpath'   => 'files/externallib.php',
110     ),
112     // === user related functions ===
114     'moodle_user_create_users' => array(
115         'classname'   => 'moodle_user_external',
116         'methodname'  => 'create_users',
117         'classpath'   => 'user/externallib.php',
118         'description' => 'Create users.',
119         'type'        => 'write',
120         'capabilities'=> 'moodle/user:create',
121     ),
123     'moodle_user_get_users_by_id' => array(
124         'classname'   => 'moodle_user_external',
125         'methodname'  => 'get_users_by_id',
126         'classpath'   => 'user/externallib.php',
127         'description' => 'Get users by id.',
128         'type'        => 'read',
129         'capabilities'=> 'moodle/user:viewdetails',
130     ),
132     'moodle_user_delete_users' => array(
133         'classname'   => 'moodle_user_external',
134         'methodname'  => 'delete_users',
135         'classpath'   => 'user/externallib.php',
136         'description' => 'Delete users.',
137         'type'        => 'write',
138         'capabilities'=> 'moodle/user:delete',
139     ),
141     'moodle_user_update_users' => array(
142         'classname'   => 'moodle_user_external',
143         'methodname'  => 'update_users',
144         'classpath'   => 'user/externallib.php',
145         'description' => 'Update users.',
146         'type'        => 'write',
147         'capabilities'=> 'moodle/user:update',
148     ),
150     // === enrol related functions ===
152     'moodle_enrol_get_enrolled_users' => array(
153         'classname'   => 'moodle_enrol_external',
154         'methodname'  => 'get_enrolled_users',
155         'classpath'   => 'enrol/externallib.php',
156         'description' => 'Get list of course participants',
157         'type'        => 'read',
158         'capabilities'=> 'moodle/site:viewparticipants, moodle/course:viewparticipants,
159             moodle/role:review, moodle/site:accessallgroups, moodle/course:enrolreview',
160     ),
162     'moodle_role_assign' => array(
163         'classname'   => 'moodle_enrol_external',
164         'methodname'  => 'role_assign',
165         'classpath'   => 'enrol/externallib.php',
166         'description' => 'Manual role assignments.',
167         'type'        => 'write',
168         'capabilities'=> 'moodle/role:assign',
169     ),
171     'moodle_role_unassign' => array(
172         'classname'   => 'moodle_enrol_external',
173         'methodname'  => 'role_unassign',
174         'classpath'   => 'enrol/externallib.php',
175         'description' => 'Manual role unassignments.',
176         'type'        => 'write',
177         'capabilities'=> 'moodle/role:assign',
178     ),
180 );