Add free text (Other) to rate/scale. (#604)

toanlamt · toanlam · web-flow · commit 8ed9ad7f7f4d · 2025-06-05T10:39:11.000-04:00
* Questionnaire: amend the 'Scale' question so that if you have 'Other', there's a text field underneath

* Questionnaire: List each Other choice individually on the summary page.

---------

Co-authored-by: toanlam &lt;toanlamt1@nashtechglobal.com&gt;
diff --git a/classes/question/rate.php b/classes/question/rate.php
@@ -336,8 +336,22 @@ protected function question_survey_display($response, $descendantsdata, $blankqu
                 if ($this->osgood_rate_scale()) {
                     list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' '));
                 }
-                $cols[] = ['colstyle' => 'text-align: '.$textalign.';',
-                           'coltext' => format_text($content, FORMAT_HTML, ['noclean' => true]).'&nbsp;'];
+                if ($choice->is_other_choice()) {
+                    $othertext = $choice->other_choice_display();
+                    $oname = $cid . '_qother';
+                    $oid = $cid . '-other';
+                    $odata = isset($response->answers[$this->id][$cid]) ? $response->answers[$this->id][$cid]->value : '';
+                    if (isset($odata)) {
+                        $ovalue = stripslashes($odata);
+                    }
+                    $content = $othertext;
+                    $cols[] = ['oname' => $oname, 'oid' => $oid, 'ovalue' => $ovalue,
+                            'colstyle' => 'text-align: ' . $textalign . ';',
+                            'coltext' => format_text($content, FORMAT_HTML, ['noclean' => true]) . '&nbsp;'];
+                } else {
+                    $cols[] = ['colstyle' => 'text-align: '.$textalign.';',
+                            'coltext' => format_text($content, FORMAT_HTML, ['noclean' => true]) . '&nbsp;'];
+                }
 
                 $bg = 'c0 raterow';
                 $hasnotansweredchoice = false;
@@ -512,6 +526,12 @@ protected function response_survey_display($response) {
                 if ($this->osgood_rate_scale()) {
                     list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' '));
                 }
+                if ($choice->is_other_choice()) {
+                    $content = $choice->other_choice_display();
+                    if (isset($response->answers[$this->id][$cid]->otheresponse)) {
+                        $rowobj->othercontent = $response->answers[$this->id][$cid]->otheresponse;
+                    }
+                }
                 $rowobj->content = format_text($content, FORMAT_HTML, ['noclean' => true]).'&nbsp;';
                 $bg = 'c0';
                 $cols = [];
