Questionnaire: create PDF version for downloadable printed packs

NashTechOpenUniversity · Oct 24, 2024 · b96382b · b96382b
1 parent f2ffa46
commit b96382b
Show file tree

Hide file tree

Showing 15 changed files with 215 additions and 24 deletions.
diff --git a/classes/output/renderer.php b/classes/output/renderer.php
@@ -217,16 +217,18 @@ public function render_progress_bar($section, $questionsbysec) {
 
     /**
      * Render a question for a survey.
+     *
      * @param \mod_questionnaire\question\question $question The question object.
      * @param \mod_questionnaire\responsetype\response\response $response Any current response data.
      * @param int $qnum The question number.
      * @param boolean $blankquestionnaire Used for printing a blank one.
      * @param array $dependants Array of all questions/choices depending on $question.
+     * @param boolean $isprint if true, this content is in print blank page, vice versa.
      * @return string The output for the page.
      */
-    public function question_output($question, $response, $qnum, $blankquestionnaire, $dependants=[]) {
+    public function question_output($question, $response, $qnum, $blankquestionnaire, $dependants=[], $isprint=false) {
 
-        $pagetags = $question->question_output($response, $blankquestionnaire, $dependants, $qnum);
+        $pagetags = $question->question_output($response, $blankquestionnaire, $dependants, $qnum, $isprint);
 
         // If the question has a template, then render it from the 'qformelement' context. If no template, then 'qformelement'
         // already contains HTML.

diff --git a/classes/question/date.php b/classes/question/date.php
@@ -63,9 +63,10 @@ public function response_template() {
      * @param \mod_questionnaire\responsetype\response\response $response
      * @param array $descendantsdata
      * @param boolean $blankquestionnaire
+     * @param boolean $isprint if true, this content is in print blank page, vice versa.
      * @return object The check question context tags.
      */
-    protected function question_survey_display($response, $descendantsdata, $blankquestionnaire=false) {
+    protected function question_survey_display($response, $descendantsdata, $blankquestionnaire=false, $isprint=false) {
         // Date.
         $questiontags = new \stdClass();
         if (!empty($response->answers[$this->id])) {
@@ -83,6 +84,7 @@ protected function question_survey_display($response, $descendantsdata, $blankqu
         $choice->onkeypress = 'return event.keyCode != 13;';
         $choice->name = 'q'.$this->id;
         $choice->value = (isset($response->answers[$this->id][0]->value) ? $response->answers[$this->id][0]->value : '');
+        $choice->isprint = $isprint;
         $questiontags->qelements = new \stdClass();
         $questiontags->qelements->choice = $choice;
         return $questiontags;

diff --git a/classes/question/drop.php b/classes/question/drop.php
@@ -89,10 +89,11 @@ public function supports_feedback() {
      * @param \mod_questionnaire\responsetype\response\response $response
      * @param array $dependants Array of all questions/choices depending on this question.
      * @param boolean $blankquestionnaire
+     * @param boolean $isprint if true, this content is in print blank page, vice versa.
      * @return object The check question context tags.
      *
      */
-    protected function question_survey_display($response, $dependants, $blankquestionnaire=false) {
+    protected function question_survey_display($response, $dependants, $blankquestionnaire=false, $isprint=false) {
         // Drop.
         $options = [];
 
@@ -116,6 +117,7 @@ protected function question_survey_display($response, $dependants, $blankquestio
         $chobj->id = self::qtypename($this->type_id) . $this->name;
         $chobj->class = 'select custom-select menu q'.$this->id;
         $chobj->options = $options;
+        $chobj->isprint = $isprint;
         $choicetags->qelements->choice = $chobj;
 
         return $choicetags;

diff --git a/classes/question/essay.php b/classes/question/essay.php
@@ -65,9 +65,10 @@ public function response_template() {
      * @param response $response
      * @param array $descendantsdata
      * @param bool $blankquestionnaire
+     * @param boolean $isprint if true, this content is in print blank page, vice versa.
      *
      */
-    protected function question_survey_display($response, $descendantsdata, $blankquestionnaire=false) {
+    protected function question_survey_display($response, $descendantsdata, $blankquestionnaire=false, $isprint=false) {
         $output = '';
 
         // Essay.
@@ -89,13 +90,12 @@ protected function question_survey_display($response, $descendantsdata, $blankqu
         } else {
             $value = '';
         }
-        if ($canusehtmleditor) {
+        if ($canusehtmleditor && !$isprint) {
             $editor = editors_get_preferred_editor();
             $editor->use_editor($name, questionnaire_get_editor_options($this->context));
             $texteditor = html_writer::tag('textarea', $value,
                             ['id' => $name, 'name' => $name, 'rows' => $rows, 'cols' => $cols, 'class' => 'form-control']);
         } else {
-            $editor = FORMAT_PLAIN;
             $texteditor = html_writer::tag('textarea', $value,
                             ['id' => $name, 'name' => $name, 'rows' => $rows, 'cols' => $cols]);
         }

diff --git a/classes/question/question.php b/classes/question/question.php
@@ -869,11 +869,15 @@ public function results_template($pdf = false) {
      * @param boolean $blankquestionnaire
      * @param array $dependants Array of all questions/choices depending on this question.
      * @param int $qnum
+     * @param boolean $isprint if true, this content is in print blank page, vice versa.
      * @return \stdClass
      */
-    public function question_output($response, $blankquestionnaire, $dependants=[], $qnum='') {
+    public function question_output($response, $blankquestionnaire, $dependants=[], $qnum='', $isprint=false) {
         $pagetags = $this->questionstart_survey_display($qnum, $response);
-        $pagetags->qformelement = $this->question_survey_display($response, $dependants, $blankquestionnaire);
+        if ($isprint) {
+            $pagetags->isprint = true;
+        }
+        $pagetags->qformelement = $this->question_survey_display($response, $dependants, $blankquestionnaire, $isprint);
         return $pagetags;
     }
 

diff --git a/classes/question/slider.php b/classes/question/slider.php
@@ -106,10 +106,11 @@ public function get_feedback_maxscore() {
      * @param \mod_questionnaire\responsetype\response\response $response
      * @param array $dependants Array of all questions/choices depending on this question.
      * @param boolean $blankquestionnaire
+     * @param boolean $isprint if true, this content is in print blank page, vice versa.
      * @return object The check question context tags.
      *
      */
-    protected function question_survey_display($response, $dependants = [], $blankquestionnaire = false) {
+    protected function question_survey_display($response, $dependants = [], $blankquestionnaire = false, $isprint=false) {
         global $PAGE;
         $PAGE->requires->js_init_call('M.mod_questionnaire.init_slider', null, false, questionnaire_get_js_module());
         $extradata = json_decode($this->extradata);
@@ -121,6 +122,7 @@ protected function question_survey_display($response, $dependants = [], $blankqu
         $extradata->id = self::qtypename($this->type_id) . $this->id;
         $questiontags->qelements = new \stdClass();
         $questiontags->qelements->extradata = $extradata;
+        $questiontags->isprint = $isprint;
         return $questiontags;
     }
 

diff --git a/classes/question/text.php b/classes/question/text.php
@@ -76,9 +76,10 @@ public function response_template() {
      * @param \stdClass $response
      * @param array $descendantsdata
      * @param bool $blankquestionnaire
+     * @param boolean $isprint if true, this content is in print blank page, vice versa.
      *
      */
-    protected function question_survey_display($response, $descendantsdata, $blankquestionnaire=false) {
+    protected function question_survey_display($response, $descendantsdata, $blankquestionnaire=false, $isprint=false) {
         // Text Box.
         $questiontags = new \stdClass();
         $questiontags->qelements = new \stdClass();
@@ -92,6 +93,7 @@ protected function question_survey_display($response, $descendantsdata, $blankqu
         $choice->value = (isset($response->answers[$this->id][0]) ?
             format_string(stripslashes($response->answers[$this->id][0]->value)) : '');
         $choice->id = self::qtypename($this->type_id) . $this->id;
+        $choice->isprint = $isprint;
         $questiontags->qelements->choice = $choice;
         return $questiontags;
     }

diff --git a/lang/en/questionnaire.php b/lang/en/questionnaire.php
@@ -421,6 +421,7 @@
 $string['print'] = 'Print this Response';
 $string['printblank'] = 'Print Blank';
 $string['printblanktooltip'] = 'Opens printer-friendly window with blank Questionnaire';
+$string['printstrictdateformatting'] = 'Enter the date';
 $string['printtooltip'] = 'Opens printer-friendly window with current Response';
 
 $string['privacy:metadata:questionnaire_response'] = 'A response in progress or submitted';

diff --git a/questionnaire.class.php b/questionnaire.class.php
@@ -1605,6 +1605,10 @@ public function survey_print_render($courseid, $message = '', $referer='', $rid=
         }
 
         $page = 1;
+        $isprint = false;
+        if ($referer === 'print') {
+            $isprint = true;
+        }
         foreach ($this->questionsbysec as $section) {
             $output = '';
             if ($numsections > 1) {
@@ -1621,7 +1625,7 @@ public function survey_print_render($courseid, $message = '', $referer='', $rid=
                     $dependants = [];
                 }
                 $output .= $this->renderer->question_output($this->questions[$questionid], $this->responses[0] ?? [],
-                    $i++, null, $dependants);
+                    $i++, null, $dependants, $isprint);
                 $this->page->add_to_page('questions', $output);
                 $output = '';
             }

diff --git a/styles.css b/styles.css
@@ -170,6 +170,18 @@ td.selected {
     margin-top: 10px;
 }
 
+#page-mod-questionnaire-print .printdropdown input:first-child,
+#page-mod-questionnaire-print .printdropdown label:first-of-type,
+#page-mod-questionnaire-print .printdropdown br:first-of-type {
+    display: none;
+}
+
+#page-mod-questionnaire-print .print-text {
+    min-width: 100%;
+    box-sizing: border-box;
+    height: 30px;
+}
+
 #page-mod-questionnaire-complete .notice .buttons div,
 #page-mod-questionnaire-complete .notice .buttons form {
     display: inline;
@@ -543,3 +555,71 @@ td.selected {
     height: 2px;
     left: 50%;
 }
+
+/* Styles for the print blank page. */
+#page-mod-questionnaire-print .slider {
+    position: relative;
+    width: 100%;
+}
+
+#page-mod-questionnaire-print.path-mod-questionnaire .question-slider.print-slider {
+    margin-top: 20px;
+    margin-bottom: 20px;
+}
+
+#page-mod-questionnaire-print.path-mod-questionnaire .print-slider .left-side-label,
+#page-mod-questionnaire-print.path-mod-questionnaire .print-slider .right-side-label,
+#page-mod-questionnaire-print.path-mod-questionnaire .print-slider .slider {
+    margin: 0;
+}
+
+#page-mod-questionnaire-print input[type="range"] {
+    appearance: none;
+    height: 10px;
+    border-radius: 5px;
+    background-color: #ddd;
+}
+
+#page-mod-questionnaire-print input[type="range"]::-webkit-slider-thumb {
+    -webkit-appearance: none;
+    appearance: none;
+    width: 0;
+    height: 0;
+}
+
+#page-mod-questionnaire-print input[type="range"]::-moz-range-thumb {
+    -webkit-appearance: none;
+    appearance: none;
+    width: 0;
+    height: 0;
+}
+
+#page-mod-questionnaire-print input[type="range"]::-ms-thumb {
+    -webkit-appearance: none;
+    appearance: none;
+    width: 0;
+    height: 0;
+}
+
+#page-mod-questionnaire-print .path-mod-questionnaire .right-side-label,
+#page-mod-questionnaire-print .path-mod-questionnaire .left-side-label{
+    margin: 0;
+}
+
+#page-mod-questionnaire-print .bubble {
+    display: none;
+}
+
+@media print {
+    #page-mod-questionnaire-print .slider {
+        position: relative;
+        width: 100%;
+    }
+
+    #page-mod-questionnaire-print input[type="range"] {
+        appearance: none;
+        width: 100%;
+        border: 1px solid #000000;
+        border-radius: 5px;
+    }
+}
diff --git a/templates/question_date.mustache b/templates/question_date.mustache
@@ -42,11 +42,17 @@
 <!-- Begin HTML generated from question_date template. -->
 {{#qelements}}
 {{#choice}}
-<div class="qn-datemsg">{{# str }}strictdateformatting, mod_questionnaire{{/ str}}</div>
-<div class="qn-date">
-    <input type="{{type}}" name="{{choice.name}}" value="{{choice.value}}" />
-<!--    <input {{#choice.onkeypress}}onkeypress="{{.}}"{{/choice.onkeypress}} type="text" size="12" name="{{choice.name}}" maxlength="10" value="{{choice.value}}" /> -->
-</div>
+{{#isprint}}
+    <div class="qn-datemsg">{{# str }}printstrictdateformatting, mod_questionnaire{{/ str}}</div>
+    <input type="text" size="{{choice.size}}" name="{{choice.name}}" />
+{{/isprint}}
+{{^isprint}}
+    <div class="qn-datemsg">{{# str }}strictdateformatting, mod_questionnaire{{/ str}}</div>
+    <div class="qn-date">
+        <input type="{{type}}" name="{{choice.name}}" value="{{choice.value}}" />
+        <!--    <input {{#choice.onkeypress}}onkeypress="{{.}}"{{/choice.onkeypress}} type="text" size="12" name="{{choice.name}}" maxlength="10" value="{{choice.value}}" /> -->
+    </div>
+{{/isprint}}
 {{/choice}}
 {{/qelements}}
 <!-- End HTML generated from question_date template. -->
diff --git a/templates/question_drop.mustache b/templates/question_drop.mustache
@@ -54,11 +54,22 @@
 <!-- Begin HTML generated from question_drop template. -->
 {{#qelements}}
 {{#choice}}
-<select id="{{choice.id}}" name="{{choice.name}}" class="{{choice.class}}" {{#choice.onchange}}onchange="{{.}}"{{/choice.onchange}}>
-{{#choice.options}}
-<option {{#selected}}selected="selected" {{/selected}}value="{{value}}">{{label}}</option>
-{{/choice.options}}
-</select>
+    {{#isprint}}
+        <div class="printdropdown">
+            {{#choice.options}}
+                <input id="{{value}}" value="{{choice.value}}" {{#selected}}checked="checked"{{/selected}} name="{{choice.name}}" type="checkbox" aria-label="{{label}}"/>
+                <label for="{{value}}">{{label}}</label>
+                <br/>
+            {{/choice.options}}
+        </div>
+    {{/isprint}}
+    {{^isprint}}
+        <select id="{{choice.id}}" name="{{choice.name}}" class="{{choice.class}}" {{#choice.onchange}}onchange="{{.}}"{{/choice.onchange}}>
+            {{#choice.options}}
+                <option {{#selected}}selected="selected" {{/selected}}value="{{value}}">{{label}}</option>
+            {{/choice.options}}
+        </select>
+    {{/isprint}}
 {{/choice}}
 {{/qelements}}
 <!-- End HTML generated from question_drop template. -->
diff --git a/templates/question_slider.mustache b/templates/question_slider.mustache
@@ -48,7 +48,7 @@
 <!-- Begin HTML generated from question_slider template. -->
 {{#qelements}}
     {{#extradata}}
-        <div class="question-slider">
+        <div class="{{#isprint}}print-slider{{/isprint}} question-slider">
             <div class="left-side-label">{{extradata.leftlabel}}</div>
             <div class="middle-side-content">
                 <div class="slider">

diff --git a/templates/question_text.mustache b/templates/question_text.mustache
@@ -44,7 +44,7 @@
 <!-- Begin HTML generated from question_text template. -->
 {{#qelements}}
 {{#choice}}
-<input {{#choice.onkeypress}}onkeypress="{{.}}"{{/choice.onkeypress}} type="text" size="{{choice.size}}" name="{{choice.name}}" {{#choice.maxlength}}maxlength="{{choice.maxlength}}"{{/choice.maxlength}} value="{{choice.value}}" id="{{choice.id}}" />
+<input {{#isprint}}class="print-text"{{/isprint}} {{#choice.onkeypress}}onkeypress="{{.}}"{{/choice.onkeypress}} type="text" size="{{choice.size}}" name="{{choice.name}}" {{#choice.maxlength}}maxlength="{{choice.maxlength}}"{{/choice.maxlength}} value="{{choice.value}}" id="{{choice.id}}" />
 {{/choice}}
 {{/qelements}}
 <!-- End HTML generated from question_text template. -->