Merge branch 'MDL-52786-master' of git://github.com/jleyva/moodle
[moodle.git] / mod / quiz / db / services.php
CommitLineData
51e27aac
JL
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/>.
16
17/**
18 * Quiz external functions and service definitions.
19 *
20 * @package mod_quiz
21 * @category external
22 * @copyright 2016 Juan Leyva <juan@moodle.com>
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 * @since Moodle 3.1
25 */
26
27defined('MOODLE_INTERNAL') || die;
28
29$functions = array(
30
31 'mod_quiz_get_quizzes_by_courses' => array(
32 'classname' => 'mod_quiz_external',
33 'methodname' => 'get_quizzes_by_courses',
34 'description' => 'Returns a list of quizzes in a provided list of courses,
35 if no list is provided all quizzes that the user can view will be returned.',
36 'type' => 'read',
0ca559a1
JL
37 'capabilities' => 'mod/quiz:view',
38 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
51e27aac 39 ),
4064dd0e
JL
40
41 'mod_quiz_view_quiz' => array(
42 'classname' => 'mod_quiz_external',
43 'methodname' => 'view_quiz',
44 'description' => 'Trigger the course module viewed event and update the module completion status.',
45 'type' => 'write',
0ca559a1
JL
46 'capabilities' => 'mod/quiz:view',
47 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
4064dd0e 48 ),
c161ecff
JL
49
50 'mod_quiz_get_user_attempts' => array(
51 'classname' => 'mod_quiz_external',
52 'methodname' => 'get_user_attempts',
53 'description' => 'Return a list of attempts for the given quiz and user.',
54 'type' => 'read',
5ca1a776
DM
55 'capabilities' => 'mod/quiz:view',
56 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
c161ecff 57 ),
e73e4581
JL
58
59 'mod_quiz_get_user_best_grade' => array(
60 'classname' => 'mod_quiz_external',
61 'methodname' => 'get_user_best_grade',
62 'description' => 'Get the best current grade for the given user on a quiz.',
63 'type' => 'read',
ba8afbdb
DM
64 'capabilities' => 'mod/quiz:view',
65 'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
e73e4581 66 ),
1f67c0b8
JL
67
68 'mod_quiz_get_combined_review_options' => array(
69 'classname' => 'mod_quiz_external',
70 'methodname' => 'get_combined_review_options',
71 'description' => 'Combines the review options from a number of different quiz attempts.',
72 'type' => 'read',
73 'capabilities' => 'mod/quiz:view'
74 ),
51e27aac 75);