MDL-81376 mod_quiz: Add bulk user/group override upload via CSV

mod/quiz/classes/form/import_override_form.php

@@ -0,0 +1,107 @@
+<?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   tool_lpimportcsv
+ * @copyright 2015 Damyon Wiese
+ * @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 csv_import_reader;
+
+require_once($CFG->libdir.'/formslib.php');
+
+/**
+ * Import Competency framework form.
+ *
+ * @package   tool_lpimportcsv
+ * @copyright 2015 Damyon Wiese
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class import_override_form extends moodleform {
+
+    /**
+     * 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);
+
+        $mform = $this->_form;
+
+        // 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);
+
+        // Example CSV, similar implementation as admin/tool/uploaduser/example.csv.
+        $url = new \moodle_url('example.csv');
+        $link = \html_writer::link($url, 'example.csv');
+        $mform->addElement('static', 'exampleimportcsv', get_string('exampleimportcsv', 'quiz'), $link);
+        $mform->addHelpButton('exampleimportcsv', 'exampleimportcsv', 'quiz');
+
+        // Filepicker.
+        $element = $mform->createElement('filepicker', 'importfile', 'CSV override file');
+        $mform->addElement($element);
+        $mform->addRule('importfile', 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');
+
+        $this->add_action_buttons(true, get_string('import', 'quiz'));
+    }
+
+    /**
+     * Display an error on the import form.
+     * @param string $msg
+     */
+    public function set_import_error($msg) {
+        $mform = $this->_form;
+
+        $mform->setElementError('importfile', $msg);
+    }
+
+}

mod/quiz/classes/output/overrides_actions.php

@@ -85,6 +85,34 @@ public function create_add_button(\renderer_base $output): \single_button {
         return $addoverridebutton;
     }
 
+    /**
+     * Create the import override button.
+     *
+     * @param \renderer_base $output an instance of the quiz renderer.
+     * @return \single_button the button, ready to reander.
+     */
+    public function create_import_button(\renderer_base $output): \single_button {
+        $addoverrideurl = new moodle_url('/mod/quiz/overrideimport.php',
+                ['cmid' => $this->cmid, 'mode' => $this->mode]);
+
+        if ($this->mode === 'group') {
+            $label = 'Import Group CSV';
+        } else {
+            $label = 'Import User CSV';
+        }
+
+        $addoverridebutton = new \single_button($addoverrideurl, $label, 'get', \single_button::BUTTON_PRIMARY);
+
+        return $addoverridebutton;
+    }
+
+
+    /**
+     * Export this data so it can be used as the context for a mustache template.
+     *
+     * @param renderer_base $output Used to do a final render of any components that need to be rendered for export.
+     * @return array
+     */
     public function export_for_template(renderer_base $output): array {
         global $PAGE;
         $templatecontext = [];
@@ -104,6 +132,7 @@ public function export_for_template(renderer_base $output): array {
         // Build the add button - but only if the user can edit.
         if ($this->canedit) {
             $templatecontext['addoverridebutton'] = $this->create_add_button($output)->export_for_template($output);
+            $templatecontext['addimportbutton'] = $this->create_import_button($output)->export_for_template($output);
         }
 
         return $templatecontext;