Update sectiontext questions to display on mobile #482 (#517)

sayoder-aprende · web-flow · commit 9dec7504b288 · 2024-02-23T13:29:28.000-05:00
* Update sectiontext questions to display on mobile.

Also refactored the code a bit for clarity: The question class now has
an is_numbered() method (default true) that can be overridden for
question types that should not have numbers. Replaced some checks for
specific question types with checks for is_numbered().

* test: Fix PHPDoc for mobile_question_display
diff --git a/classes/output/mobile.php b/classes/output/mobile.php
@@ -162,7 +162,9 @@ public static function mobile_view_activity($args) {
                         if ($question->supports_mobile()) {
                             $pagequestions[] = $question->mobile_question_display($qnum, $questionnaire->autonum);
                             $responses = array_merge($responses, $question->get_mobile_response_data($response));
-                            $qnum++;
+                            if ($question->is_numbered()) {
+                                $qnum++;
+                            }
                         }
                     }
                     $data['prevpage'] = 0;
@@ -265,8 +267,10 @@ protected static function add_pagequestion_data($questionnaire, $pagenum, $respo
                 if (($response !== null) && isset($response->answers[$questionid])) {
                     $responses = array_merge($responses, $question->get_mobile_response_data($response));
                 }
+                if ($question->is_numbered()) {
+                    $qnum++;
+                }
             }
-            $qnum++;
         }
 
         return ['pagequestions' => $pagequestions, 'responses' => $responses];
diff --git a/classes/question/pagebreak.php b/classes/question/pagebreak.php
@@ -102,4 +102,12 @@ public function supports_mobile() {
     public function mobile_question_display($qnum, $autonum = false) {
         return false;
     }
+
+    /**
+     * Override and return false if a number should not be rendered for this question in any context.
+     * @return bool
+     */
+    public function is_numbered() {
+        return false;
+    }
 }
diff --git a/classes/question/question.php b/classes/question/question.php
@@ -497,6 +497,14 @@ public function supports_feedback_scores() {
         return $this->supports_feedback();
     }
 
+    /**
+     * Override and return false if a number should not be rendered for this question in any context.
+     * @return bool
+     */
+    public function is_numbered() {
+        return true;
+    }
+
     /**
      * True if the question supports feedback and has valid settings for feedback. Override if the default logic is not enough.
      * @return bool
diff --git a/classes/question/sectiontext.php b/classes/question/sectiontext.php
@@ -59,6 +59,44 @@ public function supports_feedback() {
         return false;
     }
 
+    /**
+     * True if question provides mobile support.
+     * @return bool
+     */
+    public function supports_mobile() {
+        return true;
+    }
+
+    /**
+     * Display on mobile.
+     *
+     * @param int $qnum
+     * @param bool $autonum
+     */
+    public function mobile_question_display($qnum, $autonum = false) {
+        $options = ['noclean' => true, 'para' => false, 'filter' => true,
+            'context' => $this->context, 'overflowdiv' => true];
+        $mobiledata = (object)[
+            'id' => $this->id,
+            'name' => $this->name,
+            'type_id' => $this->type_id,
+            'length' => $this->length,
+            'content' => format_text(file_rewrite_pluginfile_urls($this->content, 'pluginfile.php', $this->context->id,
+                'mod_questionnaire', 'question', $this->id), FORMAT_HTML, $options),
+            'content_stripped' => strip_tags($this->content),
+            'required' => false,
+            'deleted' => $this->deleted,
+            'response_table' => $this->responsetable,
+            'fieldkey' => $this->mobile_fieldkey(),
+            'precise' => $this->precise,
+            'qnum' => '',
+            'errormessage' => get_string('required') . ': ' . $this->name
+        ];
+
+        $mobiledata->issectiontext = true;
+        return $mobiledata;
+    }
+
     /**
      * True if question type supports feedback scores and weights. Same as supports_feedback() by default.
      */
@@ -81,6 +119,14 @@ public function question_template() {
         return 'mod_questionnaire/question_sectionfb';
     }
 
