broken-save - Deal with input/PRT addition and deletion.

Author: EJMFarrow

edit_stack_form.php

@@ -179,7 +179,7 @@ protected function definition() {
         $mform->addHelpButton('fixdollars', 'fixdollars', 'qtype_stack');
         $isbroken = $mform->createElement('checkbox', 'isbroken',
                 stack_string('isbroken'), stack_string('isbrokenlabel'));
-        $mform->setDefault('isbroken', $this->question->options->isbroken);
+        $mform->setDefault('isbroken', (!empty($this->question->options->isbroken) ? 1 : 0));
         $mform->insertElementBefore($isbroken, 'buttonar');
         $mform->addHelpButton('isbroken', 'isbroken', 'qtype_stack');
         $mform->closeHeaderBefore('fixdollars');
@@ -507,10 +507,13 @@ protected function definition_input($inputname, MoodleQuickForm $mform, $counts)
         // Set a default for the new question.
         if ($inputname === self::DEFAULT_INPUT) {
             $mform->setDefault($inputname . 'modelans', self::DEFAULT_TEACHER_ANSWER);
+        } else {
+            // Default for all parts of an input required in order to save a broken question.
+            $mform->setDefault($inputname . 'modelans', '');
         }
 
         $mform->addElement('text', $inputname . 'boxsize', stack_string('boxsize'), ['size' => 3]);
-        $mform->setDefault($inputname . 'boxsize', $this->stackconfig->inputboxsize);
+        $mform->setDefault($inputname . 'boxsize', (int) $this->stackconfig->inputboxsize);
         $mform->setType($inputname . 'boxsize', PARAM_INT);
         $mform->addHelpButton($inputname . 'boxsize', 'boxsize', 'qtype_stack');
         $mform->hideIf($inputname . 'boxsize', $inputname . 'type', 'in',
@@ -585,6 +588,7 @@ protected function definition_input($inputname, MoodleQuickForm $mform, $counts)
         $mform->hideIf($inputname . 'showvalidation', $inputname . 'type', 'in', []);
 
         $mform->addElement('text', $inputname . 'options', stack_string('inputextraoptions'), ['size' => 30]);
+        $mform->setDefault($inputname . 'options', '');
         $mform->setType($inputname . 'options', PARAM_RAW);
         $mform->addHelpButton($inputname . 'options', 'inputextraoptions', 'qtype_stack');
     }
@@ -961,13 +965,20 @@ protected function prepare_text_field($field, $text, $format, $itemid, $filearea
     // phpcs:ignore moodle.Commenting.MissingDocblock.Function
     public function validation($fromform, $files) {
         $errors = parent::validation($fromform, $files);
-        // By-pass STACK-specific validation if question is marked as broken.
-        // Moodle validation still performed.
+        $qtype = new qtype_stack();
+        $allerrors = $qtype->validate_fromform($fromform, $errors);
+        // Ignore STACK-specific validation if question is marked as broken unless
+        // a confirmation is required.
+        // Moodle validation errors always returned.
         if (empty($fromform['isbroken'])) {
-            $qtype = new qtype_stack();
-            return $qtype->validate_fromform($fromform, $errors);
+            return $allerrors;
         } else {
-            return $errors;
+            if (array_search(stack_string('youmustconfirm'), $allerrors)) {
+                $allerrors['versioninfo'] = stack_string('notsaved') . $allerrors['versioninfo'];
+                return $allerrors;
+            } else {
+                return $errors;
+            }
         }
     }
 

lang/en/qtype_stack.php

@@ -404,6 +404,7 @@
 $string['variantsselectionseed_help'] = 'Normally you can leave this box blank. If, however, you want two different questions in a quiz to use the same random seed, then type the same string in this box for the two questions (and deploy the same set of random seeds, if you are using deployed variants) and the random seeds for the two questions will be synchronised.';
 $string['verifyquestionandupdate'] = 'Verify the question text and update the form';
 $string['youmustconfirm'] = 'You must confirm here.';
+$string['notsaved'] = '** QUESTION WAS NOT SAVED ** You have changes to confirm.';
 
 // Strings used by input elements.
 $string['studentinputtoolong'] = 'Your input is longer than permitted by STACK.';

questiontype.php

@@ -235,6 +235,12 @@ public function save_question_options($fromform) {
         $prts = $DB->get_records('qtype_stack_prts',
                 ['questionid' => $fromform->id], '', 'name, id, questionid');
         foreach ($prtnames as $prtname) {
+            if (!isset($fromform->{$prtname . 'feedbackvariables'})) {
+                // Skip the PRT if it's not been set up. This should only occur when
+                // saving a broken question.
+                continue;
+            }
+
             if (array_key_exists($prtname, $prts)) {
                 $prt = $prts[$prtname];
                 unset($prts[$prtname]);
@@ -271,7 +277,7 @@ public function save_question_options($fromform) {
             }
             $graph->layout();
             $roots = $graph->get_roots();
-            if (count($roots) != 1 || $graph->get_broken_cycles()) {
+            if (empty($fromform->isbroken) && (count($roots) != 1 || $graph->get_broken_cycles())) {
                 throw new coding_exception('The PRT ' . $prtname . ' is malformed.');
             }
             reset($roots);

tests/questiontype_test.php

@@ -251,6 +251,7 @@ public function test_xml_export(): void {
     <inversetrig>cos-1</inversetrig>
     <logicsymbol>lang</logicsymbol>
     <matrixparens>[</matrixparens>
+    <isbroken>0</isbroken>
     <variantsselectionseed></variantsselectionseed>
     <input>
       <name>ans1</name>