See Release Notes
Long Term Support Release
<?php // This file is part of Moodle - http://moodle.org/ // // Moodle is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Moodle is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Moodle. If not, see <http://www.gnu.org/licenses/>. /** * Multianswer question renderer classes. * Handle shortanswer, numerical and various multichoice subquestions * * @package qtype * @subpackage multianswer * @copyright 2010 Pierre Pichet * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ require_once($CFG->dirroot . '/question/type/shortanswer/renderer.php'); /** * Base class for generating the bits of output common to multianswer * (Cloze) questions. * This render the main question text and transfer to the subquestions * the task of display their input elements and status * feedback, grade, correct answer(s) * * @copyright 2010 Pierre Pichet * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class qtype_multianswer_renderer extends qtype_renderer { public function formulation_and_controls(question_attempt $qa, question_display_options $options) { $question = $qa->get_question(); $output = ''; $subquestions = array(); $missingsubquestions = false; foreach ($question->textfragments as $i => $fragment) { if ($i > 0) { $index = $question->places[$i]; $questionisvalid = !empty($question->subquestions[$index]) && $question->subquestions[$index]->qtype->name() !== 'subquestion_replacement'; if (!$questionisvalid) { $missingsubquestions = true; $questionreplacement = qtype_multianswer::deleted_subquestion_replacement(); // It is possible that the subquestion index does not exist. When corrupted quizzes (see MDL-54724) are // restored, the sequence column of mdl_quiz_multianswer can be empty, in this case // qtype_multianswer::get_question_options cannot fill in deleted questions, so we need to do it here. $question->subquestions[$index] = $question->subquestions[$index] ?? $questionreplacement; } $token = 'qtypemultianswer' . $i . 'marker'; $token = '<span class="nolink">' . $token . '</span>'; $output .= $token; $subquestions[$token] = $this->subquestion($qa, $options, $index, $question->subquestions[$index]); } $output .= $fragment; } if ($missingsubquestions) { $output = $this->notification(get_string('corruptedquestion', 'qtype_multianswer'), 'error') . $output; } $output = $question->format_text($output, $question->questiontextformat, $qa, 'question', 'questiontext', $question->id); $output = str_replace(array_keys($subquestions), array_values($subquestions), $output); if ($qa->get_state() == question_state::$invalid) { $output .= html_writer::nonempty_tag('div', $question->get_validation_error($qa->get_last_qt_data()), array('class' => 'validationerror')); } return $output; } public function subquestion(question_attempt $qa, question_display_options $options, $index, question_automatically_gradable $subq) { $subtype = $subq->qtype->name(); if ($subtype == 'numerical' || $subtype == 'shortanswer') { $subrenderer = 'textfield'; } else if ($subtype == 'multichoice') { if ($subq instanceof qtype_multichoice_multi_question) { if ($subq->layout == qtype_multichoice_base::LAYOUT_VERTICAL) { $subrenderer = 'multiresponse_vertical'; } else { $subrenderer = 'multiresponse_horizontal'; } } else { if ($subq->layout == qtype_multichoice_base::LAYOUT_DROPDOWN) { $subrenderer = 'multichoice_inline'; } else if ($subq->layout == qtype_multichoice_base::LAYOUT_HORIZONTAL) { $subrenderer = 'multichoice_horizontal'; } else { $subrenderer = 'multichoice_vertical'; } } } else if ($subtype == 'subquestion_replacement') { return html_writer::div( get_string('missingsubquestion', 'qtype_multianswer'), 'notifyproblem' ); } else { throw new coding_exception('Unexpected subquestion type.', $subq); } /** @var qtype_multianswer_subq_renderer_base $renderer */ $renderer = $this->page->get_renderer('qtype_multianswer', $subrenderer); return $renderer->subquestion($qa, $options, $index, $subq); } public function correct_response(question_attempt $qa) { return ''; } } /** * Subclass for generating the bits of output specific to shortanswer * subquestions. * * @copyright 2011 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class qtype_multianswer_subq_renderer_base extends qtype_renderer { /** @var int[] Stores the counts of answer instances for questions. */ protected static $answercount = []; /** @var question_display_options Question display options instance for any necessary information for rendering the question. */ protected $displayoptions; abstract public function subquestion(question_attempt $qa, question_display_options $options, $index, question_graded_automatically $subq); /** * Render the feedback pop-up contents. * * @param question_graded_automatically $subq the subquestion. * @param float $fraction the mark the student got. null if this subq was not answered. * @param string $feedbacktext the feedback text, already processed with format_text etc. * @param string $rightanswer the right answer, already processed with format_text etc. * @param question_display_options $options the display options. * @return string the HTML for the feedback popup. */ protected function feedback_popup(question_graded_automatically $subq, $fraction, $feedbacktext, $rightanswer, question_display_options $options) { $feedback = array(); if ($options->correctness) { if (is_null($fraction)) { $state = question_state::$gaveup; } else { $state = question_state::graded_state_for_fraction($fraction); } $feedback[] = $state->default_string(true); } if ($options->feedback && $feedbacktext) { $feedback[] = $feedbacktext; } if ($options->rightanswer) { $feedback[] = get_string('correctansweris', 'qtype_shortanswer', $rightanswer); } $subfraction = '';< if ($options->marks >= question_display_options::MARK_AND_MAX && $subq->maxmark > 0> if ($options->marks >= question_display_options::MARK_AND_MAX && $subq->defaultmark > 0&& (!is_null($fraction) || $feedback)) { $a = new stdClass();< $a->mark = format_float($fraction * $subq->maxmark, $options->markdp); < $a->max = format_float($subq->maxmark, $options->markdp);> $a->mark = format_float($fraction * $subq->defaultmark, $options->markdp); > $a->max = format_float($subq->defaultmark, $options->markdp);$feedback[] = get_string('markoutofmax', 'question', $a); } if (!$feedback) { return ''; } return html_writer::tag('span', implode('<br />', $feedback), [ 'class' => 'feedbackspan', ]); } /** * Render the feedback icon for a sub-question which is also the trigger for the feedback popover. * * @param string $icon The feedback icon * @param string $feedbackcontents The feedback contents to be shown on the popover. * @return string */ protected function get_feedback_image(string $icon, string $feedbackcontents): string { global $PAGE; if ($icon === '') { return ''; } $PAGE->requires->js_call_amd('qtype_multianswer/feedback', 'initPopovers'); return html_writer::link('#', $icon, [ 'role' => 'button', 'tabindex' => 0, 'class' => 'feedbacktrigger btn btn-link p-0', 'data-toggle' => 'popover', 'data-container' => 'body', 'data-content' => $feedbackcontents, 'data-placement' => 'right', 'data-trigger' => 'hover focus', 'data-html' => 'true', ]); } /** * Generates a label for an answer field. * * If the question number is set ({@see qtype_renderer::$questionnumber}), the label will * include the question number in order to indicate which question the answer field belongs to. * * @param string $langkey The lang string key for the lang string that does not include the question number. * @param string $component The Frankenstyle component name. * @return string * @throws coding_exception */ protected function get_answer_label( string $langkey = 'answerx', string $component = 'question' ): string { // There may be multiple answer fields for a question, so we need to increment the answer fields in order to distinguish // them from one another. $questionnumber = $this->displayoptions->questionidentifier ?? ''; $questionnumberindex = $questionnumber !== '' ? $questionnumber : 0; if (isset(self::$answercount[$questionnumberindex][$langkey])) { self::$answercount[$questionnumberindex][$langkey]++; } else { self::$answercount[$questionnumberindex][$langkey] = 1; } $params = self::$answercount[$questionnumberindex][$langkey]; return $this->displayoptions->add_question_identifier_to_label(get_string($langkey, $component, $params)); } } /** * Subclass for generating the bits of output specific to shortanswer * subquestions. * * @copyright 2011 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class qtype_multianswer_textfield_renderer extends qtype_multianswer_subq_renderer_base { public function subquestion(question_attempt $qa, question_display_options $options, $index, question_graded_automatically $subq) { $this->displayoptions = $options; $fieldprefix = 'sub' . $index . '_'; $fieldname = $fieldprefix . 'answer'; $response = $qa->get_last_qt_var($fieldname); if ($subq->qtype->name() == 'shortanswer') { $matchinganswer = $subq->get_matching_answer(array('answer' => $response)); } else if ($subq->qtype->name() == 'numerical') { list($value, $unit, $multiplier) = $subq->ap->apply_units($response, ''); $matchinganswer = $subq->get_matching_answer($value, 1); } else { $matchinganswer = $subq->get_matching_answer($response); } if (!$matchinganswer) { if (is_null($response) || $response === '') { $matchinganswer = new question_answer(0, '', null, '', FORMAT_HTML); } else { $matchinganswer = new question_answer(0, '', 0.0, '', FORMAT_HTML); } } // Work out a good input field size. $size = max(1, core_text::strlen(trim($response ?? '')) + 1); foreach ($subq->answers as $ans) { $size = max($size, core_text::strlen(trim($ans->answer))); } $size = min(60, round($size + rand(0, (int)($size * 0.15)))); // The rand bit is to make guessing harder. $inputattributes = array( 'type' => 'text', 'name' => $qa->get_qt_field_name($fieldname), 'value' => $response, 'id' => $qa->get_qt_field_name($fieldname), 'size' => $size, 'class' => 'form-control mb-1', ); if ($options->readonly) { $inputattributes['readonly'] = 'readonly'; } $feedbackimg = ''; if ($options->correctness) { $inputattributes['class'] .= ' ' . $this->feedback_class($matchinganswer->fraction); $feedbackimg = $this->feedback_image($matchinganswer->fraction); } if ($subq->qtype->name() == 'shortanswer') { $correctanswer = $subq->get_matching_answer($subq->get_correct_response()); } else { $correctanswer = $subq->get_correct_answer(); } $feedbackpopup = $this->feedback_popup($subq, $matchinganswer->fraction, $subq->format_text($matchinganswer->feedback, $matchinganswer->feedbackformat, $qa, 'question', 'answerfeedback', $matchinganswer->id), s($correctanswer->answer), $options); $output = html_writer::start_tag('span', array('class' => 'subquestion form-inline d-inline')); $output .= html_writer::tag('label', $this->get_answer_label(), array('class' => 'subq accesshide', 'for' => $inputattributes['id'])); $output .= html_writer::empty_tag('input', $inputattributes); $output .= $this->get_feedback_image($feedbackimg, $feedbackpopup); $output .= html_writer::end_tag('span'); return $output; } } /** * Render an embedded multiple-choice question that is displayed as a select menu. * * @copyright 2011 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class qtype_multianswer_multichoice_inline_renderer extends qtype_multianswer_subq_renderer_base { public function subquestion(question_attempt $qa, question_display_options $options, $index, question_graded_automatically $subq) { $this->displayoptions = $options; $fieldprefix = 'sub' . $index . '_'; $fieldname = $fieldprefix . 'answer'; $response = $qa->get_last_qt_var($fieldname); $choices = array(); $matchinganswer = new question_answer(0, '', null, '', FORMAT_HTML); $rightanswer = null; foreach ($subq->get_order($qa) as $value => $ansid) { $ans = $subq->answers[$ansid]; $choices[$value] = $subq->format_text($ans->answer, $ans->answerformat, $qa, 'question', 'answer', $ansid); if ($subq->is_choice_selected($response, $value)) { $matchinganswer = $ans; } } $inputattributes = array( 'id' => $qa->get_qt_field_name($fieldname), ); if ($options->readonly) { $inputattributes['disabled'] = 'disabled'; } $feedbackimg = ''; if ($options->correctness) { $inputattributes['class'] = $this->feedback_class($matchinganswer->fraction); $feedbackimg = $this->feedback_image($matchinganswer->fraction); } $select = html_writer::select($choices, $qa->get_qt_field_name($fieldname), $response, array('' => ' '), $inputattributes); $order = $subq->get_order($qa); $correctresponses = $subq->get_correct_response(); $rightanswer = $subq->answers[$order[reset($correctresponses)]]; if (!$matchinganswer) { $matchinganswer = new question_answer(0, '', null, '', FORMAT_HTML); } $feedbackpopup = $this->feedback_popup($subq, $matchinganswer->fraction, $subq->format_text($matchinganswer->feedback, $matchinganswer->feedbackformat, $qa, 'question', 'answerfeedback', $matchinganswer->id), $subq->format_text($rightanswer->answer, $rightanswer->answerformat, $qa, 'question', 'answer', $rightanswer->id), $options); $output = html_writer::start_tag('span', array('class' => 'subquestion')); $output .= html_writer::tag('label', $this->get_answer_label(), array('class' => 'subq accesshide', 'for' => $inputattributes['id'])); $output .= $select; $output .= $this->get_feedback_image($feedbackimg, $feedbackpopup); $output .= html_writer::end_tag('span'); return $output; } } /** * Render an embedded multiple-choice question vertically, like for a normal * multiple-choice question. * * @copyright 2010 Pierre Pichet * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class qtype_multianswer_multichoice_vertical_renderer extends qtype_multianswer_subq_renderer_base { public function subquestion(question_attempt $qa, question_display_options $options, $index, question_graded_automatically $subq) { $this->displayoptions = $options; $fieldprefix = 'sub' . $index . '_'; $fieldname = $fieldprefix . 'answer'; $response = $qa->get_last_qt_var($fieldname); $inputattributes = array( 'type' => 'radio', 'name' => $qa->get_qt_field_name($fieldname), 'class' => 'form-check-input', ); if ($options->readonly) { $inputattributes['disabled'] = 'disabled'; } $result = $this->all_choices_wrapper_start(); $fraction = null; foreach ($subq->get_order($qa) as $value => $ansid) { $ans = $subq->answers[$ansid]; $inputattributes['value'] = $value; $inputattributes['id'] = $inputattributes['name'] . $value; $isselected = $subq->is_choice_selected($response, $value); if ($isselected) { $inputattributes['checked'] = 'checked'; $fraction = $ans->fraction; } else { unset($inputattributes['checked']); } $class = 'form-check text-wrap text-break'; if ($options->correctness && $isselected) { $feedbackimg = $this->feedback_image($ans->fraction); $class .= ' ' . $this->feedback_class($ans->fraction); } else { $feedbackimg = ''; } $result .= $this->choice_wrapper_start($class); $result .= html_writer::empty_tag('input', $inputattributes); $result .= html_writer::tag('label', $subq->format_text($ans->answer, $ans->answerformat, $qa, 'question', 'answer', $ansid), array('for' => $inputattributes['id'], 'class' => 'form-check-label text-body')); $result .= $feedbackimg; if ($options->feedback && $isselected && trim($ans->feedback)) { $result .= html_writer::tag('div', $subq->format_text($ans->feedback, $ans->feedbackformat, $qa, 'question', 'answerfeedback', $ansid), array('class' => 'specificfeedback')); } $result .= $this->choice_wrapper_end(); } $result .= $this->all_choices_wrapper_end(); $feedback = array(); if ($options->feedback && $options->marks >= question_display_options::MARK_AND_MAX &&< $subq->maxmark > 0) {> $subq->defaultmark > 0) {$a = new stdClass();< $a->mark = format_float($fraction * $subq->maxmark, $options->markdp); < $a->max = format_float($subq->maxmark, $options->markdp);> $a->mark = format_float($fraction * $subq->defaultmark, $options->markdp); > $a->max = format_float($subq->defaultmark, $options->markdp);$feedback[] = html_writer::tag('div', get_string('markoutofmax', 'question', $a)); } if ($options->rightanswer) { foreach ($subq->answers as $ans) { if (question_state::graded_state_for_fraction($ans->fraction) == question_state::$gradedright) { $feedback[] = get_string('correctansweris', 'qtype_multichoice', $subq->format_text($ans->answer, $ans->answerformat, $qa, 'question', 'answer', $ansid)); break; } } } $result .= html_writer::nonempty_tag('div', implode('<br />', $feedback), array('class' => 'outcome')); return $result; } /** * @param string $class class attribute value. * @return string HTML to go before each choice. */ protected function choice_wrapper_start($class) { return html_writer::start_tag('div', array('class' => $class)); } /** * @return string HTML to go after each choice. */ protected function choice_wrapper_end() { return html_writer::end_tag('div'); } /** * @return string HTML to go before all the choices. */ protected function all_choices_wrapper_start() { $wrapperstart = html_writer::start_tag('fieldset', array('class' => 'answer')); $legendtext = $this->get_answer_label('multichoicex', 'qtype_multianswer'); $wrapperstart .= html_writer::tag('legend', $legendtext, ['class' => 'sr-only']); return $wrapperstart; } /** * @return string HTML to go after all the choices. */ protected function all_choices_wrapper_end() { return html_writer::end_tag('fieldset'); } } /** * Render an embedded multiple-choice question vertically, like for a normal * multiple-choice question. * * @copyright 2010 Pierre Pichet * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class qtype_multianswer_multichoice_horizontal_renderer extends qtype_multianswer_multichoice_vertical_renderer { protected function choice_wrapper_start($class) { return html_writer::start_tag('div', array('class' => $class . ' form-check-inline')); } protected function choice_wrapper_end() { return html_writer::end_tag('div'); } protected function all_choices_wrapper_start() { $wrapperstart = html_writer::start_tag('fieldset', ['class' => 'answer']); $captiontext = $this->get_answer_label('multichoicex', 'qtype_multianswer'); $wrapperstart .= html_writer::tag('legend', $captiontext, ['class' => 'sr-only']); return $wrapperstart; } protected function all_choices_wrapper_end() { return html_writer::end_tag('fieldset'); } } /** * Class qtype_multianswer_multiresponse_renderer * * @copyright 2016 Davo Smith, Synergy Learning * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class qtype_multianswer_multiresponse_vertical_renderer extends qtype_multianswer_subq_renderer_base { /** * Output the content of the subquestion. * * @param question_attempt $qa * @param question_display_options $options * @param int $index * @param question_graded_automatically $subq * @return string */ public function subquestion(question_attempt $qa, question_display_options $options, $index, question_graded_automatically $subq) { if (!$subq instanceof qtype_multichoice_multi_question) { throw new coding_exception('Expecting subquestion of type qtype_multichoice_multi_question'); } $fieldprefix = 'sub' . $index . '_'; $fieldname = $fieldprefix . 'choice'; // Extract the responses that related to this question + strip off the prefix. $fieldprefixlen = strlen($fieldprefix); $response = []; foreach ($qa->get_last_qt_data() as $name => $val) { if (substr($name, 0, $fieldprefixlen) == $fieldprefix) { $name = substr($name, $fieldprefixlen); $response[$name] = $val; } } $basename = $qa->get_qt_field_name($fieldname); $inputattributes = array( 'type' => 'checkbox', 'value' => 1, ); if ($options->readonly) { $inputattributes['disabled'] = 'disabled'; } $result = $this->all_choices_wrapper_start(); // Calculate the total score (as we need to know if choices should be marked as 'correct' or 'partial'). $fraction = 0; foreach ($subq->get_order($qa) as $value => $ansid) { $ans = $subq->answers[$ansid]; if ($subq->is_choice_selected($response, $value)) { $fraction += $ans->fraction; } } // Display 'correct' answers as correct, if we are at 100%, otherwise mark them as 'partial'. $answerfraction = ($fraction > 0.999) ? 1.0 : 0.5; foreach ($subq->get_order($qa) as $value => $ansid) { $ans = $subq->answers[$ansid]; $name = $basename.$value; $inputattributes['name'] = $name; $inputattributes['id'] = $name; $isselected = $subq->is_choice_selected($response, $value); if ($isselected) { $inputattributes['checked'] = 'checked'; } else { unset($inputattributes['checked']); } $class = 'r' . ($value % 2); if ($options->correctness && $isselected) { $thisfrac = ($ans->fraction > 0) ? $answerfraction : 0; $feedbackimg = $this->feedback_image($thisfrac); $class .= ' ' . $this->feedback_class($thisfrac); } else { $feedbackimg = ''; } $result .= $this->choice_wrapper_start($class); $result .= html_writer::empty_tag('input', $inputattributes); $result .= html_writer::tag('label', $subq->format_text($ans->answer, $ans->answerformat, $qa, 'question', 'answer', $ansid), array('for' => $inputattributes['id'])); $result .= $feedbackimg; if ($options->feedback && $isselected && trim($ans->feedback)) { $result .= html_writer::tag('div', $subq->format_text($ans->feedback, $ans->feedbackformat, $qa, 'question', 'answerfeedback', $ansid), array('class' => 'specificfeedback')); } $result .= $this->choice_wrapper_end(); } $result .= $this->all_choices_wrapper_end(); $feedback = array(); if ($options->feedback && $options->marks >= question_display_options::MARK_AND_MAX &&< $subq->maxmark > 0) {> $subq->defaultmark > 0) {$a = new stdClass();< $a->mark = format_float($fraction * $subq->maxmark, $options->markdp); < $a->max = format_float($subq->maxmark, $options->markdp);> $a->mark = format_float($fraction * $subq->defaultmark, $options->markdp); > $a->max = format_float($subq->defaultmark, $options->markdp);$feedback[] = html_writer::tag('div', get_string('markoutofmax', 'question', $a)); } if ($options->rightanswer) { $correct = []; foreach ($subq->answers as $ans) { if (question_state::graded_state_for_fraction($ans->fraction) != question_state::$gradedwrong) { $correct[] = $subq->format_text($ans->answer, $ans->answerformat, $qa, 'question', 'answer', $ans->id); } } $correct = '<ul><li>'.implode('</li><li>', $correct).'</li></ul>'; $feedback[] = get_string('correctansweris', 'qtype_multichoice', $correct); } $result .= html_writer::nonempty_tag('div', implode('<br />', $feedback), array('class' => 'outcome')); return $result; } /** * @param string $class class attribute value. * @return string HTML to go before each choice. */ protected function choice_wrapper_start($class) { return html_writer::start_tag('div', array('class' => $class)); } /** * @return string HTML to go after each choice. */ protected function choice_wrapper_end() { return html_writer::end_tag('div'); } /** * @return string HTML to go before all the choices. */ protected function all_choices_wrapper_start() { return html_writer::start_tag('div', array('class' => 'answer')); } /** * @return string HTML to go after all the choices. */ protected function all_choices_wrapper_end() { return html_writer::end_tag('div'); } } /** * Render an embedded multiple-response question horizontally. * * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class qtype_multianswer_multiresponse_horizontal_renderer extends qtype_multianswer_multiresponse_vertical_renderer { protected function choice_wrapper_start($class) { return html_writer::start_tag('td', array('class' => $class)); } protected function choice_wrapper_end() { return html_writer::end_tag('td'); } protected function all_choices_wrapper_start() { return html_writer::start_tag('table', array('class' => 'answer')) . html_writer::start_tag('tbody') . html_writer::start_tag('tr'); } protected function all_choices_wrapper_end() { return html_writer::end_tag('tr') . html_writer::end_tag('tbody') . html_writer::end_tag('table'); } }