first commit

question/bank/viewquestiontext/amd/build/question_text_format.min.js

@@ -0,0 +1,11 @@
+define("qbank_viewquestiontext/question_text_format",["exports","qbank_viewquestiontext/repository","core_question/refresh_ui","core/notification"],(function(_exports,repository,_refresh_ui,_notification){function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,repository=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}
+/**
+   * Javascript for question_text_format question bank control.
+   *
+   * @module     qbank_viewquestiontext/question_text_format
+   * @copyright  2023 Catalyst IT Europe Ltd.
+   * @author     Mark Johnson <mark.johnson@catalyst-eu.net>
+   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+   */(repository),_refresh_ui=_interopRequireDefault(_refresh_ui),_notification=_interopRequireDefault(_notification);const SELECTORS_formatSelectId="question-text-format",SELECTORS_returnUrl="[name=returnurl]";let uiRoot;const handleFormatChange=async e=>{const value=e.target.value;try{await repository.setQuestionTextFormat(value);const returnUrlInput=e.target.closest("form").querySelector(SELECTORS_returnUrl),returnUrl=new URL(returnUrlInput.value);await _refresh_ui.default.refresh(uiRoot,returnUrl)}catch(ex){_notification.default.exception(ex)}};_exports.init=uiRootId=>{uiRoot=document.getElementById(uiRootId);document.getElementById(SELECTORS_formatSelectId).addEventListener("change",handleFormatChange)}}));
+
+//# sourceMappingURL=question_text_format.min.js.map

question/bank/viewquestiontext/amd/build/question_text_format.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"question_text_format.min.js","sources":["../src/question_text_format.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Javascript for question_text_format question bank control.\n *\n * @module     qbank_viewquestiontext/question_text_format\n * @copyright  2023 Catalyst IT Europe Ltd.\n * @author     Mark Johnson <mark.johnson@catalyst-eu.net>\n * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport * as repository from 'qbank_viewquestiontext/repository';\nimport RefreshUi from 'core_question/refresh_ui';\nimport Notification from 'core/notification';\n\nconst SELECTORS = {\n    formatSelectId: 'question-text-format',\n    returnUrl: '[name=returnurl]',\n};\n\nlet uiRoot;\n\n/**\n * Save the selected format via a web service call, and refresh the UI.\n *\n * @param {Event} e Select field change event.\n * @return {Promise<void>}\n */\nconst handleFormatChange = async(e) => {\n    const value = e.target.value;\n    try {\n        await repository.setQuestionTextFormat(value);\n        const returnUrlInput = e.target.closest('form').querySelector(SELECTORS.returnUrl);\n        const returnUrl = new URL(returnUrlInput.value);\n        await RefreshUi.refresh(uiRoot, returnUrl);\n    } catch (ex) {\n        Notification.exception(ex);\n    }\n};\n\n/**\n * Initialise question text format widget.\n *\n * Find the uiRoot element and attach a change listener to the question text format selector.\n *\n * @param {String} uiRootId\n */\nexport const init = (uiRootId) => {\n    uiRoot = document.getElementById(uiRootId);\n    const select = document.getElementById(SELECTORS.formatSelectId);\n    select.addEventListener('change', handleFormatChange);\n};\n"],"names":["SELECTORS","uiRoot","handleFormatChange","async","value","e","target","repository","setQuestionTextFormat","returnUrlInput","closest","querySelector","returnUrl","URL","RefreshUi","refresh","ex","exception","uiRootId","document","getElementById","addEventListener"],"mappings":";;;;;;;;4HA4BMA,yBACc,uBADdA,oBAES,uBAGXC,aAQEC,mBAAqBC,MAAAA,UACjBC,MAAQC,EAAEC,OAAOF,gBAEbG,WAAWC,sBAAsBJ,aACjCK,eAAiBJ,EAAEC,OAAOI,QAAQ,QAAQC,cAAcX,qBACxDY,UAAY,IAAIC,IAAIJ,eAAeL,aACnCU,oBAAUC,QAAQd,OAAQW,WAClC,MAAOI,0BACQC,UAAUD,oBAWVE,WACjBjB,OAASkB,SAASC,eAAeF,UAClBC,SAASC,eAAepB,0BAChCqB,iBAAiB,SAAUnB"}

