Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.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/>.
/**
 * Page for editing questions.
 *
 * @package    qbank_editquestion
 * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

require_once(__DIR__ . '/../../../config.php');
require_once(__DIR__ . '/../../editlib.php');
require_once($CFG->libdir . '/filelib.php');
require_once($CFG->libdir . '/formslib.php');

// Read URL parameters telling us which question to edit.
$id = optional_param('id', 0, PARAM_INT); // Question id.
$makecopy = optional_param('makecopy', 0, PARAM_BOOL);
$qtype = optional_param('qtype', '', PARAM_COMPONENT);
$categoryid = optional_param('category', 0, PARAM_INT);
$cmid = optional_param('cmid', 0, PARAM_INT);
$courseid = optional_param('courseid', 0, PARAM_INT);
$wizardnow = optional_param('wizardnow', '', PARAM_ALPHA);
$originalreturnurl = optional_param('returnurl', 0, PARAM_LOCALURL);
$appendqnumstring = optional_param('appendqnumstring', '', PARAM_ALPHA);
$inpopup = optional_param('inpopup', 0, PARAM_BOOL);
< $scrollpos = optional_param('scrollpos', 0, PARAM_INT);
> $mdlscrollto = optional_param('mdlscrollto', 0, PARAM_INT);
\core_question\local\bank\helper::require_plugin_enabled('qbank_editquestion'); $url = new moodle_url('/question/bank/editquestion/question.php'); if ($id !== 0) { $url->param('id', $id); } if ($makecopy) { $url->param('makecopy', $makecopy); } if ($qtype !== '') { $url->param('qtype', $qtype); } if ($categoryid !== 0) { $url->param('category', $categoryid); } if ($cmid !== 0) { $url->param('cmid', $cmid); } if ($courseid !== 0) { $url->param('courseid', $courseid); } if ($wizardnow !== '') { $url->param('wizardnow', $wizardnow); } if ($originalreturnurl !== 0) { $url->param('returnurl', $originalreturnurl); } if ($appendqnumstring !== '') { $url->param('appendqnumstring', $appendqnumstring); } if ($inpopup !== 0) { $url->param('inpopup', $inpopup); }
< if ($scrollpos) { < $url->param('scrollpos', $scrollpos);
> if ($mdlscrollto) { > $url->param('mdlscrollto', $mdlscrollto);
} $PAGE->set_url($url); if ($cmid) { $questionbankurl = new moodle_url('/question/edit.php', array('cmid' => $cmid)); } else { $questionbankurl = new moodle_url('/question/edit.php', array('courseid' => $courseid)); } navigation_node::override_active_url($questionbankurl); if ($originalreturnurl) { if (strpos($originalreturnurl, '/') !== 0) { throw new coding_exception("returnurl must be a local URL starting with '/'. $originalreturnurl was given."); } $returnurl = new moodle_url($originalreturnurl); } else { $returnurl = $questionbankurl; }
< if ($scrollpos) { < $returnurl->param('scrollpos', $scrollpos);
> if ($mdlscrollto) { > $returnurl->param('mdlscrollto', $mdlscrollto);
} if ($cmid) { list($module, $cm) = get_module_from_cmid($cmid); require_login($cm->course, false, $cm); $thiscontext = context_module::instance($cmid); } else if ($courseid) { require_login($courseid, false); $thiscontext = context_course::instance($courseid); $module = null; $cm = null; } else { throw new moodle_exception('missingcourseorcmid', 'question'); } $contexts = new core_question\local\bank\question_edit_contexts($thiscontext); $PAGE->set_pagelayout('admin'); if (optional_param('addcancel', false, PARAM_BOOL)) { redirect($returnurl); } if ($id) { if (!$question = $DB->get_record('question', array('id' => $id))) { throw new moodle_exception('questiondoesnotexist', 'question', $returnurl); } // We can use $COURSE here because it's been initialised as part of the // require_login above. Passing it as the third parameter tells the function // to filter the course tags by that course. get_question_options($question, true, [$COURSE]); } else if ($categoryid && $qtype) { // Only for creating new questions. $question = new stdClass(); $question->category = $categoryid; $question->qtype = $qtype; $question->createdby = $USER->id; // Check that users are allowed to create this question type at the moment. if (!question_bank::qtype_enabled($qtype)) { throw new moodle_exception('cannotenable', 'question', $returnurl, $qtype); } } else if ($categoryid) { // Category, but no qtype. They probably came from the addquestion.php // script without choosing a question type. Send them back. $addurl = new moodle_url('/question/bank/editquestion/addquestion.php', $url->params()); $addurl->param('validationerror', 1); redirect($addurl); } else { throw new moodle_exception('notenoughdatatoeditaquestion', 'question', $returnurl); } $qtypeobj = question_bank::get_qtype($question->qtype); if (isset($question->categoryobject)) { $category = $question->categoryobject; } else { // Validate the question category. if (!$category = $DB->get_record('question_categories', array('id' => $question->category))) { throw new moodle_exception('categorydoesnotexist', 'question', $returnurl); } } // Check permissions. $question->formoptions = new stdClass(); $categorycontext = context::instance_by_id($category->contextid); $question->contextid = $category->contextid; $addpermission = has_capability('moodle/question:add', $categorycontext); if ($id) { $question->formoptions->canedit = question_has_capability_on($question, 'edit'); $question->formoptions->canmove = $addpermission && question_has_capability_on($question, 'move'); $question->formoptions->cansaveasnew = $addpermission && (question_has_capability_on($question, 'view') || $question->formoptions->canedit); $question->formoptions->repeatelements = $question->formoptions->canedit || $question->formoptions->cansaveasnew; $formeditable = $question->formoptions->canedit || $question->formoptions->cansaveasnew || $question->formoptions->canmove; if (!$formeditable) { question_require_capability_on($question, 'view'); } $question->beingcopied = false; if ($makecopy) { // If we are duplicating a question, add some indication to the question name. $question->name = get_string('questionnamecopy', 'question', $question->name); $question->idnumber = isset($question->idnumber) ? core_question_find_next_unused_idnumber($question->idnumber, $category->id) : ''; $question->beingcopied = true; } } else { // Creating a new question. $question->formoptions->canedit = question_has_capability_on($question, 'edit'); $question->formoptions->canmove = (question_has_capability_on($question, 'move') && $addpermission); $question->formoptions->cansaveasnew = false; $question->formoptions->repeatelements = true; $formeditable = true; require_capability('moodle/question:add', $categorycontext); } $question->formoptions->mustbeusable = (bool) $appendqnumstring; // Validate the question type. $PAGE->set_pagetype('question-type-' . $question->qtype); // Create the question editing form. if ($wizardnow !== '') { $mform = $qtypeobj->next_wizard_form('question.php', $question, $wizardnow, $formeditable); } else { $mform = $qtypeobj->create_editing_form('question.php', $question, $category, $contexts, $formeditable); } $toform = fullclone($question); // Send the question object and a few more parameters to the form. $toform->category = "{$category->id},{$category->contextid}";
< $toform->scrollpos = $scrollpos;
> $toform->mdlscrollto = $mdlscrollto;
if ($formeditable && $id) { $toform->categorymoveto = $toform->category; } $toform->appendqnumstring = $appendqnumstring; $toform->returnurl = $originalreturnurl; $toform->makecopy = $makecopy; $toform->idnumber = null; if (!empty($question->id)) { $questionobject = question_bank::load_question($question->id); $toform->status = $questionobject->status; $toform->idnumber = $questionobject->idnumber; } else { $toform->status = \core_question\local\bank\question_version_status::QUESTION_STATUS_READY; } if ($makecopy) { $toform->idnumber = core_question_find_next_unused_idnumber($toform->idnumber, $category->id); } if ($cm !== null) { $toform->cmid = $cm->id; $toform->courseid = $cm->course; } else { $toform->courseid = $COURSE->id; } $toform->inpopup = $inpopup; // Prepare custom fields data. $customfieldhandler = qbank_customfields\customfield\question_handler::create(); $customfieldhandler->instance_form_before_set_data($toform); $mform->set_data($toform); if ($mform->is_cancelled()) { if ($inpopup) { close_window(); } else { redirect($returnurl); } } else if ($fromform = $mform->get_data()) { // If we are saving as a copy, break the connection to the old question. if ($makecopy) { $question->id = 0; // Copies should not be hidden. $question->status = \core_question\local\bank\question_version_status::QUESTION_STATUS_READY; } // If is will be added directly to a module send the module name to be referenced. if ($appendqnumstring && $cm) { $fromform->modulename = 'mod_' . $cm->modname; } // Process the combination of usecurrentcat, categorymoveto and category form // fields, so the save_question method only has to consider $fromform->category. if (empty($fromform->usecurrentcat) && !empty($fromform->categorymoveto)) { $fromform->category = $fromform->categorymoveto; } // If we are moving a question, check we have permission to move it from // whence it came (Where we are moving to is validated by the form). list($newcatid, $newcontextid) = explode(',', $fromform->category); if (!empty($question->id) && $newcatid != $question->categoryobject->id) { $contextid = $newcontextid; question_require_capability_on($question, 'move'); } else { $contextid = $category->contextid; } // Ensure we redirect back to the category the question is being saved into. $returnurl->param('category', $fromform->category); // We are actually saving the question. if (!empty($question->id)) { question_require_capability_on($question, 'edit'); } else { require_capability('moodle/question:add', context::instance_by_id($contextid)); if (!empty($fromform->makecopy) && !$question->formoptions->cansaveasnew) { throw new moodle_exception('nopermissions', '', '', 'edit'); } } // If this is a new question, save defaults for user in user_preferences table. if (empty($question->id)) { $qtypeobj->save_defaults_for_new_questions($fromform); } $question = $qtypeobj->save_question($question, $fromform); if (isset($fromform->tags)) { // If we have any question context level tags then set those tags now. core_tag_tag::set_item_tags('core_question', 'question', $question->id, context::instance_by_id($contextid), $fromform->tags, 0); } if (isset($fromform->coursetags)) { // If we have and course context level tags then set those now. core_tag_tag::set_item_tags('core_question', 'question', $question->id, context_course::instance($fromform->courseid), $fromform->coursetags, 0); } // Update custom fields if there are any of them in the form. $customfieldhandler->instance_form_save($fromform); // Purge this question from the cache. question_bank::notify_question_edited($question->id); // If we are saving and continuing to edit the question. if (!empty($fromform->updatebutton)) { $url->param('id', $question->id); $url->remove_params('makecopy'); redirect($url); } if ($qtypeobj->finished_edit_wizard($fromform)) { if ($inpopup) { echo $OUTPUT->notification(get_string('changessaved'), ''); close_window(3); } else { $returnurl->param('lastchanged', $question->id); if ($appendqnumstring) { $returnurl->param($appendqnumstring, $question->id); $returnurl->param('sesskey', sesskey()); $returnurl->param('cmid', $cmid); } redirect($returnurl); } } else {
< $nexturlparams = array(
> $nexturlparams = [
'returnurl' => $originalreturnurl, 'appendqnumstring' => $appendqnumstring,
< 'scrollpos' => $scrollpos);
> 'mdlscrollto' => $mdlscrollto, > ];
if (isset($fromform->nextpageparam) && is_array($fromform->nextpageparam)) { // Useful for passing data to the next page which is not saved in the database. $nexturlparams += $fromform->nextpageparam; } $nexturlparams['id'] = $question->id; $nexturlparams['wizardnow'] = $fromform->wizard; $nexturl = new moodle_url($url, $nexturlparams); if ($cmid) { $nexturl->param('cmid', $cmid); } else { $nexturl->param('courseid', $COURSE->id); } redirect($nexturl); } } $streditingquestion = $qtypeobj->get_heading(); $PAGE->set_title($streditingquestion); $PAGE->set_heading($COURSE->fullname); $PAGE->activityheader->disable(); $PAGE->navbar->add($streditingquestion); if ($PAGE->course->id == $SITE->id) { $PAGE->set_primary_active_tab('home'); } // Display a heading, question editing form and possibly some extra content needed for // for this question type. echo $OUTPUT->header(); $qtypeobj->display_question_editing_page($mform, $question, $wizardnow); echo $OUTPUT->footer();