Fix codechecker errors

Author: AnupamaSarjoshi

backup/moodle2/backup_qtype_drawlines_plugin.class.php

@@ -42,11 +42,12 @@ protected function define_question_plugin_structure() {
 
         $plugin->add_child($pluginwrapper);
 
-        $options = new backup_nested_element('drawlines', ['id'], ['grademethod',
-                        'correctfeedback', 'correctfeedbackformat',
-                        'partiallycorrectfeedback', 'partiallycorrectfeedbackformat',
-                        'incorrectfeedback', 'incorrectfeedbackformat',
-                        'shownumcorrect', 'showmisplaced',
+        $options = new backup_nested_element('drawlines', ['id'], [
+                'grademethod',
+                'correctfeedback', 'correctfeedbackformat',
+                'partiallycorrectfeedback', 'partiallycorrectfeedbackformat',
+                'incorrectfeedback', 'incorrectfeedbackformat',
+                'shownumcorrect', 'showmisplaced',
         ]);
         $pluginwrapper->add_child($options);
 
@@ -69,12 +70,11 @@ protected function define_question_plugin_structure() {
      * files to be processed both in backup and restore.
      */
     public static function get_qtype_fileareas() {
-        return
-        [
-                'bgimage' => 'question_created',
-                'correctfeedback' => 'question_created',
-                'partiallycorrectfeedback' => 'question_created',
-                'incorrectfeedback' => 'question_created',
+        return [
+            'bgimage' => 'question_created',
+            'correctfeedback' => 'question_created',
+            'partiallycorrectfeedback' => 'question_created',
+            'incorrectfeedback' => 'question_created',
         ];
     }
 }

classes/line.php

@@ -15,11 +15,11 @@
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
 namespace qtype_drawlines;
-use qtype_drawlines\dragitem;
-use qtype_drawlines\dropzone;
+
+defined('MOODLE_INTERNAL') || die;
 
 /**
- * Represents a line objet of drawlines question.
+ * Represents a line object of drawlines question.
  *
  * @package   qtype_drawlines
  * @copyright 2024 The Open University
@@ -240,12 +240,11 @@ public static function are_response_coordinates_valid(string $linecoordinates):
         return true;
     }
 
-
     public static function make_drop_zone(int $linenumber, string $label, string $zone): drop_zone {
+        // TODO: Need to chek if we need this.
         [$xleft, $ytop] = self::parse_into_cx_cy_with_or_without_radius($zone);
-        return  new drop_zone($linenumber, $label, $xleft, $ytop);
+        return new drop_zone($linenumber, $label, $xleft, $ytop);
     }
-
 }
 
 /**

edit_drawlines_form.php

@@ -215,6 +215,9 @@ protected function data_preprocessing_hints($question, $withclearwrong = false,
         return $question;
     }
 
+    /**
+     * The needed JS setup for this question type.
+     */
     public function js_call() {
         global $PAGE;
         $PAGE->requires->js_call_amd('qtype_drawlines/form', 'init');

lang/en/qtype_drawlines.php

@@ -27,33 +27,31 @@
 
 $string['bgimage'] = 'Background image';
 
-$string['correctansweris'] = 'The correct answer is: {$a}';
-
-$string['dropbackground'] = 'Background image for DrawLines';
-
 $string['correctansweris'] = 'The correct answer is: {$a}';
 $string['correctanswersare'] = 'The correct answers are: {$a}';
+$string['dropbackground'] = 'Background image for DrawLines';
 
 $string['formerror_nobgimage'] = 'You need to select an image to use as the background for the drag and drop area.';
 $string['formerror_notype'] = 'You have to select a type for Line {$a}';
-$string['formerror_zonestart'] = 'Start 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.';
 $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.';
+$string['formerror_zonestart'] = 'Start 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.';
 
 $string['grademethod'] = 'Grading type';
 $string['grademethod_desc'] = 'Give partial credit (default): each correct response in the body cells are worth one point, so students score a percentage of the total correct responses.
 All or nothing: students must get every response correct, otherwise they score zero.';
 $string['grademethod_help'] = 'Give partial credit (default): each correct response worth one point, so students score a percentage of the total correct responses.
 
 All or nothing: students must get every response correct, otherwise they score zero.';
-$string['gradepartialcredit'] = 'Give partial credit';
 $string['gradeallornothing'] = 'All-or-nothing';
+$string['gradepartialcredit'] = 'Give partial credit';
 
-$string['labelstart'] = 'Start label';
-$string['labelmiddle'] = 'Mid label';
 $string['labelend'] = 'End label';
+$string['labelmiddle'] = 'Mid label';
+$string['labelstart'] = 'Start label';
+$string['linedoublearrows'] = 'Double arrows ←--→';
 $string['linesegment'] = 'Line segment ---';
 $string['linesinglearrow'] = 'Single arrow -→';
-$string['linedoublearrows'] = 'Double arrows ←--→';
+
 $string['lineinfinite'] = 'Infinite line --o--o--';
 $string['linexheader'] = 'Line {no}';
 
@@ -76,8 +74,8 @@
 
 $string['showmisplaced'] = 'State which zones are incorrectly placed';
 $string['summarisechoice'] = '{$a->no}. {$a->text}';
-$string['summariseplace'] = '{$a->no}. {$a->text}';
 $string['summarisechoiceno'] = 'Item {$a}';
+$string['summariseplace'] = '{$a->no}. {$a->text}';
 $string['summariseplaceno'] = 'Drop zone {$a}';
 
 $string['type'] = 'Type';
@@ -86,11 +84,11 @@
 $string['xleft'] = 'Left';
 
 $string['yougot1right'] = 'You have correctly selected one point.';
-$string['yougotnright'] = 'You have correctly selected {$a->num} points.';
 $string['yougot1rightline'] = 'You have correctly selected one line.';
+$string['yougotnright'] = 'You have correctly selected {$a->num} points.';
 $string['yougotnrightline'] = 'You have correctly selected {$a->num} lines.';
 $string['ytop'] = 'Top';
 
 $string['zonecoordinates'] = 'x,y;r (where x,y are the coordinates of the centre of the circle and r is the radius)';
-$string['zonestart'] = 'Start zone coordinates';
 $string['zoneend'] = 'End zone coordinates';
+$string['zonestart'] = 'Start zone coordinates';

question.php

@@ -24,8 +24,6 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 #[AllowDynamicProperties]
-//class qtype_drawlines_question extends question_graded_automatically_with_countback
-//        implements question_automatically_gradable_with_countback {
 class qtype_drawlines_question extends question_graded_automatically {
 
     /** @var lines[], an array of line objects. */
@@ -53,6 +51,7 @@ class qtype_drawlines_question extends question_graded_automatically {
      */
     public $places;
 
+    /** @var array The order of the lines, key => choice number in the format c0, c1... */
     public $choicesorder;
 
     #[\Override]
@@ -86,12 +85,12 @@ public function apply_attempt_state(question_attempt_step $step) {
     public function compute_final_grade(array $responses, int $totaltries): float {
         // TODO: To incorporate the question penalty for interactive with multiple tries behaviour.
 
-        $grade_value = 0;
-        foreach($responses as $response) {
+        $grade = 0;
+        foreach ($responses as $response) {
             [$fraction, $state] = $this->grade_response($response);
-            $grade_value += $fraction;
+            $grade += $fraction;
         }
-        return $grade_value;
+        return $grade;
     }
 
     /**
@@ -121,7 +120,7 @@ public function check_file_access($qa, $options, $component, $filearea, $args, $
     }
     #[\Override]
     public function get_expected_data() {
-        $expecteddata =[];
+        $expecteddata = [];
         foreach ($this->lines as $line) {
             $expecteddata[$this->choice($line->number - 1)] = PARAM_NOTAGS;
         }
@@ -213,7 +212,7 @@ public function arrays_same_at_key_integer(array $array1, array $array2, $key) {
      * @author dml at nm dot ru (taken from comments on php manual)
      */
     protected function array_intersect_fixed($array1, $array2) {
-        $result = array();
+        $result = [];
         foreach ($array1 as $val) {
             if (($key = array_search($val, $array2, true)) !== false) {
                 $result[] = $val;
@@ -235,10 +234,10 @@ public function get_validation_error(array $response): string {
     public function get_num_parts_right(array $response): array {
         $numpartrightstart = 0;
         $numpartrightend = 0;
-        if(!$response) {
+        if (!$response) {
             return [0, 0];
         }
-        foreach($this->lines as $key => $line) {
+        foreach ($this->lines as $key => $line) {
             if (array_key_exists($this->choice($key), $response) && $response[$this->choice($key)] !== '') {
                 $coords = explode(' ', $response[$this->choice($key)]);
                 if (line::is_dragitem_in_the_right_place($coords[0], $line->zonestart)) {
@@ -275,14 +274,14 @@ public function grade_response(array $response) {
     public function compute_distance_to_line(float $x1, float $y1, float $x2, float $y2, float $x, float $y): float {
         //print_object("float $x1, float $y1, float $x2, float $y2, float $x, float $y");
         //print_object(($x2 - $x1)**2);
-        return sqrt(($x - $x1)**2 + ($y - $y1)**2 -
-                (($x2 - $x1) * ($x - $x1) + ($y2 - $y1)*($y - $y1))**2/(($x2 - $x1)**2 + ($y2 - $y1)**2));
+        return sqrt(($x - $x1) ** 2 + ($y - $y1) ** 2 -
+                (($x2 - $x1) * ($x - $x1) + ($y2 - $y1)*($y - $y1)) ** 2/(($x2 - $x1) ** 2 + ($y2 - $y1) ** 2));
     }
 
     #[\Override]
     public function classify_response(array $response) {
+        // TODO: Need to check with function.
         $parts = [];
-        //$hits = $this->choose_hits($response);
         foreach ($this->places as $placeno => $place) {
             if (isset($hits[$placeno])) {
                 $shuffledchoiceno = $this->get_right_choice_for($placeno);

questiontype.php

@@ -30,14 +30,6 @@ class qtype_drawlines extends question_type {
     /** @var lines[], an array of line objects. */
     public $lines;
 
-    //protected function make_choice(stdClass $dragdata) {
-    //    return new drag_item($dragdata->linenumber, $dragdata->label);
-    //}
-
-    //protected function make_place(stdclass $dropdata) {
-    //    return new drop_zone($dropdata->linenumber, $dropdata->label, $dropdata->xleft, $dropdata->ytop);
-    //}
-
     #[\Override]
     public function get_question_options($question): bool {
         global $DB, $OUTPUT;
@@ -95,17 +87,12 @@ public function save_question_options($fromform) {
     public function save_lines(stdClass $fromform): void {
         global $DB;
         $numberoflines = $fromform->numberoflines;
-        $coordsregexp = "/^\d+,\d+;\d+$/";
         $index = 1;
         for ($i = 0; $i < $numberoflines; $i++) {
             // If line type is not set do not save the line object.
             if (!in_array($fromform->type[$i], array_keys(line::get_line_types()))) {
                 continue;
             }
-            // If line coordinates are not set or not in the right format, then do not save the line object.
-            if (!preg_match($coordsregexp, $fromform->zonestart[$i]) || !preg_match($coordsregexp, $fromform->zoneend[$i])) {
-                continue;
-            }
             $line = new stdClass;
             $line->questionid = $fromform->id;
             $line->number = $index++;
@@ -228,7 +215,8 @@ protected function initialise_question_lines(question_definition $question, $que
         $placeinex = 1;
         foreach ($questiondata->lines as $line) {
             $question->lines[$line->number - 1] = $this->make_line($line);
-            $question->choices['c' . $index] = Line::get_coordinates($line->zonestart) . ' ' . Line::get_coordinates($line->zoneend);
+            $question->choices['c' . $index] = Line::get_coordinates($line->zonestart) .
+                    ' ' . Line::get_coordinates($line->zoneend);
             $index++;
             $question->places[$placeinex++] = line::make_drop_zone(
                     $line->number,  $line->labelstart ?? 's' . $line->number, $line->zonestart);

renderer.php

@@ -85,23 +85,32 @@ protected function hidden_field_for_qt_var(question_attempt $qa, $varname, $valu
             $value = $qa->get_last_qt_var($varname);
         }
         $fieldname = $qa->get_qt_field_name($varname);
-        $attributes = array('type' => 'hidden',
+        $attributes = ['type' => 'hidden',
                 'id' => str_replace(':', '_', $fieldname),
                 'name' => $fieldname,
-                'value' => $value);
+                'value' => $value];
         if ($classes !== null) {
             $attributes['class'] = join(' ', $classes);
         }
         return [$fieldname, html_writer::empty_tag('input', $attributes)."\n"];
     }
 
-   protected function hidden_field_choice(question_attempt $qa, $choicenumber, $value = null, $class = null) {
-       $varname = 'c'. $choicenumber;
-       $classes = ['choices', 'choice'. $choicenumber];
-       [, $html] = $this->hidden_field_for_qt_var($qa, $varname, $value, $classes);
-       return $html;
-   }
+    /**
+     * Generate the hidden fields on the preview page to capture the responses.
+     * @param question_attempt $qa
+     * @param $choicenumber
+     * @param $value
+     * @param $class
+     * @return mixed
+     */
+    protected function hidden_field_choice(question_attempt $qa, $choicenumber, $value = null, $class = null) {
+        $varname = 'c'. $choicenumber;
+        $classes = ['choices', 'choice'. $choicenumber];
+        [, $html] = $this->hidden_field_for_qt_var($qa, $varname, $value, $classes);
+        return $html;
+    }
 
+    #[\Override]
     public function formulation_and_controls(question_attempt $qa, question_display_options $options) {
         $question = $qa->get_question();
         $response = $qa->get_last_qt_data();
@@ -150,12 +159,12 @@ public function formulation_and_controls(question_attempt $qa, question_display_
         $output .= html_writer::end_div();
 
         $hiddenfields = '';
-        foreach($question->lines as $line) {
+        foreach ($question->lines as $line) {
             $hiddenfields .= $this->hidden_field_choice($qa, $line->number - 1);
         }
         $output .= html_writer::div($hiddenfields, 'dragchoices');
 
-        // Call to js
+        // Call to js.
         $this->page->requires->js_call_amd('qtype_drawlines/question', 'init',
                 [$qa->get_outer_question_div_unique_id(), $options->readonly, $visibilityzones, $question->lines]);
 
@@ -164,6 +173,7 @@ public function formulation_and_controls(question_attempt $qa, question_display_
         return $output;
     }
 
+    #[\Override]
     public function specific_feedback(question_attempt $qa) {
         return $this->combined_feedback($qa);
     }

tests/backup_and_restore_test.php

@@ -33,7 +33,7 @@
  * @copyright 2024 The Open University
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  */
-class backup_and_restore_test extends \restore_date_testcase {
+final class backup_and_restore_test extends \restore_date_testcase {
 
     /**
      * Backup and restore the course containing an drawlines question for testing drawlines backup and restore.

tests/behat/edit.feature

@@ -35,7 +35,7 @@ Feature: Test editing an DrawLines question
     # Correct the input for end zone coordinates.
     And I set the field "id_zonestart_0" to "10,10;12"
 
-    And I click on "Line 2" "button"
+    And I click on "Line 2" "link"
     And I set the field "id_type_1" to "Choose"
     And I press "id_submitbutton"
     And I should see "You have to select a type for Line 2"