question/bank/viewquestiontext/amd/build/repository.min.js

@@ -0,0 +1,3 @@
+define("qbank_viewquestiontext/repository",["exports","core/ajax"],(function(_exports,_ajax){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.setQuestionTextFormat=void 0;_exports.setQuestionTextFormat=format=>(0,_ajax.call)([{methodname:"qbank_viewquestiontext_set_question_text_format",args:{format:format}}])[0]}));
+
+//# sourceMappingURL=repository.min.js.map

question/bank/viewquestiontext/amd/build/repository.min.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"repository.min.js","sources":["../src/repository.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * External function calls for qbank_columnsortorder\n *\n * @module     qbank_viewquestiontext/repository\n * @copyright  2023 Catalyst IT Europe Ltd.\n * @author     Mark Johnson <mark.johnson@catalyst-eu.net>\n * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {call as fetchMany} from 'core/ajax';\n\n/**\n * Set the question text format.\n *\n * @param {Number} format The question text format.\n * @return {Promise}\n */\nexport const setQuestionTextFormat = (format) => fetchMany([{\n    methodname: 'qbank_viewquestiontext_set_question_text_format',\n    args: {\n        format,\n    },\n}])[0];\n"],"names":["format","methodname","args"],"mappings":"0NAgCsCA,SAAW,cAAU,CAAC,CACxDC,WAAY,kDACZC,KAAM,CACFF,OAAAA,WAEJ"}

question/bank/viewquestiontext/amd/src/question_text_format.js

@@ -0,0 +1,65 @@
+// 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/>.
+
+/**
+ * Javascript for question_text_format question bank control.
+ *
+ * @module     qbank_viewquestiontext/question_text_format
+ * @copyright  2023 Catalyst IT Europe Ltd.
+ * @author     Mark Johnson <mark.johnson@catalyst-eu.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+import * as repository from 'qbank_viewquestiontext/repository';
+import RefreshUi from 'core_question/refresh_ui';
+import Notification from 'core/notification';
+
+const SELECTORS = {
+    formatSelectId: 'question-text-format',
+    returnUrl: '[name=returnurl]',
+};
+
+let uiRoot;
+
+/**
+ * Save the selected format via a web service call, and refresh the UI.
+ *
+ * @param {Event} e Select field change event.
+ * @return {Promise<void>}
+ */
+const handleFormatChange = async(e) => {
+    const value = e.target.value;
+    try {
+        await repository.setQuestionTextFormat(value);
+        const returnUrlInput = e.target.closest('form').querySelector(SELECTORS.returnUrl);
+        const returnUrl = new URL(returnUrlInput.value);
+        await RefreshUi.refresh(uiRoot, returnUrl);
+    } catch (ex) {
+        Notification.exception(ex);
+    }
+};
+
+/**
+ * Initialise question text format widget.
+ *
+ * Find the uiRoot element and attach a change listener to the question text format selector.
+ *
+ * @param {String} uiRootId
+ */
+export const init = (uiRootId) => {
+    uiRoot = document.getElementById(uiRootId);
+    const select = document.getElementById(SELECTORS.formatSelectId);
+    select.addEventListener('change', handleFormatChange);
+};

question/bank/viewquestiontext/amd/src/repository.js

@@ -0,0 +1,38 @@
+// 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/>.
+
+/**
+ * External function calls for qbank_columnsortorder
+ *
+ * @module     qbank_viewquestiontext/repository
+ * @copyright  2023 Catalyst IT Europe Ltd.
+ * @author     Mark Johnson <mark.johnson@catalyst-eu.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+import {call as fetchMany} from 'core/ajax';
+
+/**
+ * Set the question text format.
+ *
+ * @param {Number} format The question text format.
+ * @return {Promise}
+ */
+export const setQuestionTextFormat = (format) => fetchMany([{
+    methodname: 'qbank_viewquestiontext_set_question_text_format',
+    args: {
+        format,
+    },
+}])[0];

