Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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;

defined('MOODLE_INTERNAL') || die();

< require_once($CFG->libdir . '/externallib.php');
require_once($CFG->dirroot . '/question/engine/lib.php'); require_once($CFG->dirroot . '/question/engine/datalib.php'); require_once($CFG->libdir . '/questionlib.php');
< use external_api; < use external_description; < use external_function_parameters; < use external_single_structure; < use external_value;
> use core_external\external_api; > use core_external\external_function_parameters; > use core_external\external_single_structure; > use core_external\external_value;
use stdClass; /** * External api for changing the question version in the quiz. * * @package mod_quiz * @copyright 2021 Catalyst IT Australia Pty Ltd * @author Safat Shahin <safatshahin@catalyst-au.net> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class submit_question_version extends external_api { /** * Parameters for the submit_question_version. *
< * @return \external_function_parameters
> * @return external_function_parameters
*/ public static function execute_parameters(): external_function_parameters {
< return new external_function_parameters ( < [
> return new external_function_parameters([
'slotid' => new external_value(PARAM_INT, ''), 'newversion' => new external_value(PARAM_INT, '')
< ] < );
> ]);
} /** * Set the questions slot parameters to display the question template. * * @param int $slotid Slot id to display. * @param int $newversion the version to set. 0 means 'always latest'. * @return array */ public static function execute(int $slotid, int $newversion): array { global $DB; $params = [ 'slotid' => $slotid, 'newversion' => $newversion ]; $params = self::validate_parameters(self::execute_parameters(), $params);
< $response = ['result' => false];
> $response = [];
// Get the required data. $referencedata = $DB->get_record('question_references', ['itemid' => $params['slotid'], 'component' => 'mod_quiz', 'questionarea' => 'slot']); $slotdata = $DB->get_record('quiz_slots', ['id' => $slotid]); // Capability check.
< list($course, $cm) = get_course_and_cm_from_instance($slotdata->quizid, 'quiz');
> [, $cm] = get_course_and_cm_from_instance($slotdata->quizid, 'quiz');
$context = \context_module::instance($cm->id); self::validate_context($context); require_capability('mod/quiz:manage', $context); $reference = new stdClass(); $reference->id = $referencedata->id; if ($params['newversion'] === 0) { $reference->version = null; } else { $reference->version = $params['newversion']; } $response['result'] = $DB->update_record('question_references', $reference); return $response; } /** * Define the webservice response. *
< * @return external_description
> * @return \core_external\external_description
*/ public static function execute_returns() {
< return new external_single_structure( < [
> return new external_single_structure([
'result' => new external_value(PARAM_BOOL, '')
< ] < );
> > ]);
} }