+    /**
+     * Override and return false if a number should not be rendered for this question in any context.
+     * @return bool
+     */
+    public function is_numbered() {
+        return false;
+    }
+
     /**
      * Return the context tags for the check question template.
      * @param \mod_questionnaire\responsetype\response\response $response
diff --git a/classes/questions_form.php b/classes/questions_form.php
@@ -146,7 +146,7 @@ public function definition() {
                 redirect($CFG->wwwroot.'/mod/questionnaire/questions.php?id='.$questionnaire->cm->id);
             }
 
-            if ($tid != QUESPAGEBREAK && $tid != QUESSECTIONTEXT) {
+            if ($question->is_numbered()) {
                 $qnum++;
             }
 
@@ -330,12 +330,10 @@ public function definition() {
                 $mform->addElement('static', 'qdepend_' . $question->id, '', $dependencies);
             }
 
-            if ($tid != QUESPAGEBREAK) {
-                if ($tid != QUESSECTIONTEXT) {
+            if ($question->is_numbered()) {
                     $qnumber = '<div class="qn-info"><h2 class="qn-number">'.$qnum.'</h2></div>';
-                } else {
+            } else {
                     $qnumber = '';
-                }
             }
 
             if ($this->moveq && $pos < $moveqposition) {
diff --git a/questionnaire.class.php b/questionnaire.class.php
@@ -1323,7 +1323,7 @@ private function survey_render(&$formdata, $section = 1, $message = '') {
                     $this->renderer->render_progress_bar($section, $this->questionsbysec));
         }
         foreach ($this->questionsbysec[$section] as $questionid) {
-            if ($this->questions[$questionid]->type_id != QUESSECTIONTEXT) {
+            if ($this->questions[$questionid]->is_numbered()) {
                 $i++;
             }
             // Need questionnaire id to get the questionnaire object in sectiontext (Label) question class.
@@ -1615,7 +1615,7 @@ public function survey_print_render($courseid, $message = '', $referer='', $rid=
                 $page++;
             }
             foreach ($section as $questionid) {
-                if ($this->questions[$questionid]->type_id == QUESSECTIONTEXT) {
+                if (!$this->questions[$questionid]->is_numbered()) {
                     $i--;
                 }
                 if (isset($allqdependants[$questionid])) {
@@ -1848,8 +1848,8 @@ private function response_check_format($section, $formdata, $checkmissing = true
 
         if (key_exists($section, $this->questionsbysec)) {
             foreach ($this->questionsbysec[$section] as $questionid) {
-                $tid = $this->questions[$questionid]->type_id;
-                if ($tid != QUESSECTIONTEXT) {
+
+                if ($this->questions[$questionid]->is_numbered()) {
                     $qnum++;
                 }
                 if (!$this->questions[$questionid]->response_complete($formdata)) {
@@ -2910,13 +2910,13 @@ public function survey_results($rid = '', $uid=false, $pdf = false, $currentgrou
             if ($question->type_id == QUESPAGEBREAK) {
                 continue;
             }
-            if ($question->type_id != QUESSECTIONTEXT) {
+            if ($question->is_numbered()) {
                 $qnum++;
             }
             if (!$pdf) {
                 $this->page->add_to_page('responses', $this->renderer->container_start('qn-container'));
                 $this->page->add_to_page('responses', $this->renderer->container_start('qn-info'));
-                if ($question->type_id != QUESSECTIONTEXT) {
+                if ($question->is_numbered()) {
                     $this->page->add_to_page('responses', $this->renderer->heading($qnum, 2, 'qn-number'));
                 }
                 $this->page->add_to_page('responses', $this->renderer->container_end()); // End qn-info.
@@ -2928,7 +2928,7 @@ public function survey_results($rid = '', $uid=false, $pdf = false, $currentgrou
             }
             if ($pdf) {
                 $response = new stdClass();
-                if ($question->type_id != QUESSECTIONTEXT) {
+                if ($question->is_numbered()) {
                     $response->qnum = $qnum;
                 }
                 $response->qcontent = format_text(file_rewrite_pluginfile_urls($question->content, 'pluginfile.php',

Original file line number	Diff line number	Diff line change
`@@ -162,7 +162,9 @@ public static function mobile_view_activity($args) {`
`162`	`162`	`if ($question->supports_mobile()) {`
`163`	`163`	`$pagequestions[] = $question->mobile_question_display($qnum, $questionnaire->autonum);`
`164`	`164`	`$responses = array_merge($responses, $question->get_mobile_response_data($response));`
`165`		`- $qnum++;`
	`165`	`+ if ($question->is_numbered()) {`
	`166`	`+ $qnum++;`
	`167`	`+ }`
`166`	`168`	`}`
`167`	`169`	`}`
`168`	`170`	`$data['prevpage'] = 0;`
`@@ -265,8 +267,10 @@ protected static function add_pagequestion_data($questionnaire, $pagenum, $respo`
`265`	`267`	`if (($response !== null) && isset($response->answers[$questionid])) {`
`266`	`268`	`$responses = array_merge($responses, $question->get_mobile_response_data($response));`
`267`	`269`	`}`
	`270`	`+ if ($question->is_numbered()) {`
	`271`	`+ $qnum++;`
	`272`	`+ }`
`268`	`273`	`}`
`269`		`- $qnum++;`
`270`	`274`	`}`
`271`	`275`
`272`	`276`	`return ['pagequestions' => $pagequestions, 'responses' => $responses];`
Original file line number	Diff line number	Diff line change
`@@ -102,4 +102,12 @@ public function supports_mobile() {`
`102`	`102`	`public function mobile_question_display($qnum, $autonum = false) {`
`103`	`103`	`return false;`
`104`	`104`	`}`
	`105`	`+`
	`106`	`+ /**`
	`107`	`+ * Override and return false if a number should not be rendered for this question in any context.`
	`108`	`+ * @return bool`
	`109`	`+ */`
	`110`	`+ public function is_numbered() {`
	`111`	`+ return false;`
	`112`	`+ }`
`105`	`113`	`}`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@ public function definition() {`
`146`	`146`	`redirect($CFG->wwwroot.'/mod/questionnaire/questions.php?id='.$questionnaire->cm->id);`
`147`	`147`	`}`
`148`	`148`
`149`		`- if ($tid != QUESPAGEBREAK && $tid != QUESSECTIONTEXT) {`
	`149`	`+ if ($question->is_numbered()) {`
