integrate new option in question data

Author: PhilippImhof

backup/moodle2/backup_qtype_formulas_plugin.class.php

@@ -51,10 +51,10 @@ protected function define_question_plugin_structure() {
 
         $formulasanswers = new backup_nested_element('formulas_answers');
         $formulasanswer = new backup_nested_element('formulas_answer', ['id'], [
-            'partindex', 'placeholder', 'answermark', 'answertype', 'numbox', 'vars1', 'answer', 'answernotunique', 'vars2',
-            'correctness', 'unitpenalty', 'postunit', 'ruleid', 'otherrule', 'subqtext', 'subqtextformat', 'feedback',
+            'partindex', 'placeholder', 'answermark', 'answertype', 'numbox', 'vars1', 'answer', 'answernotunique', 'emptyallowed',
+            'vars2', 'correctness', 'unitpenalty', 'postunit', 'ruleid', 'otherrule', 'subqtext', 'subqtextformat', 'feedback',
             'feedbackformat', 'partcorrectfb', 'partcorrectfbformat', 'partpartiallycorrectfb', 'partpartiallycorrectfbformat',
-            'partincorrectfb', 'partincorrectfbformat', 'emptyallowed',
+            'partincorrectfb', 'partincorrectfbformat'
         ]);
 
         // Don't need to annotate ids nor files.

backup/moodle2/restore_qtype_formulas_plugin.class.php

@@ -149,6 +149,11 @@ public function process_formulas_answer($data) {
             if (!isset($data->answernotunique)) {
                 $data->answernotunique = '1';
             }
+            // Backups prior to 6.2 do not yet have the emptyallowed field. In that case, we set it
+            // to false. It should default to true for *new* questions only.
+            if (!isset($data->emptyallowed)) {
+                $data->emptyallowed = '0';
+            }
             // Insert record.
             $newitemid = $DB->insert_record('qtype_formulas_answers', $data);
             // Create mapping.
@@ -195,6 +200,9 @@ public static function convert_backup_to_questiondata(array $backupdata): stdCla
             if (!key_exists('answernotunique', $answer)) {
                 $answer['answernotunique'] = '1';
             }
+            if (!key_exists('emptyallowed', $answer)) {
+                $answer['emptyallowed'] = '0';
+            }
             if (!key_exists('partindex', $answer)) {
                 $answer['partindex'] = $i;
             }

db/install.xml

@@ -36,6 +36,7 @@
         <FIELD NAME="vars1" TYPE="text" NOTNULL="false" SEQUENCE="false"/>
         <FIELD NAME="answer" TYPE="text" NOTNULL="true" SEQUENCE="false"/>
         <FIELD NAME="answernotunique" TYPE="int" LENGTH="4" NOTNULL="true" DEFAULT="1" SEQUENCE="false"/>
+        <FIELD NAME="emptyallowed" TYPE="int" LENGTH="4" NOTNULL="true" DEFAULT="0" SEQUENCE="false"/>
         <FIELD NAME="vars2" TYPE="text" NOTNULL="false" SEQUENCE="false"/>
         <FIELD NAME="correctness" TYPE="text" NOTNULL="true" SEQUENCE="false"/>
         <FIELD NAME="unitpenalty" TYPE="float" NOTNULL="false" SEQUENCE="false"/>

db/upgrade.php

@@ -396,5 +396,21 @@ function xmldb_qtype_formulas_upgrade($oldversion = 0) {
         upgrade_plugin_savepoint(true, 2023100800, 'qtype', 'formulas');
     }
 
+    if ($oldversion < 2025080100) {
+        // Define field emptyallowed to be added to qtype_formulas_answers.
+        $table = new xmldb_table('qtype_formulas_answers');
+        $field = new xmldb_field('emptyallowed', XMLDB_TYPE_INTEGER, '4', null, XMLDB_NOTNULL, null, '0', 'answernotunique');
+
+        // Conditionally add field.
+        if (!$dbman->field_exists($table, $field)) {
+            $dbman->add_field($table, $field);
+            // Now fill it with '0' for compatibility with existing questions.
+            $DB->set_field('qtype_formulas_answers', 'emptyallowed', '0');
+        }
+
+        // Formulas savepoint reached.
+        upgrade_plugin_savepoint(true, 2025080100, 'qtype', 'formulas');
+    }
+
     return true;
 }

edit_formulas_form.php

@@ -328,10 +328,6 @@ protected function data_preprocessing($question) {
                 foreach ($question->options->answers as $key => $answer) {
 
                     foreach ($tags as $tag) {
-                        // FIXME: remove this later, when the DB is updated
-                        if ($tag === 'emptyallowed') {
-                            continue;
-                        }
                         if ($tag === 'unitpenalty' || $tag === 'ruleid') {
                             $defaultvalues['global' . $tag] = $answer->$tag;
                         } else {

question.php

@@ -886,8 +886,7 @@ class qtype_formulas_part {
     public int $answernotunique;
 
     /** @var int whether students can leave one or more fields empty */
-    public int $emptyallowed = 1;
-    // FIXME: change this once the DB is updated
+    public int $emptyallowed;
 
     /** @var string definition of the grading criterion */
     public string $correctness;

questiontype.php

@@ -616,12 +616,16 @@ public function import_from_xml($xml, $question, qformat_xml $format, $extra = n
                 $question->partindex[$i] = $partindex;
             }
             foreach (self::PART_BASIC_FIELDS as $field) {
-                // Older questions do not have this field, so we do not want to issue an error message.
-                // Also, for maximum backwards compatibility, we set the default value to 1. With this,
-                // nothing changes for old questions.
+                // Older questions do not have the 'answernotunique' field, so we do not want to issue an
+                // error message. For maximum backwards compatibility, we set the default value to 1. With
+                // this, nothing changes for old questions. Also, questions exported prior to version 6.2
+                // won't have the 'emptyallowed' field. We will set it to 0 (false) for backwards compatiblity.
                 if ($field === 'answernotunique') {
                     $ifnotexists = '';
                     $default = '1';
+                } else if ($field === 'emptyallowed') {
+                    $ifnotexists = '';
+                    $default = '0';
                 } else {
                     $ifnotexists = get_string('error_import_missing_field', 'qtype_formulas', $field);
                     $default = '0';
@@ -861,11 +865,6 @@ public function check_and_filter_parts(object $data): object {
             $partdata[$i] = (object)['questionid' => $data->id];
             // Set the basic fields, e.g. mark, placeholder or definition of local variables.
             foreach (self::PART_BASIC_FIELDS as $field) {
-                // FIXME: remove this later, when the DB is updated
-                if ($field === 'emptyallowed') {
-                    $partdata[$i]->emptyallowed = 1;
-                    continue;
-                }
                 // In the edit form, the part's 'unitpenalty' and 'ruleid' are set via the global options
                 // 'globalunitpenalty' and 'globalruleid'. When importing a question, they do not need
                 // special treatment, because they are already stored with the part. Also, all other fields