Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
- Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
- PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.
/mod/quiz/ -> renderer.php (source)
Differences Between: [Versions 310 and 400] [Versions 311 and 400] [Versions 39 and 400] [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]
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/>. 16 17 /** 18 * Defines the renderer for the quiz module. 19 * 20 * @package mod_quiz 21 * @copyright 2011 The Open University 22 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 23 */ 24 25 26 defined('MOODLE_INTERNAL') || die(); 27 28 29 /** 30 * The renderer for the quiz module. 31 * 32 * @copyright 2011 The Open University 33 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 34 */ 35 class mod_quiz_renderer extends plugin_renderer_base { 36 /** 37 * Builds the review page 38 * 39 * @param quiz_attempt $attemptobj an instance of quiz_attempt. 40 * @param array $slots an array of intgers relating to questions. 41 * @param int $page the current page number 42 * @param bool $showall whether to show entire attempt on one page. 43 * @param bool $lastpage if true the current page is the last page. 44 * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options. 45 * @param array $summarydata contains all table data 46 * @return $output containing html data. 47 */ 48 public function review_page(quiz_attempt $attemptobj, $slots, $page, $showall, 49 $lastpage, mod_quiz_display_options $displayoptions, 50 $summarydata) { 51 52 $output = ''; 53 $output .= $this->header(); 54 $output .= $this->review_summary_table($summarydata, $page); 55 $output .= $this->review_form($page, $showall, $displayoptions, 56 $this->questions($attemptobj, true, $slots, $page, $showall, $displayoptions), 57 $attemptobj); 58 59 $output .= $this->review_next_navigation($attemptobj, $page, $lastpage, $showall); 60 $output .= $this->footer(); 61 return $output; 62 } 63 64 /** 65 * Renders the review question pop-up. 66 * 67 * @param quiz_attempt $attemptobj an instance of quiz_attempt. 68 * @param int $slot which question to display. 69 * @param int $seq which step of the question attempt to show. null = latest. 70 * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options. 71 * @param array $summarydata contains all table data 72 * @return $output containing html data. 73 */ 74 public function review_question_page(quiz_attempt $attemptobj, $slot, $seq, 75 mod_quiz_display_options $displayoptions, $summarydata) { 76 77 $output = ''; 78 $output .= $this->header(); 79 $output .= $this->review_summary_table($summarydata, 0); 80 81 if (!is_null($seq)) { 82 $output .= $attemptobj->render_question_at_step($slot, $seq, true, $this); 83 } else { 84 $output .= $attemptobj->render_question($slot, true, $this); 85 } 86 87 $output .= $this->close_window_button(); 88 $output .= $this->footer(); 89 return $output; 90 } 91 92 /** 93 * Renders the review question pop-up. 94 * 95 * @param quiz_attempt $attemptobj an instance of quiz_attempt. 96 * @param string $message Why the review is not allowed. 97 * @return string html to output. 98 */ 99 public function review_question_not_allowed(quiz_attempt $attemptobj, $message) { 100 $output = ''; 101 $output .= $this->header(); 102 $output .= $this->heading(format_string($attemptobj->get_quiz_name(), true, 103 array("context" => $attemptobj->get_quizobj()->get_context()))); 104 $output .= $this->notification($message); 105 $output .= $this->close_window_button(); 106 $output .= $this->footer(); 107 return $output; 108 } 109 110 /** 111 * Filters the summarydata array. 112 * 113 * @param array $summarydata contains row data for table 114 * @param int $page the current page number 115 * @return $summarydata containing filtered row data 116 */ 117 protected function filter_review_summary_table($summarydata, $page) { 118 if ($page == 0) { 119 return $summarydata; 120 } 121 122 // Only show some of summary table on subsequent pages. 123 foreach ($summarydata as $key => $rowdata) { 124 if (!in_array($key, array('user', 'attemptlist'))) { 125 unset($summarydata[$key]); 126 } 127 } 128 129 return $summarydata; 130 } 131 132 /** 133 * Outputs the table containing data from summary data array 134 * 135 * @param array $summarydata contains row data for table 136 * @param int $page contains the current page number 137 */ 138 public function review_summary_table($summarydata, $page) { 139 $summarydata = $this->filter_review_summary_table($summarydata, $page); 140 if (empty($summarydata)) { 141 return ''; 142 } 143 144 $output = ''; 145 $output .= html_writer::start_tag('table', array( 146 'class' => 'generaltable generalbox quizreviewsummary')); 147 $output .= html_writer::start_tag('tbody'); 148 foreach ($summarydata as $rowdata) { 149 if ($rowdata['title'] instanceof renderable) { 150 $title = $this->render($rowdata['title']); 151 } else { 152 $title = $rowdata['title']; 153 } 154 155 if ($rowdata['content'] instanceof renderable) { 156 $content = $this->render($rowdata['content']); 157 } else { 158 $content = $rowdata['content']; 159 } 160 161 $output .= html_writer::tag('tr', 162 html_writer::tag('th', $title, array('class' => 'cell', 'scope' => 'row')) . 163 html_writer::tag('td', $content, array('class' => 'cell')) 164 ); 165 } 166 167 $output .= html_writer::end_tag('tbody'); 168 $output .= html_writer::end_tag('table'); 169 return $output; 170 } 171 172 /** 173 * Renders each question 174 * 175 * @param quiz_attempt $attemptobj instance of quiz_attempt 176 * @param bool $reviewing 177 * @param array $slots array of intgers relating to questions 178 * @param int $page current page number 179 * @param bool $showall if true shows attempt on single page 180 * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options 181 */ 182 public function questions(quiz_attempt $attemptobj, $reviewing, $slots, $page, $showall, 183 mod_quiz_display_options $displayoptions) { 184 $output = ''; 185 foreach ($slots as $slot) { 186 $output .= $attemptobj->render_question($slot, $reviewing, $this, 187 $attemptobj->review_url($slot, $page, $showall)); 188 } 189 return $output; 190 } 191 192 /** 193 * Renders the main bit of the review page. 194 * 195 * @param array $summarydata contain row data for table 196 * @param int $page current page number 197 * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options 198 * @param $content contains each question 199 * @param quiz_attempt $attemptobj instance of quiz_attempt 200 * @param bool $showall if true display attempt on one page 201 */ 202 public function review_form($page, $showall, $displayoptions, $content, $attemptobj) { 203 if ($displayoptions->flags != question_display_options::EDITABLE) { 204 return $content; 205 } 206 207 $this->page->requires->js_init_call('M.mod_quiz.init_review_form', null, false, 208 quiz_get_js_module()); 209 210 $output = ''; 211 $output .= html_writer::start_tag('form', array('action' => $attemptobj->review_url(null, 212 $page, $showall), 'method' => 'post', 'class' => 'questionflagsaveform')); 213 $output .= html_writer::start_tag('div'); 214 $output .= $content; 215 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 216 'value' => sesskey())); 217 $output .= html_writer::start_tag('div', array('class' => 'submitbtns')); 218 $output .= html_writer::empty_tag('input', array('type' => 'submit', 219 'class' => 'questionflagsavebutton btn btn-secondary', 'name' => 'savingflags', 220 'value' => get_string('saveflags', 'question'))); 221 $output .= html_writer::end_tag('div'); 222 $output .= html_writer::end_tag('div'); 223 $output .= html_writer::end_tag('form'); 224 225 return $output; 226 } 227 228 /** 229 * Returns either a liink or button 230 * 231 * @param quiz_attempt $attemptobj instance of quiz_attempt 232 */ 233 public function finish_review_link(quiz_attempt $attemptobj) { 234 $url = $attemptobj->view_url(); 235 236 if ($attemptobj->get_access_manager(time())->attempt_must_be_in_popup()) { 237 $this->page->requires->js_init_call('M.mod_quiz.secure_window.init_close_button', 238 array($url), false, quiz_get_js_module()); 239 return html_writer::empty_tag('input', array('type' => 'button', 240 'value' => get_string('finishreview', 'quiz'), 241 'id' => 'secureclosebutton', 242 'class' => 'mod_quiz-next-nav btn btn-primary')); 243 244 } else { 245 return html_writer::link($url, get_string('finishreview', 'quiz'), 246 array('class' => 'mod_quiz-next-nav')); 247 } 248 } 249 250 /** 251 * Creates the navigation links/buttons at the bottom of the reivew attempt page. 252 * 253 * Note, the name of this function is no longer accurate, but when the design 254 * changed, it was decided to keep the old name for backwards compatibility. 255 * 256 * @param quiz_attempt $attemptobj instance of quiz_attempt 257 * @param int $page the current page 258 * @param bool $lastpage if true current page is the last page 259 * @param bool|null $showall if true, the URL will be to review the entire attempt on one page, 260 * and $page will be ignored. If null, a sensible default will be chosen. 261 * 262 * @return string HTML fragment. 263 */ 264 public function review_next_navigation(quiz_attempt $attemptobj, $page, $lastpage, $showall = null) { 265 $nav = ''; 266 if ($page > 0) { 267 $nav .= link_arrow_left(get_string('navigateprevious', 'quiz'), 268 $attemptobj->review_url(null, $page - 1, $showall), false, 'mod_quiz-prev-nav'); 269 } 270 if ($lastpage) { 271 $nav .= $this->finish_review_link($attemptobj); 272 } else { 273 $nav .= link_arrow_right(get_string('navigatenext', 'quiz'), 274 $attemptobj->review_url(null, $page + 1, $showall), false, 'mod_quiz-next-nav'); 275 } 276 return html_writer::tag('div', $nav, array('class' => 'submitbtns')); 277 } 278 279 /** 280 * Return the HTML of the quiz timer. 281 * @return string HTML content. 282 */ 283 public function countdown_timer(quiz_attempt $attemptobj, $timenow) { 284 285 $timeleft = $attemptobj->get_time_left_display($timenow); 286 if ($timeleft !== false) { 287 $ispreview = $attemptobj->is_preview(); 288 $timerstartvalue = $timeleft; 289 if (!$ispreview) { 290 // Make sure the timer starts just above zero. If $timeleft was <= 0, then 291 // this will just have the effect of causing the quiz to be submitted immediately. 292 $timerstartvalue = max($timerstartvalue, 1); 293 } 294 $this->initialise_timer($timerstartvalue, $ispreview); 295 } 296 297 298 return $this->output->render_from_template('mod_quiz/timer', (object)[]); 299 } 300 301 /** 302 * Create a preview link 303 * 304 * @param moodle_url $url contains a url to the given page 305 */ 306 public function restart_preview_button($url) { 307 return $this->single_button($url, get_string('startnewpreview', 'quiz')); 308 } 309 310 /** 311 * Outputs the navigation block panel 312 * 313 * @param quiz_nav_panel_base $panel instance of quiz_nav_panel_base 314 */ 315 public function navigation_panel(quiz_nav_panel_base $panel) { 316 317 $output = ''; 318 $userpicture = $panel->user_picture(); 319 if ($userpicture) { 320 $fullname = fullname($userpicture->user); 321 if ($userpicture->size === true) { 322 $fullname = html_writer::div($fullname); 323 } 324 $output .= html_writer::tag('div', $this->render($userpicture) . $fullname, 325 array('id' => 'user-picture', 'class' => 'clearfix')); 326 } 327 $output .= $panel->render_before_button_bits($this); 328 329 $bcc = $panel->get_button_container_class(); 330 $output .= html_writer::start_tag('div', array('class' => "qn_buttons clearfix $bcc")); 331 foreach ($panel->get_question_buttons() as $button) { 332 $output .= $this->render($button); 333 } 334 $output .= html_writer::end_tag('div'); 335 336 $output .= html_writer::tag('div', $panel->render_end_bits($this), 337 array('class' => 'othernav')); 338 339 $this->page->requires->js_init_call('M.mod_quiz.nav.init', null, false, 340 quiz_get_js_module()); 341 342 return $output; 343 } 344 345 /** 346 * Display a quiz navigation button. 347 * 348 * @param quiz_nav_question_button $button 349 * @return string HTML fragment. 350 */ 351 protected function render_quiz_nav_question_button(quiz_nav_question_button $button) { 352 $classes = array('qnbutton', $button->stateclass, $button->navmethod, 'btn'); 353 $extrainfo = array(); 354 355 if ($button->currentpage) { 356 $classes[] = 'thispage'; 357 $extrainfo[] = get_string('onthispage', 'quiz'); 358 } 359 360 // Flagged? 361 if ($button->flagged) { 362 $classes[] = 'flagged'; 363 $flaglabel = get_string('flagged', 'question'); 364 } else { 365 $flaglabel = ''; 366 } 367 $extrainfo[] = html_writer::tag('span', $flaglabel, array('class' => 'flagstate')); 368 369 if (is_numeric($button->number)) { 370 $qnostring = 'questionnonav'; 371 } else { 372 $qnostring = 'questionnonavinfo'; 373 } 374 375 $a = new stdClass(); 376 $a->number = $button->number; 377 $a->attributes = implode(' ', $extrainfo); 378 $tagcontents = html_writer::tag('span', '', array('class' => 'thispageholder')) . 379 html_writer::tag('span', '', array('class' => 'trafficlight')) . 380 get_string($qnostring, 'quiz', $a); 381 $tagattributes = array('class' => implode(' ', $classes), 'id' => $button->id, 382 'title' => $button->statestring, 'data-quiz-page' => $button->page); 383 384 if ($button->url) { 385 return html_writer::link($button->url, $tagcontents, $tagattributes); 386 } else { 387 return html_writer::tag('span', $tagcontents, $tagattributes); 388 } 389 } 390 391 /** 392 * Display a quiz navigation heading. 393 * 394 * @param quiz_nav_section_heading $heading the heading. 395 * @return string HTML fragment. 396 */ 397 protected function render_quiz_nav_section_heading(quiz_nav_section_heading $heading) { 398 if (empty($heading->heading)) { 399 $headingtext = get_string('sectionnoname', 'quiz'); 400 $class = ' dimmed_text'; 401 } else { 402 $headingtext = $heading->heading; 403 $class = ''; 404 } 405 return $this->heading($headingtext, 3, 'mod_quiz-section-heading' . $class); 406 } 407 408 /** 409 * outputs the link the other attempts. 410 * 411 * @param mod_quiz_links_to_other_attempts $links 412 */ 413 protected function render_mod_quiz_links_to_other_attempts( 414 mod_quiz_links_to_other_attempts $links) { 415 $attemptlinks = array(); 416 foreach ($links->links as $attempt => $url) { 417 if (!$url) { 418 $attemptlinks[] = html_writer::tag('strong', $attempt); 419 } else if ($url instanceof renderable) { 420 $attemptlinks[] = $this->render($url); 421 } else { 422 $attemptlinks[] = html_writer::link($url, $attempt); 423 } 424 } 425 return implode(', ', $attemptlinks); 426 } 427 428 public function start_attempt_page(quiz $quizobj, mod_quiz_preflight_check_form $mform) { 429 $output = ''; 430 $output .= $this->header(); 431 $output .= $this->during_attempt_tertiary_nav($quizobj->view_url()); 432 $output .= $this->heading(format_string($quizobj->get_quiz_name(), true, 433 array("context" => $quizobj->get_context()))); 434 $output .= $this->quiz_intro($quizobj->get_quiz(), $quizobj->get_cm()); 435 $output .= $mform->render(); 436 $output .= $this->footer(); 437 return $output; 438 } 439 440 /** 441 * Attempt Page 442 * 443 * @param quiz_attempt $attemptobj Instance of quiz_attempt 444 * @param int $page Current page number 445 * @param quiz_access_manager $accessmanager Instance of quiz_access_manager 446 * @param array $messages An array of messages 447 * @param array $slots Contains an array of integers that relate to questions 448 * @param int $id The ID of an attempt 449 * @param int $nextpage The number of the next page 450 * @return string HTML to output. 451 */ 452 public function attempt_page($attemptobj, $page, $accessmanager, $messages, $slots, $id, 453 $nextpage) { 454 $output = ''; 455 $output .= $this->header(); 456 $output .= $this->during_attempt_tertiary_nav($attemptobj->view_url()); 457 $output .= $this->quiz_notices($messages); 458 $output .= $this->countdown_timer($attemptobj, time()); 459 $output .= $this->attempt_form($attemptobj, $page, $slots, $id, $nextpage); 460 $output .= $this->footer(); 461 return $output; 462 } 463 464 /** 465 * Render the tertiary navigation for pages during the attempt. 466 * 467 * @param string|moodle_url $quizviewurl url of the view.php page for this quiz. 468 * @return string HTML to output. 469 */ 470 public function during_attempt_tertiary_nav($quizviewurl): string { 471 $output = ''; 472 $output .= html_writer::start_div('container-fluid tertiary-navigation'); 473 $output .= html_writer::start_div('row'); 474 $output .= html_writer::start_div('navitem'); 475 $output .= html_writer::link($quizviewurl, get_string('back'), 476 ['class' => 'btn btn-secondary']); 477 $output .= html_writer::end_div(); 478 $output .= html_writer::end_div(); 479 $output .= html_writer::end_div(); 480 return $output; 481 } 482 483 /** 484 * Returns any notices. 485 * 486 * @param array $messages 487 */ 488 public function quiz_notices($messages) { 489 if (!$messages) { 490 return ''; 491 } 492 return $this->notification( 493 html_writer::tag('p', get_string('accessnoticesheader', 'quiz')) . $this->access_messages($messages), 494 'warning', 495 false 496 ); 497 } 498 499 /** 500 * Ouputs the form for making an attempt 501 * 502 * @param quiz_attempt $attemptobj 503 * @param int $page Current page number 504 * @param array $slots Array of integers relating to questions 505 * @param int $id ID of the attempt 506 * @param int $nextpage Next page number 507 */ 508 public function attempt_form($attemptobj, $page, $slots, $id, $nextpage) { 509 $output = ''; 510 511 // Start the form. 512 $output .= html_writer::start_tag('form', 513 array('action' => new moodle_url($attemptobj->processattempt_url(), 514 array('cmid' => $attemptobj->get_cmid())), 'method' => 'post', 515 'enctype' => 'multipart/form-data', 'accept-charset' => 'utf-8', 516 'id' => 'responseform')); 517 $output .= html_writer::start_tag('div'); 518 519 // Print all the questions. 520 foreach ($slots as $slot) { 521 $output .= $attemptobj->render_question($slot, false, $this, 522 $attemptobj->attempt_url($slot, $page), $this); 523 } 524 525 $navmethod = $attemptobj->get_quiz()->navmethod; 526 $output .= $this->attempt_navigation_buttons($page, $attemptobj->is_last_page($page), $navmethod); 527 528 // Some hidden fields to trach what is going on. 529 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'attempt', 530 'value' => $attemptobj->get_attemptid())); 531 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'thispage', 532 'value' => $page, 'id' => 'followingpage')); 533 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'nextpage', 534 'value' => $nextpage)); 535 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'timeup', 536 'value' => '0', 'id' => 'timeup')); 537 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey', 538 'value' => sesskey())); 539 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'scrollpos', 540 'value' => '', 'id' => 'scrollpos')); 541 542 // Add a hidden field with questionids. Do this at the end of the form, so 543 // if you navigate before the form has finished loading, it does not wipe all 544 // the student's answers. 545 $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'slots', 546 'value' => implode(',', $attemptobj->get_active_slots($page)))); 547 548 // Finish the form. 549 $output .= html_writer::end_tag('div'); 550 $output .= html_writer::end_tag('form'); 551 552 $output .= $this->connection_warning(); 553 554 return $output; 555 } 556 557 /** 558 * Display the prev/next buttons that go at the bottom of each page of the attempt. 559 * 560 * @param int $page the page number. Starts at 0 for the first page. 561 * @param bool $lastpage is this the last page in the quiz? 562 * @param string $navmethod Optional quiz attribute, 'free' (default) or 'sequential' 563 * @return string HTML fragment. 564 */ 565 protected function attempt_navigation_buttons($page, $lastpage, $navmethod = 'free') { 566 $output = ''; 567 568 $output .= html_writer::start_tag('div', array('class' => 'submitbtns')); 569 if ($page > 0 && $navmethod == 'free') { 570 $output .= html_writer::empty_tag('input', array('type' => 'submit', 'name' => 'previous', 571 'value' => get_string('navigateprevious', 'quiz'), 'class' => 'mod_quiz-prev-nav btn btn-secondary', 572 'id' => 'mod_quiz-prev-nav')); 573 $this->page->requires->js_call_amd('core_form/submit', 'init', ['mod_quiz-prev-nav']); 574 } 575 if ($lastpage) { 576 $nextlabel = get_string('endtest', 'quiz'); 577 } else { 578 $nextlabel = get_string('navigatenext', 'quiz'); 579 } 580 $output .= html_writer::empty_tag('input', array('type' => 'submit', 'name' => 'next', 581 'value' => $nextlabel, 'class' => 'mod_quiz-next-nav btn btn-primary', 'id' => 'mod_quiz-next-nav')); 582 $output .= html_writer::end_tag('div'); 583 $this->page->requires->js_call_amd('core_form/submit', 'init', ['mod_quiz-next-nav']); 584 585 return $output; 586 } 587 588 /** 589 * Render a button which allows students to redo a question in the attempt. 590 * 591 * @param int $slot the number of the slot to generate the button for. 592 * @param bool $disabled if true, output the button disabled. 593 * @return string HTML fragment. 594 */ 595 public function redo_question_button($slot, $disabled) { 596 $attributes = array('type' => 'submit', 'name' => 'redoslot' . $slot, 597 'value' => get_string('redoquestion', 'quiz'), 598 'class' => 'mod_quiz-redo_question_button btn btn-secondary'); 599 if ($disabled) { 600 $attributes['disabled'] = 'disabled'; 601 } 602 return html_writer::div(html_writer::empty_tag('input', $attributes)); 603 } 604 605 /** 606 * Output the JavaScript required to initialise the countdown timer. 607 * @param int $timerstartvalue time remaining, in seconds. 608 */ 609 public function initialise_timer($timerstartvalue, $ispreview) { 610 $options = array($timerstartvalue, (bool)$ispreview); 611 $this->page->requires->js_init_call('M.mod_quiz.timer.init', $options, false, quiz_get_js_module()); 612 } 613 614 /** 615 * Output a page with an optional message, and JavaScript code to close the 616 * current window and redirect the parent window to a new URL. 617 * @param moodle_url $url the URL to redirect the parent window to. 618 * @param string $message message to display before closing the window. (optional) 619 * @return string HTML to output. 620 */ 621 public function close_attempt_popup($url, $message = '') { 622 $output = ''; 623 $output .= $this->header(); 624 $output .= $this->box_start(); 625 626 if ($message) { 627 $output .= html_writer::tag('p', $message); 628 $output .= html_writer::tag('p', get_string('windowclosing', 'quiz')); 629 $delay = 5; 630 } else { 631 $output .= html_writer::tag('p', get_string('pleaseclose', 'quiz')); 632 $delay = 0; 633 } 634 $this->page->requires->js_init_call('M.mod_quiz.secure_window.close', 635 array($url, $delay), false, quiz_get_js_module()); 636 637 $output .= $this->box_end(); 638 $output .= $this->footer(); 639 return $output; 640 } 641 642 /** 643 * Print each message in an array, surrounded by <p>, </p> tags. 644 * 645 * @param array $messages the array of message strings. 646 * @param bool $return if true, return a string, instead of outputting. 647 * 648 * @return string HTML to output. 649 */ 650 public function access_messages($messages) { 651 $output = ''; 652 foreach ($messages as $message) { 653 $output .= html_writer::tag('p', $message, ['class' => 'text-left']); 654 } 655 return $output; 656 } 657 658 /* 659 * Summary Page 660 */ 661 /** 662 * Create the summary page 663 * 664 * @param quiz_attempt $attemptobj 665 * @param mod_quiz_display_options $displayoptions 666 */ 667 public function summary_page($attemptobj, $displayoptions) { 668 $output = ''; 669 $output .= $this->header(); 670 $output .= $this->during_attempt_tertiary_nav($attemptobj->view_url()); 671 $output .= $this->heading(format_string($attemptobj->get_quiz_name())); 672 $output .= $this->heading(get_string('summaryofattempt', 'quiz'), 3); 673 $output .= $this->summary_table($attemptobj, $displayoptions); 674 $output .= $this->summary_page_controls($attemptobj); 675 $output .= $this->footer(); 676 return $output; 677 } 678 679 /** 680 * Generates the table of summarydata 681 * 682 * @param quiz_attempt $attemptobj 683 * @param mod_quiz_display_options $displayoptions 684 */ 685 public function summary_table($attemptobj, $displayoptions) { 686 // Prepare the summary table header. 687 $table = new html_table(); 688 $table->attributes['class'] = 'generaltable quizsummaryofattempt boxaligncenter'; 689 $table->head = array(get_string('question', 'quiz'), get_string('status', 'quiz')); 690 $table->align = array('left', 'left'); 691 $table->size = array('', ''); 692 $markscolumn = $displayoptions->marks >= question_display_options::MARK_AND_MAX; 693 if ($markscolumn) { 694 $table->head[] = get_string('marks', 'quiz'); 695 $table->align[] = 'left'; 696 $table->size[] = ''; 697 } 698 $tablewidth = count($table->align); 699 $table->data = array(); 700 701 // Get the summary info for each question. 702 $slots = $attemptobj->get_slots(); 703 foreach ($slots as $slot) { 704 // Add a section headings if we need one here. 705 $heading = $attemptobj->get_heading_before_slot($slot); 706 if ($heading !== null) { 707 // There is a heading here. 708 $rowclasses = 'quizsummaryheading'; 709 if ($heading) { 710 $heading = format_string($heading); 711 } else if (count($attemptobj->get_quizobj()->get_sections()) > 1) { 712 // If this is the start of an unnamed section, and the quiz has more 713 // than one section, then add a default heading. 714 $heading = get_string('sectionnoname', 'quiz'); 715 $rowclasses .= ' dimmed_text'; 716 } 717 $cell = new html_table_cell(format_string($heading)); 718 $cell->header = true; 719 $cell->colspan = $tablewidth; 720 $table->data[] = array($cell); 721 $table->rowclasses[] = $rowclasses; 722 } 723 724 // Don't display information items. 725 if (!$attemptobj->is_real_question($slot)) { 726 continue; 727 } 728 729 // Real question, show it. 730 $flag = ''; 731 if ($attemptobj->is_question_flagged($slot)) { 732 // Quiz has custom JS manipulating these image tags - so we can't use the pix_icon method here. 733 $flag = html_writer::empty_tag('img', array('src' => $this->image_url('i/flagged'), 734 'alt' => get_string('flagged', 'question'), 'class' => 'questionflag icon-post')); 735 } 736 if ($attemptobj->can_navigate_to($slot)) { 737 $row = array(html_writer::link($attemptobj->attempt_url($slot), 738 $attemptobj->get_question_number($slot) . $flag), 739 $attemptobj->get_question_status($slot, $displayoptions->correctness)); 740 } else { 741 $row = array($attemptobj->get_question_number($slot) . $flag, 742 $attemptobj->get_question_status($slot, $displayoptions->correctness)); 743 } 744 if ($markscolumn) { 745 $row[] = $attemptobj->get_question_mark($slot); 746 } 747 $table->data[] = $row; 748 $table->rowclasses[] = 'quizsummary' . $slot . ' ' . $attemptobj->get_question_state_class( 749 $slot, $displayoptions->correctness); 750 } 751 752 // Print the summary table. 753 $output = html_writer::table($table); 754 755 return $output; 756 } 757 758 /** 759 * Creates any controls a the page should have. 760 * 761 * @param quiz_attempt $attemptobj 762 */ 763 public function summary_page_controls($attemptobj) { 764 $output = ''; 765 766 // Return to place button. 767 if ($attemptobj->get_state() == quiz_attempt::IN_PROGRESS) { 768 $button = new single_button( 769 new moodle_url($attemptobj->attempt_url(null, $attemptobj->get_currentpage())), 770 get_string('returnattempt', 'quiz')); 771 $output .= $this->container($this->container($this->render($button), 772 'controls'), 'submitbtns mdl-align'); 773 } 774 775 // Finish attempt button. 776 $options = array( 777 'attempt' => $attemptobj->get_attemptid(), 778 'finishattempt' => 1, 779 'timeup' => 0, 780 'slots' => '', 781 'cmid' => $attemptobj->get_cmid(), 782 'sesskey' => sesskey(), 783 ); 784 785 $button = new single_button( 786 new moodle_url($attemptobj->processattempt_url(), $options), 787 get_string('submitallandfinish', 'quiz')); 788 $button->id = 'responseform'; 789 if ($attemptobj->get_state() == quiz_attempt::IN_PROGRESS) { 790 $button->add_action(new confirm_action(get_string('confirmclose', 'quiz'), null, 791 get_string('submitallandfinish', 'quiz'))); 792 } 793 $button->primary = true; 794 795 $duedate = $attemptobj->get_due_date(); 796 $message = ''; 797 if ($attemptobj->get_state() == quiz_attempt::OVERDUE) { 798 $message = get_string('overduemustbesubmittedby', 'quiz', userdate($duedate)); 799 800 } else if ($duedate) { 801 $message = get_string('mustbesubmittedby', 'quiz', userdate($duedate)); 802 } 803 804 $output .= $this->countdown_timer($attemptobj, time()); 805 $output .= $this->container($message . $this->container( 806 $this->render($button), 'controls'), 'submitbtns mdl-align'); 807 808 return $output; 809 } 810 811 /* 812 * View Page 813 */ 814 /** 815 * Generates the view page 816 * 817 * @param stdClass $course the course settings row from the database. 818 * @param stdClass $quiz the quiz settings row from the database. 819 * @param stdClass $cm the course_module settings row from the database. 820 * @param context_module $context the quiz context. 821 * @param mod_quiz_view_object $viewobj 822 * @return string HTML to display 823 */ 824 public function view_page($course, $quiz, $cm, $context, $viewobj) { 825 $output = ''; 826 827 $output .= $this->view_page_tertiary_nav($viewobj); 828 $output .= $this->view_information($quiz, $cm, $context, $viewobj->infomessages); 829 $output .= $this->view_table($quiz, $context, $viewobj); 830 $output .= $this->view_result_info($quiz, $context, $cm, $viewobj); 831 $output .= $this->box($this->view_page_buttons($viewobj), 'quizattempt'); 832 return $output; 833 } 834 835 /** 836 * Render the tertiary navigation for the view page. 837 * 838 * @param mod_quiz_view_object $viewobj the information required to display the view page. 839 * @return string HTML to output. 840 */ 841 public function view_page_tertiary_nav(mod_quiz_view_object $viewobj): string { 842 $content = ''; 843 844 if ($viewobj->buttontext) { 845 $attemptbtn = $this->start_attempt_button($viewobj->buttontext, 846 $viewobj->startattempturl, $viewobj->preflightcheckform, 847 $viewobj->popuprequired, $viewobj->popupoptions); 848 $content .= $attemptbtn; 849 } 850 851 if ($viewobj->canedit && !$viewobj->quizhasquestions) { 852 $content .= html_writer::link($viewobj->editurl, get_string('addquestion', 'quiz'), 853 ['class' => 'btn btn-secondary']); 854 } 855 856 if ($content) { 857 return html_writer::div(html_writer::div($content, 'row'), 'container-fluid tertiary-navigation'); 858 } else { 859 return ''; 860 } 861 } 862 863 /** 864 * Work out, and render, whatever buttons, and surrounding info, should appear 865 * at the end of the review page. 866 * 867 * @param mod_quiz_view_object $viewobj the information required to display the view page. 868 * @return string HTML to output. 869 */ 870 public function view_page_buttons(mod_quiz_view_object $viewobj) { 871 $output = ''; 872 873 if (!$viewobj->quizhasquestions) { 874 $output .= html_writer::div( 875 $this->notification(get_string('noquestions', 'quiz'), 'warning', false), 876 'text-left mb-3'); 877 } 878 $output .= $this->access_messages($viewobj->preventmessages); 879 880 if ($viewobj->showbacktocourse) { 881 $output .= $this->single_button($viewobj->backtocourseurl, 882 get_string('backtocourse', 'quiz'), 'get', 883 array('class' => 'continuebutton')); 884 } 885 886 return $output; 887 } 888 889 /** 890 * Generates the view attempt button 891 * 892 * @param string $buttontext the label to display on the button. 893 * @param moodle_url $url The URL to POST to in order to start the attempt. 894 * @param mod_quiz_preflight_check_form $preflightcheckform deprecated. 895 * @param bool $popuprequired whether the attempt needs to be opened in a pop-up. 896 * @param array $popupoptions the options to use if we are opening a popup. 897 * @return string HTML fragment. 898 */ 899 public function start_attempt_button($buttontext, moodle_url $url, 900 mod_quiz_preflight_check_form $preflightcheckform = null, 901 $popuprequired = false, $popupoptions = null) { 902 903 if (is_string($preflightcheckform)) { 904 // Calling code was not updated since the API change. 905 debugging('The third argument to start_attempt_button should now be the ' . 906 'mod_quiz_preflight_check_form from ' . 907 'quiz_access_manager::get_preflight_check_form, not a warning message string.'); 908 } 909 910 $button = new single_button($url, $buttontext, 'post', true); 911 $button->class .= ' quizstartbuttondiv'; 912 if ($popuprequired) { 913 $button->class .= ' quizsecuremoderequired'; 914 } 915 916 $popupjsoptions = null; 917 if ($popuprequired && $popupoptions) { 918 $action = new popup_action('click', $url, 'popup', $popupoptions); 919 $popupjsoptions = $action->get_js_options(); 920 } 921 922 if ($preflightcheckform) { 923 $checkform = $preflightcheckform->render(); 924 } else { 925 $checkform = null; 926 } 927 928 $this->page->requires->js_call_amd('mod_quiz/preflightcheck', 'init', 929 array('.quizstartbuttondiv [type=submit]', get_string('startattempt', 'quiz'), 930 '#mod_quiz_preflight_form', $popupjsoptions)); 931 932 return $this->render($button) . $checkform; 933 } 934 935 /** 936 * Generate a message saying that this quiz has no questions, with a button to 937 * go to the edit page, if the user has the right capability. 938 * 939 * @param bool $canedit can the current user edit the quiz? 940 * @param moodle_url $editurl URL of the edit quiz page. 941 * @return string HTML to output. 942 * 943 * @deprecated since Moodle 4.0 MDL-71915 - please do not use this function any more. 944 */ 945 public function no_questions_message($canedit, $editurl) { 946 debugging('no_questions_message() is deprecated, please use generate_no_questions_message() instead.', DEBUG_DEVELOPER); 947 948 $output = html_writer::start_tag('div', array('class' => 'card text-center mb-3')); 949 $output .= html_writer::start_tag('div', array('class' => 'card-body')); 950 951 $output .= $this->notification(get_string('noquestions', 'quiz'), 'warning', false); 952 if ($canedit) { 953 $output .= $this->single_button($editurl, get_string('editquiz', 'quiz'), 'get'); 954 } 955 $output .= html_writer::end_tag('div'); 956 $output .= html_writer::end_tag('div'); 957 958 return $output; 959 } 960 961 /** 962 * Outputs an error message for any guests accessing the quiz 963 * 964 * @param stdClass $course the course settings row from the database. 965 * @param stdClass $quiz the quiz settings row from the database. 966 * @param stdClass $cm the course_module settings row from the database. 967 * @param context_module $context the quiz context. 968 * @param array $messages Array containing any messages 969 * @param mod_quiz_view_object $viewobj 970 */ 971 public function view_page_guest($course, $quiz, $cm, $context, $messages, $viewobj) { 972 $output = ''; 973 $output .= $this->view_page_tertiary_nav($viewobj); 974 $output .= $this->view_information($quiz, $cm, $context, $messages); 975 $guestno = html_writer::tag('p', get_string('guestsno', 'quiz')); 976 $liketologin = html_writer::tag('p', get_string('liketologin')); 977 $referer = get_local_referer(false); 978 $output .= $this->confirm($guestno."\n\n".$liketologin."\n", get_login_url(), $referer); 979 return $output; 980 } 981 982 /** 983 * Outputs and error message for anyone who is not enrolle don the course 984 * 985 * @param stdClass $course the course settings row from the database. 986 * @param stdClass $quiz the quiz settings row from the database. 987 * @param stdClass $cm the course_module settings row from the database. 988 * @param context_module $context the quiz context. 989 * @param array $messages Array containing any messages 990 * @param mod_quiz_view_object $viewobj 991 */ 992 public function view_page_notenrolled($course, $quiz, $cm, $context, $messages, $viewobj) { 993 global $CFG; 994 $output = ''; 995 $output .= $this->view_page_tertiary_nav($viewobj); 996 $output .= $this->view_information($quiz, $cm, $context, $messages); 997 $youneedtoenrol = html_writer::tag('p', get_string('youneedtoenrol', 'quiz')); 998 $button = html_writer::tag('p', 999 $this->continue_button($CFG->wwwroot . '/course/view.php?id=' . $course->id)); 1000 $output .= $this->box($youneedtoenrol."\n\n".$button."\n", 'generalbox', 'notice'); 1001 return $output; 1002 } 1003 1004 /** 1005 * Output the page information 1006 * 1007 * @param object $quiz the quiz settings. 1008 * @param object $cm the course_module object. 1009 * @param context $context the quiz context. 1010 * @param array $messages any access messages that should be described. 1011 * @param bool $quizhasquestions does quiz has questions added. 1012 * @return string HTML to output. 1013 */ 1014 public function view_information($quiz, $cm, $context, $messages, bool $quizhasquestions = false) { 1015 $output = ''; 1016 1017 // Output any access messages. 1018 if ($messages) { 1019 $output .= $this->box($this->access_messages($messages), 'quizinfo'); 1020 } 1021 1022 // Show number of attempts summary to those who can view reports. 1023 if (has_capability('mod/quiz:viewreports', $context)) { 1024 if ($strattemptnum = $this->quiz_attempt_summary_link_to_reports($quiz, $cm, 1025 $context)) { 1026 $output .= html_writer::tag('div', $strattemptnum, 1027 array('class' => 'quizattemptcounts')); 1028 } 1029 } 1030 1031 if (has_any_capability(['mod/quiz:manageoverrides', 'mod/quiz:viewoverrides'], $context)) { 1032 if ($overrideinfo = $this->quiz_override_summary_links($quiz, $cm)) { 1033 $output .= html_writer::tag('div', $overrideinfo, ['class' => 'quizattemptcounts']); 1034 } 1035 } 1036 1037 return $output; 1038 } 1039 1040 /** 1041 * Output the quiz intro. 1042 * @param object $quiz the quiz settings. 1043 * @param object $cm the course_module object. 1044 * @return string HTML to output. 1045 */ 1046 public function quiz_intro($quiz, $cm) { 1047 if (html_is_blank($quiz->intro)) { 1048 return ''; 1049 } 1050 1051 return $this->box(format_module_intro('quiz', $quiz, $cm->id), 'generalbox', 'intro'); 1052 } 1053 1054 /** 1055 * Generates the table heading. 1056 */ 1057 public function view_table_heading() { 1058 return $this->heading(get_string('summaryofattempts', 'quiz'), 3); 1059 } 1060 1061 /** 1062 * Generates the table of data 1063 * 1064 * @param array $quiz Array contining quiz data 1065 * @param int $context The page context ID 1066 * @param mod_quiz_view_object $viewobj 1067 */ 1068 public function view_table($quiz, $context, $viewobj) { 1069 if (!$viewobj->attempts) { 1070 return ''; 1071 } 1072 1073 // Prepare table header. 1074 $table = new html_table(); 1075 $table->attributes['class'] = 'generaltable quizattemptsummary'; 1076 $table->head = array(); 1077 $table->align = array(); 1078 $table->size = array(); 1079 if ($viewobj->attemptcolumn) { 1080 $table->head[] = get_string('attemptnumber', 'quiz'); 1081 $table->align[] = 'center'; 1082 $table->size[] = ''; 1083 } 1084 $table->head[] = get_string('attemptstate', 'quiz'); 1085 $table->align[] = 'left'; 1086 $table->size[] = ''; 1087 if ($viewobj->markcolumn) { 1088 $table->head[] = get_string('marks', 'quiz') . ' / ' . 1089 quiz_format_grade($quiz, $quiz->sumgrades); 1090 $table->align[] = 'center'; 1091 $table->size[] = ''; 1092 } 1093 if ($viewobj->gradecolumn) { 1094 $table->head[] = get_string('gradenoun') . ' / ' . 1095 quiz_format_grade($quiz, $quiz->grade); 1096 $table->align[] = 'center'; 1097 $table->size[] = ''; 1098 } 1099 if ($viewobj->canreviewmine) { 1100 $table->head[] = get_string('review', 'quiz'); 1101 $table->align[] = 'center'; 1102 $table->size[] = ''; 1103 } 1104 if ($viewobj->feedbackcolumn) { 1105 $table->head[] = get_string('feedback', 'quiz'); 1106 $table->align[] = 'left'; 1107 $table->size[] = ''; 1108 } 1109 1110 // One row for each attempt. 1111 foreach ($viewobj->attemptobjs as $attemptobj) { 1112 $attemptoptions = $attemptobj->get_display_options(true); 1113 $row = array(); 1114 1115 // Add the attempt number. 1116 if ($viewobj->attemptcolumn) { 1117 if ($attemptobj->is_preview()) { 1118 $row[] = get_string('preview', 'quiz'); 1119 } else { 1120 $row[] = $attemptobj->get_attempt_number(); 1121 } 1122 } 1123 1124 $row[] = $this->attempt_state($attemptobj); 1125 1126 if ($viewobj->markcolumn) { 1127 if ($attemptoptions->marks >= question_display_options::MARK_AND_MAX && 1128 $attemptobj->is_finished()) { 1129 $row[] = quiz_format_grade($quiz, $attemptobj->get_sum_marks()); 1130 } else { 1131 $row[] = ''; 1132 } 1133 } 1134 1135 // Ouside the if because we may be showing feedback but not grades. 1136 $attemptgrade = quiz_rescale_grade($attemptobj->get_sum_marks(), $quiz, false); 1137 1138 if ($viewobj->gradecolumn) { 1139 if ($attemptoptions->marks >= question_display_options::MARK_AND_MAX && 1140 $attemptobj->is_finished()) { 1141 1142 // Highlight the highest grade if appropriate. 1143 if ($viewobj->overallstats && !$attemptobj->is_preview() 1144 && $viewobj->numattempts > 1 && !is_null($viewobj->mygrade) 1145 && $attemptobj->get_state() == quiz_attempt::FINISHED 1146 && $attemptgrade == $viewobj->mygrade 1147 && $quiz->grademethod == QUIZ_GRADEHIGHEST) { 1148 $table->rowclasses[$attemptobj->get_attempt_number()] = 'bestrow'; 1149 } 1150 1151 $row[] = quiz_format_grade($quiz, $attemptgrade); 1152 } else { 1153 $row[] = ''; 1154 } 1155 } 1156 1157 if ($viewobj->canreviewmine) { 1158 $row[] = $viewobj->accessmanager->make_review_link($attemptobj->get_attempt(), 1159 $attemptoptions, $this); 1160 } 1161 1162 if ($viewobj->feedbackcolumn && $attemptobj->is_finished()) { 1163 if ($attemptoptions->overallfeedback) { 1164 $row[] = quiz_feedback_for_grade($attemptgrade, $quiz, $context); 1165 } else { 1166 $row[] = ''; 1167 } 1168 } 1169 1170 if ($attemptobj->is_preview()) { 1171 $table->data['preview'] = $row; 1172 } else { 1173 $table->data[$attemptobj->get_attempt_number()] = $row; 1174 } 1175 } // End of loop over attempts. 1176 1177 $output = ''; 1178 $output .= $this->view_table_heading(); 1179 $output .= html_writer::table($table); 1180 return $output; 1181 } 1182 1183 /** 1184 * Generate a brief textual desciption of the current state of an attempt. 1185 * @param quiz_attempt $attemptobj the attempt 1186 * @param int $timenow the time to use as 'now'. 1187 * @return string the appropriate lang string to describe the state. 1188 */ 1189 public function attempt_state($attemptobj) { 1190 switch ($attemptobj->get_state()) { 1191 case quiz_attempt::IN_PROGRESS: 1192 return get_string('stateinprogress', 'quiz'); 1193 1194 case quiz_attempt::OVERDUE: 1195 return get_string('stateoverdue', 'quiz') . html_writer::tag('span', 1196 get_string('stateoverduedetails', 'quiz', 1197 userdate($attemptobj->get_due_date())), 1198 array('class' => 'statedetails')); 1199 1200 case quiz_attempt::FINISHED: 1201 return get_string('statefinished', 'quiz') . html_writer::tag('span', 1202 get_string('statefinisheddetails', 'quiz', 1203 userdate($attemptobj->get_submitted_date())), 1204 array('class' => 'statedetails')); 1205 1206 case quiz_attempt::ABANDONED: 1207 return get_string('stateabandoned', 'quiz'); 1208 } 1209 } 1210 1211 /** 1212 * Generates data pertaining to quiz results 1213 * 1214 * @param array $quiz Array containing quiz data 1215 * @param int $context The page context ID 1216 * @param int $cm The Course Module Id 1217 * @param mod_quiz_view_object $viewobj 1218 */ 1219 public function view_result_info($quiz, $context, $cm, $viewobj) { 1220 $output = ''; 1221 if (!$viewobj->numattempts && !$viewobj->gradecolumn && is_null($viewobj->mygrade)) { 1222 return $output; 1223 } 1224 $resultinfo = ''; 1225 1226 if ($viewobj->overallstats) { 1227 if ($viewobj->moreattempts) { 1228 $a = new stdClass(); 1229 $a->method = quiz_get_grading_option_name($quiz->grademethod); 1230 $a->mygrade = quiz_format_grade($quiz, $viewobj->mygrade); 1231 $a->quizgrade = quiz_format_grade($quiz, $quiz->grade); 1232 $resultinfo .= $this->heading(get_string('gradesofar', 'quiz', $a), 3); 1233 } else { 1234 $a = new stdClass(); 1235 $a->grade = quiz_format_grade($quiz, $viewobj->mygrade); 1236 $a->maxgrade = quiz_format_grade($quiz, $quiz->grade); 1237 $a = get_string('outofshort', 'quiz', $a); 1238 $resultinfo .= $this->heading(get_string('yourfinalgradeis', 'quiz', $a), 3); 1239 } 1240 } 1241 1242 if ($viewobj->mygradeoverridden) { 1243 1244 $resultinfo .= html_writer::tag('p', get_string('overriddennotice', 'grades'), 1245 array('class' => 'overriddennotice'))."\n"; 1246 } 1247 if ($viewobj->gradebookfeedback) { 1248 $resultinfo .= $this->heading(get_string('comment', 'quiz'), 3); 1249 $resultinfo .= html_writer::div($viewobj->gradebookfeedback, 'quizteacherfeedback') . "\n"; 1250 } 1251 if ($viewobj->feedbackcolumn) { 1252 $resultinfo .= $this->heading(get_string('overallfeedback', 'quiz'), 3); 1253 $resultinfo .= html_writer::div( 1254 quiz_feedback_for_grade($viewobj->mygrade, $quiz, $context), 1255 'quizgradefeedback') . "\n"; 1256 } 1257 1258 if ($resultinfo) { 1259 $output .= $this->box($resultinfo, 'generalbox', 'feedback'); 1260 } 1261 return $output; 1262 } 1263 1264 /** 1265 * Output either a link to the review page for an attempt, or a button to 1266 * open the review in a popup window. 1267 * 1268 * @param moodle_url $url of the target page. 1269 * @param bool $reviewinpopup whether a pop-up is required. 1270 * @param array $popupoptions options to pass to the popup_action constructor. 1271 * @return string HTML to output. 1272 */ 1273 public function review_link($url, $reviewinpopup, $popupoptions) { 1274 if ($reviewinpopup) { 1275 $button = new single_button($url, get_string('review', 'quiz')); 1276 $button->add_action(new popup_action('click', $url, 'quizpopup', $popupoptions)); 1277 return $this->render($button); 1278 1279 } else { 1280 return html_writer::link($url, get_string('review', 'quiz'), 1281 array('title' => get_string('reviewthisattempt', 'quiz'))); 1282 } 1283 } 1284 1285 /** 1286 * Displayed where there might normally be a review link, to explain why the 1287 * review is not available at this time. 1288 * @param string $message optional message explaining why the review is not possible. 1289 * @return string HTML to output. 1290 */ 1291 public function no_review_message($message) { 1292 return html_writer::nonempty_tag('span', $message, 1293 array('class' => 'noreviewmessage')); 1294 } 1295 1296 /** 1297 * Returns the same as {@link quiz_num_attempt_summary()} but wrapped in a link 1298 * to the quiz reports. 1299 * 1300 * @param stdClass $quiz the quiz object. Only $quiz->id is used at the moment. 1301 * @param stdClass $cm the cm object. Only $cm->course, $cm->groupmode and $cm->groupingid 1302 * fields are used at the moment. 1303 * @param context $context the quiz context. 1304 * @param bool $returnzero if false (default), when no attempts have been made '' is returned 1305 * instead of 'Attempts: 0'. 1306 * @param int $currentgroup if there is a concept of current group where this method is being 1307 * called (e.g. a report) pass it in here. Default 0 which means no current group. 1308 * @return string HTML fragment for the link. 1309 */ 1310 public function quiz_attempt_summary_link_to_reports($quiz, $cm, $context, 1311 $returnzero = false, $currentgroup = 0) { 1312 global $CFG; 1313 $summary = quiz_num_attempt_summary($quiz, $cm, $returnzero, $currentgroup); 1314 if (!$summary) { 1315 return ''; 1316 } 1317 1318 require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php'); 1319 $url = new moodle_url('/mod/quiz/report.php', array( 1320 'id' => $cm->id, 'mode' => quiz_report_default_report($context))); 1321 return html_writer::link($url, $summary); 1322 } 1323 1324 /** 1325 * Render a summary of the number of group and user overrides, with corresponding links. 1326 * 1327 * @param stdClass $quiz the quiz settings. 1328 * @param stdClass|cm_info $cm the cm object. 1329 * @param int $currentgroup currently selected group, if there is one. 1330 * @return string HTML fragment for the link. 1331 */ 1332 public function quiz_override_summary_links(stdClass $quiz, stdClass $cm, $currentgroup = 0): string { 1333 1334 $baseurl = new moodle_url('/mod/quiz/overrides.php', ['cmid' => $cm->id]); 1335 $counts = quiz_override_summary($quiz, $cm, $currentgroup); 1336 1337 $links = []; 1338 if ($counts['group']) { 1339 $links[] = html_writer::link(new moodle_url($baseurl, ['mode' => 'group']), 1340 get_string('overridessummarygroup', 'quiz', $counts['group'])); 1341 } 1342 if ($counts['user']) { 1343 $links[] = html_writer::link(new moodle_url($baseurl, ['mode' => 'user']), 1344 get_string('overridessummaryuser', 'quiz', $counts['user'])); 1345 } 1346 1347 if (!$links) { 1348 return ''; 1349 } 1350 1351 $links = implode(', ', $links); 1352 switch ($counts['mode']) { 1353 case 'onegroup': 1354 return get_string('overridessummarythisgroup', 'quiz', $links); 1355 1356 case 'somegroups': 1357 return get_string('overridessummaryyourgroups', 'quiz', $links); 1358 1359 case 'allgroups': 1360 return get_string('overridessummary', 'quiz', $links); 1361 1362 default: 1363 throw new coding_exception('Unexpected mode ' . $counts['mode']); 1364 } 1365 } 1366 1367 /** 1368 * Outputs a chart. 1369 * 1370 * @param \core\chart_base $chart The chart. 1371 * @param string $title The title to display above the graph. 1372 * @param array $attrs extra container html attributes. 1373 * @return string HTML fragment for the graph. 1374 */ 1375 public function chart(\core\chart_base $chart, $title, $attrs = []) { 1376 return $this->heading($title, 3) . html_writer::tag('div', 1377 $this->render($chart), array_merge(['class' => 'graph'], $attrs)); 1378 } 1379 1380 /** 1381 * Output a graph, or a message saying that GD is required. 1382 * @param moodle_url $url the URL of the graph. 1383 * @param string $title the title to display above the graph. 1384 * @return string HTML fragment for the graph. 1385 */ 1386 public function graph(moodle_url $url, $title) { 1387 global $CFG; 1388 1389 $graph = html_writer::empty_tag('img', array('src' => $url, 'alt' => $title)); 1390 1391 return $this->heading($title, 3) . html_writer::tag('div', $graph, array('class' => 'graph')); 1392 } 1393 1394 /** 1395 * Output the connection warning messages, which are initially hidden, and 1396 * only revealed by JavaScript if necessary. 1397 */ 1398 public function connection_warning() { 1399 $options = array('filter' => false, 'newlines' => false); 1400 $warning = format_text(get_string('connectionerror', 'quiz'), FORMAT_MARKDOWN, $options); 1401 $ok = format_text(get_string('connectionok', 'quiz'), FORMAT_MARKDOWN, $options); 1402 return html_writer::tag('div', $warning, 1403 array('id' => 'connection-error', 'style' => 'display: none;', 'role' => 'alert')) . 1404 html_writer::tag('div', $ok, array('id' => 'connection-ok', 'style' => 'display: none;', 'role' => 'alert')); 1405 } 1406 } 1407 1408 1409 class mod_quiz_links_to_other_attempts implements renderable { 1410 /** 1411 * @var array string attempt number => url, or null for the current attempt. 1412 * url may be either a moodle_url, or a renderable. 1413 */ 1414 public $links = array(); 1415 } 1416 1417 1418 class mod_quiz_view_object { 1419 /** @var array $infomessages of messages with information to display about the quiz. */ 1420 public $infomessages; 1421 /** @var array $attempts contains all the user's attempts at this quiz. */ 1422 public $attempts; 1423 /** @var array $attemptobjs quiz_attempt objects corresponding to $attempts. */ 1424 public $attemptobjs; 1425 /** @var quiz_access_manager $accessmanager contains various access rules. */ 1426 public $accessmanager; 1427 /** @var bool $canreviewmine whether the current user has the capability to 1428 * review their own attempts. */ 1429 public $canreviewmine; 1430 /** @var bool $canedit whether the current user has the capability to edit the quiz. */ 1431 public $canedit; 1432 /** @var moodle_url $editurl the URL for editing this quiz. */ 1433 public $editurl; 1434 /** @var int $attemptcolumn contains the number of attempts done. */ 1435 public $attemptcolumn; 1436 /** @var int $gradecolumn contains the grades of any attempts. */ 1437 public $gradecolumn; 1438 /** @var int $markcolumn contains the marks of any attempt. */ 1439 public $markcolumn; 1440 /** @var int $overallstats contains all marks for any attempt. */ 1441 public $overallstats; 1442 /** @var string $feedbackcolumn contains any feedback for and attempt. */ 1443 public $feedbackcolumn; 1444 /** @var string $timenow contains a timestamp in string format. */ 1445 public $timenow; 1446 /** @var int $numattempts contains the total number of attempts. */ 1447 public $numattempts; 1448 /** @var float $mygrade contains the user's final grade for a quiz. */ 1449 public $mygrade; 1450 /** @var bool $moreattempts whether this user is allowed more attempts. */ 1451 public $moreattempts; 1452 /** @var int $mygradeoverridden contains an overriden grade. */ 1453 public $mygradeoverridden; 1454 /** @var string $gradebookfeedback contains any feedback for a gradebook. */ 1455 public $gradebookfeedback; 1456 /** @var bool $unfinished contains 1 if an attempt is unfinished. */ 1457 public $unfinished; 1458 /** @var object $lastfinishedattempt the last attempt from the attempts array. */ 1459 public $lastfinishedattempt; 1460 /** @var array $preventmessages of messages telling the user why they can't 1461 * attempt the quiz now. */ 1462 public $preventmessages; 1463 /** @var string $buttontext caption for the start attempt button. If this is null, show no 1464 * button, or if it is '' show a back to the course button. */ 1465 public $buttontext; 1466 /** @var moodle_url $startattempturl URL to start an attempt. */ 1467 public $startattempturl; 1468 /** @var mod_quiz_preflight_check_form|null $preflightcheckform confirmation form that must be 1469 * submitted before an attempt is started, if required. */ 1470 public $preflightcheckform; 1471 /** @var moodle_url $startattempturl URL for any Back to the course button. */ 1472 public $backtocourseurl; 1473 /** @var bool $showbacktocourse should we show a back to the course button? */ 1474 public $showbacktocourse; 1475 /** @var bool whether the attempt must take place in a popup window. */ 1476 public $popuprequired; 1477 /** @var array options to use for the popup window, if required. */ 1478 public $popupoptions; 1479 /** @var bool $quizhasquestions whether the quiz has any questions. */ 1480 public $quizhasquestions; 1481 1482 public function __get($field) { 1483 switch ($field) { 1484 case 'startattemptwarning': 1485 debugging('startattemptwarning has been deprecated. It is now always blank.'); 1486 return ''; 1487 1488 default: 1489 debugging('Unknown property ' . $field); 1490 return null; 1491 } 1492 } 1493 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
