Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.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/>.

/**
 * Defines the renderer for the quiz module.
 *
 * @package   mod_quiz
 * @copyright 2011 The Open University
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */


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


/**
 * The renderer for the quiz module.
 *
 * @copyright  2011 The Open University
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class mod_quiz_renderer extends plugin_renderer_base {
    /**
     * Builds the review page
     *
     * @param quiz_attempt $attemptobj an instance of quiz_attempt.
     * @param array $slots an array of intgers relating to questions.
     * @param int $page the current page number
     * @param bool $showall whether to show entire attempt on one page.
     * @param bool $lastpage if true the current page is the last page.
     * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options.
     * @param array $summarydata contains all table data
     * @return $output containing html data.
     */
    public function review_page(quiz_attempt $attemptobj, $slots, $page, $showall,
                                $lastpage, mod_quiz_display_options $displayoptions,
                                $summarydata) {

        $output = '';
        $output .= $this->header();
        $output .= $this->review_summary_table($summarydata, $page);
        $output .= $this->review_form($page, $showall, $displayoptions,
                $this->questions($attemptobj, true, $slots, $page, $showall, $displayoptions),
                $attemptobj);

        $output .= $this->review_next_navigation($attemptobj, $page, $lastpage, $showall);
        $output .= $this->footer();
        return $output;
    }

    /**
     * Renders the review question pop-up.
     *
     * @param quiz_attempt $attemptobj an instance of quiz_attempt.
     * @param int $slot which question to display.
     * @param int $seq which step of the question attempt to show. null = latest.
     * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options.
     * @param array $summarydata contains all table data
     * @return $output containing html data.
     */
    public function review_question_page(quiz_attempt $attemptobj, $slot, $seq,
            mod_quiz_display_options $displayoptions, $summarydata) {

        $output = '';
        $output .= $this->header();
        $output .= $this->review_summary_table($summarydata, 0);

        if (!is_null($seq)) {
            $output .= $attemptobj->render_question_at_step($slot, $seq, true, $this);
        } else {
            $output .= $attemptobj->render_question($slot, true, $this);
        }

        $output .= $this->close_window_button();
        $output .= $this->footer();
        return $output;
    }

    /**
     * Renders the review question pop-up.
     *
     * @param quiz_attempt $attemptobj an instance of quiz_attempt.
     * @param string $message Why the review is not allowed.
     * @return string html to output.
     */
    public function review_question_not_allowed(quiz_attempt $attemptobj, $message) {
        $output = '';
        $output .= $this->header();
        $output .= $this->heading(format_string($attemptobj->get_quiz_name(), true,
                                  array("context" => $attemptobj->get_quizobj()->get_context())));
        $output .= $this->notification($message);
        $output .= $this->close_window_button();
        $output .= $this->footer();
        return $output;
    }

    /**
     * Filters the summarydata array.
     *
     * @param array $summarydata contains row data for table
     * @param int $page the current page number
     * @return $summarydata containing filtered row data
     */
    protected function filter_review_summary_table($summarydata, $page) {
        if ($page == 0) {
            return $summarydata;
        }

        // Only show some of summary table on subsequent pages.
        foreach ($summarydata as $key => $rowdata) {
            if (!in_array($key, array('user', 'attemptlist'))) {
                unset($summarydata[$key]);
            }
        }

        return $summarydata;
    }

    /**
     * Outputs the table containing data from summary data array
     *
     * @param array $summarydata contains row data for table
     * @param int $page contains the current page number
     */
    public function review_summary_table($summarydata, $page) {
        $summarydata = $this->filter_review_summary_table($summarydata, $page);
        if (empty($summarydata)) {
            return '';
        }

        $output = '';
        $output .= html_writer::start_tag('table', array(
                'class' => 'generaltable generalbox quizreviewsummary'));
        $output .= html_writer::start_tag('tbody');
        foreach ($summarydata as $rowdata) {
            if ($rowdata['title'] instanceof renderable) {
                $title = $this->render($rowdata['title']);
            } else {
                $title = $rowdata['title'];
            }

            if ($rowdata['content'] instanceof renderable) {
                $content = $this->render($rowdata['content']);
            } else {
                $content = $rowdata['content'];
            }

            $output .= html_writer::tag('tr',
                html_writer::tag('th', $title, array('class' => 'cell', 'scope' => 'row')) .
                        html_writer::tag('td', $content, array('class' => 'cell'))
            );
        }

        $output .= html_writer::end_tag('tbody');
        $output .= html_writer::end_tag('table');
        return $output;
    }

    /**
     * Renders each question
     *
     * @param quiz_attempt $attemptobj instance of quiz_attempt
     * @param bool $reviewing
     * @param array $slots array of intgers relating to questions
     * @param int $page current page number
     * @param bool $showall if true shows attempt on single page
     * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options
     */
    public function questions(quiz_attempt $attemptobj, $reviewing, $slots, $page, $showall,
                              mod_quiz_display_options $displayoptions) {
        $output = '';
        foreach ($slots as $slot) {
            $output .= $attemptobj->render_question($slot, $reviewing, $this,
                    $attemptobj->review_url($slot, $page, $showall));
        }
        return $output;
    }

    /**
     * Renders the main bit of the review page.
     *
     * @param array $summarydata contain row data for table
     * @param int $page current page number
     * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options
     * @param $content contains each question
     * @param quiz_attempt $attemptobj instance of quiz_attempt
     * @param bool $showall if true display attempt on one page
     */
    public function review_form($page, $showall, $displayoptions, $content, $attemptobj) {
        if ($displayoptions->flags != question_display_options::EDITABLE) {
            return $content;
        }

        $this->page->requires->js_init_call('M.mod_quiz.init_review_form', null, false,
                quiz_get_js_module());

        $output = '';
        $output .= html_writer::start_tag('form', array('action' => $attemptobj->review_url(null,
                $page, $showall), 'method' => 'post', 'class' => 'questionflagsaveform'));
        $output .= html_writer::start_tag('div');
        $output .= $content;
        $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey',
                'value' => sesskey()));
        $output .= html_writer::start_tag('div', array('class' => 'submitbtns'));
        $output .= html_writer::empty_tag('input', array('type' => 'submit',
                'class' => 'questionflagsavebutton btn btn-secondary', 'name' => 'savingflags',
                'value' => get_string('saveflags', 'question')));
        $output .= html_writer::end_tag('div');
        $output .= html_writer::end_tag('div');
        $output .= html_writer::end_tag('form');

        return $output;
    }

    /**
     * Returns either a liink or button
     *
     * @param quiz_attempt $attemptobj instance of quiz_attempt
     */
    public function finish_review_link(quiz_attempt $attemptobj) {
        $url = $attemptobj->view_url();

        if ($attemptobj->get_access_manager(time())->attempt_must_be_in_popup()) {
            $this->page->requires->js_init_call('M.mod_quiz.secure_window.init_close_button',
                    array($url), false, quiz_get_js_module());
            return html_writer::empty_tag('input', array('type' => 'button',
                    'value' => get_string('finishreview', 'quiz'),
                    'id' => 'secureclosebutton',
                    'class' => 'mod_quiz-next-nav btn btn-primary'));

        } else {
            return html_writer::link($url, get_string('finishreview', 'quiz'),
                    array('class' => 'mod_quiz-next-nav'));
        }
    }

    /**
     * Creates the navigation links/buttons at the bottom of the reivew attempt page.
     *
     * Note, the name of this function is no longer accurate, but when the design
     * changed, it was decided to keep the old name for backwards compatibility.
     *
     * @param quiz_attempt $attemptobj instance of quiz_attempt
     * @param int $page the current page
     * @param bool $lastpage if true current page is the last page
     * @param bool|null $showall if true, the URL will be to review the entire attempt on one page,
     *      and $page will be ignored. If null, a sensible default will be chosen.
     *
     * @return string HTML fragment.
     */
    public function review_next_navigation(quiz_attempt $attemptobj, $page, $lastpage, $showall = null) {
        $nav = '';
        if ($page > 0) {
            $nav .= link_arrow_left(get_string('navigateprevious', 'quiz'),
                    $attemptobj->review_url(null, $page - 1, $showall), false, 'mod_quiz-prev-nav');
        }
        if ($lastpage) {
            $nav .= $this->finish_review_link($attemptobj);
        } else {
            $nav .= link_arrow_right(get_string('navigatenext', 'quiz'),
                    $attemptobj->review_url(null, $page + 1, $showall), false, 'mod_quiz-next-nav');
        }
        return html_writer::tag('div', $nav, array('class' => 'submitbtns'));
    }

    /**
     * Return the HTML of the quiz timer.
     * @return string HTML content.
     */
    public function countdown_timer(quiz_attempt $attemptobj, $timenow) {

        $timeleft = $attemptobj->get_time_left_display($timenow);
        if ($timeleft !== false) {
            $ispreview = $attemptobj->is_preview();
            $timerstartvalue = $timeleft;
            if (!$ispreview) {
                // Make sure the timer starts just above zero. If $timeleft was <= 0, then
                // this will just have the effect of causing the quiz to be submitted immediately.
                $timerstartvalue = max($timerstartvalue, 1);
            }
            $this->initialise_timer($timerstartvalue, $ispreview);
        }

< return html_writer::tag('div', get_string('timeleft', 'quiz') . ' ' . < html_writer::tag('span', '', array('id' => 'quiz-time-left')), < array('id' => 'quiz-timer', 'role' => 'timer', < 'aria-atomic' => 'true', 'aria-relevant' => 'text'));
> > return $this->output->render_from_template('mod_quiz/timer', (object)[]);
} /** * Create a preview link * * @param moodle_url $url contains a url to the given page */ public function restart_preview_button($url) { return $this->single_button($url, get_string('startnewpreview', 'quiz')); } /** * Outputs the navigation block panel * * @param quiz_nav_panel_base $panel instance of quiz_nav_panel_base */ public function navigation_panel(quiz_nav_panel_base $panel) { $output = ''; $userpicture = $panel->user_picture(); if ($userpicture) { $fullname = fullname($userpicture->user); if ($userpicture->size === true) { $fullname = html_writer::div($fullname); } $output .= html_writer::tag('div', $this->render($userpicture) . $fullname, array('id' => 'user-picture', 'class' => 'clearfix')); } $output .= $panel->render_before_button_bits($this); $bcc = $panel->get_button_container_class(); $output .= html_writer::start_tag('div', array('class' => "qn_buttons clearfix $bcc")); foreach ($panel->get_question_buttons() as $button) { $output .= $this->render($button); } $output .= html_writer::end_tag('div'); $output .= html_writer::tag('div', $panel->render_end_bits($this), array('class' => 'othernav')); $this->page->requires->js_init_call('M.mod_quiz.nav.init', null, false, quiz_get_js_module()); return $output; } /** * Display a quiz navigation button. * * @param quiz_nav_question_button $button * @return string HTML fragment. */ protected function render_quiz_nav_question_button(quiz_nav_question_button $button) { $classes = array('qnbutton', $button->stateclass, $button->navmethod, 'btn'); $extrainfo = array(); if ($button->currentpage) { $classes[] = 'thispage'; $extrainfo[] = get_string('onthispage', 'quiz'); } // Flagged? if ($button->flagged) { $classes[] = 'flagged'; $flaglabel = get_string('flagged', 'question'); } else { $flaglabel = ''; } $extrainfo[] = html_writer::tag('span', $flaglabel, array('class' => 'flagstate')); if (is_numeric($button->number)) { $qnostring = 'questionnonav'; } else { $qnostring = 'questionnonavinfo'; } $a = new stdClass(); $a->number = $button->number; $a->attributes = implode(' ', $extrainfo); $tagcontents = html_writer::tag('span', '', array('class' => 'thispageholder')) . html_writer::tag('span', '', array('class' => 'trafficlight')) . get_string($qnostring, 'quiz', $a); $tagattributes = array('class' => implode(' ', $classes), 'id' => $button->id, 'title' => $button->statestring, 'data-quiz-page' => $button->page); if ($button->url) { return html_writer::link($button->url, $tagcontents, $tagattributes); } else { return html_writer::tag('span', $tagcontents, $tagattributes); } } /** * Display a quiz navigation heading. * * @param quiz_nav_section_heading $heading the heading. * @return string HTML fragment. */ protected function render_quiz_nav_section_heading(quiz_nav_section_heading $heading) {
< return $this->heading($heading->heading, 3, 'mod_quiz-section-heading');
> if (empty($heading->heading)) { > $headingtext = get_string('sectionnoname', 'quiz'); > $class = ' dimmed_text'; > } else { > $headingtext = $heading->heading; > $class = ''; > } > return $this->heading($headingtext, 3, 'mod_quiz-section-heading' . $class);
} /** * outputs the link the other attempts. * * @param mod_quiz_links_to_other_attempts $links */ protected function render_mod_quiz_links_to_other_attempts( mod_quiz_links_to_other_attempts $links) { $attemptlinks = array(); foreach ($links->links as $attempt => $url) { if (!$url) { $attemptlinks[] = html_writer::tag('strong', $attempt); } else if ($url instanceof renderable) { $attemptlinks[] = $this->render($url); } else { $attemptlinks[] = html_writer::link($url, $attempt); } } return implode(', ', $attemptlinks); } public function start_attempt_page(quiz $quizobj, mod_quiz_preflight_check_form $mform) { $output = ''; $output .= $this->header(); $output .= $this->heading(format_string($quizobj->get_quiz_name(), true, array("context" => $quizobj->get_context()))); $output .= $this->quiz_intro($quizobj->get_quiz(), $quizobj->get_cm()); $output .= $mform->render(); $output .= $this->footer(); return $output; } /** * Attempt Page * * @param quiz_attempt $attemptobj Instance of quiz_attempt * @param int $page Current page number * @param quiz_access_manager $accessmanager Instance of quiz_access_manager * @param array $messages An array of messages * @param array $slots Contains an array of integers that relate to questions * @param int $id The ID of an attempt * @param int $nextpage The number of the next page */ public function attempt_page($attemptobj, $page, $accessmanager, $messages, $slots, $id, $nextpage) { $output = ''; $output .= $this->header(); $output .= $this->quiz_notices($messages);
> $output .= $this->countdown_timer($attemptobj, time());
$output .= $this->attempt_form($attemptobj, $page, $slots, $id, $nextpage); $output .= $this->footer(); return $output; } /** * Returns any notices. * * @param array $messages */ public function quiz_notices($messages) { if (!$messages) { return ''; } return $this->box($this->heading(get_string('accessnoticesheader', 'quiz'), 3) . $this->access_messages($messages), 'quizaccessnotices'); } /** * Ouputs the form for making an attempt * * @param quiz_attempt $attemptobj * @param int $page Current page number * @param array $slots Array of integers relating to questions * @param int $id ID of the attempt * @param int $nextpage Next page number */ public function attempt_form($attemptobj, $page, $slots, $id, $nextpage) { $output = ''; // Start the form. $output .= html_writer::start_tag('form', array('action' => new moodle_url($attemptobj->processattempt_url(), array('cmid' => $attemptobj->get_cmid())), 'method' => 'post', 'enctype' => 'multipart/form-data', 'accept-charset' => 'utf-8', 'id' => 'responseform')); $output .= html_writer::start_tag('div'); // Print all the questions. foreach ($slots as $slot) { $output .= $attemptobj->render_question($slot, false, $this, $attemptobj->attempt_url($slot, $page), $this); } $navmethod = $attemptobj->get_quiz()->navmethod; $output .= $this->attempt_navigation_buttons($page, $attemptobj->is_last_page($page), $navmethod); // Some hidden fields to trach what is going on. $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'attempt', 'value' => $attemptobj->get_attemptid())); $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'thispage', 'value' => $page, 'id' => 'followingpage')); $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'nextpage', 'value' => $nextpage)); $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'timeup', 'value' => '0', 'id' => 'timeup')); $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 'value' => sesskey())); $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'scrollpos', 'value' => '', 'id' => 'scrollpos')); // Add a hidden field with questionids. Do this at the end of the form, so // if you navigate before the form has finished loading, it does not wipe all // the student's answers. $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'slots', 'value' => implode(',', $attemptobj->get_active_slots($page)))); // Finish the form. $output .= html_writer::end_tag('div'); $output .= html_writer::end_tag('form'); $output .= $this->connection_warning(); return $output; } /** * Display the prev/next buttons that go at the bottom of each page of the attempt. * * @param int $page the page number. Starts at 0 for the first page. * @param bool $lastpage is this the last page in the quiz? * @param string $navmethod Optional quiz attribute, 'free' (default) or 'sequential' * @return string HTML fragment. */ protected function attempt_navigation_buttons($page, $lastpage, $navmethod = 'free') { $output = ''; $output .= html_writer::start_tag('div', array('class' => 'submitbtns')); if ($page > 0 && $navmethod == 'free') { $output .= html_writer::empty_tag('input', array('type' => 'submit', 'name' => 'previous',
< 'value' => get_string('navigateprevious', 'quiz'), 'class' => 'mod_quiz-prev-nav btn btn-secondary'));
> 'value' => get_string('navigateprevious', 'quiz'), 'class' => 'mod_quiz-prev-nav btn btn-secondary', > 'id' => 'mod_quiz-prev-nav')); > $this->page->requires->js_call_amd('core_form/submit', 'init', ['mod_quiz-prev-nav']);
} if ($lastpage) { $nextlabel = get_string('endtest', 'quiz'); } else { $nextlabel = get_string('navigatenext', 'quiz'); } $output .= html_writer::empty_tag('input', array('type' => 'submit', 'name' => 'next',
< 'value' => $nextlabel, 'class' => 'mod_quiz-next-nav btn btn-primary'));
> 'value' => $nextlabel, 'class' => 'mod_quiz-next-nav btn btn-primary', 'id' => 'mod_quiz-next-nav'));
$output .= html_writer::end_tag('div');
> $this->page->requires->js_call_amd('core_form/submit', 'init', ['mod_quiz-next-nav']);
return $output; } /** * Render a button which allows students to redo a question in the attempt. * * @param int $slot the number of the slot to generate the button for. * @param bool $disabled if true, output the button disabled. * @return string HTML fragment. */ public function redo_question_button($slot, $disabled) { $attributes = array('type' => 'submit', 'name' => 'redoslot' . $slot, 'value' => get_string('redoquestion', 'quiz'), 'class' => 'mod_quiz-redo_question_button btn btn-secondary'); if ($disabled) { $attributes['disabled'] = 'disabled'; } return html_writer::div(html_writer::empty_tag('input', $attributes)); } /** * Output the JavaScript required to initialise the countdown timer. * @param int $timerstartvalue time remaining, in seconds. */ public function initialise_timer($timerstartvalue, $ispreview) { $options = array($timerstartvalue, (bool)$ispreview); $this->page->requires->js_init_call('M.mod_quiz.timer.init', $options, false, quiz_get_js_module()); } /** * Output a page with an optional message, and JavaScript code to close the * current window and redirect the parent window to a new URL. * @param moodle_url $url the URL to redirect the parent window to. * @param string $message message to display before closing the window. (optional) * @return string HTML to output. */ public function close_attempt_popup($url, $message = '') { $output = ''; $output .= $this->header(); $output .= $this->box_start(); if ($message) { $output .= html_writer::tag('p', $message); $output .= html_writer::tag('p', get_string('windowclosing', 'quiz')); $delay = 5; } else { $output .= html_writer::tag('p', get_string('pleaseclose', 'quiz')); $delay = 0; } $this->page->requires->js_init_call('M.mod_quiz.secure_window.close', array($url, $delay), false, quiz_get_js_module()); $output .= $this->box_end(); $output .= $this->footer(); return $output; } /** * Print each message in an array, surrounded by &lt;p>, &lt;/p> tags. * * @param array $messages the array of message strings. * @param bool $return if true, return a string, instead of outputting. * * @return string HTML to output. */ public function access_messages($messages) { $output = ''; foreach ($messages as $message) { $output .= html_writer::tag('p', $message) . "\n"; } return $output; } /* * Summary Page */ /** * Create the summary page * * @param quiz_attempt $attemptobj * @param mod_quiz_display_options $displayoptions */ public function summary_page($attemptobj, $displayoptions) { $output = ''; $output .= $this->header(); $output .= $this->heading(format_string($attemptobj->get_quiz_name())); $output .= $this->heading(get_string('summaryofattempt', 'quiz'), 3); $output .= $this->summary_table($attemptobj, $displayoptions); $output .= $this->summary_page_controls($attemptobj); $output .= $this->footer(); return $output; } /** * Generates the table of summarydata * * @param quiz_attempt $attemptobj * @param mod_quiz_display_options $displayoptions */ public function summary_table($attemptobj, $displayoptions) { // Prepare the summary table header. $table = new html_table(); $table->attributes['class'] = 'generaltable quizsummaryofattempt boxaligncenter'; $table->head = array(get_string('question', 'quiz'), get_string('status', 'quiz')); $table->align = array('left', 'left'); $table->size = array('', ''); $markscolumn = $displayoptions->marks >= question_display_options::MARK_AND_MAX; if ($markscolumn) { $table->head[] = get_string('marks', 'quiz'); $table->align[] = 'left'; $table->size[] = ''; } $tablewidth = count($table->align); $table->data = array(); // Get the summary info for each question. $slots = $attemptobj->get_slots(); foreach ($slots as $slot) { // Add a section headings if we need one here. $heading = $attemptobj->get_heading_before_slot($slot); if ($heading) {
< $cell = new html_table_cell(format_string($heading));
> $heading = format_string($heading); > } > $sections = $attemptobj->get_quizobj()->get_sections(); > if (!is_null($heading) && empty($heading) && count($sections) > 1) { > $heading = get_string('sectionnoname', 'quiz'); > $heading = \html_writer::span($heading, 'dimmed_text'); > } > > if ($heading) { > $cell = new html_table_cell($heading);
$cell->header = true; $cell->colspan = $tablewidth; $table->data[] = array($cell); $table->rowclasses[] = 'quizsummaryheading'; } // Don't display information items. if (!$attemptobj->is_real_question($slot)) { continue; } // Real question, show it. $flag = ''; if ($attemptobj->is_question_flagged($slot)) { // Quiz has custom JS manipulating these image tags - so we can't use the pix_icon method here. $flag = html_writer::empty_tag('img', array('src' => $this->image_url('i/flagged'), 'alt' => get_string('flagged', 'question'), 'class' => 'questionflag icon-post')); } if ($attemptobj->can_navigate_to($slot)) { $row = array(html_writer::link($attemptobj->attempt_url($slot), $attemptobj->get_question_number($slot) . $flag), $attemptobj->get_question_status($slot, $displayoptions->correctness)); } else { $row = array($attemptobj->get_question_number($slot) . $flag, $attemptobj->get_question_status($slot, $displayoptions->correctness)); } if ($markscolumn) { $row[] = $attemptobj->get_question_mark($slot); } $table->data[] = $row; $table->rowclasses[] = 'quizsummary' . $slot . ' ' . $attemptobj->get_question_state_class( $slot, $displayoptions->correctness); } // Print the summary table. $output = html_writer::table($table); return $output; } /** * Creates any controls a the page should have. * * @param quiz_attempt $attemptobj */ public function summary_page_controls($attemptobj) { $output = ''; // Return to place button. if ($attemptobj->get_state() == quiz_attempt::IN_PROGRESS) { $button = new single_button( new moodle_url($attemptobj->attempt_url(null, $attemptobj->get_currentpage())), get_string('returnattempt', 'quiz')); $output .= $this->container($this->container($this->render($button), 'controls'), 'submitbtns mdl-align'); } // Finish attempt button. $options = array( 'attempt' => $attemptobj->get_attemptid(), 'finishattempt' => 1, 'timeup' => 0, 'slots' => '', 'cmid' => $attemptobj->get_cmid(), 'sesskey' => sesskey(), ); $button = new single_button( new moodle_url($attemptobj->processattempt_url(), $options), get_string('submitallandfinish', 'quiz')); $button->id = 'responseform'; if ($attemptobj->get_state() == quiz_attempt::IN_PROGRESS) { $button->add_action(new confirm_action(get_string('confirmclose', 'quiz'), null, get_string('submitallandfinish', 'quiz'))); } $duedate = $attemptobj->get_due_date(); $message = ''; if ($attemptobj->get_state() == quiz_attempt::OVERDUE) { $message = get_string('overduemustbesubmittedby', 'quiz', userdate($duedate)); } else if ($duedate) { $message = get_string('mustbesubmittedby', 'quiz', userdate($duedate)); } $output .= $this->countdown_timer($attemptobj, time()); $output .= $this->container($message . $this->container( $this->render($button), 'controls'), 'submitbtns mdl-align'); return $output; } /* * View Page */ /** * Generates the view page * * @param int $course The id of the course * @param array $quiz Array conting quiz data * @param int $cm Course Module ID * @param int $context The page context ID * @param array $infomessages information about this quiz * @param mod_quiz_view_object $viewobj * @param string $buttontext text for the start/continue attempt button, if * it should be shown. * @param array $infomessages further information about why the student cannot * attempt this quiz now, if appicable this quiz */ public function view_page($course, $quiz, $cm, $context, $viewobj) { $output = ''; $output .= $this->view_information($quiz, $cm, $context, $viewobj->infomessages); $output .= $this->view_table($quiz, $context, $viewobj); $output .= $this->view_result_info($quiz, $context, $cm, $viewobj); $output .= $this->box($this->view_page_buttons($viewobj), 'quizattempt'); return $output; } /** * Work out, and render, whatever buttons, and surrounding info, should appear * at the end of the review page. * @param mod_quiz_view_object $viewobj the information required to display * the view page. * @return string HTML to output. */ public function view_page_buttons(mod_quiz_view_object $viewobj) { global $CFG; $output = ''; if (!$viewobj->quizhasquestions) { $output .= $this->no_questions_message($viewobj->canedit, $viewobj->editurl); } $output .= $this->access_messages($viewobj->preventmessages); if ($viewobj->buttontext) { $output .= $this->start_attempt_button($viewobj->buttontext, $viewobj->startattempturl, $viewobj->preflightcheckform, $viewobj->popuprequired, $viewobj->popupoptions); } if ($viewobj->showbacktocourse) { $output .= $this->single_button($viewobj->backtocourseurl, get_string('backtocourse', 'quiz'), 'get', array('class' => 'continuebutton')); } return $output; } /** * Generates the view attempt button * * @param string $buttontext the label to display on the button. * @param moodle_url $url The URL to POST to in order to start the attempt. * @param mod_quiz_preflight_check_form $preflightcheckform deprecated. * @param bool $popuprequired whether the attempt needs to be opened in a pop-up. * @param array $popupoptions the options to use if we are opening a popup. * @return string HTML fragment. */ public function start_attempt_button($buttontext, moodle_url $url, mod_quiz_preflight_check_form $preflightcheckform = null, $popuprequired = false, $popupoptions = null) { if (is_string($preflightcheckform)) { // Calling code was not updated since the API change. debugging('The third argument to start_attempt_button should now be the ' . 'mod_quiz_preflight_check_form from ' . 'quiz_access_manager::get_preflight_check_form, not a warning message string.'); }
< $button = new single_button($url, $buttontext);
> $button = new single_button($url, $buttontext, 'post', true);
$button->class .= ' quizstartbuttondiv'; if ($popuprequired) { $button->class .= ' quizsecuremoderequired'; } $popupjsoptions = null; if ($popuprequired && $popupoptions) { $action = new popup_action('click', $url, 'popup', $popupoptions); $popupjsoptions = $action->get_js_options(); } if ($preflightcheckform) { $checkform = $preflightcheckform->render(); } else { $checkform = null; } $this->page->requires->js_call_amd('mod_quiz/preflightcheck', 'init', array('.quizstartbuttondiv [type=submit]', get_string('startattempt', 'quiz'), '#mod_quiz_preflight_form', $popupjsoptions)); return $this->render($button) . $checkform; } /** * Generate a message saying that this quiz has no questions, with a button to * go to the edit page, if the user has the right capability. * @param object $quiz the quiz settings. * @param object $cm the course_module object. * @param object $context the quiz context. * @return string HTML to output. */ public function no_questions_message($canedit, $editurl) {
< $output = ''; < $output .= $this->notification(get_string('noquestions', 'quiz'));
> $output = html_writer::start_tag('div', array('class' => 'card text-center mb-3')); > $output .= html_writer::start_tag('div', array('class' => 'card-body')); > > $output .= $this->notification(get_string('noquestions', 'quiz'), 'warning', false);
if ($canedit) { $output .= $this->single_button($editurl, get_string('editquiz', 'quiz'), 'get'); }
> $output .= html_writer::end_tag('div'); > $output .= html_writer::end_tag('div');
return $output; } /** * Outputs an error message for any guests accessing the quiz * * @param int $course The course ID * @param array $quiz Array contingin quiz data * @param int $cm Course Module ID * @param int $context The page contect ID * @param array $messages Array containing any messages */ public function view_page_guest($course, $quiz, $cm, $context, $messages) { $output = ''; $output .= $this->view_information($quiz, $cm, $context, $messages); $guestno = html_writer::tag('p', get_string('guestsno', 'quiz')); $liketologin = html_writer::tag('p', get_string('liketologin')); $referer = get_local_referer(false); $output .= $this->confirm($guestno."\n\n".$liketologin."\n", get_login_url(), $referer); return $output; } /** * Outputs and error message for anyone who is not enrolle don the course * * @param int $course The course ID * @param array $quiz Array contingin quiz data * @param int $cm Course Module ID * @param int $context The page contect ID * @param array $messages Array containing any messages */ public function view_page_notenrolled($course, $quiz, $cm, $context, $messages) { global $CFG; $output = ''; $output .= $this->view_information($quiz, $cm, $context, $messages); $youneedtoenrol = html_writer::tag('p', get_string('youneedtoenrol', 'quiz')); $button = html_writer::tag('p', $this->continue_button($CFG->wwwroot . '/course/view.php?id=' . $course->id)); $output .= $this->box($youneedtoenrol."\n\n".$button."\n", 'generalbox', 'notice'); return $output; } /** * Output the page information * * @param object $quiz the quiz settings. * @param object $cm the course_module object.
< * @param object $context the quiz context.
> * @param context $context the quiz context.
* @param array $messages any access messages that should be described. * @return string HTML to output. */ public function view_information($quiz, $cm, $context, $messages) {
< global $CFG;
> global $USER;
$output = '';
< // Print quiz name and description.
> // Print quiz name.
$output .= $this->heading(format_string($quiz->name));
> $output .= $this->quiz_intro($quiz, $cm); > // Print any activity information (eg completion requirements / dates). > $cminfo = cm_info::create($cm); // Output any access messages. > $completiondetails = \core_completion\cm_completion_details::get_instance($cminfo, $USER->id); if ($messages) { > $activitydates = \core\activity_dates::get_dates_for_module($cminfo, $USER->id); $output .= $this->box($this->access_messages($messages), 'quizinfo'); > $output .= $this->output->activity_information($cminfo, $completiondetails, $activitydates); } > > // Print quiz description.
// Show number of attempts summary to those who can view reports. if (has_capability('mod/quiz:viewreports', $context)) { if ($strattemptnum = $this->quiz_attempt_summary_link_to_reports($quiz, $cm, $context)) { $output .= html_writer::tag('div', $strattemptnum, array('class' => 'quizattemptcounts')); } }
> return $output; > if (has_any_capability(['mod/quiz:manageoverrides', 'mod/quiz:viewoverrides'], $context)) { } > if ($overrideinfo = $this->quiz_override_summary_links($quiz, $cm)) { > $output .= html_writer::tag('div', $overrideinfo, ['class' => 'quizattemptcounts']); /** > } * Output the quiz intro. > } * @param object $quiz the quiz settings. >
* @param object $cm the course_module object. * @return string HTML to output. */ public function quiz_intro($quiz, $cm) { if (html_is_blank($quiz->intro)) { return ''; } return $this->box(format_module_intro('quiz', $quiz, $cm->id), 'generalbox', 'intro'); } /** * Generates the table heading. */ public function view_table_heading() { return $this->heading(get_string('summaryofattempts', 'quiz'), 3); } /** * Generates the table of data * * @param array $quiz Array contining quiz data * @param int $context The page context ID * @param mod_quiz_view_object $viewobj */ public function view_table($quiz, $context, $viewobj) { if (!$viewobj->attempts) { return ''; } // Prepare table header. $table = new html_table(); $table->attributes['class'] = 'generaltable quizattemptsummary'; $table->head = array(); $table->align = array(); $table->size = array(); if ($viewobj->attemptcolumn) { $table->head[] = get_string('attemptnumber', 'quiz'); $table->align[] = 'center'; $table->size[] = ''; } $table->head[] = get_string('attemptstate', 'quiz'); $table->align[] = 'left'; $table->size[] = ''; if ($viewobj->markcolumn) { $table->head[] = get_string('marks', 'quiz') . ' / ' . quiz_format_grade($quiz, $quiz->sumgrades); $table->align[] = 'center'; $table->size[] = ''; } if ($viewobj->gradecolumn) {
< $table->head[] = get_string('grade') . ' / ' .
> $table->head[] = get_string('gradenoun') . ' / ' .
quiz_format_grade($quiz, $quiz->grade); $table->align[] = 'center'; $table->size[] = ''; } if ($viewobj->canreviewmine) { $table->head[] = get_string('review', 'quiz'); $table->align[] = 'center'; $table->size[] = ''; } if ($viewobj->feedbackcolumn) { $table->head[] = get_string('feedback', 'quiz'); $table->align[] = 'left'; $table->size[] = ''; } // One row for each attempt. foreach ($viewobj->attemptobjs as $attemptobj) { $attemptoptions = $attemptobj->get_display_options(true); $row = array(); // Add the attempt number. if ($viewobj->attemptcolumn) { if ($attemptobj->is_preview()) { $row[] = get_string('preview', 'quiz'); } else { $row[] = $attemptobj->get_attempt_number(); } } $row[] = $this->attempt_state($attemptobj); if ($viewobj->markcolumn) { if ($attemptoptions->marks >= question_display_options::MARK_AND_MAX && $attemptobj->is_finished()) { $row[] = quiz_format_grade($quiz, $attemptobj->get_sum_marks()); } else { $row[] = ''; } } // Ouside the if because we may be showing feedback but not grades. $attemptgrade = quiz_rescale_grade($attemptobj->get_sum_marks(), $quiz, false); if ($viewobj->gradecolumn) { if ($attemptoptions->marks >= question_display_options::MARK_AND_MAX && $attemptobj->is_finished()) { // Highlight the highest grade if appropriate. if ($viewobj->overallstats && !$attemptobj->is_preview() && $viewobj->numattempts > 1 && !is_null($viewobj->mygrade) && $attemptobj->get_state() == quiz_attempt::FINISHED && $attemptgrade == $viewobj->mygrade && $quiz->grademethod == QUIZ_GRADEHIGHEST) { $table->rowclasses[$attemptobj->get_attempt_number()] = 'bestrow'; } $row[] = quiz_format_grade($quiz, $attemptgrade); } else { $row[] = ''; } } if ($viewobj->canreviewmine) { $row[] = $viewobj->accessmanager->make_review_link($attemptobj->get_attempt(), $attemptoptions, $this); } if ($viewobj->feedbackcolumn && $attemptobj->is_finished()) { if ($attemptoptions->overallfeedback) { $row[] = quiz_feedback_for_grade($attemptgrade, $quiz, $context); } else { $row[] = ''; } } if ($attemptobj->is_preview()) { $table->data['preview'] = $row; } else { $table->data[$attemptobj->get_attempt_number()] = $row; } } // End of loop over attempts. $output = ''; $output .= $this->view_table_heading(); $output .= html_writer::table($table); return $output; } /** * Generate a brief textual desciption of the current state of an attempt. * @param quiz_attempt $attemptobj the attempt * @param int $timenow the time to use as 'now'. * @return string the appropriate lang string to describe the state. */ public function attempt_state($attemptobj) { switch ($attemptobj->get_state()) { case quiz_attempt::IN_PROGRESS: return get_string('stateinprogress', 'quiz'); case quiz_attempt::OVERDUE: return get_string('stateoverdue', 'quiz') . html_writer::tag('span', get_string('stateoverduedetails', 'quiz', userdate($attemptobj->get_due_date())), array('class' => 'statedetails')); case quiz_attempt::FINISHED: return get_string('statefinished', 'quiz') . html_writer::tag('span', get_string('statefinisheddetails', 'quiz', userdate($attemptobj->get_submitted_date())), array('class' => 'statedetails')); case quiz_attempt::ABANDONED: return get_string('stateabandoned', 'quiz'); } } /** * Generates data pertaining to quiz results * * @param array $quiz Array containing quiz data * @param int $context The page context ID * @param int $cm The Course Module Id * @param mod_quiz_view_object $viewobj */ public function view_result_info($quiz, $context, $cm, $viewobj) { $output = ''; if (!$viewobj->numattempts && !$viewobj->gradecolumn && is_null($viewobj->mygrade)) { return $output; } $resultinfo = ''; if ($viewobj->overallstats) { if ($viewobj->moreattempts) { $a = new stdClass(); $a->method = quiz_get_grading_option_name($quiz->grademethod); $a->mygrade = quiz_format_grade($quiz, $viewobj->mygrade); $a->quizgrade = quiz_format_grade($quiz, $quiz->grade); $resultinfo .= $this->heading(get_string('gradesofar', 'quiz', $a), 3); } else { $a = new stdClass(); $a->grade = quiz_format_grade($quiz, $viewobj->mygrade); $a->maxgrade = quiz_format_grade($quiz, $quiz->grade); $a = get_string('outofshort', 'quiz', $a); $resultinfo .= $this->heading(get_string('yourfinalgradeis', 'quiz', $a), 3); } } if ($viewobj->mygradeoverridden) { $resultinfo .= html_writer::tag('p', get_string('overriddennotice', 'grades'), array('class' => 'overriddennotice'))."\n"; } if ($viewobj->gradebookfeedback) { $resultinfo .= $this->heading(get_string('comment', 'quiz'), 3); $resultinfo .= html_writer::div($viewobj->gradebookfeedback, 'quizteacherfeedback') . "\n"; } if ($viewobj->feedbackcolumn) { $resultinfo .= $this->heading(get_string('overallfeedback', 'quiz'), 3); $resultinfo .= html_writer::div( quiz_feedback_for_grade($viewobj->mygrade, $quiz, $context), 'quizgradefeedback') . "\n"; } if ($resultinfo) { $output .= $this->box($resultinfo, 'generalbox', 'feedback'); } return $output; } /** * Output either a link to the review page for an attempt, or a button to * open the review in a popup window. * * @param moodle_url $url of the target page. * @param bool $reviewinpopup whether a pop-up is required. * @param array $popupoptions options to pass to the popup_action constructor. * @return string HTML to output. */ public function review_link($url, $reviewinpopup, $popupoptions) { if ($reviewinpopup) { $button = new single_button($url, get_string('review', 'quiz')); $button->add_action(new popup_action('click', $url, 'quizpopup', $popupoptions)); return $this->render($button); } else { return html_writer::link($url, get_string('review', 'quiz'), array('title' => get_string('reviewthisattempt', 'quiz'))); } } /** * Displayed where there might normally be a review link, to explain why the * review is not available at this time. * @param string $message optional message explaining why the review is not possible. * @return string HTML to output. */ public function no_review_message($message) { return html_writer::nonempty_tag('span', $message, array('class' => 'noreviewmessage')); } /** * Returns the same as {@link quiz_num_attempt_summary()} but wrapped in a link * to the quiz reports. *
< * @param object $quiz the quiz object. Only $quiz->id is used at the moment. < * @param object $cm the cm object. Only $cm->course, $cm->groupmode and $cm->groupingid
> * @param stdClass $quiz the quiz object. Only $quiz->id is used at the moment. > * @param stdClass $cm the cm object. Only $cm->course, $cm->groupmode and $cm->groupingid
* fields are used at the moment.
< * @param object $context the quiz context.
> * @param context $context the quiz context.
* @param bool $returnzero if false (default), when no attempts have been made '' is returned * instead of 'Attempts: 0'. * @param int $currentgroup if there is a concept of current group where this method is being
< * called < * (e.g. a report) pass it in here. Default 0 which means no current group.
> * called (e.g. a report) pass it in here. Default 0 which means no current group.
* @return string HTML fragment for the link. */ public function quiz_attempt_summary_link_to_reports($quiz, $cm, $context, $returnzero = false, $currentgroup = 0) { global $CFG; $summary = quiz_num_attempt_summary($quiz, $cm, $returnzero, $currentgroup); if (!$summary) { return ''; } require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php'); $url = new moodle_url('/mod/quiz/report.php', array( 'id' => $cm->id, 'mode' => quiz_report_default_report($context))); return html_writer::link($url, $summary);
> } } > > /** /** > * Render a summary of the number of group and user overrides, with corresponding links. * Outputs a chart. > * * > * @param stdClass $quiz the quiz settings. * @param \core\chart_base $chart The chart. > * @param stdClass|cm_info $cm the cm object. * @param string $title The title to display above the graph. > * @param int $currentgroup currently selected group, if there is one. * @param array $attrs extra container html attributes. > * @return string HTML fragment for the link. * @return string HTML fragment for the graph. > */ */ > public function quiz_override_summary_links(stdClass $quiz, stdClass $cm, $currentgroup = 0): string { public function chart(\core\chart_base $chart, $title, $attrs = []) { > return $this->heading($title, 3) . html_writer::tag('div', > $baseurl = new moodle_url('/mod/quiz/overrides.php', ['cmid' => $cm->id]); $this->render($chart), array_merge(['class' => 'graph'], $attrs)); > $counts = quiz_override_summary($quiz, $cm, $currentgroup); } > > $links = []; /** > if ($counts['group']) { * Output a graph, or a message saying that GD is required. > $links[] = html_writer::link(new moodle_url($baseurl, ['mode' => 'group']), * @param moodle_url $url the URL of the graph. > get_string('overridessummarygroup', 'quiz', $counts['group'])); * @param string $title the title to display above the graph. > } * @return string HTML fragment for the graph. > if ($counts['user']) { */ > $links[] = html_writer::link(new moodle_url($baseurl, ['mode' => 'user']), public function graph(moodle_url $url, $title) { > get_string('overridessummaryuser', 'quiz', $counts['user'])); global $CFG; > } > $graph = html_writer::empty_tag('img', array('src' => $url, 'alt' => $title)); > if (!$links) { > return ''; return $this->heading($title, 3) . html_writer::tag('div', $graph, array('class' => 'graph')); > } } > > $links = implode(', ', $links); /** > switch ($counts['mode']) { * Output the connection warning messages, which are initially hidden, and > case 'onegroup': * only revealed by JavaScript if necessary. > return get_string('overridessummarythisgroup', 'quiz', $links); */ > public function connection_warning() { > case 'somegroups': $options = array('filter' => false, 'newlines' => false); > return get_string('overridessummaryyourgroups', 'quiz', $links); $warning = format_text(get_string('connectionerror', 'quiz'), FORMAT_MARKDOWN, $options); > $ok = format_text(get_string('connectionok', 'quiz'), FORMAT_MARKDOWN, $options); > case 'allgroups': return html_writer::tag('div', $warning, > return get_string('overridessummary', 'quiz', $links); array('id' => 'connection-error', 'style' => 'display: none;', 'role' => 'alert')) . > html_writer::tag('div', $ok, array('id' => 'connection-ok', 'style' => 'display: none;', 'role' => 'alert')); > default: } > throw new coding_exception('Unexpected mode ' . $counts['mode']); } > }
class mod_quiz_links_to_other_attempts implements renderable { /** * @var array string attempt number => url, or null for the current attempt. * url may be either a moodle_url, or a renderable. */ public $links = array(); } class mod_quiz_view_object { /** @var array $infomessages of messages with information to display about the quiz. */ public $infomessages; /** @var array $attempts contains all the user's attempts at this quiz. */ public $attempts; /** @var array $attemptobjs quiz_attempt objects corresponding to $attempts. */ public $attemptobjs; /** @var quiz_access_manager $accessmanager contains various access rules. */ public $accessmanager; /** @var bool $canreviewmine whether the current user has the capability to * review their own attempts. */ public $canreviewmine; /** @var bool $canedit whether the current user has the capability to edit the quiz. */ public $canedit; /** @var moodle_url $editurl the URL for editing this quiz. */ public $editurl; /** @var int $attemptcolumn contains the number of attempts done. */ public $attemptcolumn; /** @var int $gradecolumn contains the grades of any attempts. */ public $gradecolumn; /** @var int $markcolumn contains the marks of any attempt. */ public $markcolumn; /** @var int $overallstats contains all marks for any attempt. */ public $overallstats; /** @var string $feedbackcolumn contains any feedback for and attempt. */ public $feedbackcolumn; /** @var string $timenow contains a timestamp in string format. */ public $timenow; /** @var int $numattempts contains the total number of attempts. */ public $numattempts; /** @var float $mygrade contains the user's final grade for a quiz. */ public $mygrade; /** @var bool $moreattempts whether this user is allowed more attempts. */ public $moreattempts; /** @var int $mygradeoverridden contains an overriden grade. */ public $mygradeoverridden; /** @var string $gradebookfeedback contains any feedback for a gradebook. */ public $gradebookfeedback; /** @var bool $unfinished contains 1 if an attempt is unfinished. */ public $unfinished; /** @var object $lastfinishedattempt the last attempt from the attempts array. */ public $lastfinishedattempt; /** @var array $preventmessages of messages telling the user why they can't * attempt the quiz now. */ public $preventmessages; /** @var string $buttontext caption for the start attempt button. If this is null, show no * button, or if it is '' show a back to the course button. */ public $buttontext; /** @var moodle_url $startattempturl URL to start an attempt. */ public $startattempturl; /** @var moodleform|null $preflightcheckform confirmation form that must be * submitted before an attempt is started, if required. */ public $preflightcheckform; /** @var moodle_url $startattempturl URL for any Back to the course button. */ public $backtocourseurl; /** @var bool $showbacktocourse should we show a back to the course button? */ public $showbacktocourse; /** @var bool whether the attempt must take place in a popup window. */ public $popuprequired; /** @var array options to use for the popup window, if required. */ public $popupoptions; /** @var bool $quizhasquestions whether the quiz has any questions. */ public $quizhasquestions; public function __get($field) { switch ($field) { case 'startattemptwarning': debugging('startattemptwarning has been deprecated. It is now always blank.'); return ''; default: debugging('Unknown property ' . $field); return null; } } }