`150`	`150`	`$qnum++;`
`151`	`151`	`}`
`152`	`152`
`@@ -330,12 +330,10 @@ public function definition() {`
`330`	`330`	`$mform->addElement('static', 'qdepend_' . $question->id, '', $dependencies);`
`331`	`331`	`}`
`332`	`332`
`333`		`- if ($tid != QUESPAGEBREAK) {`
`334`		`- if ($tid != QUESSECTIONTEXT) {`
	`333`	`+ if ($question->is_numbered()) {`
`335`	`334`	`$qnumber = '<div class="qn-info"><h2 class="qn-number">'.$qnum.'</h2></div>';`
`336`		`- } else {`
	`335`	`+ } else {`
`337`	`336`	`$qnumber = '';`
`338`		`- }`
`339`	`337`	`}`
`340`	`338`
`341`	`339`	`if ($this->moveq && $pos < $moveqposition) {`
Original file line number	Diff line number	Diff line change
`@@ -1323,7 +1323,7 @@ private function survey_render(&$formdata, $section = 1, $message = '') {`
`1323`	`1323`	`$this->renderer->render_progress_bar($section, $this->questionsbysec));`
`1324`	`1324`	`}`
`1325`	`1325`	`foreach ($this->questionsbysec[$section] as $questionid) {`
`1326`		`- if ($this->questions[$questionid]->type_id != QUESSECTIONTEXT) {`
	`1326`	`+ if ($this->questions[$questionid]->is_numbered()) {`
`1327`	`1327`	`$i++;`
`1328`	`1328`	`}`
`1329`	`1329`	`// Need questionnaire id to get the questionnaire object in sectiontext (Label) question class.`
`@@ -1615,7 +1615,7 @@ public function survey_print_render($courseid, $message = '', $referer='', $rid=`
`1615`	`1615`	`$page++;`
`1616`	`1616`	`}`
`1617`	`1617`	`foreach ($section as $questionid) {`
`1618`		`- if ($this->questions[$questionid]->type_id == QUESSECTIONTEXT) {`
	`1618`	`+ if (!$this->questions[$questionid]->is_numbered()) {`
`1619`	`1619`	`$i--;`
`1620`	`1620`	`}`
`1621`	`1621`	`if (isset($allqdependants[$questionid])) {`
`@@ -1848,8 +1848,8 @@ private function response_check_format($section, $formdata, $checkmissing = true`
`1848`	`1848`
`1849`	`1849`	`if (key_exists($section, $this->questionsbysec)) {`
`1850`	`1850`	`foreach ($this->questionsbysec[$section] as $questionid) {`
`1851`		`- $tid = $this->questions[$questionid]->type_id;`
`1852`		`- if ($tid != QUESSECTIONTEXT) {`
	`1851`	`+`
	`1852`	`+ if ($this->questions[$questionid]->is_numbered()) {`
`1853`	`1853`	`$qnum++;`
`1854`	`1854`	`}`
`1855`	`1855`	`if (!$this->questions[$questionid]->response_complete($formdata)) {`
`@@ -2910,13 +2910,13 @@ public function survey_results($rid = '', $uid=false, $pdf = false, $currentgrou`
`2910`	`2910`	`if ($question->type_id == QUESPAGEBREAK) {`
`2911`	`2911`	`continue;`
`2912`	`2912`	`}`
`2913`		`- if ($question->type_id != QUESSECTIONTEXT) {`
	`2913`	`+ if ($question->is_numbered()) {`
`2914`	`2914`	`$qnum++;`
`2915`	`2915`	`}`
`2916`	`2916`	`if (!$pdf) {`
`2917`	`2917`	`$this->page->add_to_page('responses', $this->renderer->container_start('qn-container'));`
`2918`	`2918`	`$this->page->add_to_page('responses', $this->renderer->container_start('qn-info'));`
`2919`		`- if ($question->type_id != QUESSECTIONTEXT) {`
	`2919`	`+ if ($question->is_numbered()) {`
`2920`	`2920`	`$this->page->add_to_page('responses', $this->renderer->heading($qnum, 2, 'qn-number'));`
`2921`	`2921`	`}`
`2922`	`2922`	`$this->page->add_to_page('responses', $this->renderer->container_end()); // End qn-info.`
`@@ -2928,7 +2928,7 @@ public function survey_results($rid = '', $uid=false, $pdf = false, $currentgrou`
`2928`	`2928`	`}`
`2929`	`2929`	`if ($pdf) {`
`2930`	`2930`	`$response = new stdClass();`
`2931`		`- if ($question->type_id != QUESSECTIONTEXT) {`
	`2931`	`+ if ($question->is_numbered()) {`
`2932`	`2932`	`$response->qnum = $qnum;`
`2933`	`2933`	`}`
`2934`	`2934`	`$response->qcontent = format_text(file_rewrite_pluginfile_urls($question->content, 'pluginfile.php',`