Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
<?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/>.

/**
 * Multiple choice question renderer classes.
 *
 * @package    qtype
 * @subpackage multichoice
 * @copyright  2009 The Open University
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */


defined('MOODLE_INTERNAL') || die();


/**
 * Base class for generating the bits of output common to multiple choice
 * single and multiple questions.
 *
 * @copyright  2009 The Open University
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
abstract class qtype_multichoice_renderer_base extends qtype_with_combined_feedback_renderer {

    /**
     * Method to generating the bits of output after question choices.
     *
     * @param question_attempt $qa The question attempt object.
     * @param question_display_options $options controls what should and should not be displayed.
     *
     * @return string HTML output.
     */
    protected abstract function after_choices(question_attempt $qa, question_display_options $options);

    protected abstract function get_input_type();

    protected abstract function get_input_name(question_attempt $qa, $value);

    protected abstract function get_input_value($value);

    protected abstract function get_input_id(question_attempt $qa, $value);

    /**
     * Whether a choice should be considered right, wrong or partially right.
     * @param question_answer $ans representing one of the choices.
     * @return fload 1.0, 0.0 or something in between, respectively.
     */
    protected abstract function is_right(question_answer $ans);

    protected abstract function prompt();

    public function formulation_and_controls(question_attempt $qa,
            question_display_options $options) {

        $question = $qa->get_question();
        $response = $question->get_response($qa);

        $inputname = $qa->get_qt_field_name('answer');
        $inputattributes = array(
            'type' => $this->get_input_type(),
            'name' => $inputname,
        );

        if ($options->readonly) {
            $inputattributes['disabled'] = 'disabled';
        }

        $radiobuttons = array();
        $feedbackimg = array();
        $feedback = array();
        $classes = array();
        foreach ($question->get_order($qa) as $value => $ansid) {
            $ans = $question->answers[$ansid];
            $inputattributes['name'] = $this->get_input_name($qa, $value);
            $inputattributes['value'] = $this->get_input_value($value);
            $inputattributes['id'] = $this->get_input_id($qa, $value);
            $inputattributes['aria-labelledby'] = $inputattributes['id'] . '_label';
            $isselected = $question->is_choice_selected($response, $value);
            if ($isselected) {
                $inputattributes['checked'] = 'checked';
            } else {
                unset($inputattributes['checked']);
            }
            $hidden = '';
            if (!$options->readonly && $this->get_input_type() == 'checkbox') {
                $hidden = html_writer::empty_tag('input', array(
                    'type' => 'hidden',
                    'name' => $inputattributes['name'],
                    'value' => 0,
                ));
            }

            $choicenumber = '';
            if ($question->answernumbering !== 'none') {
                $choicenumber = html_writer::span(
                        $this->number_in_style($value, $question->answernumbering), 'answernumber');
            }
            $choicetext = $question->format_text($ans->answer, $ans->answerformat, $qa, 'question', 'answer', $ansid);
            $choice = html_writer::div($choicetext, 'flex-fill ml-1');

            $radiobuttons[] = $hidden . html_writer::empty_tag('input', $inputattributes) .
                    html_writer::div($choicenumber . $choice, 'd-flex w-auto', [
                        'id' => $inputattributes['id'] . '_label',
                        'data-region' => 'answer-label',
                    ]);

            // Param $options->suppresschoicefeedback is a hack specific to the
            // oumultiresponse question type. It would be good to refactor to
            // avoid refering to it here.
            if ($options->feedback && empty($options->suppresschoicefeedback) &&
                    $isselected && trim($ans->feedback)) {
                $feedback[] = html_writer::tag('div',
                        $question->make_html_inline($question->format_text(
                                $ans->feedback, $ans->feedbackformat,
                                $qa, 'question', 'answerfeedback', $ansid)),
                        array('class' => 'specificfeedback'));
            } else {
                $feedback[] = '';
            }
            $class = 'r' . ($value % 2);
            if ($options->correctness && $isselected) {
< $feedbackimg[] = $this->feedback_image($this->is_right($ans));
> // Feedback images will be rendered using Font awesome. > // Font awesome icons are actually characters(text) with special glyphs, > // so the icons cannot be aligned correctly even if the parent div wrapper is using align-items: flex-start. > // To make the Font awesome icons follow align-items: flex-start, we need to wrap them inside a span tag. > $feedbackimg[] = html_writer::span($this->feedback_image($this->is_right($ans)), 'ml-1');
$class .= ' ' . $this->feedback_class($this->is_right($ans)); } else { $feedbackimg[] = ''; } $classes[] = $class; } $result = ''; $result .= html_writer::tag('div', $question->format_questiontext($qa), array('class' => 'qtext'));
< $result .= html_writer::start_tag('div', array('class' => 'ablock no-overflow visual-scroll-x'));
> $result .= html_writer::start_tag('fieldset', array('class' => 'ablock no-overflow visual-scroll-x'));
if ($question->showstandardinstruction == 1) {
< $result .= html_writer::tag('div', $this->prompt(), array('class' => 'prompt'));
> $legendclass = ''; > $questionnumber = $options->add_question_identifier_to_label($this->prompt(), true, true); > } else { > $questionnumber = $options->add_question_identifier_to_label(get_string('answer'), true, true); > $legendclass = 'sr-only';
}
> $legendattrs = [ > 'class' => 'prompt h6 font-weight-normal ' . $legendclass, $result .= html_writer::start_tag('div', array('class' => 'answer')); > ]; foreach ($radiobuttons as $key => $radio) { > $result .= html_writer::tag('legend', $questionnumber, $legendattrs);
$result .= html_writer::tag('div', $radio . ' ' . $feedbackimg[$key] . $feedback[$key], array('class' => $classes[$key])) . "\n"; } $result .= html_writer::end_tag('div'); // Answer. // Load JS module for the question answers. $this->page->requires->js_call_amd('qtype_multichoice/answers', 'init', [$qa->get_outer_question_div_unique_id()]); $result .= $this->after_choices($qa, $options);
< $result .= html_writer::end_tag('div'); // Ablock.
> $result .= html_writer::end_tag('fieldset'); // Ablock.
if ($qa->get_state() == question_state::$invalid) { $result .= html_writer::nonempty_tag('div', $question->get_validation_error($qa->get_last_qt_data()), array('class' => 'validationerror')); } return $result; } protected function number_html($qnum) { return $qnum . '. '; } /** * @param int $num The number, starting at 0. * @param string $style The style to render the number in. One of the * options returned by {@link qtype_multichoice:;get_numbering_styles()}. * @return string the number $num in the requested style. */ protected function number_in_style($num, $style) { switch($style) { case 'abc': $number = chr(ord('a') + $num); break; case 'ABCD': $number = chr(ord('A') + $num); break; case '123': $number = $num + 1; break; case 'iii': $number = question_utils::int_to_roman($num + 1); break; case 'IIII': $number = strtoupper(question_utils::int_to_roman($num + 1)); break; case 'none': return ''; default: return 'ERR'; } return $this->number_html($number); } public function specific_feedback(question_attempt $qa) { return $this->combined_feedback($qa); } /** * Function returns string based on number of correct answers * @param array $right An Array of correct responses to the current question * @return string based on number of correct responses */ protected function correct_choices(array $right) { // Return appropriate string for single/multiple correct answer(s). if (count($right) == 1) { return get_string('correctansweris', 'qtype_multichoice', implode(', ', $right)); } else if (count($right) > 1) { return get_string('correctanswersare', 'qtype_multichoice', implode(', ', $right)); } else { return ""; } } } /** * Subclass for generating the bits of output specific to multiple choice * single questions. * * @copyright 2009 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class qtype_multichoice_single_renderer extends qtype_multichoice_renderer_base { protected function get_input_type() { return 'radio'; } protected function get_input_name(question_attempt $qa, $value) { return $qa->get_qt_field_name('answer'); } protected function get_input_value($value) { return $value; } protected function get_input_id(question_attempt $qa, $value) { return $qa->get_qt_field_name('answer' . $value); } protected function is_right(question_answer $ans) { return $ans->fraction; } protected function prompt() { return get_string('selectone', 'qtype_multichoice'); } public function correct_response(question_attempt $qa) { $question = $qa->get_question(); // Put all correct answers (100% grade) into $right. $right = array(); foreach ($question->answers as $ansid => $ans) { if (question_state::graded_state_for_fraction($ans->fraction) == question_state::$gradedright) { $right[] = $question->make_html_inline($question->format_text($ans->answer, $ans->answerformat, $qa, 'question', 'answer', $ansid)); } } return $this->correct_choices($right); } public function after_choices(question_attempt $qa, question_display_options $options) { // Only load the clear choice feature if it's not read only. if ($options->readonly) { return ''; } $question = $qa->get_question(); $response = $question->get_response($qa); $hascheckedchoice = false; foreach ($question->get_order($qa) as $value => $ansid) { if ($question->is_choice_selected($response, $value)) { $hascheckedchoice = true; break; } } $clearchoiceid = $this->get_input_id($qa, -1); $clearchoicefieldname = $qa->get_qt_field_name('clearchoice'); $clearchoiceradioattrs = [ 'type' => $this->get_input_type(), 'name' => $qa->get_qt_field_name('answer'), 'id' => $clearchoiceid, 'value' => -1, 'class' => 'sr-only', 'aria-hidden' => 'true' ]; $clearchoicewrapperattrs = [ 'id' => $clearchoicefieldname, 'class' => 'qtype_multichoice_clearchoice', ]; // When no choice selected during rendering, then hide the clear choice option. // We are using .sr-only and aria-hidden together so while the element is hidden // from both the monitor and the screen-reader, it is still tabbable. $linktabindex = 0; if (!$hascheckedchoice && $response == -1) { $clearchoicewrapperattrs['class'] .= ' sr-only'; $clearchoicewrapperattrs['aria-hidden'] = 'true'; $clearchoiceradioattrs['checked'] = 'checked'; $linktabindex = -1; } // Adds an hidden radio that will be checked to give the impression the choice has been cleared. $clearchoiceradio = html_writer::empty_tag('input', $clearchoiceradioattrs); $clearchoice = html_writer::link('#', get_string('clearchoice', 'qtype_multichoice'),
< ['tabindex' => $linktabindex, 'role' => 'button', 'class' => 'btn btn-link ml-3 mt-n1 mb-n1']);
> ['tabindex' => $linktabindex, 'role' => 'button', 'class' => 'btn btn-link ml-3 mt-n1']);
$clearchoiceradio .= html_writer::label($clearchoice, $clearchoiceid); // Now wrap the radio and label inside a div. $result = html_writer::tag('div', $clearchoiceradio, $clearchoicewrapperattrs); // Load required clearchoice AMD module. $this->page->requires->js_call_amd('qtype_multichoice/clearchoice', 'init', [$qa->get_outer_question_div_unique_id(), $clearchoicefieldname]); return $result; } } /** * Subclass for generating the bits of output specific to multiple choice * multi=select questions. * * @copyright 2009 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class qtype_multichoice_multi_renderer extends qtype_multichoice_renderer_base { protected function after_choices(question_attempt $qa, question_display_options $options) { return ''; } protected function get_input_type() { return 'checkbox'; } protected function get_input_name(question_attempt $qa, $value) { return $qa->get_qt_field_name('choice' . $value); } protected function get_input_value($value) { return 1; } protected function get_input_id(question_attempt $qa, $value) { return $this->get_input_name($qa, $value); } protected function is_right(question_answer $ans) { if ($ans->fraction > 0) { return 1; } else { return 0; } } protected function prompt() { return get_string('selectmulti', 'qtype_multichoice'); } public function correct_response(question_attempt $qa) { $question = $qa->get_question(); $right = array(); foreach ($question->answers as $ansid => $ans) { if ($ans->fraction > 0) { $right[] = $question->make_html_inline($question->format_text($ans->answer, $ans->answerformat, $qa, 'question', 'answer', $ansid)); } } return $this->correct_choices($right); } protected function num_parts_correct(question_attempt $qa) { if ($qa->get_question()->get_num_selected_choices($qa->get_last_qt_data()) > $qa->get_question()->get_num_correct_choices()) { return get_string('toomanyselected', 'qtype_multichoice'); } return parent::num_parts_correct($qa); } }