Matrix add support for sub-questions to be lists

Author: hieuvu

.github/workflows/ci.yml

@@ -110,7 +110,6 @@ jobs:
         run: moodle-plugin-ci mustache
 
       - name: Grunt
-        if: ${{ matrix.moodle-branch == 'MOODLE_401_STABLE' }}
         run: moodle-plugin-ci grunt --max-lint-warnings 0
 
       - name: PHPUnit tests

backup/moodle2/backup_qtype_oumatrix_plugin.class.php

@@ -40,7 +40,7 @@ protected function define_question_plugin_structure(): backup_plugin_element {
         // Now create the qtype own structures.
         $matrix = new backup_nested_element('oumatrix', ['id'], ['inputtype', 'grademethod', 'shuffleanswers',
             'correctfeedback', 'correctfeedbackformat', 'partiallycorrectfeedback', 'partiallycorrectfeedbackformat',
-            'incorrectfeedback', 'incorrectfeedbackformat', 'shownumcorrect',
+            'incorrectfeedback', 'incorrectfeedbackformat', 'shownumcorrect', 'questionnumbering',
         ]);
         $pluginwrapper->add_child($matrix);
 

db/install.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
-<XMLDB PATH="question/type/oumatrix/db" VERSION="20230621" COMMENT="XMLDB file for Moodle question/type/oumatrix"
-   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-   xsi:noNamespaceSchemaLocation="../../../../lib/xmldb/xmldb.xsd"
+<XMLDB PATH="question/type/oumatrix/db" VERSION="20250903" COMMENT="XMLDB file for Moodle question/type/oumatrix"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="../../../../lib/xmldb/xmldb.xsd"
 >
   <TABLES>
     <TABLE NAME="qtype_oumatrix_options" COMMENT="Options for OU matrix question">
@@ -18,6 +18,7 @@
         <FIELD NAME="incorrectfeedback" TYPE="text" LENGTH="small" NOTNULL="true" SEQUENCE="false" COMMENT="Feedback shown for any incorrect response."/>
         <FIELD NAME="incorrectfeedbackformat" TYPE="int" LENGTH="2" NOTNULL="true" UNSIGNED="false" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="shownumcorrect" TYPE="int" LENGTH="2" NOTNULL="true" UNSIGNED="true" DEFAULT="0" SEQUENCE="false"/>
+        <FIELD NAME="questionnumbering" TYPE="char" LENGTH="10" NOTNULL="true" DEFAULT="none" SEQUENCE="false"/>
       </FIELDS>
       <KEYS>
         <KEY NAME="primary" TYPE="primary" FIELDS="id"/>

db/upgrade.php

@@ -30,8 +30,22 @@
  */
 function xmldb_qtype_oumatrix_upgrade($oldversion) {
     global $DB;
-
+    $dbman = $DB->get_manager();
     // Put any upgrade step following this.
+    if ($oldversion < 2025090200) {
+
+        // Define field questionnumbering to be added to qtype_oumatrix_options.
+        $table = new xmldb_table('qtype_oumatrix_options');
+        $field = new xmldb_field('questionnumbering', XMLDB_TYPE_CHAR, '10', null, XMLDB_NOTNULL, null, 'none', 'shownumcorrect');
+
+        // Conditionally launch add field questionnumbering.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+        }
+
+        // Oumatrix savepoint reached.
+        upgrade_plugin_savepoint(true, 2025090200, 'qtype', 'oumatrix');
+    }
 
     return true;
 }

edit_oumatrix_form.php

@@ -14,9 +14,13 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <https://www.gnu.org/licenses/>.
 
+defined('MOODLE_INTERNAL') || die();
+
 use qtype_oumatrix\row;
 use qtype_oumatrix\column;
 use qtype_oumatrix\utils;
+require_once($CFG->dirroot . '/question/type/multichoice/questiontype.php');
+
 /**
  * Editing form for the oumatrix question type.
  *
@@ -110,6 +114,10 @@ protected function definition_inner($mform) {
         $mform->setDefault('shuffleanswers', $this->get_default_value('shuffleanswers',
                 get_config('qtype_oumatrix', 'shuffleanswers')));
 
+        $mform->addElement('select', 'questionnumbering',
+            get_string('questionnumbering', 'qtype_oumatrix'), qtype_multichoice::get_numbering_styles());
+        $mform->setDefault('questionnumbering', 'none');
+
         // Add update field.
         $mform->addElement('submit', 'updateform', get_string('updateform', 'qtype_oumatrix'));
         $mform->registerNoSubmitButton('updateform');
@@ -236,6 +244,7 @@ protected function data_preprocessing_options(stdClass $question): object {
         $question->inputtype = $question->options->inputtype;
         $question->grademethod = $question->options->grademethod;
         $question->shuffleanswers = $question->options->shuffleanswers;
+        $question->questionnumbering = $question->options->questionnumbering;
         $question->shownumcorrect = $question->options->shownumcorrect;
         return $question;
     }

lang/en/qtype_oumatrix.php

@@ -62,6 +62,7 @@
 $string['privacy:preference:inputtype'] = 'Whether the \'One or multiple answers?\' should be \'Single choice\' or \'Multiple response\'.';
 $string['privacy:preference:penalty'] = 'The penalty for each incorrect try when questions are run using the \'Interactive with multiple tries\' or \'Adaptive mode\' behaviour.';
 $string['privacy:preference:shuffleanswers'] = 'Whether the answers should be automatically shuffled.';
+$string['questionnumbering'] = 'Number the sub-questions?';
 $string['regradeissuenumcolumnschanged'] = 'The number of columns has changed.';
 $string['regradeissuenumrowschanged'] = 'The number of rows has changed.';
 $string['row'] = 'Row {$a}';

question.php

@@ -38,6 +38,9 @@ abstract class qtype_oumatrix_base extends question_graded_automatically {
     /** @var int whether the rows/columns or both should be shuffled. */
     public int $shuffleanswers;
 
+    /** @var string 'abc', 'ABCD', '123', etc. or '' for no numbering. */
+    public string $questionnumbering;
+
     /** @var string 'All or none' or 'partial' grading method for multiple response. */
     public string $grademethod;
 

questiontype.php

@@ -60,6 +60,7 @@ public function save_defaults_for_new_questions(stdClass $fromform): void {
         $this->set_default_value('inputtype', $fromform->inputtype);
         $this->set_default_value('grademethod', $fromform->grademethod);
         $this->set_default_value('shuffleanswers', $fromform->shuffleanswers);
+        $this->set_default_value('questionnumbering', $fromform->questionnumbering);
         $this->set_default_value('shownumcorrect', $fromform->shownumcorrect);
     }
 
@@ -74,6 +75,7 @@ public function save_question_options($question) {
             $options->inputtype = '';
             $options->grademethod = '';
             $options->shuffleanswers = 0;
+            $options->questionnumbering = 'none';
             $options->correctfeedback = '';
             $options->partiallycorrectfeedback = '';
             $options->incorrectfeedback = '';
@@ -84,6 +86,7 @@ public function save_question_options($question) {
         $options->inputtype = $question->inputtype;
         $options->grademethod = $question->grademethod;
         $options->shuffleanswers = $question->shuffleanswers;
+        $options->questionnumbering = $question->questionnumbering;
         $options = $this->save_combined_feedback_helper($options, $question, $context, true);
         $DB->update_record('qtype_oumatrix_options', $options);
 
@@ -188,6 +191,7 @@ protected function initialise_question_instance(question_definition $question, $
         parent::initialise_question_instance($question, $questiondata);
         $question->grademethod = $questiondata->options->grademethod;
         $question->shuffleanswers = $questiondata->options->shuffleanswers;
+        $question->questionnumbering = $questiondata->options->questionnumbering;
         $this->initialise_question_columns($question, $questiondata);
         $this->initialise_question_rows($question, $questiondata);
         $this->initialise_combined_feedback($question, $questiondata, true);
@@ -393,6 +397,9 @@ public function import_from_xml($data, $question, qformat_xml $format, $extra =
             $format->getpath($data, ['#', 'inputtype'], 'single'));
         $question->grademethod = $format->import_text(
             $format->getpath($data, ['#', 'grademethod'], 'partial'));
+        $question->questionnumbering = $format->getpath($data, ['#', 'questionnumbering'], '')
+            ? $format->import_text($format->getpath($data, ['#', 'questionnumbering'], '')) : 'none';
+
         $shuffleanswers = $format->getpath($data, ['#', 'shuffleanswers', 0, '#'], 1);
         $question->shuffleanswers = $shuffleanswers === 'false' || $shuffleanswers === 'true'
             ? $format->trans_single($shuffleanswers) : $shuffleanswers;
@@ -487,6 +494,9 @@ public function export_to_xml($question, qformat_xml $format, $extra = null) {
         $output .= '    <grademethod>' . $format->xml_escape($question->options->grademethod)
                 . "</grademethod>\n";
         $output .= "    <shuffleanswers>" . $question->options->shuffleanswers . "</shuffleanswers>\n";
+        $output .= "    <questionnumbering>" . $format->xml_escape(
+                $question->options->questionnumbering) . "</questionnumbering>\n";
+
 
         // Export columns data.
         $output .= "    <columns>\n";

renderer.php

@@ -23,6 +23,7 @@
  */
 
 use qtype_oumatrix\column;
+use question_utils;
 
 defined('MOODLE_INTERNAL') || die();
 
@@ -168,14 +169,17 @@ public function matrix_table(question_attempt $qa, question_display_options $opt
         $inputattributes['type'] = $this->get_input_type();
 
         // Adding table rows for the sub-questions.
+        $columncount = 0;
         foreach ($question->get_roworder($qa) as $rowkey => $rowid) {
 
             $row = $question->rows[$rowid];
             $rownewid = 'row'. $rowkey;
             $feedback = '';
 
             $table .= html_writer::start_tag('tr');
-            $table .= html_writer::tag('th', html_writer::span(format_string($row->name), '', ['id' => $rownewid]),
+            $table .= html_writer::tag('th', html_writer::span(
+                $this->number_in_style($columncount, $question->questionnumbering) .
+                format_string($row->name), '', ['id' => $rownewid]),
                 ['class' => 'subquestion align-middle', 'scope' => 'row']);
 
             foreach ($question->get_colorder($qa) as $colkey => $colid) {
@@ -222,6 +226,7 @@ public function matrix_table(question_attempt $qa, question_display_options $opt
                 $table .= html_writer::tag('td', $feedback);
             }
             $table .= html_writer::end_tag('tr');
+            $columncount++;
         }
 
         $table .= html_writer::end_tag('table');
@@ -253,6 +258,48 @@ protected function correct_choices(array $right): string {
             return "";
         }
     }
+
+    /**
+     * Renders a number in a particular style.
+     *
+     * @param int $num The number, starting at 0.
+     * @param string $style The style to render the number in.
+     * @return string the number $num in the requested style.
+     */
+    protected function number_in_style(int $num, string $style): string {
+        switch($style) {
+            case 'abc':
+                $number = chr(ord('a') + $num);
+                break;
+            case 'ABCD':
+                $number = chr(ord('A') + $num);
+                break;
+            case '123':
+                $number = $num + 1;
+                break;
+            case 'iii':
+                $number = question_utils::int_to_roman($num + 1);
+                break;
+            case 'IIII':
+                $number = strtoupper(question_utils::int_to_roman($num + 1));
+                break;
+            case 'none':
+                return '';
+            default:
+                return 'ERR';
+        }
+        return $this->number_html($number);
+    }
+
+    /**
+     * Returns the HTML to display before the number in a question.
+     *
+     * @param string $qnum The question number, in whatever format is required.
+     * @return string HTML to display before the question number.
+     */
+    protected function number_html(string $qnum): string {
+        return $qnum . '. ';
+    }
 }
 
 /**

styles.css

@@ -11,7 +11,7 @@
     background-color: rgba(0, 0, 0, 0.03);
 }
 .que.oumatrix .answer .generaltable tbody tr:nth-of-type(odd) {
-    background-color: #FFFFFF;
+    background-color: #fff;
 }
 
 /* Editing form. */