question/bank/viewquestiontext/classes/external/set_question_text_format.php

@@ -0,0 +1,79 @@
+<?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_viewquestiontext\external;
+
+use context_system;
+use core_external\external_api;
+use core_external\external_function_parameters;
+use core_external\external_value;
+use qbank_viewquestiontext\output\question_text_format;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/question/editlib.php');
+
+/**
+ * External function for setting the question text format.
+ *
+ * @package   qbank_viewquestiontext
+ * @copyright 2023 onwards Catalyst IT EU {@link https://catalyst-eu.net}
+ * @author    Mark Johnson <mark.johnson@catalyst-eu.net>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class set_question_text_format extends external_api {
+    /**
+     * Returns description of method parameters.
+     *
+     * @return external_function_parameters
+     */
+    public static function execute_parameters(): external_function_parameters {
+        return new external_function_parameters([
+            'format' => new external_value(PARAM_INT, 'Format for the question text', VALUE_REQUIRED),
+        ]);
+    }
+
+    /**
+     * Returns description of method result value.
+     */
+    public static function execute_returns(): void {
+    }
+
+    /**
+     * Save the question text format preference for the current user.
+     *
+     * @param int $format Format for the question text.
+     */
+    public static function execute(int $format): void {
+        [
+            'format' => $format,
+        ] = self::validate_parameters(
+            self::execute_parameters(),
+            [
+                'format' => $format,
+            ]
+        );
+
+        if (!in_array($format, [question_text_format::OFF, question_text_format::PLAIN, question_text_format::FULL])) {
+            throw new \invalid_parameter_exception('$format must be one of question_text_format::OFF, ::PLAIN or ::FULL.');
+        }
+
+        $context = context_system::instance();
+        self::validate_context($context);
+
+        \question_set_or_get_user_preference('qbshowtext', $format, 0, new \moodle_url('/'));
+    }
+}

question/bank/viewquestiontext/classes/output/question_text_format.php

@@ -0,0 +1,92 @@
+<?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_viewquestiontext\output;
+
+use core_question\local\bank\view;
+use qbank_viewquestiontext\question_text_row;
+use renderer_base;
+
+/**
+ * Question text format selector.
+ *
+ * @package   qbank_viewquestiontext
+ * @copyright 2023 onwards Catalyst IT EU {@link https://catalyst-eu.net}
+ * @author    Mark Johnson <mark.johnson@catalyst-eu.net>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_text_format implements \renderable, \templatable {
+    /**
+     * @var int Question text is off.
+     */
+    const OFF = 0;
+
+    /**
+     * @var int Question text is displayed in plain text mode.
+     */
+    const PLAIN = 1;
+
+    /**
+     * @var int Question text is displayed fully rendered.
+     */
+    const FULL = 2;
+
+    /** @var int|mixed The current display preference value. */
+    protected int $preference;
+
+    /**
+     * @var \moodle_url The return URL for redirecting back to the current question bank page.
+     */
+    protected \moodle_url $returnurl;
+
+    /**
+     * Store the returnurl and the current preference value.
+     *
+     * @param view $qbank
+     * @throws \moodle_exception
+     */
+    public function __construct(view $qbank) {
+        $row = new question_text_row($qbank);
+        $this->returnurl = new \moodle_url($qbank->returnurl);
+        $this->preference = question_get_display_preference($row->get_preference_key(), 0, PARAM_INT, new \moodle_url(''));
+    }
+
+    public function export_for_template(renderer_base $output): array {
+        return [
+            'formaction' => new \moodle_url('/question/bank/viewquestiontext/save.php'),
+            'sesskey' => sesskey(),
+            'returnurl' => $this->returnurl->out(false),
+            'options' => [
+                (object)[
+                    'label' => get_string('showquestiontext_off', 'question'),
+                    'value' => self::OFF,
+                    'selected' => $this->preference === self::OFF,
+                ],
+                (object)[
+                    'label' => get_string('showquestiontext_plain', 'question'),
+                    'value' => self::PLAIN,
+                    'selected' => $this->preference === self::PLAIN,
+                ],
+                (object)[
+                    'label' => get_string('showquestiontext_full', 'question'),
+                    'value' => self::FULL,
+                    'selected' => $this->preference === self::FULL,
+                ],
+            ],
+            'label' => get_string('showquestiontext', 'core_question'),
+        ];
+    }
+}

