mirrored from git://git.moodle.org/moodle.git
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
MDL-71639 qbank_exporttoxml: Add Export to xml plugin to core
This implementation will introduce a qbank plugin "exporttoxml" which will implement the export to xml action in the question bank view by replacing the core class. Having this plugin will give users the flexibility of enabling or disabling this action.
- Loading branch information
1 parent
443a980
commit c1797c6
Showing
14 changed files
with
443 additions
and
47 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
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
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
59 changes: 59 additions & 0 deletions
59
question/bank/exporttoxml/classes/export_xml_action_column.php
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,59 @@ | ||
| <?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 qbank_exporttoxml; | ||
|
|
||
| use core_question\local\bank\menu_action_column_base; | ||
|
|
||
| /** | ||
| * Question bank column export the question in Moodle XML format. | ||
| * | ||
| * @package qbank_exporttoxml | ||
| * @copyright 2019 The Open University | ||
| * @author 2021 Safat Shahin <safatshahin@catalyst-au.net> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
| class export_xml_action_column extends menu_action_column_base { | ||
|
|
||
| /** @var string avoids repeated calls to get_string('duplicate'). */ | ||
| protected $strexportasxml; | ||
|
|
||
| public function init(): void { | ||
| parent::init(); | ||
| $this->strexportasxml = get_string('exportasxml', 'question'); | ||
| } | ||
|
|
||
| public function get_name(): string { | ||
| return 'exportasxmlaction'; | ||
| } | ||
|
|
||
| protected function get_url_icon_and_label(\stdClass $question): array { | ||
| if (!\question_bank::is_qtype_installed($question->qtype)) { | ||
| // It sometimes happens that people end up with junk questions | ||
| // in their question bank of a type that is no longer installed. | ||
| // We cannot do most actions on them, because that leads to errors. | ||
| return [null, null, null]; | ||
| } | ||
|
|
||
| if (!question_has_capability_on($question, 'view')) { | ||
| return [null, null, null]; | ||
| } | ||
|
|
||
| return [helper::question_get_export_single_question_url($question), | ||
| 't/download', $this->strexportasxml]; | ||
| } | ||
|
|
||
| } |
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,56 @@ | ||
| <?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 qbank_exporttoxml; | ||
|
|
||
| /** | ||
| * Class helper for export plugin. | ||
| * | ||
| * @package qbank_exporttoxml | ||
| * @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 helper { | ||
|
|
||
| /** | ||
| * Get the URL to export a single question (exportone.php). | ||
| * | ||
| * @param \stdClass|\question_definition $question the question definition as obtained from | ||
| * question_bank::load_question_data() or question_bank::make_question(). | ||
| * (Only ->id and ->contextid are used.) | ||
| * @return \moodle_url the requested URL. | ||
| */ | ||
| public static function question_get_export_single_question_url($question): \moodle_url { | ||
| $params = ['id' => $question->id, 'sesskey' => sesskey()]; | ||
| $context = \context::instance_by_id($question->contextid); | ||
| switch ($context->contextlevel) { | ||
| case CONTEXT_MODULE: | ||
| $params['cmid'] = $context->instanceid; | ||
| break; | ||
|
|
||
| case CONTEXT_COURSE: | ||
| $params['courseid'] = $context->instanceid; | ||
| break; | ||
|
|
||
| default: | ||
| $params['courseid'] = SITEID; | ||
| } | ||
|
|
||
| return new \moodle_url('/question/bank/exporttoxml/exportone.php', $params); | ||
| } | ||
|
|
||
| } |
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,37 @@ | ||
| <?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 qbank_exporttoxml; | ||
|
|
||
| use core_question\local\bank\plugin_features_base; | ||
|
|
||
| /** | ||
| * Class plugin_feature is the entrypoint for the columns. | ||
| * | ||
| * @package qbank_exporttoxml | ||
| * @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 plugin_feature extends plugin_features_base { | ||
|
|
||
| public function get_question_columns($qbank): array { | ||
| return [ | ||
| new export_xml_action_column($qbank) | ||
| ]; | ||
| } | ||
|
|
||
| } |
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,32 @@ | ||
| <?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 qbank_exporttoxml\privacy; | ||
|
|
||
| /** | ||
| * Privacy Subsystem for qbank_exporttoxml implementing null_provider. | ||
| * | ||
| * @package qbank_exporttoxml | ||
| * @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 provider implements \core_privacy\local\metadata\null_provider { | ||
|
|
||
| public static function get_reason(): string { | ||
| return 'privacy:metadata'; | ||
| } | ||
| } |
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,82 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * Script to download the export of a single question. | ||
| * | ||
| * @package qbank_exporttoxml | ||
| * @copyright 2015 the Open University | ||
| * @author Safat Shahin <safatshahin@catalyst-au.net> | ||
| * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later | ||
| */ | ||
|
|
||
| require_once(__DIR__ . '/../../../config.php'); | ||
| require_once($CFG->libdir . '/questionlib.php'); | ||
| require_once($CFG->dirroot . '/question/format/xml/format.php'); | ||
|
|
||
| // Get the parameters from the URL. | ||
| $questionid = required_param('id', PARAM_INT); | ||
| $cmid = optional_param('cmid', 0, PARAM_INT); | ||
| $courseid = optional_param('courseid', 0, PARAM_INT); | ||
| $urlparams = ['id' => $questionid, 'sesskey' => sesskey()]; | ||
|
|
||
| \core_question\local\bank\helper::require_plugin_enabled('qbank_exporttoxml'); | ||
|
|
||
| if ($cmid) { | ||
| $cm = get_coursemodule_from_id(null, $cmid); | ||
| require_login($cm->course, false, $cm); | ||
| $thiscontext = context_module::instance($cmid); | ||
| $urlparams['cmid'] = $cmid; | ||
| } else if ($courseid) { | ||
| require_login($courseid, false); | ||
| $thiscontext = context_course::instance($courseid); | ||
| $urlparams['courseid'] = $courseid; | ||
| } else { | ||
| throw new moodle_exception('missingcourseorcmid', 'question'); | ||
| } | ||
| require_sesskey(); | ||
|
|
||
| // Load the necessary data. | ||
| $contexts = new question_edit_contexts($thiscontext); | ||
| $questiondata = question_bank::load_question_data($questionid); | ||
|
|
||
| // Check permissions. | ||
| question_require_capability_on($questiondata, 'view'); | ||
|
|
||
| // Initialise $PAGE. Nothing is output, so this does not really matter. Just avoids notices. | ||
| $nexturl = new moodle_url('/question/type/stack/questiontestrun.php', $urlparams); | ||
| $PAGE->set_url('/question/bank/exporttoxml/exportone.php', $urlparams); | ||
| $PAGE->set_heading($COURSE->fullname); | ||
| $PAGE->set_pagelayout('admin'); | ||
|
|
||
| // Set up the export format. | ||
| $qformat = new qformat_xml(); | ||
| $filename = question_default_export_filename($COURSE, $questiondata) . | ||
| $qformat->export_file_extension(); | ||
| $qformat->setContexts($contexts->having_one_edit_tab_cap('export')); | ||
| $qformat->setCourse($COURSE); | ||
| $qformat->setQuestions([$questiondata]); | ||
| $qformat->setCattofile(false); | ||
| $qformat->setContexttofile(false); | ||
|
|
||
| // Do the export. | ||
| if (!$qformat->exportpreprocess()) { | ||
| send_file_not_found(); | ||
| } | ||
| if (!$content = $qformat->exportprocess(true)) { | ||
| send_file_not_found(); | ||
| } | ||
| send_file($content, $filename, 0, 0, true, true, $qformat->mime_type()); |
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,27 @@ | ||
| <?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/>. | ||
|
|
||
| /** | ||
| * Strings for component qbank_exporttoxml, language 'en' | ||
| * | ||
| * @package qbank_exporttoxml | ||
| * @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 | ||
| */ | ||
|
|
||
| $string['pluginname'] = 'Export to XML'; | ||
| $string['privacy:metadata'] = 'Export to xml question bank plugin does not store any user data.'; |
Oops, something went wrong.