forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-81376 mod_quiz: Add quiz overrides bulk import functionality
- Loading branch information
Showing
12 changed files
with
2,165 additions
and
259 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
<?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/>. | ||
|
||
/** | ||
* This file contains the form for importing a framework from a file. | ||
* | ||
* @package mod_quiz | ||
* @copyright 2024 Djarran Cotleanu | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
|
||
namespace mod_quiz\form; | ||
|
||
defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.'); | ||
|
||
use moodleform; | ||
use core_text; | ||
use context_module; | ||
use csv_import_reader; | ||
|
||
require_once($CFG->libdir.'/formslib.php'); | ||
|
||
/** | ||
* Import user/group quiz overrides. | ||
* | ||
* @package mod_quiz | ||
* @copyright 2024 Djarran Cotleanu | ||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
*/ | ||
class import_override_form extends moodleform { | ||
|
||
/** | ||
* Import quiz overrides form definition. | ||
* | ||
* @return void | ||
*/ | ||
public function definition(): void { | ||
global $CFG; | ||
require_once($CFG->libdir . '/csvlib.class.php'); | ||
|
||
// Additional code to capture parameters. | ||
$cmid = optional_param('cmid', 0, PARAM_INT); | ||
$mode = optional_param('mode', '', PARAM_ALPHANUMEXT); | ||
$context = context_module::instance($cmid); | ||
|
||
// Get the course module object. | ||
$cm = get_coursemodule_from_id(null, $cmid); | ||
if (!$cm) { | ||
throw new moodle_exception('invalidcoursemodule'); | ||
} | ||
|
||
// Get the course object. | ||
$course = get_course($cm->course); | ||
|
||
$mform = $this->_form; | ||
|
||
$mform->addElement('header', 'importheader', get_string('import')); | ||
|
||
// Include cmid and action as hidden elements to pass parameters on submission. | ||
$mform->addElement('hidden', 'cmid', $cmid); | ||
$mform->setType('cmid', PARAM_INT); | ||
|
||
$mform->addElement('hidden', 'mode', $mode); | ||
$mform->setType('mode', PARAM_ALPHANUMEXT); | ||
|
||
// Filepicker. | ||
$element = $mform->createElement('filepicker', 'overridefile', | ||
get_string('overridefile', 'quiz'), null, ['accepted_types' => '.csv']); | ||
$mform->addElement($element); | ||
$mform->addHelpButton('overridefile', 'overridefile', 'quiz', null, null, $mode); | ||
$mform->addRule('overridefile', null, 'required'); | ||
$mform->addElement('hidden', 'confirm', 0); | ||
$mform->setType('confirm', PARAM_BOOL); | ||
|
||
// Delimiter. | ||
$choices = csv_import_reader::get_delimiter_list(); | ||
$mform->addElement('select', 'delimiter_name', get_string('csvdelimiter', 'quiz'), $choices); | ||
if (array_key_exists('cfg', $choices)) { | ||
$mform->setDefault('delimiter_name', 'cfg'); | ||
} else if (get_string('listsep', 'langconfig') == ';') { | ||
$mform->setDefault('delimiter_name', 'semicolon'); | ||
} else { | ||
$mform->setDefault('delimiter_name', 'comma'); | ||
} | ||
|
||
// Encoding. | ||
$choices = core_text::get_encodings(); | ||
$mform->addElement('select', 'encoding', get_string('encoding', 'quiz'), $choices); | ||
$mform->setDefault('encoding', 'UTF-8'); | ||
|
||
// Template File. | ||
$downloadurl = \moodle_url::make_pluginfile_url( | ||
$context->id, | ||
'mod_quiz', | ||
'overrides', | ||
$mode, | ||
null, | ||
null, | ||
true, | ||
); | ||
$downloadurl->params([ | ||
'template' => 1, | ||
]); | ||
|
||
$templatename = "{$course->shortname}-{$mode}-overrides-template.csv"; | ||
$templatelink = \html_writer::link($downloadurl, $templatename); | ||
$mform->addElement('static', 'templatefile', get_string('templatefile', 'quiz'), $templatelink); | ||
$mform->addHelpButton('templatefile', 'templatefile', 'quiz', null, null, $mode . 's'); | ||
|
||
// Action buttons. | ||
$this->add_action_buttons(true, get_string('importvalidate', 'quiz')); | ||
} | ||
|
||
/** | ||
* Display an error on the import form. | ||
* @param string $msg | ||
*/ | ||
public function set_import_error($msg) { | ||
$mform = $this->_form; | ||
|
||
$mform->setElementError('importfile', $msg); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.