e32132287022f75f7e169024666409edc24f9ff6
[moodle.git] / mod / quiz / renderer.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Defines the renderer for the quiz module.
19  *
20  * @package    mod
21  * @subpackage quiz
22  * @copyright  2011 The Open University
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 /**
28  * The renderer for the quiz module.
29  *
30  * @copyright  2011 The Open University
31  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32  */
33 class mod_quiz_renderer extends plugin_renderer_base {
34     /**
35      * Builds the review page
36      *
37      * @param quiz_attempt $attemptobj an instance of quiz_attempt.
38      * @param array $slots an array of intgers relating to questions.
39      * @param int $page the current page number
40      * @param bool $showall whether to show entire attempt on one page.
41      * @param bool $lastpage if true the current page is the last page.
42      * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options.
43      * @param array $summarydata contains all table data
44      * @return $output containing html data.
45      */
46     public function review_page(quiz_attempt $attemptobj, $slots, $page, $showall,
47                                 $lastpage, mod_quiz_display_options $displayoptions,
48                                 $summarydata) {
50         $output = '';
51         $output .= $this->header();
52         $output .= $this->review_summary_table($summarydata, $page);
53         $output .= $this->review_form($page, $showall, $displayoptions,
54                 $this->questions($attemptobj, true, $slots, $page, $showall, $displayoptions),
55                 $attemptobj, $showall);
57         $output .= $this->review_next_navigation($attemptobj, $page, $lastpage);
58         $output .= $this->footer();
59         return $output;
60     }
62     /**
63      * Renders the review question pop-up.
64      *
65      * @param quiz_attempt $attemptobj an instance of quiz_attempt.
66      * @param int $slot which question to display.
67      * @param int $seq which step of the question attempt to show. null = latest.
68      * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options.
69      * @param array $summarydata contains all table data
70      * @return $output containing html data.
71      */
72     public function review_question_page(quiz_attempt $attemptobj, $slot, $seq,
73             mod_quiz_display_options $displayoptions, $summarydata) {
75         $output = '';
76         $output .= $this->header();
77         $output .= $this->review_summary_table($summarydata, 0);
79         if (!is_null($seq)) {
80             $output .= $attemptobj->render_question_at_step($slot, $seq, true);
81         } else {
82             $output .= $attemptobj->render_question($slot, true);
83         }
85         $output .= $this->close_window_button();
86         $output .= $this->footer();
87         return $output;
88     }
90     /**
91      * Renders the review question pop-up.
92      *
93      * @param string $message Why the review is not allowed.
94      * @return string html to output.
95      */
96     public function review_question_not_allowed($message) {
97         $output = '';
98         $output .= $this->header();
99         $output .= $this->notification($message);
100         $output .= $this->close_window_button();
101         $output .= $this->footer();
102         return $output;
103     }
105     /**
106      * Filters the summarydata array.
107      *
108      * @param array $summarydata contains row data for table
109      * @param int $page the current page number
110      * @return $summarydata containing filtered row data
111      */
112     protected function filter_summary_table($summarydata, $page) {
113         if ($page == 0) {
114             return $summarydata;
115         }
117         // Only show some of summary table on subsequent pages.
118         foreach ($summarydata as $key => $rowdata) {
119             if (!in_array($key, array('user', 'attemptlist'))) {
120                 unset($summarydata[$key]);
121             }
122         }
124         return $summarydata;
125     }
127     /**
128      * Outputs the table containing data from summary data array
129      *
130      * @param array $summarydata contains row data for table
131      * @param int $page contains the current page number
132      */
133     public function review_summary_table($summarydata, $page) {
134         $summarydata = $this->filter_summary_table($summarydata, $page);
135         if (empty($summarydata)) {
136             return '';
137         }
139         $output = '';
140         $output .= html_writer::start_tag('table', array(
141                 'class' => 'generaltable generalbox quizreviewsummary'));
142         $output .= html_writer::start_tag('tbody');
143         foreach ($summarydata as $rowdata) {
144             if ($rowdata['title'] instanceof renderable) {
145                 $title = $this->render($rowdata['title']);
146             } else {
147                 $title = $rowdata['title'];
148             }
150             if ($rowdata['content'] instanceof renderable) {
151                 $content = $this->render($rowdata['content']);
152             } else {
153                 $content = $rowdata['content'];
154             }
156             $output .= html_writer::tag('tr',
157                 html_writer::tag('th', $title, array('class' => 'cell', 'scope' => 'row')) .
158                         html_writer::tag('td', $content, array('class' => 'cell'))
159             );
160         }
162         $output .= html_writer::end_tag('tbody');
163         $output .= html_writer::end_tag('table');
164         return $output;
165     }
167     /**
168      * Renders each question
169      *
170      * @param quiz_attempt $attemptobj instance of quiz_attempt
171      * @param bool $reviewing
172      * @param array $slots array of intgers relating to questions
173      * @param int $page current page number
174      * @param bool $showall if true shows attempt on single page
175      * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options
176      */
177     public function questions(quiz_attempt $attemptobj, $reviewing, $slots, $page, $showall,
178                               mod_quiz_display_options $displayoptions) {
179         $output = '';
180         foreach ($slots as $slot) {
181             $output .= $attemptobj->render_question($slot, $reviewing,
182                     $attemptobj->review_url($slot, $page, $showall));
183         }
184         return $output;
185     }
187     /**
188      * Renders the main bit of the review page.
189      *
190      * @param array $summarydata contain row data for table
191      * @param int $page current page number
192      * @param mod_quiz_display_options $displayoptions instance of mod_quiz_display_options
193      * @param $content contains each question
194      * @param quiz_attempt $attemptobj instance of quiz_attempt
195      * @param bool $showall if true display attempt on one page
196      */
197     public function review_form($summarydata, $page, $displayoptions, $content, $attemptobj,
198                                 $showall) {
199         if ($displayoptions->flags != question_display_options::EDITABLE) {
200             return $content;
201         }
203         $this->page->requires->js_init_call('M.mod_quiz.init_review_form', null, false,
204                 quiz_get_js_module());
206         $output = '';
207         $output .= html_writer::start_tag('form', array('action' => $attemptobj->review_url(0,
208                 $page, $showall), 'method' => 'post', 'class' => 'questionflagsaveform'));
209         $output .= html_writer::start_tag('div');
210         $output .= $content;
211         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey',
212                 'value' => sesskey()));
213         $output .= html_writer::start_tag('div', array('class' => 'submitbtns'));
214         $output .= html_writer::empty_tag('input', array('type' => 'submit',
215                 'class' => 'questionflagsavebutton', 'name' => 'savingflags',
216                 'value' => get_string('saveflags', 'question')));
217         $output .= html_writer::end_tag('div');
218         $output .= html_writer::end_tag('div');
219         $output .= html_writer::end_tag('form');
221         return $output;
222     }
224     /**
225      * Returns either a liink or button
226      *
227      * @param $url contains a url for the review link
228      */
229     public function finish_review_link($url) {
230         if ($this->page->pagelayout == 'popup') {
231             // In a 'secure' popup window.
232             $this->page->requires->js_init_call('M.mod_quiz.secure_window.init_close_button',
233                     array($url), quiz_get_js_module());
234             return html_writer::empty_tag('input', array('type' => 'button',
235                     'value' => get_string('finishreview', 'quiz'),
236                     'id' => 'secureclosebutton'));
237         } else {
238             return html_writer::link($url, get_string('finishreview', 'quiz'));
239         }
240     }
242     /**
243      * Creates a next page arrow or the finishing link
244      *
245      * @param quiz_attempt $attemptobj instance of quiz_attempt
246      * @param int $page the current page
247      * @param bool $lastpage if true current page is the last page
248      */
249     public function review_next_navigation(quiz_attempt $attemptobj, $page, $lastpage) {
250         if ($lastpage) {
251             $nav = $this->finish_review_link($attemptobj->view_url());
252         } else {
253             $nav = link_arrow_right(get_string('next'), $attemptobj->review_url(0, $page + 1));
254         }
255         return html_writer::tag('div', $nav, array('class' => 'submitbtns'));
256     }
258     /**
259      * Return the HTML of the quiz timer.
260      * @return string HTML content.
261      */
262     public function countdown_timer() {
263         return html_writer::tag('div', get_string('timeleft', 'quiz') .
264                 html_writer::tag('span', '', array('id' => 'quiz-time-left')),
265                 array('id' => 'quiz-timer'));
266     }
268     /**
269      * Create a preview link
270      *
271      * @param $url contains a url to the given page
272      */
273     public function restart_preview_button($url) {
274         return $this->single_button($url, get_string('startnewpreview', 'quiz'));
275     }
277     /**
278      * Outputs the navigation block panel
279      *
280      * @param quiz_nav_panel_base $panel instance of quiz_nav_panel_base
281      */
282     public function navigation_panel(quiz_nav_panel_base $panel) {
284         $output = '';
285         $userpicture = $panel->user_picture();
286         if ($userpicture) {
287             $output .= html_writer::tag('div', $this->render($userpicture),
288                     array('id' => 'user-picture', 'class' => 'clearfix'));
289         }
290         $output .= $panel->render_before_button_bits($this);
292         $output .= html_writer::start_tag('div', array('class' => 'qn_buttons'));
293         foreach ($panel->get_question_buttons() as $button) {
294             $output .= $this->render($button);
295         }
296         $output .= html_writer::end_tag('div');
298         $output .= html_writer::tag('div', $panel->render_end_bits($this),
299                 array('class' => 'othernav'));
301         $this->page->requires->js_init_call('M.mod_quiz.nav.init', null, false,
302                 quiz_get_js_module());
304         return $output;
305     }
307     /**
308      * Returns the quizzes navigation button
309      *
310      * @param quiz_nav_question_button $button
311      */
312     protected function render_quiz_nav_question_button(quiz_nav_question_button $button) {
313         $classes = array('qnbutton', $button->stateclass);
314         $attributes = array();
316         if ($button->currentpage) {
317             $classes[] = 'thispage';
318             $attributes[] = get_string('onthispage', 'quiz');
319         }
321         $attributes[] = $button->statestring;
323         // Flagged?
324         if ($button->flagged) {
325             $classes[] = 'flagged';
326             $flaglabel = get_string('flagged', 'question');
327         } else {
328             $flaglabel = '';
329         }
330         $attributes[] = html_writer::tag('span', $flaglabel, array('class' => 'flagstate'));
332         if (is_numeric($button->number)) {
333             $qnostring = 'questionnonav';
334         } else {
335             $qnostring = 'questionnonavinfo';
336         }
338         $a = new stdClass();
339         $a->number = $button->number;
340         $a->attributes = implode(' ', $attributes);
342         return html_writer::link($button->url,
343                 html_writer::tag('span', '', array('class' => 'thispageholder')) .
344                 html_writer::tag('span', '', array('class' => 'trafficlight')) .
345                 get_string($qnostring, 'quiz', $a),
346                 array('class' => implode(' ', $classes), 'id' => $button->id,
347                         'title' => $button->statestring));
348     }
350     /**
351      * outputs the link the other attempts.
352      *
353      * @param mod_quiz_links_to_other_attempts $links
354      */
355     protected function render_mod_quiz_links_to_other_attempts(
356             mod_quiz_links_to_other_attempts $links) {
357         $attemptlinks = array();
358         foreach ($links->links as $attempt => $url) {
359             if ($url) {
360                 $attemptlinks[] = html_writer::link($url, $attempt);
361             } else {
362                 $attemptlinks[] = html_writer::tag('strong', $attempt);
363             }
364         }
365         return implode(', ', $attemptlinks);
366     }
368     /**
369      * Attempt Page
370      *
371      * @param quiz_attempt $attemptobj Instance of quiz_attempt
372      * @param int $page Current page number
373      * @param quiz_access_manager $accessmanager Instance of quiz_access_manager
374      * @param array $messages An array of messages
375      * @param array $slots Contains an array of integers that relate to questions
376      * @param int $id The ID of an attempt
377      * @param int $nextpage The number of the next page
378      */
379     public function attempt_page($attemptobj, $page, $accessmanager, $messages, $slots, $id,
380             $nextpage) {
381         $output = '';
382         $output .= $this->quiz_notices($messages);
383         $output .= $this->attempt_form($attemptobj, $page, $slots, $id, $nextpage);
384         return $output;
385     }
387     /**
388      * Returns any notices.
389      *
390      * @param array $messages
391      */
392     public function quiz_notices($messages) {
393         if (!$messages) {
394             return '';
395         }
396         return $this->box($this->heading(get_string('accessnoticesheader', 'quiz'), 3) .
397                 $this->access_messages($messages), 'quizaccessnotices');
398     }
400     /**
401      * Ouputs the form for making an attempt
402      *
403      * @param quiz_attempt $attemptobj
404      * @param int $page Current page number
405      * @param array $slots Array of integers relating to questions
406      * @param int $id ID of the attempt
407      * @param int $nextpage Next page number
408      */
409     public function attempt_form($attemptobj, $page, $slots, $id, $nextpage) {
410         $output = '';
412         //Start Form
413         $output .= html_writer::start_tag('form',
414                 array('action' => $attemptobj->processattempt_url(), 'method' => 'post',
415                 'enctype' => 'multipart/form-data', 'accept-charset' => 'utf-8',
416                 'id' => 'responseform'));
417         $output .= html_writer::start_tag('div');
419         // Print all the questions
420         foreach ($slots as $slot) {
421             $output .= $attemptobj->render_question($slot, false, $attemptobj->attempt_url($id,
422                     $page));
423         }
425         $output .= html_writer::start_tag('div', array('class' => 'submitbtns'));
426         $output .= html_writer::empty_tag('input', array('type' => 'submit', 'name' => 'next',
427                 'value' => get_string('next')));
428         $output .= html_writer::end_tag('div');
430         // Some hidden fields to trach what is going on.
431         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'attempt',
432                 'value' => $attemptobj->get_attemptid()));
433         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'thispage',
434                 'value' => $page, 'id' => 'followingpage'));
435         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'nextpage',
436                 'value' => $nextpage));
437         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'timeup',
438                 'value' => '0', 'id' => 'timeup'));
439         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey',
440                 'value' => sesskey()));
441         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'scrollpos',
442                 'value' => '', 'id' => 'scrollpos'));
444         // Add a hidden field with questionids. Do this at the end of the form, so
445         // if you navigate before the form has finished loading, it does not wipe all
446         // the student's answers.
447         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'slots',
448                 'value' => implode(',', $slots)));
450         //Finish form
451         $output .= html_writer::end_tag('div');
452         $output .= html_writer::end_tag('form');
454         return $output;
455     }
457     /**
458      * Print each message in an array, surrounded by &lt;p>, &lt;/p> tags.
459      *
460      * @param array $messages the array of message strings.
461      * @param bool $return if true, return a string, instead of outputting.
462      *
463      * @return mixed, if $return is true, return the string that would have been output, otherwise
464      * return null.
465      */
466     public function access_messages($messages) {
467         $output = '';
468         foreach ($messages as $message) {
469             $output .= html_writer::tag('p', $message) . "\n";
470         }
471         return $output;
472     }
474     /*
475      * Summary Page
476      */
477     /**
478      * Create the summary page
479      *
480      * @param quiz_attempt $attemptobj
481      * @param mod_quiz_display_options $displayoptions
482      */
483     public function summary_page($attemptobj, $displayoptions) {
484         $output = '';
485         $output .= $this->summary_table($attemptobj, $displayoptions);
486         $output .= $this->summary_page_controls($attemptobj);
487         return $output;
488     }
490     /**
491      * Generates the table of summarydata
492      *
493      * @param quiz_attempt $attemptobj
494      * @param mod_quiz_display_options $displayoptions
495      */
496     public function summary_table($attemptobj, $displayoptions) {
497         // Prepare the summary table header
498         $table = new html_table();
499         $table->attributes['class'] = 'generaltable quizsummaryofattempt boxaligncenter';
500         $table->head = array(get_string('question', 'quiz'), get_string('status', 'quiz'));
501         $table->align = array('left', 'left');
502         $table->size = array('', '');
503         $markscolumn = $displayoptions->marks >= question_display_options::MARK_AND_MAX;
504         if ($markscolumn) {
505             $table->head[] = get_string('marks', 'quiz');
506             $table->align[] = 'left';
507             $table->size[] = '';
508         }
509         $table->data = array();
511         // Get the summary info for each question.
512         $slots = $attemptobj->get_slots();
513         foreach ($slots as $slot) {
514             if (!$attemptobj->is_real_question($slot)) {
515                 continue;
516             }
517             $flag = '';
518             if ($attemptobj->is_question_flagged($slot)) {
519                 $flag = html_writer::empty_tag('img', array('src' => $this->pix_url('i/flagged'),
520                         'alt' => get_string('flagged', 'question'), 'class' => 'questionflag'));
521             }
522             $row = array(html_writer::link($attemptobj->attempt_url($slot),
523                     $attemptobj->get_question_number($slot) . $flag),
524                     $attemptobj->get_question_status($slot, $displayoptions->correctness));
525             if ($markscolumn) {
526                 $row[] = $attemptobj->get_question_mark($slot);
527             }
528             $table->data[] = $row;
529             $table->rowclasses[] = $attemptobj->get_question_state_class(
530                     $slot, $displayoptions->correctness);
531         }
533         // Print the summary table.
534         $output = html_writer::table($table);
536         return $output;
537     }
539     /**
540      * Creates any controls a the page should have.
541      *
542      * @param quiz_attempt $attemptobj
543      */
544     public function summary_page_controls($attemptobj) {
545         $output = '';
546         // countdown timer
547         $output .= $this->countdown_timer();
549         // Finish attempt button.
550         $options = array(
551             'attempt' => $attemptobj->get_attemptid(),
552             'finishattempt' => 1,
553             'timeup' => 0,
554             'slots' => '',
555             'sesskey' => sesskey(),
556         );
558         $button = new single_button(
559                 new moodle_url($attemptobj->processattempt_url(), $options),
560                 get_string('submitallandfinish', 'quiz'));
561         $button->id = 'responseform';
562         $button->add_action(new confirm_action(get_string('confirmclose', 'quiz'), null,
563                 get_string('submitallandfinish', 'quiz')));
565         $output .= $this->container($this->container($this->render($button),
566                 'controls'), 'submitbtns mdl-align');
568         return $output;
569     }
571     /*
572      * View Page
573      */
574     /**
575      * Generates the view page
576      *
577      * @param int $course The id of the course
578      * @param array $quiz Array conting quiz data
579      * @param int $cm Course Module ID
580      * @param int $context The page context ID
581      * @param array $infomessages information about this quiz
582      * @param mod_quiz_view_object $viewobj
583      * @param string $buttontext text for the start/continue attempt button, if
584      *      it should be shown.
585      * @param array $infomessages further information about why the student cannot
586      *      attempt this quiz now, if appicable this quiz
587      */
588     public function view_page($course, $quiz, $cm, $context, $infomessages, $viewobj,
589             $buttontext, $preventmessages) {
590         $output = '';
591         $output .= $this->view_information($course, $quiz, $cm, $context, $infomessages);
592         $output .= $this->view_table($quiz, $context, $viewobj);
593         $output .= $this->view_best_score($viewobj);
594         $output .= $this->view_result_info($quiz, $context, $cm, $viewobj);
595         $output .= $this->view_attempt_button($course, $quiz, $cm, $context, $viewobj,
596                 $buttontext, $preventmessages);
597         return $output;
598     }
600     /**
601      * Outputs an error message for any guests accessing the quiz
602      *
603      * @param int $course The course ID
604      * @param array $quiz Array contingin quiz data
605      * @param int $cm Course Module ID
606      * @param int $context The page contect ID
607      * @param array $messages Array containing any messages
608      */
609     public function view_page_guest($course, $quiz, $cm, $context, $messages) {
610         $output = '';
611         $output .= $this->view_information($course, $quiz, $cm, $context, $messages);
612         $guestno = html_writer::tag('p', get_string('guestsno', 'quiz'));
613         $liketologin = html_writer::tag('p', get_string('liketologin'));
614         $output .= $this->confirm($guestno.'\n\n'.$liketologin.'\n', get_login_url(),
615                 get_referer(false));
616         return $output;
617     }
619     /**
620      * Outputs and error message for anyone who is not enrolle don the course
621      *
622      * @param int $course The course ID
623      * @param array $quiz Array contingin quiz data
624      * @param int $cm Course Module ID
625      * @param int $context The page contect ID
626      * @param array $messages Array containing any messages
627      */
628     public function view_page_notenrolled($course, $quiz, $cm, $context, $messages) {
629         global $CFG;
630         $output = '';
631         $output .= $this->view_information($course, $quiz, $cm, $context, $messages);
632         $youneedtoenrol = html_writer::tag('p', get_string('youneedtoenrol', 'quiz'));
633         $button = html_writer::tag('p',
634                 $this->continue_button($CFG->wwwroot . '/course/view.php?id=' . $course->id));
635         $output .= $this->box($youneedtoenrol.'\n\n'.$button.'\n', 'generalbox', 'notice');
636         return $output;
637     }
639     /**
640      * Output the page information
641      *
642      * @param int $course The course ID
643      * @param array $quiz Array contingin quiz data
644      * @param int $cm Course Module ID
645      * @param int $context The page contect ID
646      * @param array $messages Array containing any messages
647      */
648     public function view_information($course, $quiz, $cm, $context, $messages) {
649         global $CFG;
650         $output = '';
651         // Print quiz name and description
652         $output .= $this->heading(format_string($quiz->name));
653         if (trim(strip_tags($quiz->intro))) {
654             $output .= $this->box(format_module_intro('quiz', $quiz, $cm->id), 'generalbox',
655                     'intro');
656         }
658         $output .= $this->box($this->access_messages($messages), 'quizinfo');
660         // Show number of attempts summary to those who can view reports.
661         if (has_capability('mod/quiz:viewreports', $context)) {
662             if ($strattemptnum = $this->quiz_attempt_summary_link_to_reports($quiz, $cm,
663                     $context)) {
664                 $output .= html_writer::tag('div', $strattemptnum,
665                         array('class' => 'quizattemptcounts'));
666             }
667         }
668         return $output;
669     }
671     /**
672      * Generates the table heading.
673      */
674     public function view_table_heading() {
675         return $this->heading(get_string('summaryofattempts', 'quiz'));
676     }
678     /**
679      * Generates the table of data
680      *
681      * @param array $quiz Array contining quiz data
682      * @param int $context The page context ID
683      * @param mod_quiz_view_object $viewobj
684      */
685     public function view_table($quiz, $context, $viewobj) {
686         $output = '';
687         if (!$viewobj->attempts) {
688             return $output;
689         }
690         $output .= $this->view_table_heading();
692         // Prepare table header
693         $table = new html_table();
694         $table->attributes['class'] = 'generaltable quizattemptsummary';
695         $table->head = array();
696         $table->align = array();
697         $table->size = array();
698         if ($viewobj->attemptcolumn) {
699             $table->head[] = get_string('attemptnumber', 'quiz');
700             $table->align[] = 'center';
701             $table->size[] = '';
702         }
703         $table->head[] = get_string('timecompleted', 'quiz');
704         $table->align[] = 'left';
705         $table->size[] = '';
706         if ($viewobj->markcolumn) {
707             $table->head[] = get_string('marks', 'quiz') . ' / ' .
708                     quiz_format_grade($quiz, $quiz->sumgrades);
709             $table->align[] = 'center';
710             $table->size[] = '';
711         }
712         if ($viewobj->gradecolumn) {
713             $table->head[] = get_string('grade') . ' / ' .
714                     quiz_format_grade($quiz, $quiz->grade);
715             $table->align[] = 'center';
716             $table->size[] = '';
717         }
718         if ($viewobj->canreviewmine) {
719             $table->head[] = get_string('review', 'quiz');
720             $table->align[] = 'center';
721             $table->size[] = '';
722         }
723         if ($viewobj->feedbackcolumn) {
724             $table->head[] = get_string('feedback', 'quiz');
725             $table->align[] = 'left';
726             $table->size[] = '';
727         }
728         if (isset($quiz->showtimetaken)) {
729             $table->head[] = get_string('timetaken', 'quiz');
730             $table->align[] = 'left';
731             $table->size[] = '';
732         }
734         // One row for each attempt
735         foreach ($viewobj->attempts as $attempt) {
736             $attemptoptions = quiz_get_review_options($quiz, $attempt, $context);
737             $row = array();
739             // Add the attempt number, making it a link, if appropriate.
740             if ($viewobj->attemptcolumn) {
741                 if ($attempt->preview) {
742                     $row[] = get_string('preview', 'quiz');
743                 } else {
744                     $row[] = $attempt->attempt;
745                 }
746             }
748             // prepare strings for time taken and date completed
749             $timetaken = '';
750             $datecompleted = '';
751             if ($attempt->timefinish > 0) {
752                 // attempt has finished
753                 $timetaken = format_time($attempt->timefinish - $attempt->timestart);
754                 $datecompleted = userdate($attempt->timefinish);
755             } else if (!$quiz->timeclose || $viewobj->timenow < $quiz->timeclose) {
756                 // The attempt is still in progress.
757                 $timetaken = format_time($viewobj->timenow - $attempt->timestart);
758                 $datecompleted = get_string('inprogress', 'quiz');
759             } else {
760                 $timetaken = format_time($quiz->timeclose - $attempt->timestart);
761                 $datecompleted = userdate($quiz->timeclose);
762             }
763             $row[] = $datecompleted;
765             if ($viewobj->markcolumn && $attempt->timefinish > 0) {
766                 if ($attemptoptions->marks >= question_display_options::MARK_AND_MAX) {
767                     $row[] = quiz_format_grade($quiz, $attempt->sumgrades);
768                 } else {
769                     $row[] = '';
770                 }
771             }
773             // Ouside the if because we may be showing feedback but not grades.
774             $attemptgrade = quiz_rescale_grade($attempt->sumgrades, $quiz, false);
776             if ($viewobj->gradecolumn) {
777                 if ($attemptoptions->marks >= question_display_options::MARK_AND_MAX &&
778                         $attempt->timefinish > 0) {
779                     $formattedgrade = quiz_format_grade($quiz, $attemptgrade);
780                     // highlight the highest grade if appropriate
781                     if ($viewobj->overallstats && !$attempt->preview
782                             && $viewobj->numattempts > 1 && !is_null($viewobj->mygrade)
783                             && $attemptgrade == $viewobj->mygrade
784                             && $quiz->grademethod == QUIZ_GRADEHIGHEST) {
785                         $table->rowclasses[$attempt->attempt] = 'bestrow';
786                     }
788                     $row[] = $formattedgrade;
789                 } else {
790                     $row[] = '';
791                 }
792             }
794             if ($viewobj->canreviewmine) {
795                 $row[] = $viewobj->accessmanager->make_review_link($attempt,
796                         $viewobj->canpreview, $attemptoptions);
797             }
799             if ($viewobj->feedbackcolumn && $attempt->timefinish > 0) {
800                 if ($attemptoptions->overallfeedback) {
801                     $row[] = quiz_feedback_for_grade($attemptgrade, $quiz, $context);
802                 } else {
803                     $row[] = '';
804                 }
805             }
807             if (isset($quiz->showtimetaken)) {
808                 $row[] = $timetaken;
809             }
811             if ($attempt->preview) {
812                 $table->data['preview'] = $row;
813             } else {
814                 $table->data[$attempt->attempt] = $row;
815             }
816         } // End of loop over attempts.
817         $output .= html_writer::table($table);
819         return $output;
820     }
822     /**
823      * Prints the students best score
824      *
825      * @param mod_quiz_view_object $viewobj
826      */
827     public function view_best_score($viewobj) {
828         $output = '';
829         // Print information about the student's best score for this quiz if possible.
830         if (!$viewobj->moreattempts) {
831             $output .= $this->heading(get_string('nomoreattempts', 'quiz'));
832         }
833         return $output;
834     }
836     /**
837      * Generates data pertaining to quiz results
838      *
839      * @param array $quiz Array containing quiz data
840      * @param int $context The page context ID
841      * @param int $cm The Course Module Id
842      * @param mod_quiz_view_object $viewobj
843      */
844     public function view_result_info($quiz, $context, $cm, $viewobj) {
845         $output = '';
846         if (!$viewobj->numattempts && !$viewobj->gradecolumn && is_null($viewobj->mygrade)) {
847             return $output;
848         }
849         $resultinfo = '';
851         if ($viewobj->overallstats) {
852             if ($viewobj->moreattempts) {
853                 $a = new stdClass();
854                 $a->method = quiz_get_grading_option_name($quiz->grademethod);
855                 $a->mygrade = quiz_format_grade($quiz, $viewobj->mygrade);
856                 $a->quizgrade = quiz_format_grade($quiz, $quiz->grade);
857                 $resultinfo .= $this->heading(get_string('gradesofar', 'quiz', $a), 2, 'main');
858             } else {
859                 $a = new stdClass();
860                 $a->grade = quiz_format_grade($quiz, $viewobj->mygrade);
861                 $a->maxgrade = quiz_format_grade($quiz, $quiz->grade);
862                 $a = get_string('outofshort', 'quiz', $a);
863                 $resultinfo .= $this->heading(get_string('yourfinalgradeis', 'quiz', $a), 2,
864                         'main');
865             }
866         }
868         if ($viewobj->mygradeoverridden) {
870             $resultinfo .= html_writer::tag('p', get_string('overriddennotice', 'grades'),
871                     array('class' => 'overriddennotice')).'\n';
872         }
873         if ($viewobj->gradebookfeedback) {
874             $resultinfo .= $this->heading(get_string('comment', 'quiz'), 3, 'main');
875             $resultinfo .= '<p class="quizteacherfeedback">'.$viewobj->gradebookfeedback.
876                     "</p>\n";
877         }
878         if ($viewobj->feedbackcolumn) {
879             $resultinfo .= $this->heading(get_string('overallfeedback', 'quiz'), 3, 'main');
880             $resultinfo .= html_writer::tag('p',
881                     quiz_feedback_for_grade($viewobj->mygrade, $quiz, $context),
882                     array('class' => 'quizgradefeedback')).'\n';
883         }
885         if ($resultinfo) {
886             $output .= $this->box($resultinfo, 'generalbox', 'feedback');
887         }
888         return $output;
889     }
891     /**
892      * Generates the view attempt button
893      *
894      * @param int $course The course ID
895      * @param array $quiz Array containging quiz date
896      * @param int $cm The Course Module ID
897      * @param int $context The page Context ID
898      * @param mod_quiz_view_object $viewobj
899      * @param string $buttontext
900      */
901     public function view_attempt_button($course, $quiz, $cm, $context, $viewobj,
902             $buttontext, $preventmessages) {
903         $output = '';
904         // Determine if we should be showing a start/continue attempt button,
905         // or a button to go back to the course page.
906         $output .= $this->box_start('quizattempt');
908         // Now actually print the appropriate button.
909         if (!quiz_clean_layout($quiz->questions, true)) {
910             $output .= quiz_no_questions_message($quiz, $cm, $context);
911         }
913         if ($preventmessages) {
914             $output .= $this->access_messages($preventmessages);
915         }
917         if ($buttontext) {
918             $output .= $viewobj->accessmanager->print_start_attempt_button($viewobj->canpreview,
919                     $buttontext, $viewobj->unfinished);
920         } else if ($buttontext === '') {
921             $output .= $this->single_button(new moodle_url('/course/view.php',
922                     array('id' => $course->id)), get_string('backtocourse', 'quiz'), 'get',
923                     array('class' => 'continuebutton'));
924         }
925         $output .= $this->box_end();
927         return $output;
928     }
930     /**
931      * Returns the same as {@link quiz_num_attempt_summary()} but wrapped in a link
932      * to the quiz reports.
933      *
934      * @param object $quiz the quiz object. Only $quiz->id is used at the moment.
935      * @param object $cm the cm object. Only $cm->course, $cm->groupmode and $cm->groupingid
936      * fields are used at the moment.
937      * @param object $context the quiz context.
938      * @param bool $returnzero if false (default), when no attempts have been made '' is returned
939      * instead of 'Attempts: 0'.
940      * @param int $currentgroup if there is a concept of current group where this method is being
941      * called
942      *         (e.g. a report) pass it in here. Default 0 which means no current group.
943      * @return string HTML fragment for the link.
944      */
945     public function quiz_attempt_summary_link_to_reports($quiz, $cm, $context,
946                                                           $returnzero = false, $currentgroup = 0) {
947         global $CFG;
948         $summary = quiz_num_attempt_summary($quiz, $cm, $returnzero, $currentgroup);
949         if (!$summary) {
950             return '';
951         }
953         require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php');
954         $url = new moodle_url('/mod/quiz/report.php', array(
955                 'id' => $cm->id, 'mode' => quiz_report_default_report($context)));
956         return html_writer::link($url, $summary);
957     }
960 class mod_quiz_links_to_other_attempts implements renderable {
961     /**
962      * @var array string attempt number => url, or null for the current attempt.
963      */
964     public $links = array();
967 class mod_quiz_view_object {
968     /**
969      * @var array $attempt contains all the user's attempts at this quiz.
970      */
971     public $attempts;
972     /**
973      * @var object $accessmanager contains various access rules.
974      */
975     public $accessmanager;
976     /**
977      * @var int $canattempt determins capability for attempting a quiz.
978      */
979     public $canattempt;
980     /**
981      * @var int $canpreview determins capability for previewing a quiz.
982      */
983     public $canpreview;
984     /**
985      * @var int $canreviewmine determins capability for reviwing own quiz.
986      */
987     public $canreviewmine;
988     /**
989      * @var int $attemptcolumn contains the number of attempts done.
990      */
991     public $attemptcolumn;
992     /**
993      * @var int $gradecolumn contains the grades of any attempts.
994      */
995     public $gradecolumn;
996     /**
997      * @var int $markcolumn contains the marks of any attempt.
998      */
999     public $markcolumn;
1000     /**
1001      * @var int $overallstats contains all marks for any attempt.
1002      */
1003     public $overallstats;
1004     /**
1005      * @var string $feedbackcolumn contains any feedback for and attempt.
1006      */
1007     public $feedbackcolumn;
1008     /**
1009      * @var string $timenow contains a timestamp in string format.
1010      */
1011     public $timenow;
1012     /**
1013      * @var int $numattempts contains the total number of attempts.
1014      */
1015     public $numattempts;
1016     /**
1017      * @var int $mygrade contains the current users final grade for a quiz.
1018      */
1019     public $mygrade;
1020     /**
1021      * @var int $moreattempts total attempts left.
1022      */
1023     public $moreattempts;
1024     /**
1025      * @var int $mygradeoverridden contains an overriden grade.
1026      */
1027     public $mygradeoverridden;
1028     /**
1029      * @var string $gradebookfeedback contains any feedback for a gradebook.
1030      */
1031     public $gradebookfeedback;
1032     /**
1033      * @var int $unfinished contains 1 if an attempt is unfinished.
1034      */
1035     public $unfinished;
1036     /**
1037      * @var int $lastfinishedattempt contains a pointer to the last attempt in the attempts array.
1038      */
1039     public $lastfinishedattempt;