33e45e77a009a2eab15152f99021ba7647a4f496
[moodle.git] / question / type / multichoice / renderer.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Multiple choice question renderer classes.
19  *
20  * @package    qtype
21  * @subpackage multichoice
22  * @copyright  2009 The Open University
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
30 /**
31  * Base class for generating the bits of output common to multiple choice
32  * single and multiple questions.
33  *
34  * @copyright  2009 The Open University
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 abstract class qtype_multichoice_renderer_base extends qtype_with_combined_feedback_renderer {
39     /**
40      * Method to generating the bits of output after question choices.
41      *
42      * @param question_attempt $qa The question attempt object.
43      * @param question_display_options $options controls what should and should not be displayed.
44      *
45      * @return string HTML output.
46      */
47     protected abstract function after_choices(question_attempt $qa, question_display_options $options);
49     protected abstract function get_input_type();
51     protected abstract function get_input_name(question_attempt $qa, $value);
53     protected abstract function get_input_value($value);
55     protected abstract function get_input_id(question_attempt $qa, $value);
57     /**
58      * Whether a choice should be considered right, wrong or partially right.
59      * @param question_answer $ans representing one of the choices.
60      * @return fload 1.0, 0.0 or something in between, respectively.
61      */
62     protected abstract function is_right(question_answer $ans);
64     protected abstract function prompt();
66     public function formulation_and_controls(question_attempt $qa,
67             question_display_options $options) {
69         $question = $qa->get_question();
70         $response = $question->get_response($qa);
72         $inputname = $qa->get_qt_field_name('answer');
73         $inputattributes = array(
74             'type' => $this->get_input_type(),
75             'name' => $inputname,
76         );
78         if ($options->readonly) {
79             $inputattributes['disabled'] = 'disabled';
80         }
82         $radiobuttons = array();
83         $feedbackimg = array();
84         $feedback = array();
85         $classes = array();
86         foreach ($question->get_order($qa) as $value => $ansid) {
87             $ans = $question->answers[$ansid];
88             $inputattributes['name'] = $this->get_input_name($qa, $value);
89             $inputattributes['value'] = $this->get_input_value($value);
90             $inputattributes['id'] = $this->get_input_id($qa, $value);
91             $isselected = $question->is_choice_selected($response, $value);
92             if ($isselected) {
93                 $inputattributes['checked'] = 'checked';
94             } else {
95                 unset($inputattributes['checked']);
96             }
97             $hidden = '';
98             if (!$options->readonly && $this->get_input_type() == 'checkbox') {
99                 $hidden = html_writer::empty_tag('input', array(
100                     'type' => 'hidden',
101                     'name' => $inputattributes['name'],
102                     'value' => 0,
103                 ));
104             }
105             $radiobuttons[] = $hidden . html_writer::empty_tag('input', $inputattributes) .
106                     html_writer::tag('label',
107                         html_writer::span($this->number_in_style($value, $question->answernumbering), 'answernumber') .
108                         $question->make_html_inline($question->format_text(
109                                 $ans->answer, $ans->answerformat,
110                                 $qa, 'question', 'answer', $ansid)),
111                         array('for' => $inputattributes['id'], 'class' => 'ml-1'));
113             // Param $options->suppresschoicefeedback is a hack specific to the
114             // oumultiresponse question type. It would be good to refactor to
115             // avoid refering to it here.
116             if ($options->feedback && empty($options->suppresschoicefeedback) &&
117                     $isselected && trim($ans->feedback)) {
118                 $feedback[] = html_writer::tag('div',
119                         $question->make_html_inline($question->format_text(
120                                 $ans->feedback, $ans->feedbackformat,
121                                 $qa, 'question', 'answerfeedback', $ansid)),
122                         array('class' => 'specificfeedback'));
123             } else {
124                 $feedback[] = '';
125             }
126             $class = 'r' . ($value % 2);
127             if ($options->correctness && $isselected) {
128                 $feedbackimg[] = $this->feedback_image($this->is_right($ans));
129                 $class .= ' ' . $this->feedback_class($this->is_right($ans));
130             } else {
131                 $feedbackimg[] = '';
132             }
133             $classes[] = $class;
134         }
136         $result = '';
137         $result .= html_writer::tag('div', $question->format_questiontext($qa),
138                 array('class' => 'qtext'));
140         $result .= html_writer::start_tag('div', array('class' => 'ablock'));
141         if ($question->showstandardinstruction == 1) {
142             $result .= html_writer::tag('div', $this->prompt(), array('class' => 'prompt'));
143         }
145         $result .= html_writer::start_tag('div', array('class' => 'answer'));
146         foreach ($radiobuttons as $key => $radio) {
147             $result .= html_writer::tag('div', $radio . ' ' . $feedbackimg[$key] . $feedback[$key],
148                     array('class' => $classes[$key])) . "\n";
149         }
150         $result .= html_writer::end_tag('div'); // Answer.
152         $result .= $this->after_choices($qa, $options);
154         $result .= html_writer::end_tag('div'); // Ablock.
156         if ($qa->get_state() == question_state::$invalid) {
157             $result .= html_writer::nonempty_tag('div',
158                     $question->get_validation_error($qa->get_last_qt_data()),
159                     array('class' => 'validationerror'));
160         }
162         return $result;
163     }
165     protected function number_html($qnum) {
166         return $qnum . '. ';
167     }
169     /**
170      * @param int $num The number, starting at 0.
171      * @param string $style The style to render the number in. One of the
172      * options returned by {@link qtype_multichoice:;get_numbering_styles()}.
173      * @return string the number $num in the requested style.
174      */
175     protected function number_in_style($num, $style) {
176         switch($style) {
177             case 'abc':
178                 $number = chr(ord('a') + $num);
179                 break;
180             case 'ABCD':
181                 $number = chr(ord('A') + $num);
182                 break;
183             case '123':
184                 $number = $num + 1;
185                 break;
186             case 'iii':
187                 $number = question_utils::int_to_roman($num + 1);
188                 break;
189             case 'IIII':
190                 $number = strtoupper(question_utils::int_to_roman($num + 1));
191                 break;
192             case 'none':
193                 return '';
194             default:
195                 return 'ERR';
196         }
197         return $this->number_html($number);
198     }
200     public function specific_feedback(question_attempt $qa) {
201         return $this->combined_feedback($qa);
202     }
204     /**
205      * Function returns string based on number of correct answers
206      * @param array $right An Array of correct responses to the current question
207      * @return string based on number of correct responses
208      */
209     protected function correct_choices(array $right) {
210         // Return appropriate string for single/multiple correct answer(s).
211         if (count($right) == 1) {
212                 return get_string('correctansweris', 'qtype_multichoice',
213                         implode(', ', $right));
214         } else if (count($right) > 1) {
215                 return get_string('correctanswersare', 'qtype_multichoice',
216                         implode(', ', $right));
217         } else {
218                 return "";
219         }
220     }
224 /**
225  * Subclass for generating the bits of output specific to multiple choice
226  * single questions.
227  *
228  * @copyright  2009 The Open University
229  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
230  */
231 class qtype_multichoice_single_renderer extends qtype_multichoice_renderer_base {
232     protected function get_input_type() {
233         return 'radio';
234     }
236     protected function get_input_name(question_attempt $qa, $value) {
237         return $qa->get_qt_field_name('answer');
238     }
240     protected function get_input_value($value) {
241         return $value;
242     }
244     protected function get_input_id(question_attempt $qa, $value) {
245         return $qa->get_qt_field_name('answer' . $value);
246     }
248     protected function is_right(question_answer $ans) {
249         return $ans->fraction;
250     }
252     protected function prompt() {
253         return get_string('selectone', 'qtype_multichoice');
254     }
256     public function correct_response(question_attempt $qa) {
257         $question = $qa->get_question();
259         // Put all correct answers (100% grade) into $right.
260         $right = array();
261         foreach ($question->answers as $ansid => $ans) {
262             if (question_state::graded_state_for_fraction($ans->fraction) ==
263                     question_state::$gradedright) {
264                 $right[] = $question->make_html_inline($question->format_text($ans->answer, $ans->answerformat,
265                         $qa, 'question', 'answer', $ansid));
266             }
267         }
268         return $this->correct_choices($right);
269     }
271     public function after_choices(question_attempt $qa, question_display_options $options) {
272         // Only load the clear choice feature if it's not read only.
273         if ($options->readonly) {
274             return '';
275         }
277         $question = $qa->get_question();
278         $response = $question->get_response($qa);
279         $hascheckedchoice = false;
280         foreach ($question->get_order($qa) as $value => $ansid) {
281             if ($question->is_choice_selected($response, $value)) {
282                 $hascheckedchoice = true;
283                 break;
284             }
285         }
287         $questiondivid = $qa->get_outer_question_div_unique_id();
289         // When no choice selected during rendering, then hide the clear choice option.
290         $cssclass = '';
291         if (!$hascheckedchoice && $response == -1) {
292             $cssclass = 'd-none';
293         }
295         $clearchoicebutton = html_writer::tag('button', get_string('clearchoice', 'qtype_multichoice'), [
296             'class' => 'btn btn-link ml-3 ' . $cssclass,
297             'data-action' => 'clearresults',
298             'data-target' => '#' . $questiondivid
299         ]);
301         // Load required clearchoice AMD module.
302         $this->page->requires->js_call_amd('qtype_multichoice/clearchoice', 'init',
303             [$questiondivid]);
305         return $clearchoicebutton;
306     }
310 /**
311  * Subclass for generating the bits of output specific to multiple choice
312  * multi=select questions.
313  *
314  * @copyright  2009 The Open University
315  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
316  */
317 class qtype_multichoice_multi_renderer extends qtype_multichoice_renderer_base {
318     protected function after_choices(question_attempt $qa, question_display_options $options) {
319         return '';
320     }
322     protected function get_input_type() {
323         return 'checkbox';
324     }
326     protected function get_input_name(question_attempt $qa, $value) {
327         return $qa->get_qt_field_name('choice' . $value);
328     }
330     protected function get_input_value($value) {
331         return 1;
332     }
334     protected function get_input_id(question_attempt $qa, $value) {
335         return $this->get_input_name($qa, $value);
336     }
338     protected function is_right(question_answer $ans) {
339         if ($ans->fraction > 0) {
340             return 1;
341         } else {
342             return 0;
343         }
344     }
346     protected function prompt() {
347         return get_string('selectmulti', 'qtype_multichoice');
348     }
350     public function correct_response(question_attempt $qa) {
351         $question = $qa->get_question();
353         $right = array();
354         foreach ($question->answers as $ansid => $ans) {
355             if ($ans->fraction > 0) {
356                 $right[] = $question->make_html_inline($question->format_text($ans->answer, $ans->answerformat,
357                         $qa, 'question', 'answer', $ansid));
358             }
359         }
360         return $this->correct_choices($right);
361     }
363     protected function num_parts_correct(question_attempt $qa) {
364         if ($qa->get_question()->get_num_selected_choices($qa->get_last_qt_data()) >
365                 $qa->get_question()->get_num_correct_choices()) {
366             return get_string('toomanyselected', 'qtype_multichoice');
367         }
369         return parent::num_parts_correct($qa);
370     }