Qtype_drawlines: Implement shownumcorrect , showmisplaced and remove clearwrong #882022

Author: Mahmoud Kassaei

classes/line.php

@@ -177,7 +177,7 @@ public static function is_item_positioned_correctly_on_axis($responsecoord, $lin
      * Parse the input and return the parts in a list of 'cx', 'cy' with or whothout 'r'.
      *
      * @param string $dropzone, the string in a given format with or whithout radius
-     * @param bool $radius, if set to true, return the list with radius, otherwise with radius
+     * @param bool $radius, if set to true, return the list with radius, otherwise without radius
      * @return int[], a list of 'cx', 'cy' with or whothout 'r'.
      */
     public static function parse_into_cx_cy_with_or_without_radius(string $dropzone, bool $radius = false): array {

edit_drawlines_form.php

@@ -172,11 +172,11 @@ protected function get_per_line_fields(MoodleQuickForm $mform, string $label, ar
     /**
      * Create the form elements required by one hint.
      *
-     * @param string $withclearwrong whether this quesiton type uses the 'Clear wrong' option on hints.
+     * @param string $withshowmisplaced whether this quesiton type uses the 'show misplaced' option on hints.
      * @param string $withshownumpartscorrect whether this quesiton type uses the 'Show num parts correct' option on hints.
      * @return array form field elements for one hint.
      */
-    protected function get_hint_fields($withclearwrong = false, $withshownumpartscorrect = false) {
+    protected function get_hint_fields($withshowmisplaced = true, $withshownumpartscorrect = false) {
         $mform = $this->_form;
 
         $repeated = [];
@@ -187,7 +187,7 @@ protected function get_hint_fields($withclearwrong = false, $withshownumpartscor
         $repeated[] = $mform->createElement('checkbox', 'hintshownumcorrect',
                 get_string('options', 'question'),
                 get_string('shownumpartscorrect', 'question'));
-        $repeated[] = $mform->createElement('checkbox', 'hintoptions', '',
+        $repeated[] = $mform->createElement('checkbox', 'hintshowmisplaced', '',
                 get_string('showmisplaced', 'qtype_' . $this->qtype()));
 
         return [$repeated, $repeatedoptions];
@@ -256,16 +256,19 @@ protected function data_preprocessing_lines(stdClass $question): object {
     }
 
     #[\Override]
-    protected function data_preprocessing_hints($question, $withclearwrong = false,
-            $withshownumpartscorrect = false) {
+    protected function data_preprocessing_hints($question, $withshowmisplaced = true,
+                                                $withshownumpartscorrect = false) {
         if (empty($question->hints)) {
             return $question;
         }
-        parent::data_preprocessing_hints($question, $withclearwrong, $withshownumpartscorrect);
+        parent::data_preprocessing_hints($question, false, $withshownumpartscorrect);
 
         $question->hintoptions = [];
         foreach ($question->hints as $hint) {
             $question->hintoptions[] = $hint->options;
+            if ($question->hintoptions) {
+                $question->hintshowmisplaced[] = $hint->options;
+            }
         }
 
         return $question;

lang/en/qtype_drawlines.php

@@ -31,8 +31,8 @@
 $string['correctanswersare'] = 'The correct answers are: {$a}';
 $string['dropbackground'] = 'Background image for Draw lines';
 
-$string['formerror_nobgimage'] = 'You need to select an image to use as the background for the drag and drop area.';
 $string['formerror_invalidimagesize'] = 'Image file should not be larger than 600x600 px. The uploaded image file size is {$a->width}x{$a->height} px.';
+$string['formerror_nobgimage'] = 'You need to select an image to use as the background for the drag and drop area.';
 $string['formerror_nolines'] = 'You need to expand \'Line 1\' and fill the form for it';
 $string['formerror_notype'] = 'You have to select a type for Line {$a}';
 $string['formerror_zoneend'] = 'End zone coordinates should be in x,y;r format, where x,y are the coordinates of the centre of a circle and r is the radius.';

questiontype.php

@@ -115,17 +115,17 @@ public function save_hints($fromform, $withparts = false) {
         }
 
         if ($withparts) {
-            if (!empty($fromform->hintclearwrong)) {
-                $numclears = max(array_keys($fromform->hintclearwrong)) + 1;
+            if (!empty($fromform->hintoptions)) {
+                $numshowmisplaced = max(array_keys($fromform->hintshowmisplaced)) + 1;
             } else {
-                $numclears = 0;
+                $numshowmisplaced = 0;
             }
             if (!empty($fromform->hintshownumcorrect)) {
                 $numshows = max(array_keys($fromform->hintshownumcorrect)) + 1;
             } else {
                 $numshows = 0;
             }
-            $numhints = max($numhints, $numclears, $numshows);
+            $numhints = max($numhints, $numshowmisplaced, $numshows);
         }
 
         for ($i = 0; $i < $numhints; $i += 1) {
@@ -134,7 +134,7 @@ public function save_hints($fromform, $withparts = false) {
             }
 
             if ($withparts) {
-                $clearwrong = !empty($fromform->hintclearwrong[$i]);
+                $statewhichincorrect = !empty($fromform->hintshowmisplaced[$i]);
                 $shownumcorrect = !empty($fromform->hintshownumcorrect[$i]);
                 $statewhichincorrect = !empty($fromform->hintoptions[$i]);
             }
@@ -157,7 +157,7 @@ public function save_hints($fromform, $withparts = false) {
                     $context, 'question', 'hint', $hint->id);
             $hint->hintformat = $fromform->hint[$i]['format'];
             if ($withparts) {
-                $hint->clearwrong = $clearwrong;
+                $hint->showmisplaced = $statewhichincorrect;
                 $hint->shownumcorrect = $shownumcorrect;
                 $hint->options = $statewhichincorrect;
             }

renderer.php

@@ -164,7 +164,10 @@ public function formulation_and_controls(question_attempt $qa, question_display_
 
     #[\Override]
     public function specific_feedback(question_attempt $qa) {
-        return $this->combined_feedback($qa);
+        $output = '';
+        $output .= $this->combined_feedback($qa);
+        $hint = $qa->get_applicable_hint();
+        return $output;
     }
 
     #[\Override]
@@ -193,6 +196,46 @@ public function correct_response(question_attempt $qa) {
         return $this->correct_choices($rightanswers);
     }
 
+    #[\Override]
+    protected function hint(question_attempt $qa, question_hint $hint) {
+        $output = '';
+        $question = $qa->get_question();
+        $response = $qa->get_last_qt_data();
+        // Accumulate the wrong coords for each lines to be displayed and hint options.
+        $wrongcoords = [];
+        foreach ($question->lines as $key => $line) {
+            if (in_array($question->field($key), array_keys($response))) {
+                $coords = explode(' ', $response[$question->field($key)]);
+                if ($question->grademethod === 'partial') {
+                    // Label the line.
+                    $linelabelstart = null;
+                    $linelabelend = null;
+                    if (!line::is_dragitem_in_the_right_place($coords[0], $line->zonestart)) {
+                        $linelabelstart = ' L' . $line->number;
+                        $wrongcoords[] = $linelabelstart . html_writer::tag('span',
+                                ' start =' . $coords[0], ['class' => 'misplaced']);
+                    }
+                    if (!line::is_dragitem_in_the_right_place($coords[1], $line->zoneend)) {
+                        if (is_null($linelabelstart)) {
+                            // Do not repeat the line number for the end-prt of the line coordinates.
+                            $linelabelend = ' L' . $line->number;
+                        }
+                        $wrongcoords[] = $linelabelend . html_writer::tag('span', ' end =' . $coords[1], ['class' => 'misplaced']);
+                    }
+                } else {
+                    if (!(line::is_dragitem_in_the_right_place($coords[0], $line->zonestart) &&
+                        line::is_dragitem_in_the_right_place($coords[1], $line->zoneend))) {
+                        $wrongcoords[] = ' L' . $line->number . html_writer::tag('span',
+                                ' start=' . $coords[0] . ' end=' . $coords[1], ['class' => 'misplaced']);
+                    }
+                }
+            }
+        }
+        $output .= html_writer::tag('div', get_string('showmisplaced', 'qtype_drawlines', implode($wrongcoords)));
+        $output .= parent::hint($qa, $hint);
+        return $output;
+    }
+
     /**
      * Function returns string based on number of correct answers.
      *
@@ -214,16 +257,26 @@ protected function correct_choices(array $right): string {
     #[\Override]
     protected function num_parts_correct(question_attempt $qa): string {
         $a = new stdClass();
-        list($a->num, $a->outof) = $qa->get_question()->get_num_parts_right(
-                $qa->get_last_qt_data());
-        if (is_null($a->outof)) {
+        $grademethod = $qa->get_question()->grademethod;
+        if ($grademethod === 'partial') {
+            [$a->num, $a->outof] = $qa->get_question()->get_num_parts_right_grade_partial($qa->get_last_qt_data());
+        } else {
+            [$a->num, $a->outof] = $qa->get_question()->get_num_parts_right_grade_allornone($qa->get_last_qt_data());
+        }
+        if ($a->num === 0 || is_null($a->outof)) {
             return '';
         } else if ($a->num == 1) {
             return html_writer::tag('p', get_string('yougot1right', 'qtype_drawlines'));
         } else {
             $f = new NumberFormatter(current_language(), NumberFormatter::SPELLOUT);
             $a->num = $f->format($a->num);
-            return html_writer::tag('p', get_string('yougotnright', 'qtype_drawlines', $a));
+            $string['yougotnright'] = 'You have correctly selected {$a->num} points.';
+            $string['yougotnrightline'] = 'You have correctly selected {$a->num} lines.';
+            if ($grademethod === 'partial') {
+                return html_writer::tag('p', get_string('yougotnright', 'qtype_drawlines', $a->num));
+            } else {
+                return html_writer::tag('p', get_string('yougotnrightline', 'qtype_drawlines', $a->num));
+            }
         }
     }
 }

styles.css

@@ -65,3 +65,9 @@ form.mform fieldset#id_previewareaheader .dropbackground {
 form.mform fieldset#id_previewareaheader div.ddarea {
     text-align: center;
 }
+
+.que.drawlines span.misplaced  {
+    background-color: #ff0;
+    opacity: .6;
+    margin: 2px;
+}

tests/helper.php

@@ -65,7 +65,7 @@ public function get_drawlines_question_data_mkmap_twolines(): stdClass {
         $qdata->options->incorrectfeedback = test_question_maker::STANDARD_OVERALL_INCORRECT_FEEDBACK;
         $qdata->options->incorrectfeedbackformat = FORMAT_HTML;
         $qdata->options->shownumcorrect = 1;
-        $qdata->options->showmisplaced = 0;
+        $qdata->options->showmisplaced = 1;
 
         $qdata->lines = [
                 1 => (object)[
@@ -93,7 +93,7 @@ public function get_drawlines_question_data_mkmap_twolines(): stdClass {
                         'hint' => 'Hint 1.',
                         'hintformat' => FORMAT_HTML,
                         'shownumcorrect' => 1,
-                        'showmisplaced' => 0,
+                        'showmisplaced' => 1,
                         'options' => 0,
                 ],
                 2 => (object) [
@@ -168,7 +168,7 @@ public function get_drawlines_question_form_data_mkmap_twolines(): stdClass {
             ],
         ];
         $fromform->hintshownumcorrect = [1, 1];
-        $fromform->hintclearwrong = [0, 1];
+        $fromform->hintshowmisplaced = [0, 1];
         $fromform->hintoptions = [0, 1];
 
         $fromform->status = \core_question\local\bank\question_version_status::QUESTION_STATUS_READY;
@@ -211,7 +211,7 @@ public function make_drawlines_question_mkmap_twolines(): qtype_drawlines_questi
         $question->incorrectfeedback = test_question_maker::STANDARD_OVERALL_INCORRECT_FEEDBACK;
         $question->incorrectfeedbackformat = FORMAT_HTML;
         $question->shownumcorrect = 1;
-        $question->showmisplaced = 0;
+        $question->showmisplaced = 1;
 
         $question->lines = [
                 0 => new line(