question/bank/viewquestiontext/classes/plugin_feature.php

@@ -0,0 +1,57 @@
+<?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_viewquestiontext;
+
+use core\context;
+use core_question\local\bank\plugin_features_base;
+use core_question\local\bank\view;
+use qbank_viewquestiontext\output\question_text_format;
+
+/**
+ * Class columns is the entrypoint for the columns.
+ *
+ * @package    qbank_viewquestiontext
+ * @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 {
+
+    /**
+     * Return an additional row for displaying the question text, if user has a preference set to display it.
+     *
+     * @param view $qbank
+     * @return array
+     */
+    public function get_question_columns(view $qbank): array {
+        $row = new question_text_row($qbank);
+        $preference = (int)question_get_display_preference($row->get_preference_key(), '0', PARAM_INT, new \moodle_url('/'));
+        if ($preference != question_text_format::OFF) {
+            return [
+                $row,
+            ];
+        }
+        return [];
+
+    }
+
+    public function get_question_bank_controls(view $qbank, context $context, int $categoryid): array {
+        return [
+            400 => new question_text_format($qbank),
+        ];
+    }
+}

question/bank/viewquestiontext/classes/privacy/provider.php

@@ -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_viewquestiontext\privacy;
+
+/**
+ * Privacy Subsystem for qbank_viewquestiontext implementing null_provider.
+ *
+ * @package    qbank_viewquestiontext
+ * @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';
+    }
+}

question/bank/viewquestiontext/classes/question_text_row.php

@@ -0,0 +1,88 @@
+<?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_viewquestiontext;
+
+use core_question\local\bank\row_base;
+use qbank_viewquestiontext\output\question_text_format;
+use question_utils;
+
+/**
+ * A column type for the name of the question name.
+ *
+ * @package   qbank_viewquestiontext
+ * @copyright 2009 Tim Hunt
+ * @author    2021 Safat Shahin <safatshahin@catalyst-au.net>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class question_text_row extends row_base {
+
+    /** @var int if true, we will show the question text reduced to plain text, else it is fully rendered. */
+    protected $preference;
+
+    /** @var \stdClass $formatoptions options used when displaying the question text as HTML. */
+    protected $formatoptions;
+
+    protected function init(): void {
+
+        // Cannot use $this->get_preference because of PHP type hints.
+        $this->preference = (int)question_get_display_preference($this->get_preference_key(), 0, PARAM_INT, new \moodle_url(''));
+        $this->formatoptions = new \stdClass();
+        $this->formatoptions->noclean = true;
+        $this->formatoptions->para = false;
+    }
+
+    public function get_name(): string {
+        return 'questiontext';
+    }
+
+    public function get_title(): string {
+        return get_string('questiontext', 'question');
+    }
+
+    protected function display_content($question, $rowclasses): void {
+        // Access 'showtext' filter from pagevars.
+        if ($this->preference !== question_text_format::OFF) {
+            $text = '';
+            if ($this->preference === question_text_format::PLAIN) {
+                $text = s(question_utils::to_plain_text($question->questiontext,
+                        $question->questiontextformat, ['noclean' => true, 'para' => false, 'filter' => false]));
+            } else if ($this->preference === question_text_format::FULL) {
+                $text = question_rewrite_question_preview_urls($question->questiontext, $question->id,
+                        $question->contextid, 'question', 'questiontext', $question->id,
+                        $question->contextid, 'core_question');
+                $text = format_text($text, $question->questiontextformat,
+                        $this->formatoptions);
+            }
+            if ($text == '') {
+                $text = '&#160;';
+            }
+            echo $text;
+        }
+    }
+
+    public function get_required_fields(): array {
+        return ['q.questiontext', 'q.questiontextformat'];
+    }
+
+    public function has_preference(): bool {
+        return false;
+    }
+
+    public function get_preference_key(): string {
+        return 'qbshowtext';
+    }
+}