diff --git a/classes/responsetype/answer/answer.php b/classes/responsetype/answer/answer.php
@@ -43,20 +43,25 @@ class answer {
     /** @var string $value The value of this response (if applicable). */
     public $value;
 
+    /** @var string $value The other value of this response (if applicable). */
+    public $otheresponse;
+
     /**
      * Answer constructor.
      * @param null $id
      * @param null $responseid
      * @param null $questionid
      * @param null $choiceid
+     * @param null $otheresponse
      * @param null $value
      */
-    public function __construct($id = null, $responseid = null, $questionid = null, $choiceid = null, $value = null) {
+    public function __construct($id = null, $responseid = null, $questionid = null, $choiceid = null, $value = null, $otheresponse = null) {
         $this->id = $id;
         $this->responseid = $responseid;
         $this->questionid = $questionid;
         $this->choiceid = $choiceid;
         $this->value = $value;
+        $this->otheresponse = $otheresponse;
     }
 
     /**
@@ -78,6 +83,6 @@ public static function create_from_data($answerdata) {
         }
 
         return new answer($answerdata['id'], $answerdata['responseid'], $answerdata['questionid'], $answerdata['choiceid'],
-            $answerdata['value']);
+                $answerdata['value'], $answerdata['otheresponse']);
     }
 }
diff --git a/classes/responsetype/rank.php b/classes/responsetype/rank.php
@@ -132,6 +132,14 @@ public function insert_response($responsedata) {
                 $record->choice_id = $answer->choiceid;
                 $record->rankvalue = $answer->value;
                 $resid = $DB->insert_record(static::response_table(), $record);
+                if (isset($responsedata->{$answer->choiceid . '_qother'})) {
+                    $otherrecord = new \stdClass();
+                    $otherrecord->response_id = $response->id;
+                    $otherrecord->question_id = $this->question->id;
+                    $otherrecord->choice_id = $answer->choiceid;
+                    $otherrecord->response = $responsedata->{$answer->choiceid . '_qother'};
+                    $DB->insert_record('questionnaire_response_other', $otherrecord);
+                }
             }
         }
         return $resid;
@@ -148,18 +156,29 @@ public function get_results($rids=false, $anonymous=false) {
         global $DB;
 
         $rsql = '';
+        $params = [];
         if (!empty($rids)) {
             list($rsql, $params) = $DB->get_in_or_equal($rids);
             $rsql = ' AND response_id ' . $rsql;
         }
+        // Get other choices.
+        $otherrecs = $this->get_other_choice($rsql, $params);
 
-        $select = 'question_id=' . $this->question->id . ' AND content NOT LIKE \'!other%\' ORDER BY id ASC';
+        $select = 'question_id=' . $this->question->id . ' ORDER BY id ASC';
         if ($rows = $DB->get_records_select('questionnaire_quest_choice', $select)) {
             foreach ($rows as $row) {
-                $this->counts[$row->content] = new \stdClass();
                 $nbna = $DB->count_records(static::response_table(), array('question_id' => $this->question->id,
-                                'choice_id' => $row->id, 'rankvalue' => '-1'));
-                $this->counts[$row->content]->nbna = $nbna;
+                        'choice_id' => $row->id, 'rankvalue' => '-1'));
+                if (\mod_questionnaire\question\choice::content_is_other_choice($row->content) && !empty($otherrecs)) {
+                    foreach (array_keys($otherrecs) as $key) {
+                        $this->counts[$key] = new \stdClass();
+                        $this->counts[$key]->nbna = $nbna;
+                        $this->counts[$key]->content = $row->content;
+                    }
+                } else {
+                    $this->counts[$row->content] = new \stdClass();
+                    $this->counts[$row->content]->nbna = $nbna; 
+                }
             }
         }
 
@@ -193,14 +212,30 @@ public function get_results($rids=false, $anonymous=false) {
             }
 
             $sql = "SELECT c.id, c.content, a.average, a.num
-                    FROM {questionnaire_quest_choice} c
-                    INNER JOIN
+                      FROM {questionnaire_quest_choice} c
+                INNER JOIN
                          (SELECT c2.id, AVG(a2.rankvalue) AS average, COUNT(a2.response_id) AS num
-                          FROM {questionnaire_quest_choice} c2, {".static::response_table()."} a2
-                          WHERE c2.question_id = ? AND a2.question_id = ? AND a2.choice_id = c2.id AND a2.rankvalue >= 0{$rsql}
-                          GROUP BY c2.id) a ON a.id = c.id
-                          order by c.id";
+                            FROM {questionnaire_quest_choice} c2, {".static::response_table()."} a2
+                           WHERE c2.question_id = ? AND a2.question_id = ? AND a2.choice_id = c2.id 
+                                 AND a2.rankvalue >= 0 AND c2.content NOT LIKE '!other%'{$rsql}
+                        GROUP BY c2.id) a ON a.id = c.id
+                  ORDER BY c.id";
             $results = $DB->get_records_sql($sql, array_merge(array($this->question->id, $this->question->id), $params));
+
+            // Handle 'other...'.
+            if ($otherrecs) {
+                $i = 1;
+                foreach ($otherrecs as $rec) {
+                    $results['other'.$i] = new \stdClass();
+                    $results['other'.$i]->id = $rec->cid;
+                    $results['other'.$i]->content = $rec->response;
+                    $results['other'.$i]->average = $rec->average;
+                    $results['other'.$i]->num = $rec->num;
+                    $results['other'.$i]->isother = true;
+                    $i++;
+                }
+            }
+
             if (!empty ($rankvalue)) {
                 foreach ($results as $key => $result) {
                     if (isset($value[$key])) {
@@ -217,24 +252,68 @@ public function get_results($rids=false, $anonymous=false) {
             // Case where scaleitems is less than possible choices.
         } else {
             $sql = "SELECT c.id, c.content, a.sum, a.num
-                    FROM {questionnaire_quest_choice} c
-                    INNER JOIN
+                      FROM {questionnaire_quest_choice} c
+                INNER JOIN
                          (SELECT c2.id, SUM(a2.rankvalue) AS sum, COUNT(a2.response_id) AS num
-                          FROM {questionnaire_quest_choice} c2, {".static::response_table()."} a2
-                          WHERE c2.question_id = ? AND a2.question_id = ? AND a2.choice_id = c2.id AND a2.rankvalue >= 0{$rsql}
-                          GROUP BY c2.id) a ON a.id = c.id";
+                            FROM {questionnaire_quest_choice} c2, {".static::response_table()."} a2
+                           WHERE c2.question_id = ? AND a2.question_id = ? AND a2.choice_id = c2.id 
+                                 AND a2.rankvalue >= 0 AND c2.content NOT LIKE '!other%'{$rsql}
+                  GROUP BY c2.id) a ON a.id = c.id";
+
             $results = $DB->get_records_sql($sql, array_merge(array($this->question->id, $this->question->id), $params));
+
+            if ($otherrecs) {
+                $i = 1;
+                foreach ($otherrecs as $rec) {
+                    $results['other'.$i] = new \stdClass();
+                    $results['other'.$i]->id = $rec->cid;
+                    $results['other'.$i]->content = $rec->response;
+                    $results['other'.$i]->sum = $rec->average;
+                    $results['other'.$i]->num = $rec->num;
+                    $results['other'.$i]->isother = true;
+                    $i++;
+                }
+            }
             // Formula to calculate the best ranking order.
             $nbresponses = count($rids);
             foreach ($results as $key => $result) {
-                $result->average = ($result->sum + ($nbresponses - $result->num) * ($this->length + 1)) / $nbresponses;
+                if (isset($this->length)) {
+                    $result->average = ($result->sum + ($nbresponses - $result->num) * ($this->length + 1)) / $nbresponses;
+                } else {
+                    $result->average = ($result->sum + ($nbresponses - $result->num) * 1 ) / $nbresponses;
+                }
                 $results[$result->content] = $result;
                 unset($results[$key]);
             }
             return $results;
         }
     }
 
+    /**
+     * Get a list of other available choices.
+     *
+     * @param string $rsql
+     * @param array $params
+     * @return array
+     */
+    public function get_other_choice(string $rsql, array $params): array {
+        global $DB;
+        $osql = "SELECT ro.response, AVG(a.rankvalue) AS average, COUNT(a.response_id) AS num, c.id as cid
+                   FROM {questionnaire_quest_choice} c
+             INNER JOIN {" . static::response_table() . "} a ON a.choice_id = c.id
+                        AND a.rankvalue >= 0
+                        AND a.question_id = c.question_id{$rsql}
+             INNER JOIN {questionnaire_response_other} ro  ON ro.choice_id = c.id
+                        AND ro.response_id = a.response_id
+                        AND ro.question_id = c.question_id
+                  WHERE c.question_id = ?
+                        AND c.content = '!other'
+                        AND ro.response <> ''
+               GROUP BY ro.response, cid
+               ORDER BY cid";
+        return $DB->get_records_sql($osql, array_merge($params, [$this->question->id]));
+    }
+
     /**
      * Provide the feedback scores for all requested response id's. This should be provided only by questions that provide feedback.
      * @param array $rids
@@ -417,9 +496,17 @@ public static function response_answers_by_question($rid) {
         global $DB;
 
         $answers = [];
-        $sql = 'SELECT id, response_id as responseid, question_id as questionid, choice_id as choiceid, rankvalue as value ' .
-            'FROM {' . static::response_table() .'} ' .
-            'WHERE response_id = ? ';
+        $sql = 'SELECT r.id, 
+                       r.response_id AS responseid, 
+                       r.question_id AS questionid, 
+                       r.choice_id AS choiceid, 
+                       r.rankvalue AS value, 
+                       rt.response AS otheresponse
+                  FROM {' . static::response_table() . '} r
+             LEFT JOIN {questionnaire_response_other} rt ON rt.choice_id = r.choice_id
+                       AND r.question_id = rt.question_id
+                       AND r.response_id = rt.response_id
+                 WHERE r.response_id = ?';
         $records = $DB->get_records_sql($sql, [$rid]);
         foreach ($records as $record) {
             $answers[$record->questionid][$record->choiceid] = answer\answer::create_from_data($record);
@@ -637,6 +724,11 @@ private function mkresavg($sort, $stravgvalue='') {
                             $content = $contents->text;
                         }
                     }
+                    if (isset($contentobj->content) &&
+                            \mod_questionnaire\question\choice::content_other_choice_display($contentobj->content)) {
+                        $othertext = \mod_questionnaire\question\choice::content_other_choice_display($contentobj->content);
+                        $content = $othertext . ' ' . clean_text($content);
+                    }
                     if ($osgood) {
                         $choicecol1 = new \stdClass();
                         $choicecol1->width = $header1->width;
@@ -761,15 +853,21 @@ private function mkrescount($rids, $rows, $sort) {
             $rsql = ' AND response_id ' . $rsql;
         }
 
-        array_unshift($params, $this->question->id); // This is question_id.
-        $sql = 'SELECT r.id, c.content, r.rankvalue, c.id AS choiceid ' .
-            'FROM {questionnaire_quest_choice} c , ' .
-            '{questionnaire_response_rank} r ' .
-            'WHERE c.question_id = ?' .
-            ' AND r.question_id = c.question_id' .
-            ' AND r.choice_id = c.id ' .
-            $rsql .
-            ' ORDER BY choiceid, rankvalue ASC';
+        // This is question_id.
+        array_push($params, $this->question->id);
+        $sql = "SELECT r.id,
+                       CASE 
+                            WHEN c.content = '!other' THEN o.response 
+                            ELSE c.content
+                       END as content, r.rankvalue, c.id AS choiceid
+                  FROM {questionnaire_quest_choice} c
+            INNER JOIN {" . static::response_table() . "} r ON r.question_id = c.question_id
+                       AND r.choice_id = c.id{$rsql}
+             LEFT JOIN {questionnaire_response_other} o ON o.choice_id = c.id
+                       AND o.response_id = r.response_id
+                       AND o.question_id = c.question_id
+                 WHERE c.question_id = ? AND (c.content != '!other' OR (o.response IS NOT NULL AND o.response <> ''))
+              ORDER BY choiceid, rankvalue ASC";
         $choices = $DB->get_records_sql($sql, $params);
 
         // Sort rows (results) by average value.
@@ -799,10 +897,10 @@ private function mkrescount($rids, $rows, $sort) {
         if (!empty($this->question->nameddegrees)) {
             $rankvalue = array_flip(array_keys($this->question->nameddegrees));
         }
-        foreach ($rows as $row) {
+        foreach ($rows as $key => $row) {
             $choiceid = $row->id;
             foreach ($choices as $choice) {
-                if ($choice->choiceid == $choiceid) {
+                if ($choice->choiceid == $choiceid && $choice->content === $key) {
                     $n = 0;
                     for ($i = 1; $i <= $nbranks; $i++) {
                         if ((isset($rankvalue[$choice->rankvalue]) && ($rankvalue[$choice->rankvalue] == ($i - 1))) ||
@@ -893,17 +991,23 @@ private function mkrescount($rids, $rows, $sort) {
                     // Ensure there are two bits of content.
                     list($content, $contentright) = array_merge(preg_split('/[|]/', $content), array(' '));
                     $header = reset($pagetags->totals->headers);
+                    if (isset($rows[$content]) && isset($rows[$content]->isother) && $rows[$content]->isother) {
+                        $content = get_string('other', 'questionnaire') . ' ' . $content;
+                    }
                     $totalcols[] = (object)['align' => $header->align,
-                        'text' => format_text($content, FORMAT_HTML, ['noclean' => true])];
+                        'text' => format_text($content, FORMAT_HTML, ['noclean' => true, 'filter' => false])];
                 } else {
                     // Eliminate potentially short-named choices.
                     $contents = questionnaire_choice_values($content);
                     if ($contents->modname) {
                         $content = $contents->text;
                     }
+                    if (isset($rows[$content]) && isset($rows[$content]->isother) && $rows[$content]->isother) {
+                        $content = get_string('other', 'questionnaire') . ' ' . $content;
+                    }
                     $header = reset($pagetags->totals->headers);
                     $totalcols[] = (object)['align' => $header->align,
-                        'text' => format_text($content, FORMAT_HTML, ['noclean' => true])];
+                        'text' => format_text($content, FORMAT_HTML, ['noclean' => true, 'filter' => false])];
                 }
                 // Display ranks/rates numbers.
                 $maxrank = max($rank);
diff --git a/templates/question_rate.mustache b/templates/question_rate.mustache
@@ -140,6 +140,7 @@
       <td {{#colstyle}}style="{{.}}"{{/colstyle}}{{#colclass}} class="{{.}}"{{/colclass}}{{#coltitle}} title="{{.}}"{{/coltitle}}
 			{{#colinput}} onclick="if('{{id}}'.length>0) document.getElementById('{{id}}').click()"{{/colinput}}>
         {{#coltext}}{{{.}}}{{/coltext}}
+        {{#oname}}<input size="25" name="{{oname}}" id="{{oid}}" value="" type="text" />{{/oname}}
         {{#colhiddentext}}<span class="accesshide">{{{.}}}</span>{{/colhiddentext}}
         {{#colinput}}<input type="radio" name="{{name}}" id="{{id}}" value="{{value}}"{{#checked}} checked="checked"{{/checked}}{{#disabled}} disabled="disabled"{{/disabled}}{{#onclick}} onclick="{{.}}"{{/onclick}}>
         {{#label}}<label for="{{id}}" class="accesshide">{{{.}}}</label>{{/label}}{{/colinput}}
diff --git a/templates/response_rate.mustache b/templates/response_rate.mustache
@@ -70,7 +70,7 @@
     </tr>
     {{#rows}}
     <tr>
-        <td style="text-align:{{textalign}}">{{{content}}}</td>
+        <td style="text-align:{{textalign}}">{{{content}}} {{#othercontent}} <span class="response text">{{.}}</span>{{/othercontent}}</td>
         {{#cols}}
         {{#checked}}
         <td style="text-align:center;" class="selected">
diff --git a/tests/behat/rate_question_other.feature b/tests/behat/rate_question_other.feature
