MDL-29571 qtype description refactor unit test code a bit.
[moodle.git] / question / engine / renderer.php
CommitLineData
d1b7e03d 1<?php
d1b7e03d
TH
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
d1b7e03d
TH
17/**
18 * Renderers for outputting parts of the question engine.
19 *
017bc1d9 20 * @package moodlecore
d1b7e03d 21 * @subpackage questionengine
017bc1d9
TH
22 * @copyright 2009 The Open University
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
d1b7e03d
TH
24 */
25
26
a17b297d
TH
27defined('MOODLE_INTERNAL') || die();
28
29
d1b7e03d
TH
30/**
31 * This renderer controls the overall output of questions. It works with a
32 * {@link qbehaviour_renderer} and a {@link qtype_renderer} to output the
33 * type-specific bits. The main entry point is the {@link question()} method.
34 *
017bc1d9
TH
35 * @copyright 2009 The Open University
36 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
d1b7e03d 37 */
729c372b 38class core_question_renderer extends plugin_renderer_base {
2daffca5
TH
39 public function get_page() {
40 return $this->page;
41 }
d1b7e03d
TH
42
43 /**
44 * Generate the display of a question in a particular state, and with certain
45 * display options. Normally you do not call this method directly. Intsead
46 * you call {@link question_usage_by_activity::render_question()} which will
47 * call this method with appropriate arguments.
48 *
49 * @param question_attempt $qa the question attempt to display.
50 * @param qbehaviour_renderer $behaviouroutput the renderer to output the behaviour
51 * specific parts.
52 * @param qtype_renderer $qtoutput the renderer to output the question type
53 * specific parts.
54 * @param question_display_options $options controls what should and should not be displayed.
55 * @param string|null $number The question number to display. 'i' is a special
56 * value that gets displayed as Information. Null means no number is displayed.
57 * @return string HTML representation of the question.
58 */
59 public function question(question_attempt $qa, qbehaviour_renderer $behaviouroutput,
60 qtype_renderer $qtoutput, question_display_options $options, $number) {
61
62 $output = '';
63 $output .= html_writer::start_tag('div', array(
64 'id' => 'q' . $qa->get_slot(),
25d9a6a6
TH
65 'class' => implode(' ', array(
66 'que',
67 $qa->get_question()->qtype->name(),
68 $qa->get_behaviour_name(),
69 $qa->get_state_class($options->correctness && $qa->has_marks()),
70 ))
d1b7e03d
TH
71 ));
72
73 $output .= html_writer::tag('div',
74 $this->info($qa, $behaviouroutput, $qtoutput, $options, $number),
75 array('class' => 'info'));
76
77 $output .= html_writer::start_tag('div', array('class' => 'content'));
78
79 $output .= html_writer::tag('div',
80 $this->add_part_heading(get_string('questiontext', 'question'),
81 $this->formulation($qa, $behaviouroutput, $qtoutput, $options)),
82 array('class' => 'formulation'));
83 $output .= html_writer::nonempty_tag('div',
84 $this->add_part_heading(get_string('feedback', 'question'),
85 $this->outcome($qa, $behaviouroutput, $qtoutput, $options)),
86 array('class' => 'outcome'));
87 $output .= html_writer::nonempty_tag('div',
88 $this->add_part_heading(get_string('comments', 'question'),
783af252
TH
89 $this->manual_comment($qa, $behaviouroutput, $qtoutput, $options)),
90 array('class' => 'comment'));
d1b7e03d
TH
91 $output .= html_writer::nonempty_tag('div',
92 $this->response_history($qa, $behaviouroutput, $qtoutput, $options),
93 array('class' => 'history'));
94
95 $output .= html_writer::end_tag('div');
96 $output .= html_writer::end_tag('div');
97 return $output;
98 }
99
100 /**
101 * Generate the information bit of the question display that contains the
102 * metadata like the question number, current state, and mark.
103 * @param question_attempt $qa the question attempt to display.
104 * @param qbehaviour_renderer $behaviouroutput the renderer to output the behaviour
105 * specific parts.
106 * @param qtype_renderer $qtoutput the renderer to output the question type
107 * specific parts.
108 * @param question_display_options $options controls what should and should not be displayed.
109 * @param string|null $number The question number to display. 'i' is a special
110 * value that gets displayed as Information. Null means no number is displayed.
111 * @return HTML fragment.
112 */
113 protected function info(question_attempt $qa, qbehaviour_renderer $behaviouroutput,
114 qtype_renderer $qtoutput, question_display_options $options, $number) {
115 $output = '';
116 $output .= $this->number($number);
117 $output .= $this->status($qa, $behaviouroutput, $options);
118 $output .= $this->mark_summary($qa, $options);
119 $output .= $this->question_flag($qa, $options->flags);
da729916 120 $output .= $this->edit_question_link($qa, $options);
d1b7e03d
TH
121 return $output;
122 }
123
124 /**
125 * Generate the display of the question number.
126 * @param string|null $number The question number to display. 'i' is a special
127 * value that gets displayed as Information. Null means no number is displayed.
128 * @return HTML fragment.
129 */
130 protected function number($number) {
131 $numbertext = '';
132 if (is_numeric($number)) {
133 $numbertext = get_string('questionx', 'question',
134 html_writer::tag('span', $number, array('class' => 'qno')));
135 } else if ($number == 'i') {
136 $numbertext = get_string('information', 'question');
137 }
138 if (!$numbertext) {
139 return '';
140 }
141 return html_writer::tag('h2', $numbertext, array('class' => 'no'));
142 }
143
144 /**
145 * Add an invisible heading like 'question text', 'feebdack' at the top of
146 * a section's contents, but only if the section has some content.
147 * @param string $heading the heading to add.
148 * @param string $content the content of the section.
149 * @return string HTML fragment with the heading added.
150 */
151 protected function add_part_heading($heading, $content) {
152 if ($content) {
153 $content = html_writer::tag('h3', $heading, array('class' => 'accesshide')) . $content;
154 }
155 return $content;
156 }
157
158 /**
159 * Generate the display of the status line that gives the current state of
160 * the question.
161 * @param question_attempt $qa the question attempt to display.
162 * @param qbehaviour_renderer $behaviouroutput the renderer to output the behaviour
163 * specific parts.
164 * @param question_display_options $options controls what should and should not be displayed.
165 * @return HTML fragment.
166 */
9c197f44
TH
167 protected function status(question_attempt $qa, qbehaviour_renderer $behaviouroutput,
168 question_display_options $options) {
d1b7e03d
TH
169 return html_writer::tag('div', $qa->get_state_string($options->correctness),
170 array('class' => 'state'));
171 }
172
173 /**
174 * Generate the display of the marks for this question.
175 * @param question_attempt $qa the question attempt to display.
176 * @param question_display_options $options controls what should and should not be displayed.
177 * @return HTML fragment.
178 */
179 protected function mark_summary(question_attempt $qa, question_display_options $options) {
180 if (!$options->marks) {
181 return '';
182 }
183
184 if ($qa->get_max_mark() == 0) {
185 $summary = get_string('notgraded', 'question');
186
187 } else if ($options->marks == question_display_options::MAX_ONLY ||
188 is_null($qa->get_fraction())) {
9c197f44
TH
189 $summary = get_string('markedoutofmax', 'question',
190 $qa->format_max_mark($options->markdp));
d1b7e03d
TH
191
192 } else {
0ff4bd08 193 $a = new stdClass();
d1b7e03d
TH
194 $a->mark = $qa->format_mark($options->markdp);
195 $a->max = $qa->format_max_mark($options->markdp);
196 $summary = get_string('markoutofmax', 'question', $a);
197 }
198
199 return html_writer::tag('div', $summary, array('class' => 'grade'));
200 }
201
202 /**
203 * Render the question flag, assuming $flagsoption allows it.
204 *
205 * @param question_attempt $qa the question attempt to display.
f7970e3c 206 * @param int $flagsoption the option that says whether flags should be displayed.
d1b7e03d
TH
207 */
208 protected function question_flag(question_attempt $qa, $flagsoption) {
209 global $CFG;
210 switch ($flagsoption) {
211 case question_display_options::VISIBLE:
212 $flagcontent = $this->get_flag_html($qa->is_flagged());
213 break;
214 case question_display_options::EDITABLE:
215 $id = $qa->get_flag_field_name();
216 if ($qa->is_flagged()) {
217 $checked = 'checked="checked" ';
218 } else {
219 $checked = '';
220 }
221 $postdata = question_flags::get_postdata($qa);
9c197f44
TH
222 // The checkbox id must be different from any element name, because
223 // of a stupid IE bug:
224 // http://www.456bereastreet.com/archive/200802/beware_of_id_and_name_attribute_mixups_when_using_getelementbyid_in_internet_explorer/
d1b7e03d 225 $flagcontent = '<input type="hidden" name="' . $id . '" value="0" />' .
9c197f44
TH
226 '<input type="checkbox" id="' . $id . 'checkbox" name="' . $id .
227 '" value="1" ' . $checked . ' />' .
228 '<input type="hidden" value="' . s($postdata) .
229 '" class="questionflagpostdata" />' .
230 '<label id="' . $id . 'label" for="' . $id . 'checkbox">' .
231 $this->get_flag_html($qa->is_flagged(), $id . 'img') .
232 '</label>' . "\n";
d1b7e03d
TH
233 break;
234 default:
235 $flagcontent = '';
236 }
237 if ($flagcontent) {
238 return '<div class="questionflag">' . $flagcontent . "</div>\n";
239 }
240 }
241
242 /**
243 * Work out the actual img tag needed for the flag
244 *
f7970e3c 245 * @param bool $flagged whether the question is currently flagged.
d1b7e03d
TH
246 * @param string $id an id to be added as an attribute to the img (optional).
247 * @return string the img tag.
248 */
249 protected function get_flag_html($flagged, $id = '') {
22c97c64
TH
250 if ($flagged) {
251 $icon = 'i/flagged';
252 $alt = get_string('flagged', 'question');
253 } else {
254 $icon = 'i/unflagged';
255 $alt = get_string('notflagged', 'question');
256 }
257 $attributes = array(
258 'src' => $this->pix_url($icon),
259 'alt' => $alt,
260 );
d1b7e03d 261 if ($id) {
22c97c64 262 $attributes['id'] = $id;
d1b7e03d 263 }
22c97c64 264 $img = html_writer::empty_tag('img', $attributes);
d1b7e03d 265 if ($flagged) {
22c97c64 266 $img .= ' ' . get_string('flagged', 'question');
d1b7e03d 267 }
22c97c64 268 return $img;
d1b7e03d
TH
269 }
270
da729916
TH
271 protected function edit_question_link(question_attempt $qa,
272 question_display_options $options) {
273 global $CFG;
274
275 if (empty($options->editquestionparams)) {
276 return '';
277 }
278
279 $params = $options->editquestionparams;
280 if ($params['returnurl'] instanceof moodle_url) {
281 $params['returnurl'] = str_replace($CFG->wwwroot, '',
282 $params['returnurl']->out(false));
283 }
284 $params['id'] = $qa->get_question()->id;
285 $editurl = new moodle_url('/question/question.php', $params);
286
287 return html_writer::tag('div', html_writer::link(
288 $editurl, $this->pix_icon('i/edit', get_string('edit')) .
289 get_string('editquestion', 'question')),
290 array('class' => 'editquestion'));
291 }
292
d1b7e03d
TH
293 /**
294 * Generate the display of the formulation part of the question. This is the
295 * area that contains the quetsion text, and the controls for students to
296 * input their answers. Some question types also embed feedback, for
297 * example ticks and crosses, in this area.
298 *
299 * @param question_attempt $qa the question attempt to display.
300 * @param qbehaviour_renderer $behaviouroutput the renderer to output the behaviour
301 * specific parts.
302 * @param qtype_renderer $qtoutput the renderer to output the question type
303 * specific parts.
304 * @param question_display_options $options controls what should and should not be displayed.
305 * @return HTML fragment.
306 */
307 protected function formulation(question_attempt $qa, qbehaviour_renderer $behaviouroutput,
308 qtype_renderer $qtoutput, question_display_options $options) {
309 $output = '';
310 $output .= html_writer::empty_tag('input', array(
311 'type' => 'hidden',
312 'name' => $qa->get_control_field_name('sequencecheck'),
313 'value' => $qa->get_num_steps()));
314 $output .= $qtoutput->formulation_and_controls($qa, $options);
315 if ($options->clearwrong) {
316 $output .= $qtoutput->clear_wrong($qa);
317 }
318 $output .= html_writer::nonempty_tag('div',
319 $behaviouroutput->controls($qa, $options), array('class' => 'im-controls'));
320 return $output;
321 }
322
323 /**
324 * Generate the display of the outcome part of the question. This is the
325 * area that contains the various forms of feedback.
326 *
327 * @param question_attempt $qa the question attempt to display.
328 * @param qbehaviour_renderer $behaviouroutput the renderer to output the behaviour
329 * specific parts.
330 * @param qtype_renderer $qtoutput the renderer to output the question type
331 * specific parts.
332 * @param question_display_options $options controls what should and should not be displayed.
333 * @return HTML fragment.
334 */
335 protected function outcome(question_attempt $qa, qbehaviour_renderer $behaviouroutput,
336 qtype_renderer $qtoutput, question_display_options $options) {
337 $output = '';
338 $output .= html_writer::nonempty_tag('div',
339 $qtoutput->feedback($qa, $options), array('class' => 'feedback'));
340 $output .= html_writer::nonempty_tag('div',
341 $behaviouroutput->feedback($qa, $options), array('class' => 'im-feedback'));
342 return $output;
343 }
344
783af252
TH
345 protected function manual_comment(question_attempt $qa, qbehaviour_renderer $behaviouroutput,
346 qtype_renderer $qtoutput, question_display_options $options) {
347 return $qtoutput->manual_comment($qa, $options) .
348 $behaviouroutput->manual_comment($qa, $options);
349 }
350
d1b7e03d
TH
351 /**
352 * Generate the display of the response history part of the question. This
353 * is the table showing all the steps the question has been through.
354 *
355 * @param question_attempt $qa the question attempt to display.
356 * @param qbehaviour_renderer $behaviouroutput the renderer to output the behaviour
357 * specific parts.
358 * @param qtype_renderer $qtoutput the renderer to output the question type
359 * specific parts.
360 * @param question_display_options $options controls what should and should not be displayed.
361 * @return HTML fragment.
362 */
363 protected function response_history(question_attempt $qa, qbehaviour_renderer $behaviouroutput,
364 qtype_renderer $qtoutput, question_display_options $options) {
365
366 if (!$options->history) {
367 return '';
368 }
369
068b4594 370 $table = new html_table();
d1b7e03d
TH
371 $table->head = array (
372 get_string('step', 'question'),
373 get_string('time'),
374 get_string('action', 'question'),
375 get_string('state', 'question'),
376 );
377 if ($options->marks >= question_display_options::MARK_AND_MAX) {
378 $table->head[] = get_string('marks', 'question');
379 }
380
381 foreach ($qa->get_full_step_iterator() as $i => $step) {
382 $stepno = $i + 1;
d47d12d0 383
d1b7e03d
TH
384 $rowclass = '';
385 if ($stepno == $qa->get_num_steps()) {
386 $rowclass = 'current';
387 } else if (!empty($options->questionreviewlink)) {
9c197f44
TH
388 $url = new moodle_url($options->questionreviewlink,
389 array('slot' => $qa->get_slot(), 'step' => $i));
729c372b 390 $stepno = $this->output->action_link($url, $stepno,
9c197f44
TH
391 new popup_action('click', $url, 'reviewquestion',
392 array('width' => 450, 'height' => 650)),
5e8a85aa 393 array('title' => get_string('reviewresponse', 'question')));
d1b7e03d 394 }
d47d12d0
TH
395
396 $restrictedqa = new question_attempt_with_restricted_history($qa, $i, null);
397
0ff4bd08 398 $user = new stdClass();
d1b7e03d
TH
399 $user->id = $step->get_user_id();
400 $row = array(
401 $stepno,
402 userdate($step->get_timecreated(), get_string('strftimedatetimeshort')),
403 s($qa->summarise_action($step)),
d47d12d0 404 $restrictedqa->get_state_string($options->correctness),
d1b7e03d
TH
405 );
406
407 if ($options->marks >= question_display_options::MARK_AND_MAX) {
408 $row[] = $qa->format_fraction_as_mark($step->get_fraction(), $options->markdp);
409 }
410
068b4594 411 $table->rowclasses[] = $rowclass;
d1b7e03d
TH
412 $table->data[] = $row;
413 }
414
415 return html_writer::tag('h3', get_string('responsehistory', 'question'),
416 array('class' => 'responsehistoryheader')) . html_writer::tag('div',
068b4594 417 html_writer::table($table, true), array('class' => 'responsehistoryheader'));
d1b7e03d
TH
418 }
419
420}