question/bank/viewquestiontext/db/services.php

@@ -0,0 +1,36 @@
+<?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/>.
+
+/**
+ * qbank_viewquestiontext external functions and service definitions.
+ *
+ * @package    qbank_viewquestiontext
+ * @category   webservice
+ * @copyright  2023 Catalyst IT Europe Ltd
+ * @author     Mark Johnson <mark.johnson@catalyst-eu.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$functions = [
+    'qbank_viewquestiontext_set_question_text_format' => [
+        'classname' => 'qbank_viewquestiontext\external\set_question_text_format',
+        'description' => 'Sets the preference for displaying and formatting the question text',
+        'type' => 'write',
+        'ajax' => true,
+    ],
+];

question/bank/viewquestiontext/lang/en/qbank_viewquestiontext.php

@@ -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_viewquestiontext, language 'en'
+ *
+ * @package    qbank_viewquestiontext
+ * @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'] = 'View question text';
+$string['privacy:metadata'] = 'The View question text question bank plugin does not store any personal data.';

question/bank/viewquestiontext/save.php

@@ -0,0 +1,48 @@
+<?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/>.
+
+/**
+ * Synchronously save the question text display preference, and redirect back to the previous page.
+ *
+ * This is progressively enhanced by question_text_format.js, but this remains as a fallback.
+ *
+ * @package   qbank_viewquestiontext
+ * @copyright 2023 onwards Catalyst IT EU {@link https://catalyst-eu.net}
+ * @author    Mark Johnson <mark.johnson@catalyst-eu.net>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once(__DIR__ . '/../../../config.php');
+require_once($CFG->dirroot . '/question/editlib.php');
+
+$format = required_param('format', PARAM_INT);
+$returnurl = required_param('returnurl', PARAM_LOCALURL);
+
+require_login();
+require_sesskey();
+
+$validformats = [
+    \qbank_viewquestiontext\output\question_text_format::OFF,
+    \qbank_viewquestiontext\output\question_text_format::PLAIN,
+    \qbank_viewquestiontext\output\question_text_format::FULL,
+];
+if (!in_array($format, $validformats)) {
+    throw new \invalid_parameter_exception('$format must be one of question_text_format::OFF, ::PLAIN or ::FULL.');
+}
+
+question_set_or_get_user_preference('qbshowtext', $format, 0, new \moodle_url('/'));
+
+redirect(new moodle_url($returnurl));

question/bank/viewquestiontext/styles.css

@@ -0,0 +1,3 @@
+.jsenabled .question-text-format .input-group-append {
+    display: none;
+}

question/bank/viewquestiontext/templates/question_text_format.mustache

@@ -0,0 +1,58 @@
+{{!
+    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/>.
+}}
+{{!
+    @template qbank_viewquestiontext/question_text_format
+
+    Example context (json):
+    {
+        "label": "Question text format",
+        "options": [
+          {
+             "value": 1,
+             "label": "Plain text",
+             "selected": true
+          },
+          {
+             "value": 2,
+             "label": "Fully rendered",
+             "selected": false
+          }
+        ]
+    }
+}}
+<form class="question-text-format ml-1" action="{{formaction}}">
+    <input type="hidden" name="sesskey" value="{{sesskey}}">
+    <input type="hidden" name="returnurl" value="{{returnurl}}">
+    <div class="input-group">
+        <label class="input-group-prepend" for="question-text-format">
+            <span class="input-group-text">{{label}}</span>
+        </label>
+        <select class="form-control" name="format" id="question-text-format">
+        {{#options}}
+            <option value="{{value}}"{{#selected}} selected{{/selected}}>{{label}}</option>
+        {{/options}}
+        </select>
+        <div class="input-group-append">
+            <button class="btn btn-outline-dark mb-2">{{#str}} save {{/str}}</button>
+        </div>
+    </div>
+</form>
+{{#js}}
+    require(['qbank_viewquestiontext/question_text_format'], QuestionTextFormat => {
+        QuestionTextFormat.init('questionscontainer');
+    });
+{{/js}}

question/bank/viewquestiontext/tests/behat/view_question_text_column.feature

@@ -0,0 +1,57 @@
+@qbank @qbank_viewquestiontext
+Feature: Use the qbank plugin manager page for viewquestiontext
+  In order to check the plugin behaviour with enable and disable
+
+  Background:
+    Given the following "courses" exist:
+      | fullname | shortname | category |
+      | Course 1 | C1        | 0        |
+    And the following "activities" exist:
+      | activity   | name      | course | idnumber |
+      | quiz       | Test quiz | C1     | quiz1    |
+    And the following "question categories" exist:
+      | contextlevel | reference | name           |
+      | Course       | C1        | Test questions |
+    And the following "questions" exist:
+      | questioncategory | qtype     | name           | questiontext                                                         |
+      | Test questions   | truefalse | First question | Answer the <span class="totestforhtml">first</span> &lt;question&gt; |
+
+  @javascript
+  Scenario: Display of plain question text can be turned on and off
+    When I am on the "Test quiz" "mod_quiz > question bank" page logged in as admin
+    And I set the field "Show question text in the question list?" to "text only"
+    Then I should see "Answer the first <question>"
+    And ".totestforhtml" "css_element" should not exist in the "Answer the first <question>" "table_row"
+    And I set the field "Show question text in the question list?" to "No"
+    And I should not see "Answer the first <question>"
+
+  @javascript
+  Scenario: Display of full question text can be turned on and off
+    When I am on the "Test quiz" "mod_quiz > question bank" page logged in as admin
+    And I set the field "Show question text in the question list?" to "with images"
+    Then I should see "Answer the first <question>"
+    And ".totestforhtml" "css_element" should exist in the "Answer the first <question>" "table_row"
+    And I set the field "Show question text in the question list?" to "No"
+    And I should not see "Answer the first <question>"
+
+  @javascript
+  Scenario: Option does not show if the plugin is disabled
+    Given the following config values are set as admin:
+      | disabled | 1 | qbank_viewquestiontext |
+    When I am on the "Test quiz" "mod_quiz > question bank" page logged in as admin
+    Then I should not see "Show question text in the question list"
+
+  @javascript
+  Scenario: Enable/disable viewquestiontext column from the base view
+    Given I log in as "admin"
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I should see "View question text"
+    When I click on "Disable" "link" in the "View question text" "table_row"
+    And I am on the "Test quiz" "mod_quiz > question bank" page
+    And I should not see "Show question text in the question list"
+    Then "#categoryquestions .questiontext" "css_element" should not be visible
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I click on "Enable" "link" in the "View question text" "table_row"
+    And I am on the "Test quiz" "mod_quiz > question bank" page
+    When I set the field "Show question text in the question list?" to "text only"
+    And I should see "Answer the first <question>"

question/bank/viewquestiontext/version.php

@@ -0,0 +1,31 @@
+<?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/>.
+
+/**
+ * Version information for qbank_viewquestiontext.
+ *
+ * @package    qbank_viewquestiontext
+ * @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
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->component = 'qbank_viewquestiontext';
+$plugin->version   = 2024042200;
+$plugin->requires  = 2024041600;
+$plugin->maturity  = MATURITY_STABLE;