You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
194 lines
8.0 KiB
194 lines
8.0 KiB
<?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/>.
|
|
|
|
/**
|
|
* Quiz external functions and service definitions.
|
|
*
|
|
* @package mod_quiz
|
|
* @category external
|
|
* @copyright 2016 Juan Leyva <juan@moodle.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
* @since Moodle 3.1
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die;
|
|
|
|
$functions = array(
|
|
|
|
'mod_quiz_get_quizzes_by_courses' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_quizzes_by_courses',
|
|
'description' => 'Returns a list of quizzes in a provided list of courses,
|
|
if no list is provided all quizzes that the user can view will be returned.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:view',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_view_quiz' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'view_quiz',
|
|
'description' => 'Trigger the course module viewed event and update the module completion status.',
|
|
'type' => 'write',
|
|
'capabilities' => 'mod/quiz:view',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_get_user_attempts' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_user_attempts',
|
|
'description' => 'Return a list of attempts for the given quiz and user.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:view',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_get_user_best_grade' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_user_best_grade',
|
|
'description' => 'Get the best current grade for the given user on a quiz.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:view',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_get_combined_review_options' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_combined_review_options',
|
|
'description' => 'Combines the review options from a number of different quiz attempts.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:view',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_start_attempt' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'start_attempt',
|
|
'description' => 'Starts a new attempt at a quiz.',
|
|
'type' => 'write',
|
|
'capabilities' => 'mod/quiz:attempt',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_get_attempt_data' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_attempt_data',
|
|
'description' => 'Returns information for the given attempt page for a quiz attempt in progress.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:attempt',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_get_attempt_summary' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_attempt_summary',
|
|
'description' => 'Returns a summary of a quiz attempt before it is submitted.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:attempt',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_save_attempt' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'save_attempt',
|
|
'description' => 'Processes save requests during the quiz.
|
|
This function is intended for the quiz auto-save feature.',
|
|
'type' => 'write',
|
|
'capabilities' => 'mod/quiz:attempt',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_process_attempt' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'process_attempt',
|
|
'description' => 'Process responses during an attempt at a quiz and also deals with attempts finishing.',
|
|
'type' => 'write',
|
|
'capabilities' => 'mod/quiz:attempt',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_get_attempt_review' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_attempt_review',
|
|
'description' => 'Returns review information for the given finished attempt, can be used by users or teachers.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:reviewmyattempts',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_view_attempt' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'view_attempt',
|
|
'description' => 'Trigger the attempt viewed event.',
|
|
'type' => 'write',
|
|
'capabilities' => 'mod/quiz:attempt',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_view_attempt_summary' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'view_attempt_summary',
|
|
'description' => 'Trigger the attempt summary viewed event.',
|
|
'type' => 'write',
|
|
'capabilities' => 'mod/quiz:attempt',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_view_attempt_review' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'view_attempt_review',
|
|
'description' => 'Trigger the attempt reviewed event.',
|
|
'type' => 'write',
|
|
'capabilities' => 'mod/quiz:reviewmyattempts',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_get_quiz_feedback_for_grade' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_quiz_feedback_for_grade',
|
|
'description' => 'Get the feedback text that should be show to a student who got the given grade in the given quiz.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:view',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_get_quiz_access_information' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_quiz_access_information',
|
|
'description' => 'Return access information for a given quiz.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:view',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_get_attempt_access_information' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_attempt_access_information',
|
|
'description' => 'Return access information for a given attempt in a quiz.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:view',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
|
|
'mod_quiz_get_quiz_required_qtypes' => array(
|
|
'classname' => 'mod_quiz_external',
|
|
'methodname' => 'get_quiz_required_qtypes',
|
|
'description' => 'Return the potential question types that would be required for a given quiz.',
|
|
'type' => 'read',
|
|
'capabilities' => 'mod/quiz:view',
|
|
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
|
|
),
|
|
);
|
|
|