Matthew Hilton
78 lines
2.9 KiB
PHP
78 lines
2.9 KiB
PHP
<?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/>.
|
|
|
|
namespace mod_quiz\external;
|
|
|
|
use core_external\external_api;
|
|
use core_external\external_function_parameters;
|
|
use core_external\external_multiple_structure;
|
|
use core_external\external_single_structure;
|
|
use core_external\external_value;
|
|
use mod_quiz\quiz_settings;
|
|
|
|
/**
|
|
* Webservice for deleting quiz overrides.
|
|
*
|
|
* @package mod_quiz
|
|
* @copyright 2024 Matthew Hilton <matthewhilton@catalyst-au.net>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class delete_overrides extends external_api {
|
|
/**
|
|
* Defines parameters
|
|
*
|
|
* @return external_function_parameters
|
|
*/
|
|
public static function execute_parameters(): external_function_parameters {
|
|
return new external_function_parameters([
|
|
// This must be nested in a single structure, because the ids structure does not play nicely at the top level.
|
|
'data' => new external_single_structure([
|
|
'quizid' => new external_value(PARAM_INT, "ID of quiz to delete overrides in"),
|
|
'ids' => new external_multiple_structure(new external_value(PARAM_INT, 'ID of override to delete')),
|
|
]),
|
|
]);
|
|
}
|
|
|
|
/**
|
|
* Executes webservice function, deleting given overrides.
|
|
*
|
|
* @param array $params array of override parameters
|
|
* @return array with ids key, which contains the ids of the overrides successfully deleted.
|
|
*/
|
|
public static function execute($params): array {
|
|
$params = self::validate_parameters(self::execute_parameters(), ['data' => $params])['data'];
|
|
|
|
$quizsettings = quiz_settings::create($params['quizid']);
|
|
$manager = $quizsettings->get_override_manager();
|
|
self::validate_context($manager->context);
|
|
$manager->require_manage_capability();
|
|
$manager->delete_overrides_by_id($params['ids']);
|
|
|
|
return ['ids' => $params['ids']];
|
|
}
|
|
|
|
/**
|
|
* Defines return type
|
|
*
|
|
* @return external_single_structure
|
|
*/
|
|
public static function execute_returns(): external_single_structure {
|
|
return new external_single_structure([
|
|
'ids' => new external_multiple_structure(new external_value(PARAM_INT, 'ID of deleted override')),
|
|
]);
|
|
}
|
|
}
|