MDL-50608 tool_lp: tidy up and bug fixes
[moodle.git] / admin / tool / lp / 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  * Learning plan webservice functions.
20  *
21  *
22  * @package    tool_lp
23  * @copyright  2015 Damyon Wiese
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 $functions = array(
29     // Learning plan related functions.
31     'tool_lp_create_competency_framework' => array(
32         'classname'   => 'tool_lp\external',
33         'methodname'  => 'create_competency_framework',
34         'classpath'   => '',
35         'description' => 'Creates new competency frameworks.',
36         'type'        => 'write',
37         'capabilities'=> 'tool/lp:competencymanage',
38     ),
39     'tool_lp_read_competency_framework' => array(
40         'classname'   => 'tool_lp\external',
41         'methodname'  => 'read_competency_framework',
42         'classpath'   => '',
43         'description' => 'Load a summary of a competency framework.',
44         'type'        => 'read',
45         'capabilities'=> 'tool/lp:competencyview',
46     ),
47     'tool_lp_delete_competency_framework' => array(
48         'classname'   => 'tool_lp\external',
49         'methodname'  => 'delete_competency_framework',
50         'classpath'   => '',
51         'description' => 'Delete a competency framework.',
52         'type'        => 'write',
53         'capabilities'=> 'tool/lp:competencymanage',
54     ),
55     'tool_lp_update_competency_framework' => array(
56         'classname'   => 'tool_lp\external',
57         'methodname'  => 'update_competency_framework',
58         'classpath'   => '',
59         'description' => 'Update a competency framework.',
60         'type'        => 'write',
61         'capabilities'=> 'tool/lp:competencymanage',
62     ),
63     'tool_lp_list_competency_frameworks' => array(
64         'classname'   => 'tool_lp\external',
65         'methodname'  => 'list_competency_frameworks',
66         'classpath'   => '',
67         'description' => 'Load a list of a competency frameworks.',
68         'type'        => 'read',
69         'capabilities'=> 'tool/lp:competencyview',
70     ),
71     'tool_lp_count_competency_frameworks' => array(
72         'classname'   => 'tool_lp\external',
73         'methodname'  => 'count_competency_frameworks',
74         'classpath'   => '',
75         'description' => 'Count a list of a competency frameworks.',
76         'type'        => 'read',
77         'capabilities'=> 'tool/lp:competencyview',
78     ),
79     'tool_lp_data_for_competency_frameworks_manage_page' => array(
80         'classname'   => 'tool_lp\external',
81         'methodname'  => 'data_for_competency_frameworks_manage_page',
82         'classpath'   => '',
83         'description' => 'Load the data for the competency frameworks manage page template',
84         'type'        => 'read',
85         'capabilities'=> 'tool/lp:competencyview',
86     ),
87     'tool_lp_reorder_competency_framework' => array(
88         'classname'   => 'tool_lp\external',
89         'methodname'  => 'reorder_competency_framework',
90         'classpath'   => '',
91         'description' => 'Move a competency framework to a new relative sort order.',
92         'type'        => 'write',
93         'capabilities'=> 'tool/lp:competencymanage',
94     ),
95     'tool_lp_create_competency' => array(
96         'classname'   => 'tool_lp\external',
97         'methodname'  => 'create_competency',
98         'classpath'   => '',
99         'description' => 'Creates new competencies.',
100         'type'        => 'write',
101         'capabilities'=> 'tool/lp:competencymanage',
102     ),
103     'tool_lp_read_competency' => array(
104         'classname'   => 'tool_lp\external',
105         'methodname'  => 'read_competency',
106         'classpath'   => '',
107         'description' => 'Load a summary of a competency.',
108         'type'        => 'read',
109         'capabilities'=> 'tool/lp:competencyview',
110     ),
111     'tool_lp_delete_competency' => array(
112         'classname'   => 'tool_lp\external',
113         'methodname'  => 'delete_competency',
114         'classpath'   => '',
115         'description' => 'Delete a competency.',
116         'type'        => 'write',
117         'capabilities'=> 'tool/lp:competencymanage',
118     ),
119     'tool_lp_update_competency' => array(
120         'classname'   => 'tool_lp\external',
121         'methodname'  => 'update_competency',
122         'classpath'   => '',
123         'description' => 'Update a competency.',
124         'type'        => 'write',
125         'capabilities'=> 'tool/lp:competencymanage',
126     ),
127     'tool_lp_list_competencies' => array(
128         'classname'   => 'tool_lp\external',
129         'methodname'  => 'list_competencies',
130         'classpath'   => '',
131         'description' => 'Load a list of a competencies.',
132         'type'        => 'read',
133         'capabilities'=> 'tool/lp:competencyview',
134     ),
135     'tool_lp_count_competencies' => array(
136         'classname'   => 'tool_lp\external',
137         'methodname'  => 'count_competencies',
138         'classpath'   => '',
139         'description' => 'Count a list of a competencies.',
140         'type'        => 'read',
141         'capabilities'=> 'tool/lp:competencyview',
142     ),
143     'tool_lp_search_competencies' => array(
144         'classname'   => 'tool_lp\external',
145         'methodname'  => 'search_competencies',
146         'classpath'   => '',
147         'description' => 'Search a list of a competencies.',
148         'type'        => 'read',
149         'capabilities'=> 'tool/lp:competencyview',
150     ),
151     'tool_lp_data_for_competencies_manage_page' => array(
152         'classname'   => 'tool_lp\external',
153         'methodname'  => 'data_for_competencies_manage_page',
154         'classpath'   => '',
155         'description' => 'Load the data for the competencies manage page template',
156         'type'        => 'read',
157         'capabilities'=> 'tool/lp:competencyview',
158     ),
159     'tool_lp_set_parent_competency' => array(
160         'classname'   => 'tool_lp\external',
161         'methodname'  => 'set_parent_competency',
162         'classpath'   => '',
163         'description' => 'Set a new parent for a competency.',
164         'type'        => 'write',
165         'capabilities'=> 'tool/lp:competencymanage',
166     ),
167     'tool_lp_move_up_competency' => array(
168         'classname'   => 'tool_lp\external',
169         'methodname'  => 'move_up_competency',
170         'classpath'   => '',
171         'description' => 'Re-order a competency.',
172         'type'        => 'write',
173         'capabilities'=> 'tool/lp:competencymanage',
174     ),
175     'tool_lp_move_down_competency' => array(
176         'classname'   => 'tool_lp\external',
177         'methodname'  => 'move_down_competency',
178         'classpath'   => '',
179         'description' => 'Re-order a competency.',
180         'type'        => 'write',
181         'capabilities'=> 'tool/lp:competencymanage',
182     ),
183     'tool_lp_list_competencies_in_course' => array(
184         'classname'   => 'tool_lp\external',
185         'methodname'  => 'list_competencies_in_course',
186         'classpath'   => '',
187         'description' => 'List the competencies in a course',
188         'type'        => 'read',
189         'capabilities'=> 'tool/lp:coursecompetencyread',
190     ),
191     'tool_lp_list_courses_using_competency' => array(
192         'classname'   => 'tool_lp\external',
193         'methodname'  => 'list_courses_using_competency',
194         'classpath'   => '',
195         'description' => 'List the courses using a competency',
196         'type'        => 'read',
197         'capabilities'=> 'tool/lp:coursecompetencyread',
198     ),
199     'tool_lp_count_competencies_in_course' => array(
200         'classname'   => 'tool_lp\external',
201         'methodname'  => 'count_competencies_in_course',
202         'classpath'   => '',
203         'description' => 'List the competencies in a course',
204         'type'        => 'read',
205         'capabilities'=> 'tool/lp:coursecompetencyread',
206     ),
207     'tool_lp_count_courses_using_competency' => array(
208         'classname'   => 'tool_lp\external',
209         'methodname'  => 'count_courses_using_competency',
210         'classpath'   => '',
211         'description' => 'List the courses using a competency',
212         'type'        => 'read',
213         'capabilities'=> 'tool/lp:coursecompetencyread',
214     ),
215     'tool_lp_add_competency_to_course' => array(
216         'classname'   => 'tool_lp\external',
217         'methodname'  => 'add_competency_to_course',
218         'classpath'   => '',
219         'description' => 'Add the competency to a course',
220         'type'        => 'write',
221         'capabilities'=> 'tool/lp:coursecompetencymanage',
222     ),
223     'tool_lp_add_competency_to_template' => array(
224         'classname'   => 'tool_lp\external',
225         'methodname'  => 'add_competency_to_template',
226         'classpath'   => '',
227         'description' => 'Add the competency to a template',
228         'type'        => 'write',
229         'capabilities'=> 'tool/lp:templatemanage',
230     ),
231     'tool_lp_remove_competency_from_course' => array(
232         'classname'   => 'tool_lp\external',
233         'methodname'  => 'remove_competency_from_course',
234         'classpath'   => '',
235         'description' => 'Remove a competency from a course',
236         'type'        => 'write',
237         'capabilities'=> 'tool/lp:coursecompetencymanage',
238     ),
239     'tool_lp_remove_competency_from_template' => array(
240         'classname'   => 'tool_lp\external',
241         'methodname'  => 'remove_competency_from_template',
242         'classpath'   => '',
243         'description' => 'Remove a competency from a template',
244         'type'        => 'write',
245         'capabilities'=> 'tool/lp:templatemanage',
246     ),
247     'tool_lp_data_for_course_competencies_page' => array(
248         'classname'   => 'tool_lp\external',
249         'methodname'  => 'data_for_course_competencies_page',
250         'classpath'   => '',
251         'description' => 'Load the data for the course competencies page template.',
252         'type'        => 'read',
253         'capabilities'=> 'tool/lp:coursecompetencyread',
254     ),
255     'tool_lp_data_for_template_competencies_page' => array(
256         'classname'   => 'tool_lp\external',
257         'methodname'  => 'data_for_template_competencies_page',
258         'classpath'   => '',
259         'description' => 'Load the data for the template competencies page template.',
260         'type'        => 'read',
261         'capabilities'=> 'tool/lp:templateread',
262     ),
263     'tool_lp_reorder_course_competency' => array(
264         'classname'   => 'tool_lp\external',
265         'methodname'  => 'reorder_course_competency',
266         'classpath'   => '',
267         'description' => 'Move a course competency to a new relative sort order.',
268         'type'        => 'write',
269         'capabilities'=> 'tool/lp:coursecompetencymanage',
270     ),
271     'tool_lp_reorder_template_competency' => array(
272         'classname'   => 'tool_lp\external',
273         'methodname'  => 'reorder_template_competency',
274         'classpath'   => '',
275         'description' => 'Move a template competency to a new relative sort order.',
276         'type'        => 'write',
277         'capabilities'=> 'tool/lp:templatemanage',
278     ),
279     'tool_lp_create_template' => array(
280         'classname'   => 'tool_lp\external',
281         'methodname'  => 'create_template',
282         'classpath'   => '',
283         'description' => 'Creates new learning plan templates.',
284         'type'        => 'write',
285         'capabilities'=> 'tool/lp:templatemanage',
286     ),
287     'tool_lp_read_template' => array(
288         'classname'   => 'tool_lp\external',
289         'methodname'  => 'read_template',
290         'classpath'   => '',
291         'description' => 'Load a summary of a learning plan template.',
292         'type'        => 'read',
293         'capabilities'=> 'tool/lp:templateview',
294     ),
295     'tool_lp_delete_template' => array(
296         'classname'   => 'tool_lp\external',
297         'methodname'  => 'delete_template',
298         'classpath'   => '',
299         'description' => 'Delete a learning plan template.',
300         'type'        => 'write',
301         'capabilities'=> 'tool/lp:templatemanage',
302     ),
303     'tool_lp_update_template' => array(
304         'classname'   => 'tool_lp\external',
305         'methodname'  => 'update_template',
306         'classpath'   => '',
307         'description' => 'Update a learning plan template.',
308         'type'        => 'write',
309         'capabilities'=> 'tool/lp:templatemanage',
310     ),
311     'tool_lp_list_templates' => array(
312         'classname'   => 'tool_lp\external',
313         'methodname'  => 'list_templates',
314         'classpath'   => '',
315         'description' => 'Load a list of a learning plan templates.',
316         'type'        => 'read',
317         'capabilities'=> 'tool/lp:templateview',
318     ),
319     'tool_lp_count_templates' => array(
320         'classname'   => 'tool_lp\external',
321         'methodname'  => 'count_templates',
322         'classpath'   => '',
323         'description' => 'Count a list of a learning plan templates.',
324         'type'        => 'read',
325         'capabilities'=> 'tool/lp:templateview',
326     ),
327     'tool_lp_data_for_templates_manage_page' => array(
328         'classname'   => 'tool_lp\external',
329         'methodname'  => 'data_for_templates_manage_page',
330         'classpath'   => '',
331         'description' => 'Load the data for the learning plan templates manage page template',
332         'type'        => 'read',
333         'capabilities'=> 'tool/lp:templateview',
334     ),
335     'tool_lp_reorder_template' => array(
336         'classname'   => 'tool_lp\external',
337         'methodname'  => 'reorder_template',
338         'classpath'   => '',
339         'description' => 'Move a learning plan template to a new relative sort order.',
340         'type'        => 'write',
341         'capabilities'=> 'tool/lp:templatemanage',
342     ),
343     'tool_lp_create_plan' => array(
344         'classname'   => 'tool_lp\external',
345         'methodname'  => 'create_plan',
346         'classpath'   => '',
347         'description' => 'Creates a learning plan.',
348         'type'        => 'write',
349         'capabilities'=> 'tool/lp:planmanageall',
350     ),
351     'tool_lp_update_plan' => array(
352         'classname'   => 'tool_lp\external',
353         'methodname'  => 'update_plan',
354         'classpath'   => '',
355         'description' => 'Updates a learning plan.',
356         'type'        => 'write',
357         'capabilities'=> 'tool/lp:planmanageall',
358     ),
359     'tool_lp_read_plan' => array(
360         'classname'   => 'tool_lp\external',
361         'methodname'  => 'read_plan',
362         'classpath'   => '',
363         'description' => 'Load a learning plan.',
364         'type'        => 'read',
365         'capabilities'=> 'tool/lp:planviewown',
366     ),
367     'tool_lp_delete_plan' => array(
368         'classname'   => 'tool_lp\external',
369         'methodname'  => 'delete_plan',
370         'classpath'   => '',
371         'description' => 'Delete a learning plan.',
372         'type'        => 'write',
373         'capabilities'=> 'tool/lp:planmanageall',
374     ),
375     'tool_lp_data_for_plans_page' => array(
376         'classname'   => 'tool_lp\external',
377         'methodname'  => 'data_for_plans_page',
378         'classpath'   => '',
379         'description' => 'Load the data for the plans page template',
380         'type'        => 'read',
381         'capabilities'=> 'tool/lp:planviewown',
382     ),
383     'tool_lp_get_scale_values' => array(
384         'classname'   => 'tool_lp\external',
385         'methodname'  => 'get_scale_values',
386         'classpath'   => '',
387         'description' => 'Fetch the values for a specific scale',
388         'type'        => 'read',
389         'capabilities'=> 'tool/lp:competencymanage',
390     )
391 );