Merge branch 'MDL-29144' of git://github.com/timhunt/moodle
[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);
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($page, $showall, $displayoptions, $content, $attemptobj) {
198         if ($displayoptions->flags != question_display_options::EDITABLE) {
199             return $content;
200         }
202         $this->page->requires->js_init_call('M.mod_quiz.init_review_form', null, false,
203                 quiz_get_js_module());
205         $output = '';
206         $output .= html_writer::start_tag('form', array('action' => $attemptobj->review_url(null,
207                 $page, $showall), 'method' => 'post', 'class' => 'questionflagsaveform'));
208         $output .= html_writer::start_tag('div');
209         $output .= $content;
210         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey',
211                 'value' => sesskey()));
212         $output .= html_writer::start_tag('div', array('class' => 'submitbtns'));
213         $output .= html_writer::empty_tag('input', array('type' => 'submit',
214                 'class' => 'questionflagsavebutton', 'name' => 'savingflags',
215                 'value' => get_string('saveflags', 'question')));
216         $output .= html_writer::end_tag('div');
217         $output .= html_writer::end_tag('div');
218         $output .= html_writer::end_tag('form');
220         return $output;
221     }
223     /**
224      * Returns either a liink or button
225      *
226      * @param $url contains a url for the review link
227      */
228     public function finish_review_link($url) {
229         if ($this->page->pagelayout == 'popup') {
230             // In a 'secure' popup window.
231             $this->page->requires->js_init_call('M.mod_quiz.secure_window.init_close_button',
232                     array($url), quiz_get_js_module());
233             return html_writer::empty_tag('input', array('type' => 'button',
234                     'value' => get_string('finishreview', 'quiz'),
235                     'id' => 'secureclosebutton'));
236         } else {
237             return html_writer::link($url, get_string('finishreview', 'quiz'));
238         }
239     }
241     /**
242      * Creates a next page arrow or the finishing link
243      *
244      * @param quiz_attempt $attemptobj instance of quiz_attempt
245      * @param int $page the current page
246      * @param bool $lastpage if true current page is the last page
247      */
248     public function review_next_navigation(quiz_attempt $attemptobj, $page, $lastpage) {
249         if ($lastpage) {
250             $nav = $this->finish_review_link($attemptobj->view_url());
251         } else {
252             $nav = link_arrow_right(get_string('next'), $attemptobj->review_url(null, $page + 1));
253         }
254         return html_writer::tag('div', $nav, array('class' => 'submitbtns'));
255     }
257     /**
258      * Return the HTML of the quiz timer.
259      * @return string HTML content.
260      */
261     public function countdown_timer() {
262         return html_writer::tag('div', get_string('timeleft', 'quiz') .
263                 html_writer::tag('span', '', array('id' => 'quiz-time-left')),
264                 array('id' => 'quiz-timer'));
265     }
267     /**
268      * Create a preview link
269      *
270      * @param $url contains a url to the given page
271      */
272     public function restart_preview_button($url) {
273         return $this->single_button($url, get_string('startnewpreview', 'quiz'));
274     }
276     /**
277      * Outputs the navigation block panel
278      *
279      * @param quiz_nav_panel_base $panel instance of quiz_nav_panel_base
280      */
281     public function navigation_panel(quiz_nav_panel_base $panel) {
283         $output = '';
284         $userpicture = $panel->user_picture();
285         if ($userpicture) {
286             $output .= html_writer::tag('div', $this->render($userpicture),
287                     array('id' => 'user-picture', 'class' => 'clearfix'));
288         }
289         $output .= $panel->render_before_button_bits($this);
291         $output .= html_writer::start_tag('div', array('class' => 'qn_buttons'));
292         foreach ($panel->get_question_buttons() as $button) {
293             $output .= $this->render($button);
294         }
295         $output .= html_writer::end_tag('div');
297         $output .= html_writer::tag('div', $panel->render_end_bits($this),
298                 array('class' => 'othernav'));
300         $this->page->requires->js_init_call('M.mod_quiz.nav.init', null, false,
301                 quiz_get_js_module());
303         return $output;
304     }
306     /**
307      * Returns the quizzes navigation button
308      *
309      * @param quiz_nav_question_button $button
310      */
311     protected function render_quiz_nav_question_button(quiz_nav_question_button $button) {
312         $classes = array('qnbutton', $button->stateclass);
313         $attributes = array();
315         if ($button->currentpage) {
316             $classes[] = 'thispage';
317             $attributes[] = get_string('onthispage', 'quiz');
318         }
320         // Flagged?
321         if ($button->flagged) {
322             $classes[] = 'flagged';
323             $flaglabel = get_string('flagged', 'question');
324         } else {
325             $flaglabel = '';
326         }
327         $attributes[] = html_writer::tag('span', $flaglabel, array('class' => 'flagstate'));
329         if (is_numeric($button->number)) {
330             $qnostring = 'questionnonav';
331         } else {
332             $qnostring = 'questionnonavinfo';
333         }
335         $a = new stdClass();
336         $a->number = $button->number;
337         $a->attributes = implode(' ', $attributes);
339         return html_writer::link($button->url,
340                 html_writer::tag('span', '', array('class' => 'thispageholder')) .
341                 html_writer::tag('span', '', array('class' => 'trafficlight')) .
342                 get_string($qnostring, 'quiz', $a),
343                 array('class' => implode(' ', $classes), 'id' => $button->id,
344                         'title' => $button->statestring));
345     }
347     /**
348      * outputs the link the other attempts.
349      *
350      * @param mod_quiz_links_to_other_attempts $links
351      */
352     protected function render_mod_quiz_links_to_other_attempts(
353             mod_quiz_links_to_other_attempts $links) {
354         $attemptlinks = array();
355         foreach ($links->links as $attempt => $url) {
356             if ($url) {
357                 $attemptlinks[] = html_writer::link($url, $attempt);
358             } else {
359                 $attemptlinks[] = html_writer::tag('strong', $attempt);
360             }
361         }
362         return implode(', ', $attemptlinks);
363     }
365     /**
366      * Attempt Page
367      *
368      * @param quiz_attempt $attemptobj Instance of quiz_attempt
369      * @param int $page Current page number
370      * @param quiz_access_manager $accessmanager Instance of quiz_access_manager
371      * @param array $messages An array of messages
372      * @param array $slots Contains an array of integers that relate to questions
373      * @param int $id The ID of an attempt
374      * @param int $nextpage The number of the next page
375      */
376     public function attempt_page($attemptobj, $page, $accessmanager, $messages, $slots, $id,
377             $nextpage) {
378         $output = '';
379         $output .= $this->quiz_notices($messages);
380         $output .= $this->attempt_form($attemptobj, $page, $slots, $id, $nextpage);
381         return $output;
382     }
384     /**
385      * Returns any notices.
386      *
387      * @param array $messages
388      */
389     public function quiz_notices($messages) {
390         if (!$messages) {
391             return '';
392         }
393         return $this->box($this->heading(get_string('accessnoticesheader', 'quiz'), 3) .
394                 $this->access_messages($messages), 'quizaccessnotices');
395     }
397     /**
398      * Ouputs the form for making an attempt
399      *
400      * @param quiz_attempt $attemptobj
401      * @param int $page Current page number
402      * @param array $slots Array of integers relating to questions
403      * @param int $id ID of the attempt
404      * @param int $nextpage Next page number
405      */
406     public function attempt_form($attemptobj, $page, $slots, $id, $nextpage) {
407         $output = '';
409         //Start Form
410         $output .= html_writer::start_tag('form',
411                 array('action' => $attemptobj->processattempt_url(), 'method' => 'post',
412                 'enctype' => 'multipart/form-data', 'accept-charset' => 'utf-8',
413                 'id' => 'responseform'));
414         $output .= html_writer::start_tag('div');
416         // Print all the questions
417         foreach ($slots as $slot) {
418             $output .= $attemptobj->render_question($slot, false,
419                     $attemptobj->attempt_url($slot, $page));
420         }
422         $output .= html_writer::start_tag('div', array('class' => 'submitbtns'));
423         $output .= html_writer::empty_tag('input', array('type' => 'submit', 'name' => 'next',
424                 'value' => get_string('next')));
425         $output .= html_writer::end_tag('div');
427         // Some hidden fields to trach what is going on.
428         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'attempt',
429                 'value' => $attemptobj->get_attemptid()));
430         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'thispage',
431                 'value' => $page, 'id' => 'followingpage'));
432         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'nextpage',
433                 'value' => $nextpage));
434         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'timeup',
435                 'value' => '0', 'id' => 'timeup'));
436         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'sesskey',
437                 'value' => sesskey()));
438         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'scrollpos',
439                 'value' => '', 'id' => 'scrollpos'));
441         // Add a hidden field with questionids. Do this at the end of the form, so
442         // if you navigate before the form has finished loading, it does not wipe all
443         // the student's answers.
444         $output .= html_writer::empty_tag('input', array('type' => 'hidden', 'name' => 'slots',
445                 'value' => implode(',', $slots)));
447         //Finish form
448         $output .= html_writer::end_tag('div');
449         $output .= html_writer::end_tag('form');
451         return $output;
452     }
454     /**
455      * Print each message in an array, surrounded by &lt;p>, &lt;/p> tags.
456      *
457      * @param array $messages the array of message strings.
458      * @param bool $return if true, return a string, instead of outputting.
459      *
460      * @return mixed, if $return is true, return the string that would have been output, otherwise
461      * return null.
462      */
463     public function access_messages($messages) {
464         $output = '';
465         foreach ($messages as $message) {
466             $output .= html_writer::tag('p', $message) . "\n";
467         }
468         return $output;
469     }
471     /*
472      * Summary Page
473      */
474     /**
475      * Create the summary page
476      *
477      * @param quiz_attempt $attemptobj
478      * @param mod_quiz_display_options $displayoptions
479      */
480     public function summary_page($attemptobj, $displayoptions) {
481         $output = '';
482         $output .= $this->summary_table($attemptobj, $displayoptions);
483         $output .= $this->summary_page_controls($attemptobj);
484         return $output;
485     }
487     /**
488      * Generates the table of summarydata
489      *
490      * @param quiz_attempt $attemptobj
491      * @param mod_quiz_display_options $displayoptions
492      */
493     public function summary_table($attemptobj, $displayoptions) {
494         // Prepare the summary table header
495         $table = new html_table();
496         $table->attributes['class'] = 'generaltable quizsummaryofattempt boxaligncenter';
497         $table->head = array(get_string('question', 'quiz'), get_string('status', 'quiz'));
498         $table->align = array('left', 'left');
499         $table->size = array('', '');
500         $markscolumn = $displayoptions->marks >= question_display_options::MARK_AND_MAX;
501         if ($markscolumn) {
502             $table->head[] = get_string('marks', 'quiz');
503             $table->align[] = 'left';
504             $table->size[] = '';
505         }
506         $table->data = array();
508         // Get the summary info for each question.
509         $slots = $attemptobj->get_slots();
510         foreach ($slots as $slot) {
511             if (!$attemptobj->is_real_question($slot)) {
512                 continue;
513             }
514             $flag = '';
515             if ($attemptobj->is_question_flagged($slot)) {
516                 $flag = html_writer::empty_tag('img', array('src' => $this->pix_url('i/flagged'),
517                         'alt' => get_string('flagged', 'question'), 'class' => 'questionflag'));
518             }
519             $row = array(html_writer::link($attemptobj->attempt_url($slot),
520                     $attemptobj->get_question_number($slot) . $flag),
521                     $attemptobj->get_question_status($slot, $displayoptions->correctness));
522             if ($markscolumn) {
523                 $row[] = $attemptobj->get_question_mark($slot);
524             }
525             $table->data[] = $row;
526             $table->rowclasses[] = $attemptobj->get_question_state_class(
527                     $slot, $displayoptions->correctness);
528         }
530         // Print the summary table.
531         $output = html_writer::table($table);
533         return $output;
534     }
536     /**
537      * Creates any controls a the page should have.
538      *
539      * @param quiz_attempt $attemptobj
540      */
541     public function summary_page_controls($attemptobj) {
542         $output = '';
543         // countdown timer
544         $output .= $this->countdown_timer();
546         // Finish attempt button.
547         $options = array(
548             'attempt' => $attemptobj->get_attemptid(),
549             'finishattempt' => 1,
550             'timeup' => 0,
551             'slots' => '',
552             'sesskey' => sesskey(),
553         );
555         $button = new single_button(
556                 new moodle_url($attemptobj->processattempt_url(), $options),
557                 get_string('submitallandfinish', 'quiz'));
558         $button->id = 'responseform';
559         $button->add_action(new confirm_action(get_string('confirmclose', 'quiz'), null,
560                 get_string('submitallandfinish', 'quiz')));
562         $output .= $this->container($this->container($this->render($button),
563                 'controls'), 'submitbtns mdl-align');
565         return $output;
566     }
568     /*
569      * View Page
570      */
571     /**
572      * Generates the view page
573      *
574      * @param int $course The id of the course
575      * @param array $quiz Array conting quiz data
576      * @param int $cm Course Module ID
577      * @param int $context The page context ID
578      * @param array $infomessages information about this quiz
579      * @param mod_quiz_view_object $viewobj
580      * @param string $buttontext text for the start/continue attempt button, if
581      *      it should be shown.
582      * @param array $infomessages further information about why the student cannot
583      *      attempt this quiz now, if appicable this quiz
584      */
585     public function view_page($course, $quiz, $cm, $context, $infomessages, $viewobj,
586             $buttontext, $preventmessages) {
587         $output = '';
588         $output .= $this->view_information($course, $quiz, $cm, $context, $infomessages);
589         $output .= $this->view_table($quiz, $context, $viewobj);
590         $output .= $this->view_best_score($viewobj);
591         $output .= $this->view_result_info($quiz, $context, $cm, $viewobj);
592         $output .= $this->view_attempt_button($course, $quiz, $cm, $context, $viewobj,
593                 $buttontext, $preventmessages);
594         return $output;
595     }
597     /**
598      * Outputs an error message for any guests accessing the quiz
599      *
600      * @param int $course The course ID
601      * @param array $quiz Array contingin quiz data
602      * @param int $cm Course Module ID
603      * @param int $context The page contect ID
604      * @param array $messages Array containing any messages
605      */
606     public function view_page_guest($course, $quiz, $cm, $context, $messages) {
607         $output = '';
608         $output .= $this->view_information($course, $quiz, $cm, $context, $messages);
609         $guestno = html_writer::tag('p', get_string('guestsno', 'quiz'));
610         $liketologin = html_writer::tag('p', get_string('liketologin'));
611         $output .= $this->confirm($guestno."\n\n".$liketologin."\n", get_login_url(),
612                 get_referer(false));
613         return $output;
614     }
616     /**
617      * Outputs and error message for anyone who is not enrolle don the course
618      *
619      * @param int $course The course ID
620      * @param array $quiz Array contingin quiz data
621      * @param int $cm Course Module ID
622      * @param int $context The page contect ID
623      * @param array $messages Array containing any messages
624      */
625     public function view_page_notenrolled($course, $quiz, $cm, $context, $messages) {
626         global $CFG;
627         $output = '';
628         $output .= $this->view_information($course, $quiz, $cm, $context, $messages);
629         $youneedtoenrol = html_writer::tag('p', get_string('youneedtoenrol', 'quiz'));
630         $button = html_writer::tag('p',
631                 $this->continue_button($CFG->wwwroot . '/course/view.php?id=' . $course->id));
632         $output .= $this->box($youneedtoenrol."\n\n".$button."\n", 'generalbox', 'notice');
633         return $output;
634     }
636     /**
637      * Output the page information
638      *
639      * @param int $course The course ID
640      * @param array $quiz Array contingin quiz data
641      * @param int $cm Course Module ID
642      * @param int $context The page contect ID
643      * @param array $messages Array containing any messages
644      */
645     public function view_information($course, $quiz, $cm, $context, $messages) {
646         global $CFG;
647         $output = '';
648         // Print quiz name and description
649         $output .= $this->heading(format_string($quiz->name));
650         if (trim(strip_tags($quiz->intro))) {
651             $output .= $this->box(format_module_intro('quiz', $quiz, $cm->id), 'generalbox',
652                     'intro');
653         }
655         $output .= $this->box($this->access_messages($messages), 'quizinfo');
657         // Show number of attempts summary to those who can view reports.
658         if (has_capability('mod/quiz:viewreports', $context)) {
659             if ($strattemptnum = $this->quiz_attempt_summary_link_to_reports($quiz, $cm,
660                     $context)) {
661                 $output .= html_writer::tag('div', $strattemptnum,
662                         array('class' => 'quizattemptcounts'));
663             }
664         }
665         return $output;
666     }
668     /**
669      * Generates the table heading.
670      */
671     public function view_table_heading() {
672         return $this->heading(get_string('summaryofattempts', 'quiz'));
673     }
675     /**
676      * Generates the table of data
677      *
678      * @param array $quiz Array contining quiz data
679      * @param int $context The page context ID
680      * @param mod_quiz_view_object $viewobj
681      */
682     public function view_table($quiz, $context, $viewobj) {
683         $output = '';
684         if (!$viewobj->attempts) {
685             return $output;
686         }
687         $output .= $this->view_table_heading();
689         // Prepare table header
690         $table = new html_table();
691         $table->attributes['class'] = 'generaltable quizattemptsummary';
692         $table->head = array();
693         $table->align = array();
694         $table->size = array();
695         if ($viewobj->attemptcolumn) {
696             $table->head[] = get_string('attemptnumber', 'quiz');
697             $table->align[] = 'center';
698             $table->size[] = '';
699         }
700         $table->head[] = get_string('timecompleted', 'quiz');
701         $table->align[] = 'left';
702         $table->size[] = '';
703         if ($viewobj->markcolumn) {
704             $table->head[] = get_string('marks', 'quiz') . ' / ' .
705                     quiz_format_grade($quiz, $quiz->sumgrades);
706             $table->align[] = 'center';
707             $table->size[] = '';
708         }
709         if ($viewobj->gradecolumn) {
710             $table->head[] = get_string('grade') . ' / ' .
711                     quiz_format_grade($quiz, $quiz->grade);
712             $table->align[] = 'center';
713             $table->size[] = '';
714         }
715         if ($viewobj->canreviewmine) {
716             $table->head[] = get_string('review', 'quiz');
717             $table->align[] = 'center';
718             $table->size[] = '';
719         }
720         if ($viewobj->feedbackcolumn) {
721             $table->head[] = get_string('feedback', 'quiz');
722             $table->align[] = 'left';
723             $table->size[] = '';
724         }
725         if (isset($quiz->showtimetaken)) {
726             $table->head[] = get_string('timetaken', 'quiz');
727             $table->align[] = 'left';
728             $table->size[] = '';
729         }
731         // One row for each attempt
732         foreach ($viewobj->attempts as $attempt) {
733             $attemptoptions = quiz_get_review_options($quiz, $attempt, $context);
734             $row = array();
736             // Add the attempt number, making it a link, if appropriate.
737             if ($viewobj->attemptcolumn) {
738                 if ($attempt->preview) {
739                     $row[] = get_string('preview', 'quiz');
740                 } else {
741                     $row[] = $attempt->attempt;
742                 }
743             }
745             // prepare strings for time taken and date completed
746             $timetaken = '';
747             $datecompleted = '';
748             if ($attempt->timefinish > 0) {
749                 // attempt has finished
750                 $timetaken = format_time($attempt->timefinish - $attempt->timestart);
751                 $datecompleted = userdate($attempt->timefinish);
752             } else if (!$quiz->timeclose || $viewobj->timenow < $quiz->timeclose) {
753                 // The attempt is still in progress.
754                 $timetaken = format_time($viewobj->timenow - $attempt->timestart);
755                 $datecompleted = get_string('inprogress', 'quiz');
756             } else {
757                 $timetaken = format_time($quiz->timeclose - $attempt->timestart);
758                 $datecompleted = userdate($quiz->timeclose);
759             }
760             $row[] = $datecompleted;
762             if ($viewobj->markcolumn) {
763                 if ($attemptoptions->marks >= question_display_options::MARK_AND_MAX &&
764                         $attempt->timefinish > 0) {
765                     $row[] = quiz_format_grade($quiz, $attempt->sumgrades);
766                 } else {
767                     $row[] = '';
768                 }
769             }
771             // Ouside the if because we may be showing feedback but not grades.
772             $attemptgrade = quiz_rescale_grade($attempt->sumgrades, $quiz, false);
774             if ($viewobj->gradecolumn) {
775                 if ($attemptoptions->marks >= question_display_options::MARK_AND_MAX &&
776                         $attempt->timefinish > 0) {
777                     $formattedgrade = quiz_format_grade($quiz, $attemptgrade);
778                     // highlight the highest grade if appropriate
779                     if ($viewobj->overallstats && !$attempt->preview
780                             && $viewobj->numattempts > 1 && !is_null($viewobj->mygrade)
781                             && $attemptgrade == $viewobj->mygrade
782                             && $quiz->grademethod == QUIZ_GRADEHIGHEST) {
783                         $table->rowclasses[$attempt->attempt] = 'bestrow';
784                     }
786                     $row[] = $formattedgrade;
787                 } else {
788                     $row[] = '';
789                 }
790             }
792             if ($viewobj->canreviewmine) {
793                 $row[] = $viewobj->accessmanager->make_review_link($attempt,
794                         $viewobj->canpreview, $attemptoptions);
795             }
797             if ($viewobj->feedbackcolumn && $attempt->timefinish > 0) {
798                 if ($attemptoptions->overallfeedback) {
799                     $row[] = quiz_feedback_for_grade($attemptgrade, $quiz, $context);
800                 } else {
801                     $row[] = '';
802                 }
803             }
805             if (isset($quiz->showtimetaken)) {
806                 $row[] = $timetaken;
807             }
809             if ($attempt->preview) {
810                 $table->data['preview'] = $row;
811             } else {
812                 $table->data[$attempt->attempt] = $row;
813             }
814         } // End of loop over attempts.
815         $output .= html_writer::table($table);
817         return $output;
818     }
820     /**
821      * Prints the students best score
822      *
823      * @param mod_quiz_view_object $viewobj
824      */
825     public function view_best_score($viewobj) {
826         $output = '';
827         // Print information about the student's best score for this quiz if possible.
828         if (!$viewobj->moreattempts) {
829             $output .= $this->heading(get_string('nomoreattempts', 'quiz'));
830         }
831         return $output;
832     }
834     /**
835      * Generates data pertaining to quiz results
836      *
837      * @param array $quiz Array containing quiz data
838      * @param int $context The page context ID
839      * @param int $cm The Course Module Id
840      * @param mod_quiz_view_object $viewobj
841      */
842     public function view_result_info($quiz, $context, $cm, $viewobj) {
843         $output = '';
844         if (!$viewobj->numattempts && !$viewobj->gradecolumn && is_null($viewobj->mygrade)) {
845             return $output;
846         }
847         $resultinfo = '';
849         if ($viewobj->overallstats) {
850             if ($viewobj->moreattempts) {
851                 $a = new stdClass();
852                 $a->method = quiz_get_grading_option_name($quiz->grademethod);
853                 $a->mygrade = quiz_format_grade($quiz, $viewobj->mygrade);
854                 $a->quizgrade = quiz_format_grade($quiz, $quiz->grade);
855                 $resultinfo .= $this->heading(get_string('gradesofar', 'quiz', $a), 2, 'main');
856             } else {
857                 $a = new stdClass();
858                 $a->grade = quiz_format_grade($quiz, $viewobj->mygrade);
859                 $a->maxgrade = quiz_format_grade($quiz, $quiz->grade);
860                 $a = get_string('outofshort', 'quiz', $a);
861                 $resultinfo .= $this->heading(get_string('yourfinalgradeis', 'quiz', $a), 2,
862                         'main');
863             }
864         }
866         if ($viewobj->mygradeoverridden) {
868             $resultinfo .= html_writer::tag('p', get_string('overriddennotice', 'grades'),
869                     array('class' => 'overriddennotice'))."\n";
870         }
871         if ($viewobj->gradebookfeedback) {
872             $resultinfo .= $this->heading(get_string('comment', 'quiz'), 3, 'main');
873             $resultinfo .= '<p class="quizteacherfeedback">'.$viewobj->gradebookfeedback.
874                     "</p>\n";
875         }
876         if ($viewobj->feedbackcolumn) {
877             $resultinfo .= $this->heading(get_string('overallfeedback', 'quiz'), 3, 'main');
878             $resultinfo .= html_writer::tag('p',
879                     quiz_feedback_for_grade($viewobj->mygrade, $quiz, $context),
880                     array('class' => 'quizgradefeedback'))."\n";
881         }
883         if ($resultinfo) {
884             $output .= $this->box($resultinfo, 'generalbox', 'feedback');
885         }
886         return $output;
887     }
889     /**
890      * Generates the view attempt button
891      *
892      * @param int $course The course ID
893      * @param array $quiz Array containging quiz date
894      * @param int $cm The Course Module ID
895      * @param int $context The page Context ID
896      * @param mod_quiz_view_object $viewobj
897      * @param string $buttontext
898      */
899     public function view_attempt_button($course, $quiz, $cm, $context, $viewobj,
900             $buttontext, $preventmessages) {
901         $output = '';
902         // Determine if we should be showing a start/continue attempt button,
903         // or a button to go back to the course page.
904         $output .= $this->box_start('quizattempt');
906         // Now actually print the appropriate button.
907         if (!quiz_clean_layout($quiz->questions, true)) {
908             $output .= quiz_no_questions_message($quiz, $cm, $context);
909         }
911         if ($preventmessages) {
912             $output .= $this->access_messages($preventmessages);
913         }
915         if ($buttontext) {
916             $output .= $viewobj->accessmanager->print_start_attempt_button($viewobj->canpreview,
917                     $buttontext, $viewobj->unfinished);
918         } else if ($buttontext === '') {
919             $output .= $this->single_button(new moodle_url('/course/view.php',
920                     array('id' => $course->id)), get_string('backtocourse', 'quiz'), 'get',
921                     array('class' => 'continuebutton'));
922         }
923         $output .= $this->box_end();
925         return $output;
926     }
928     /**
929      * Returns the same as {@link quiz_num_attempt_summary()} but wrapped in a link
930      * to the quiz reports.
931      *
932      * @param object $quiz the quiz object. Only $quiz->id is used at the moment.
933      * @param object $cm the cm object. Only $cm->course, $cm->groupmode and $cm->groupingid
934      * fields are used at the moment.
935      * @param object $context the quiz context.
936      * @param bool $returnzero if false (default), when no attempts have been made '' is returned
937      * instead of 'Attempts: 0'.
938      * @param int $currentgroup if there is a concept of current group where this method is being
939      * called
940      *         (e.g. a report) pass it in here. Default 0 which means no current group.
941      * @return string HTML fragment for the link.
942      */
943     public function quiz_attempt_summary_link_to_reports($quiz, $cm, $context,
944                                                           $returnzero = false, $currentgroup = 0) {
945         global $CFG;
946         $summary = quiz_num_attempt_summary($quiz, $cm, $returnzero, $currentgroup);
947         if (!$summary) {
948             return '';
949         }
951         require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php');
952         $url = new moodle_url('/mod/quiz/report.php', array(
953                 'id' => $cm->id, 'mode' => quiz_report_default_report($context)));
954         return html_writer::link($url, $summary);
955     }
958 class mod_quiz_links_to_other_attempts implements renderable {
959     /**
960      * @var array string attempt number => url, or null for the current attempt.
961      */
962     public $links = array();
965 class mod_quiz_view_object {
966     /**
967      * @var array $attempt contains all the user's attempts at this quiz.
968      */
969     public $attempts;
970     /**
971      * @var object $accessmanager contains various access rules.
972      */
973     public $accessmanager;
974     /**
975      * @var int $canattempt determins capability for attempting a quiz.
976      */
977     public $canattempt;
978     /**
979      * @var int $canpreview determins capability for previewing a quiz.
980      */
981     public $canpreview;
982     /**
983      * @var int $canreviewmine determins capability for reviwing own quiz.
984      */
985     public $canreviewmine;
986     /**
987      * @var int $attemptcolumn contains the number of attempts done.
988      */
989     public $attemptcolumn;
990     /**
991      * @var int $gradecolumn contains the grades of any attempts.
992      */
993     public $gradecolumn;
994     /**
995      * @var int $markcolumn contains the marks of any attempt.
996      */
997     public $markcolumn;
998     /**
999      * @var int $overallstats contains all marks for any attempt.
1000      */
1001     public $overallstats;
1002     /**
1003      * @var string $feedbackcolumn contains any feedback for and attempt.
1004      */
1005     public $feedbackcolumn;
1006     /**
1007      * @var string $timenow contains a timestamp in string format.
1008      */
1009     public $timenow;
1010     /**
1011      * @var int $numattempts contains the total number of attempts.
1012      */
1013     public $numattempts;
1014     /**
1015      * @var int $mygrade contains the current users final grade for a quiz.
1016      */
1017     public $mygrade;
1018     /**
1019      * @var int $moreattempts total attempts left.
1020      */
1021     public $moreattempts;
1022     /**
1023      * @var int $mygradeoverridden contains an overriden grade.
1024      */
1025     public $mygradeoverridden;
1026     /**
1027      * @var string $gradebookfeedback contains any feedback for a gradebook.
1028      */
1029     public $gradebookfeedback;
1030     /**
1031      * @var int $unfinished contains 1 if an attempt is unfinished.
1032      */
1033     public $unfinished;
1034     /**
1035      * @var int $lastfinishedattempt contains a pointer to the last attempt in the attempts array.
1036      */
1037     public $lastfinishedattempt;