weekly release 2.3dev
[moodle.git] / question / type / questiontypebase.php
CommitLineData
f29aeb5a 1<?php
f29aeb5a
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
516cf3eb 17/**
4323d029 18 * The default questiontype class.
19 *
7764183a 20 * @package moodlecore
4323d029 21 * @subpackage questiontypes
7764183a
TH
22 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
271e6dec 24 */
516cf3eb 25
f29aeb5a 26
a17b297d
TH
27defined('MOODLE_INTERNAL') || die();
28
d1b7e03d 29require_once($CFG->dirroot . '/question/engine/lib.php');
516cf3eb 30
f29aeb5a 31
32b0adfa 32/**
33 * This is the base class for Moodle question types.
271ffe3f 34 *
32b0adfa 35 * There are detailed comments on each method, explaining what the method is
36 * for, and the circumstances under which you might need to override it.
271ffe3f 37 *
32b0adfa 38 * Note: the questiontype API should NOT be considered stable yet. Very few
22cebed5 39 * question types have been produced yet, so we do not yet know all the places
271ffe3f 40 * where the current API is insufficient. I would rather learn from the
32b0adfa 41 * experiences of the first few question type implementors, and improve the
42 * interface to meet their needs, rather the freeze the API prematurely and
43 * condem everyone to working round a clunky interface for ever afterwards.
271e6dec 44 *
7764183a
TH
45 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
46 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32b0adfa 47 */
d1b7e03d 48class question_type {
f29aeb5a
TH
49 protected $fileoptions = array(
50 'subdirs' => false,
51 'maxfiles' => -1,
52 'maxbytes' => 0,
53 );
516cf3eb 54
d1b7e03d 55 public function __construct() {
869309b8 56 }
57
4995b9c1 58 /**
d1b7e03d 59 * @return string the name of this question type.
869309b8 60 */
d1b7e03d
TH
61 public function name() {
62 return substr(get_class($this), 6);
a2156789 63 }
271ffe3f 64
f29aeb5a
TH
65 /**
66 * @return string the full frankenstyle name for this plugin.
67 */
68 public function plugin_name() {
69 return get_class($this);
70 }
71
72 /**
73 * @return string the name of this question type in the user's language.
74 * You should not need to override this method, the default behaviour should be fine.
75 */
76 public function local_name() {
0b94d6bf 77 return get_string('pluginname', $this->plugin_name());
f29aeb5a
TH
78 }
79
869309b8 80 /**
81 * The name this question should appear as in the create new question
f29aeb5a
TH
82 * dropdown. Override this method to return false if you don't want your
83 * question type to be createable, for example if it is an abstract base type,
84 * otherwise, you should not need to override this method.
869309b8 85 *
86 * @return mixed the desired string, or false to hide this question type in the menu.
87 */
d1b7e03d 88 public function menu_name() {
f29aeb5a
TH
89 return $this->local_name();
90 }
91
f29aeb5a 92 /**
f7970e3c 93 * @return bool override this to return false if this is not really a
f29aeb5a
TH
94 * question type, for example the description question type is not
95 * really a question type.
96 */
97 public function is_real_question_type() {
98 return true;
b974f947 99 }
100
a2156789 101 /**
f7970e3c 102 * @return bool true if this question type sometimes requires manual grading.
a2156789 103 */
d1b7e03d 104 public function is_manual_graded() {
a2156789 105 return false;
106 }
107
f24493ec 108 /**
109 * @param object $question a question of this type.
110 * @param string $otherquestionsinuse comma-separate list of other question ids in this attempt.
f7970e3c 111 * @return bool true if a particular instance of this question requires manual grading.
f24493ec 112 */
d1b7e03d 113 public function is_question_manual_graded($question, $otherquestionsinuse) {
f24493ec 114 return $this->is_manual_graded();
115 }
116
869309b8 117 /**
f7970e3c 118 * @return bool true if this question type can be used by the random question type.
869309b8 119 */
d1b7e03d
TH
120 public function is_usable_by_random() {
121 return true;
869309b8 122 }
123
a2156789 124 /**
d1b7e03d
TH
125 * Whether this question type can perform a frequency analysis of student
126 * responses.
127 *
128 * If this method returns true, you must implement the get_possible_responses
129 * method, and the question_definition class must implement the
130 * classify_response method.
131 *
f7970e3c 132 * @return bool whether this report can analyse all the student reponses
d1b7e03d 133 * for things like the quiz statistics report.
a2156789 134 */
d1b7e03d
TH
135 public function can_analyse_responses() {
136 // This works in most cases.
137 return !$this->is_manual_graded();
a2156789 138 }
139
869309b8 140 /**
d1b7e03d
TH
141 * @return whether the question_answers.answer field needs to have
142 * restore_decode_content_links_worker called on it.
869309b8 143 */
d1b7e03d 144 public function has_html_answers() {
869309b8 145 return false;
146 }
d001dac7 147
295043c2 148 /**
149 * If your question type has a table that extends the question table, and
150 * you want the base class to automatically save, backup and restore the extra fields,
151 * override this method to return an array wherer the first element is the table name,
152 * and the subsequent entries are the column names (apart from id and questionid).
153 *
154 * @return mixed array as above, or null to tell the base class to do nothing.
155 */
d1b7e03d 156 public function extra_question_fields() {
295043c2 157 return null;
158 }
159
d001dac7 160 /**
eaeb6b51
TH
161 * If you use extra_question_fields, overload this function to return question id field name
162 * in case you table use another name for this column
163 */
56565037 164 public function questionid_column_name() {
d001dac7 165 return 'questionid';
166 }
167
295043c2 168 /**
169 * If your question type has a table that extends the question_answers table,
170 * make this method return an array wherer the first element is the table name,
171 * and the subsequent entries are the column names (apart from id and answerid).
172 *
173 * @return mixed array as above, or null to tell the base class to do nothing.
174 */
56565037 175 public function extra_answer_fields() {
6b5f24d3
TH
176 return null;
177 }
178
179 /**
180 * If the quetsion type uses files in responses, then this method should
181 * return an array of all the response variables that might have corresponding
182 * files. For example, the essay qtype returns array('attachments', 'answers').
183 *
184 * @return array response variable names that may have associated files.
185 */
186 public function response_file_areas() {
187 return array();
188 }
295043c2 189
36703ed7 190 /**
191 * Return an instance of the question editing form definition. This looks for a
192 * class called edit_{$this->name()}_question_form in the file
f29aeb5a 193 * question/type/{$this->name()}/edit_{$this->name()}_question_form.php
36703ed7 194 * and if it exists returns an instance of it.
195 *
196 * @param string $submiturl passed on to the constructor call.
197 * @return object an instance of the form definition, or null if one could not be found.
198 */
eaeb6b51
TH
199 public function create_editing_form($submiturl, $question, $category,
200 $contexts, $formeditable) {
36703ed7 201 global $CFG;
1fa39364
TH
202 require_once($CFG->dirroot . '/question/type/edit_question_form.php');
203 $definitionfile = $CFG->dirroot . '/question/type/' . $this->name() .
eaeb6b51 204 '/edit_' . $this->name() . '_form.php';
1fa39364
TH
205 if (!is_readable($definitionfile) || !is_file($definitionfile)) {
206 throw new coding_exception($this->plugin_name() .
afe24f85
TH
207 ' is missing the definition of its editing formin file ' .
208 $definitionfile . '.');
36703ed7 209 }
1fa39364 210 require_once($definitionfile);
6e34cd29 211 $classname = $this->plugin_name() . '_edit_form';
36703ed7 212 if (!class_exists($classname)) {
1fa39364
TH
213 throw new coding_exception($this->plugin_name() .
214 ' does not define the class ' . $this->plugin_name() .
215 '_edit_form.');
36703ed7 216 }
271e6dec 217 return new $classname($submiturl, $question, $category, $contexts, $formeditable);
36703ed7 218 }
219
99ba746d 220 /**
221 * @return string the full path of the folder this plugin's files live in.
222 */
d1b7e03d 223 public function plugin_dir() {
99ba746d 224 global $CFG;
225 return $CFG->dirroot . '/question/type/' . $this->name();
226 }
227
228 /**
229 * @return string the URL of the folder this plugin's files live in.
230 */
d1b7e03d 231 public function plugin_baseurl() {
99ba746d 232 global $CFG;
233 return $CFG->wwwroot . '/question/type/' . $this->name();
234 }
235
7b41a4a9 236 /**
237 * This method should be overriden if you want to include a special heading or some other
238 * html on a question editing page besides the question editing form.
239 *
240 * @param question_edit_form $mform a child of question_edit_form
241 * @param object $question
242 * @param string $wizardnow is '' for first page.
243 */
f29aeb5a
TH
244 public function display_question_editing_page($mform, $question, $wizardnow) {
245 global $OUTPUT;
246 $heading = $this->get_heading(empty($question->id));
247
0b94d6bf 248 echo $OUTPUT->heading_with_help($heading, 'pluginname', $this->plugin_name());
f29aeb5a 249
271e6dec 250 $permissionstrs = array();
eaeb6b51
TH
251 if (!empty($question->id)) {
252 if ($question->formoptions->canedit) {
271e6dec 253 $permissionstrs[] = get_string('permissionedit', 'question');
254 }
eaeb6b51 255 if ($question->formoptions->canmove) {
271e6dec 256 $permissionstrs[] = get_string('permissionmove', 'question');
257 }
eaeb6b51 258 if ($question->formoptions->cansaveasnew) {
271e6dec 259 $permissionstrs[] = get_string('permissionsaveasnew', 'question');
260 }
261 }
eaeb6b51 262 if (!$question->formoptions->movecontext && count($permissionstrs)) {
f29aeb5a 263 echo $OUTPUT->heading(get_string('permissionto', 'question'), 3);
271e6dec 264 $html = '<ul>';
eaeb6b51 265 foreach ($permissionstrs as $permissionstr) {
271e6dec 266 $html .= '<li>'.$permissionstr.'</li>';
267 }
268 $html .= '</ul>';
f29aeb5a 269 echo $OUTPUT->box($html, 'boxwidthnarrow boxaligncenter generalbox');
271e6dec 270 }
9ab75b2b 271 $mform->display();
272 }
271e6dec 273
9ab75b2b 274 /**
eaeb6b51
TH
275 * Method called by display_question_editing_page and by question.php to get
276 * heading for breadcrumbs.
271e6dec 277 *
d1b7e03d 278 * @return string the heading
9ab75b2b 279 */
eaeb6b51 280 public function get_heading($adding = false) {
f29aeb5a 281 if ($adding) {
226b3124 282 $string = 'pluginnameadding';
226b3124
TH
283 } else {
284 $string = 'pluginnameediting';
c2f8c4be 285 }
0b94d6bf 286 return get_string($string, $this->plugin_name());
d1b7e03d
TH
287 }
288
289 /**
290 * Set any missing settings for this question to the default values. This is
291 * called before displaying the question editing form.
292 *
293 * @param object $questiondata the question data, loaded from the databsae,
294 * or more likely a newly created question object that is only partially
295 * initialised.
296 */
297 public function set_default_options($questiondata) {
7b41a4a9 298 }
299
516cf3eb 300 /**
eaeb6b51
TH
301 * Saves (creates or updates) a question.
302 *
303 * Given some question info and some data about the answers
304 * this function parses, organises and saves the question
305 * It is used by {@link question.php} when saving new data from
306 * a form, and also by {@link import.php} when importing questions
307 * This function in turn calls {@link save_question_options}
308 * to save question-type specific data.
309 *
310 * Whether we are saving a new question or updating an existing one can be
311 * determined by testing !empty($question->id). If it is not empty, we are updating.
312 *
313 * The question will be saved in category $form->category.
314 *
315 * @param object $question the question object which should be updated. For a
316 * new question will be mostly empty.
317 * @param object $form the object containing the information to save, as if
318 * from the question editing form.
319 * @param object $course not really used any more.
320 * @return object On success, return the new question object. On failure,
321 * return an object as follows. If the error object has an errors field,
322 * display that as an error message. Otherwise, the editing form will be
323 * redisplayed with validation errors, from validation_errors field, which
324 * is itself an object, shown next to the form fields. (I don't think this
325 * is accurate any more.)
326 */
c7df5006 327 public function save_question($question, $form) {
f29aeb5a
TH
328 global $USER, $DB, $OUTPUT;
329
330 list($question->category) = explode(',', $form->category);
331 $context = $this->get_context_by_category_id($question->category);
fe6ce234 332
516cf3eb 333 // This default implementation is suitable for most
334 // question types.
271ffe3f 335
516cf3eb 336 // First, save the basic question itself
24e8b9b6 337 $question->name = trim($form->name);
24e8b9b6 338 $question->parent = isset($form->parent) ? $form->parent : 0;
516cf3eb 339 $question->length = $this->actual_number_of_questions($question);
340 $question->penalty = isset($form->penalty) ? $form->penalty : 0;
341
f29aeb5a
TH
342 if (empty($form->questiontext['text'])) {
343 $question->questiontext = '';
516cf3eb 344 } else {
f29aeb5a 345 $question->questiontext = trim($form->questiontext['text']);;
516cf3eb 346 }
eaeb6b51
TH
347 $question->questiontextformat = !empty($form->questiontext['format']) ?
348 $form->questiontext['format'] : 0;
516cf3eb 349
f29aeb5a 350 if (empty($form->generalfeedback['text'])) {
a4514d91 351 $question->generalfeedback = '';
1b8a7434 352 } else {
f29aeb5a 353 $question->generalfeedback = trim($form->generalfeedback['text']);
1b8a7434 354 }
eaeb6b51
TH
355 $question->generalfeedbackformat = !empty($form->generalfeedback['format']) ?
356 $form->generalfeedback['format'] : 0;
1b8a7434 357
516cf3eb 358 if (empty($question->name)) {
f29aeb5a 359 $question->name = shorten_text(strip_tags($form->questiontext['text']), 15);
516cf3eb 360 if (empty($question->name)) {
361 $question->name = '-';
362 }
363 }
364
365 if ($question->penalty > 1 or $question->penalty < 0) {
5e8a85aa 366 $question->errors['penalty'] = get_string('invalidpenalty', 'question');
516cf3eb 367 }
368
d1b7e03d
TH
369 if (isset($form->defaultmark)) {
370 $question->defaultmark = $form->defaultmark;
516cf3eb 371 }
372
f29aeb5a
TH
373 // If the question is new, create it.
374 if (empty($question->id)) {
cbe20043 375 // Set the unique code
376 $question->stamp = make_unique_id_code();
271e6dec 377 $question->createdby = $USER->id;
378 $question->timecreated = time();
f29aeb5a 379 $question->id = $DB->insert_record('question', $question);
516cf3eb 380 }
381
f29aeb5a
TH
382 // Now, whether we are updating a existing question, or creating a new
383 // one, we have to do the files processing and update the record.
384 /// Question already exists, update.
385 $question->modifiedby = $USER->id;
386 $question->timemodified = time();
387
388 if (!empty($question->questiontext) && !empty($form->questiontext['itemid'])) {
eaeb6b51
TH
389 $question->questiontext = file_save_draft_area_files($form->questiontext['itemid'],
390 $context->id, 'question', 'questiontext', (int)$question->id,
391 $this->fileoptions, $question->questiontext);
f29aeb5a
TH
392 }
393 if (!empty($question->generalfeedback) && !empty($form->generalfeedback['itemid'])) {
eaeb6b51
TH
394 $question->generalfeedback = file_save_draft_area_files(
395 $form->generalfeedback['itemid'], $context->id,
396 'question', 'generalfeedback', (int)$question->id,
397 $this->fileoptions, $question->generalfeedback);
f29aeb5a
TH
398 }
399 $DB->update_record('question', $question);
400
516cf3eb 401 // Now to save all the answers and type-specific options
6459b8fc 402 $form->id = $question->id;
403 $form->qtype = $question->qtype;
516cf3eb 404 $form->category = $question->category;
6459b8fc 405 $form->questiontext = $question->questiontext;
f29aeb5a
TH
406 $form->questiontextformat = $question->questiontextformat;
407 // current context
408 $form->context = $context;
516cf3eb 409
410 $result = $this->save_question_options($form);
411
412 if (!empty($result->error)) {
f29aeb5a 413 print_error($result->error);
516cf3eb 414 }
415
416 if (!empty($result->notice)) {
417 notice($result->notice, "question.php?id=$question->id");
418 }
419
420 if (!empty($result->noticeyesno)) {
eaeb6b51
TH
421 throw new coding_exception(
422 '$result->noticeyesno no longer supported in save_question.');
516cf3eb 423 }
424
cbe20043 425 // Give the question a unique version stamp determined by question_hash()
eaeb6b51
TH
426 $DB->set_field('question', 'version', question_hash($question),
427 array('id' => $question->id));
cbe20043 428
516cf3eb 429 return $question;
430 }
271ffe3f 431
516cf3eb 432 /**
d1b7e03d
TH
433 * Saves question-type specific options
434 *
435 * This is called by {@link save_question()} to save the question-type specific data
436 * @return object $result->error or $result->noticeyesno or $result->notice
437 * @param object $question This holds the information from the editing form,
438 * it is not a standard question object.
439 */
440 public function save_question_options($question) {
f29aeb5a 441 global $DB;
eaeb6b51 442 $extraquestionfields = $this->extra_question_fields();
295043c2 443
eaeb6b51
TH
444 if (is_array($extraquestionfields)) {
445 $question_extension_table = array_shift($extraquestionfields);
271e6dec 446
295043c2 447 $function = 'update_record';
d001dac7 448 $questionidcolname = $this->questionid_column_name();
eaeb6b51
TH
449 $options = $DB->get_record($question_extension_table,
450 array($questionidcolname => $question->id));
295043c2 451 if (!$options) {
452 $function = 'insert_record';
0ff4bd08 453 $options = new stdClass();
d001dac7 454 $options->$questionidcolname = $question->id;
295043c2 455 }
eaeb6b51 456 foreach ($extraquestionfields as $field) {
295043c2 457 if (!isset($question->$field)) {
0ff4bd08 458 $result = new stdClass();
295043c2 459 $result->error = "No data for field $field when saving " .
460 $this->name() . ' question id ' . $question->id;
461 return $result;
462 }
463 $options->$field = $question->$field;
464 }
271e6dec 465
f29aeb5a 466 if (!$DB->{$function}($question_extension_table, $options)) {
0ff4bd08 467 $result = new stdClass();
295043c2 468 $result->error = 'Could not save question options for ' .
469 $this->name() . ' question id ' . $question->id;
470 return $result;
471 }
472 }
473
eaeb6b51 474 $extraanswerfields = $this->extra_answer_fields();
295043c2 475 // TODO save the answers, with any extra data.
516cf3eb 476 }
477
d1b7e03d 478 public function save_hints($formdata, $withparts = false) {
f29aeb5a 479 global $DB;
7a719748
TH
480 $context = $formdata->context;
481
e5060e22
JP
482 $oldhints = $DB->get_records('question_hints',
483 array('questionid' => $formdata->id), 'id ASC');
295043c2 484
d1b7e03d
TH
485 if (!empty($formdata->hint)) {
486 $numhints = max(array_keys($formdata->hint)) + 1;
487 } else {
488 $numhints = 0;
516cf3eb 489 }
295043c2 490
d1b7e03d
TH
491 if ($withparts) {
492 if (!empty($formdata->hintclearwrong)) {
493 $numclears = max(array_keys($formdata->hintclearwrong)) + 1;
494 } else {
495 $numclears = 0;
496 }
497 if (!empty($formdata->hintshownumcorrect)) {
498 $numshows = max(array_keys($formdata->hintshownumcorrect)) + 1;
499 } else {
500 $numshows = 0;
501 }
502 $numhints = max($numhints, $numclears, $numshows);
503 }
504
505 for ($i = 0; $i < $numhints; $i += 1) {
7a719748
TH
506 if (html_is_blank($formdata->hint[$i]['text'])) {
507 $formdata->hint[$i]['text'] = '';
d1b7e03d
TH
508 }
509
510 if ($withparts) {
7a719748
TH
511 $clearwrong = !empty($formdata->hintclearwrong[$i]);
512 $shownumcorrect = !empty($formdata->hintshownumcorrect[$i]);
d1b7e03d
TH
513 }
514
eaeb6b51
TH
515 if (empty($formdata->hint[$i]['text']) && empty($clearwrong) &&
516 empty($shownumcorrect)) {
d1b7e03d
TH
517 continue;
518 }
519
f3ca24e4 520 // Update an existing hint if possible.
7a719748
TH
521 $hint = array_shift($oldhints);
522 if (!$hint) {
523 $hint = new stdClass();
524 $hint->questionid = $formdata->id;
525 $hint->hint = '';
526 $hint->id = $DB->insert_record('question_hints', $hint);
527 }
528
7a719748
TH
529 $hint->hint = $this->import_or_save_files($formdata->hint[$i],
530 $context, 'question', 'hint', $hint->id);
531 $hint->hintformat = $formdata->hint[$i]['format'];
532 if ($withparts) {
533 $hint->clearwrong = $clearwrong;
534 $hint->shownumcorrect = $shownumcorrect;
535 }
536 $DB->update_record('question_hints', $hint);
537 }
538
539 // Delete any remaining old hints.
540 $fs = get_file_storage();
c73c9836 541 foreach ($oldhints as $oldhint) {
7a719748
TH
542 $fs->delete_area_files($context->id, 'question', 'hint', $oldhint->id);
543 $DB->delete_records('question_hints', array('id' => $oldhint->id));
d1b7e03d
TH
544 }
545 }
546
1c2ed7c5
TH
547 /**
548 * Can be used to {@link save_question_options()} to transfer the combined
549 * feedback fields from $formdata to $options.
550 * @param object $options the $question->options object being built.
551 * @param object $formdata the data from the form.
552 * @param object $context the context the quetsion is being saved into.
f7970e3c 553 * @param bool $withparts whether $options->shownumcorrect should be set.
1c2ed7c5 554 */
eaeb6b51
TH
555 protected function save_combined_feedback_helper($options, $formdata,
556 $context, $withparts = false) {
1c2ed7c5
TH
557 $options->correctfeedback = $this->import_or_save_files($formdata->correctfeedback,
558 $context, 'question', 'correctfeedback', $formdata->id);
559 $options->correctfeedbackformat = $formdata->correctfeedback['format'];
eaeb6b51
TH
560
561 $options->partiallycorrectfeedback = $this->import_or_save_files(
562 $formdata->partiallycorrectfeedback,
1c2ed7c5
TH
563 $context, 'question', 'partiallycorrectfeedback', $formdata->id);
564 $options->partiallycorrectfeedbackformat = $formdata->partiallycorrectfeedback['format'];
eaeb6b51 565
1c2ed7c5
TH
566 $options->incorrectfeedback = $this->import_or_save_files($formdata->incorrectfeedback,
567 $context, 'question', 'incorrectfeedback', $formdata->id);
568 $options->incorrectfeedbackformat = $formdata->incorrectfeedback['format'];
569
570 if ($withparts) {
571 $options->shownumcorrect = !empty($formdata->shownumcorrect);
572 }
573
574 return $options;
575 }
576
d1b7e03d
TH
577 /**
578 * Loads the question type specific options for the question.
579 *
580 * This function loads any question type specific options for the
581 * question from the database into the question object. This information
582 * is placed in the $question->options field. A question type is
583 * free, however, to decide on a internal structure of the options field.
584 * @return bool Indicates success or failure.
585 * @param object $question The question object for the question. This object
586 * should be updated to include the question type
587 * specific information (it is passed by reference).
588 */
589 public function get_question_options($question) {
f29aeb5a
TH
590 global $CFG, $DB, $OUTPUT;
591
592 if (!isset($question->options)) {
593 $question->options = new stdClass();
594 }
d1b7e03d 595
eaeb6b51
TH
596 $extraquestionfields = $this->extra_question_fields();
597 if (is_array($extraquestionfields)) {
598 $question_extension_table = array_shift($extraquestionfields);
599 $extra_data = $DB->get_record($question_extension_table,
600 array($this->questionid_column_name() => $question->id),
601 implode(', ', $extraquestionfields));
295043c2 602 if ($extra_data) {
eaeb6b51 603 foreach ($extraquestionfields as $field) {
295043c2 604 $question->options->$field = $extra_data->$field;
605 }
606 } else {
eaeb6b51
TH
607 echo $OUTPUT->notification('Failed to load question options from the table ' .
608 $question_extension_table . ' for questionid ' . $question->id);
295043c2 609 return false;
610 }
611 }
612
eaeb6b51
TH
613 $extraanswerfields = $this->extra_answer_fields();
614 if (is_array($extraanswerfields)) {
615 $answer_extension_table = array_shift($extraanswerfields);
f29aeb5a 616 $question->options->answers = $DB->get_records_sql("
eaeb6b51 617 SELECT qa.*, qax." . implode(', qax.', $extraanswerfields) . "
e5060e22 618 FROM {question_answers} qa, {{$answer_extension_table}} qax
da8cd9f4
JP
619 WHERE qa.question = ? AND qax.answerid = qa.id
620 ORDER BY qa.id", array($question->id));
295043c2 621 if (!$question->options->answers) {
eaeb6b51
TH
622 echo $OUTPUT->notification('Failed to load question answers from the table ' .
623 $answer_extension_table . 'for questionid ' . $question->id);
295043c2 624 return false;
625 }
626 } else {
eaeb6b51
TH
627 // Don't check for success or failure because some question types do
628 // not use the answers table.
629 $question->options->answers = $DB->get_records('question_answers',
630 array('question' => $question->id), 'id ASC');
295043c2 631 }
632
eaeb6b51
TH
633 $question->hints = $DB->get_records('question_hints',
634 array('questionid' => $question->id), 'id ASC');
d1b7e03d 635
516cf3eb 636 return true;
637 }
638
639 /**
d1b7e03d
TH
640 * Create an appropriate question_definition for the question of this type
641 * using data loaded from the database.
642 * @param object $questiondata the question data loaded from the database.
643 * @return question_definition the corresponding question_definition.
644 */
645 public function make_question($questiondata) {
646 $question = $this->make_question_instance($questiondata);
647 $this->initialise_question_instance($question, $questiondata);
648 return $question;
649 }
0429cd86 650
d1b7e03d
TH
651 /**
652 * Create an appropriate question_definition for the question of this type
653 * using data loaded from the database.
654 * @param object $questiondata the question data loaded from the database.
655 * @return question_definition an instance of the appropriate question_definition subclass.
656 * Still needs to be initialised.
657 */
658 protected function make_question_instance($questiondata) {
659 question_bank::load_question_definition_classes($this->name());
660 $class = 'qtype_' . $this->name() . '_question';
661 return new $class();
662 }
663
664 /**
665 * Initialise the common question_definition fields.
666 * @param question_definition $question the question_definition we are creating.
667 * @param object $questiondata the question data loaded from the database.
668 */
669 protected function initialise_question_instance(question_definition $question, $questiondata) {
670 $question->id = $questiondata->id;
671 $question->category = $questiondata->category;
56e82d99 672 $question->contextid = $questiondata->contextid;
d1b7e03d
TH
673 $question->parent = $questiondata->parent;
674 $question->qtype = $this;
675 $question->name = $questiondata->name;
676 $question->questiontext = $questiondata->questiontext;
677 $question->questiontextformat = $questiondata->questiontextformat;
678 $question->generalfeedback = $questiondata->generalfeedback;
1c2ed7c5 679 $question->generalfeedbackformat = $questiondata->generalfeedbackformat;
d1b7e03d
TH
680 $question->defaultmark = $questiondata->defaultmark + 0;
681 $question->length = $questiondata->length;
682 $question->penalty = $questiondata->penalty;
683 $question->stamp = $questiondata->stamp;
684 $question->version = $questiondata->version;
685 $question->hidden = $questiondata->hidden;
686 $question->timecreated = $questiondata->timecreated;
687 $question->timemodified = $questiondata->timemodified;
688 $question->createdby = $questiondata->createdby;
689 $question->modifiedby = $questiondata->modifiedby;
690
10677751
OS
691 //Fill extra question fields values
692 $extraquestionfields = $this->extra_question_fields();
693 if (is_array($extraquestionfields)) {
694 //omit table name
695 array_shift($extraquestionfields);
696 foreach($extraquestionfields as $field) {
697 $question->$field = $questiondata->options->$field;
698 }
699 }
700
d1b7e03d
TH
701 $this->initialise_question_hints($question, $questiondata);
702 }
703
704 /**
705 * Initialise question_definition::hints field.
706 * @param question_definition $question the question_definition we are creating.
707 * @param object $questiondata the question data loaded from the database.
708 */
709 protected function initialise_question_hints(question_definition $question, $questiondata) {
710 if (empty($questiondata->hints)) {
711 return;
712 }
713 foreach ($questiondata->hints as $hint) {
714 $question->hints[] = $this->make_hint($hint);
715 }
0429cd86 716 }
717
718 /**
d1b7e03d
TH
719 * Create a question_hint, or an appropriate subclass for this question,
720 * from a row loaded from the database.
721 * @param object $hint the DB row from the question hints table.
722 * @return question_hint
9203b705 723 */
d1b7e03d
TH
724 protected function make_hint($hint) {
725 return question_hint::load_from_record($hint);
726 }
727
1c2ed7c5
TH
728 /**
729 * Initialise the combined feedback fields.
730 * @param question_definition $question the question_definition we are creating.
731 * @param object $questiondata the question data loaded from the database.
f7970e3c 732 * @param bool $withparts whether to set the shownumcorrect field.
1c2ed7c5 733 */
eaeb6b51
TH
734 protected function initialise_combined_feedback(question_definition $question,
735 $questiondata, $withparts = false) {
1c2ed7c5
TH
736 $question->correctfeedback = $questiondata->options->correctfeedback;
737 $question->correctfeedbackformat = $questiondata->options->correctfeedbackformat;
738 $question->partiallycorrectfeedback = $questiondata->options->partiallycorrectfeedback;
eaeb6b51
TH
739 $question->partiallycorrectfeedbackformat =
740 $questiondata->options->partiallycorrectfeedbackformat;
1c2ed7c5
TH
741 $question->incorrectfeedback = $questiondata->options->incorrectfeedback;
742 $question->incorrectfeedbackformat = $questiondata->options->incorrectfeedbackformat;
743 if ($withparts) {
744 $question->shownumcorrect = $questiondata->options->shownumcorrect;
745 }
746 }
747
d1b7e03d
TH
748 /**
749 * Initialise question_definition::answers field.
750 * @param question_definition $question the question_definition we are creating.
751 * @param object $questiondata the question data loaded from the database.
35c9b652
TH
752 * @param bool $forceplaintextanswers most qtypes assume that answers are
753 * FORMAT_PLAIN, and dont use the answerformat DB column (it contains
754 * the default 0 = FORMAT_MOODLE). Therefore, by default this method
755 * ingores answerformat. Pass false here to use answerformat. For example
756 * multichoice does this.
757 */
758 protected function initialise_question_answers(question_definition $question,
759 $questiondata, $forceplaintextanswers = true) {
d1b7e03d
TH
760 $question->answers = array();
761 if (empty($questiondata->options->answers)) {
762 return;
763 }
764 foreach ($questiondata->options->answers as $a) {
5f7cfba7
TH
765 $question->answers[$a->id] = new question_answer($a->id, $a->answer,
766 $a->fraction, $a->feedback, $a->feedbackformat);
35c9b652
TH
767 if (!$forceplaintextanswers) {
768 $question->answers[$a->id]->answerformat = $a->answerformat;
769 }
d1b7e03d
TH
770 }
771 }
9203b705 772
d1b7e03d 773 /**
f29aeb5a 774 * Deletes the question-type specific data when a question is deleted.
f7970e3c
TH
775 * @param int $question the question being deleted.
776 * @param int $contextid the context this quesiotn belongs to.
f29aeb5a
TH
777 */
778 public function delete_question($questionid, $contextid) {
779 global $DB;
780
781 $this->delete_files($questionid, $contextid);
516cf3eb 782
eaeb6b51
TH
783 $extraquestionfields = $this->extra_question_fields();
784 if (is_array($extraquestionfields)) {
785 $question_extension_table = array_shift($extraquestionfields);
f29aeb5a
TH
786 $DB->delete_records($question_extension_table,
787 array($this->questionid_column_name() => $questionid));
295043c2 788 }
789
eaeb6b51
TH
790 $extraanswerfields = $this->extra_answer_fields();
791 if (is_array($extraanswerfields)) {
792 $answer_extension_table = array_shift($extraanswerfields);
f29aeb5a 793 $DB->delete_records_select($answer_extension_table,
eaeb6b51
TH
794 'answerid IN (SELECT qa.id FROM {question_answers} qa WHERE qa.question = ?)',
795 array($questionid));
295043c2 796 }
797
f29aeb5a 798 $DB->delete_records('question_answers', array('question' => $questionid));
d1b7e03d 799
f29aeb5a 800 $DB->delete_records('question_hints', array('questionid' => $questionid));
516cf3eb 801 }
802
803 /**
eaeb6b51
TH
804 * Returns the number of question numbers which are used by the question
805 *
806 * This function returns the number of question numbers to be assigned
807 * to the question. Most question types will have length one; they will be
808 * assigned one number. The 'description' type, however does not use up a
809 * number and so has a length of zero. Other question types may wish to
810 * handle a bundle of questions and hence return a number greater than one.
811 * @return int The number of question numbers which should be
812 * assigned to the question.
813 * @param object $question The question whose length is to be determined.
814 * Question type specific information is included.
815 */
d1b7e03d 816 public function actual_number_of_questions($question) {
516cf3eb 817 // By default, each question is given one number
818 return 1;
819 }
820
6f51ed72 821 /**
822 * @param object $question
d1b7e03d
TH
823 * @return number|null either a fraction estimating what the student would
824 * score by guessing, or null, if it is not possible to estimate.
6f51ed72 825 */
c7df5006 826 public function get_random_guess_score($questiondata) {
6f51ed72 827 return 0;
828 }
516cf3eb 829
516cf3eb 830 /**
d1b7e03d 831 * This method should return all the possible types of response that are
f9b0500f 832 * recognised for this question.
271e6dec 833 *
d1b7e03d
TH
834 * The question is modelled as comprising one or more subparts. For each
835 * subpart, there are one or more classes that that students response
836 * might fall into, each of those classes earning a certain score.
50da63eb 837 *
d1b7e03d
TH
838 * For example, in a shortanswer question, there is only one subpart, the
839 * text entry field. The response the student gave will be classified according
840 * to which of the possible $question->options->answers it matches.
271e6dec 841 *
d1b7e03d
TH
842 * For the matching question type, there will be one subpart for each
843 * question stem, and for each stem, each of the possible choices is a class
844 * of student's response.
845 *
846 * A response is an object with two fields, ->responseclass is a string
847 * presentation of that response, and ->fraction, the credit for a response
848 * in that class.
849 *
850 * Array keys have no specific meaning, but must be unique, and must be
851 * the same if this function is called repeatedly.
852 *
853 * @param object $question the question definition data.
854 * @return array keys are subquestionid, values are arrays of possible
855 * responses to that subquestion.
99ba746d 856 */
c7df5006 857 public function get_possible_responses($questiondata) {
d1b7e03d 858 return array();
50da63eb 859 }
5fceb049 860
50da63eb 861 /**
46e40567
TH
862 * Utility method used by {@link qtype_renderer::head_code()}. It looks
863 * for any of the files script.js or script.php that exist in the plugin
864 * folder and ensures they get included.
50da63eb 865 */
c76145d3 866 public function find_standard_scripts() {
f29aeb5a
TH
867 global $PAGE;
868
99ba746d 869 $plugindir = $this->plugin_dir();
f29aeb5a 870 $plugindirrel = 'question/type/' . $this->name();
50da63eb 871
872 if (file_exists($plugindir . '/script.js')) {
f29aeb5a 873 $PAGE->requires->js('/' . $plugindirrel . '/script.js');
50da63eb 874 }
875 if (file_exists($plugindir . '/script.php')) {
f29aeb5a 876 $PAGE->requires->js('/' . $plugindirrel . '/script.php');
516cf3eb 877 }
fe9b5cfd 878 }
879
62e76c67 880 /**
eaeb6b51
TH
881 * Returns true if the editing wizard is finished, false otherwise.
882 *
883 * The default implementation returns true, which is suitable for all question-
884 * types that only use one editing form. This function is used in
885 * question.php to decide whether we can regrade any states of the edited
886 * question and redirect to edit.php.
887 *
888 * The dataset dependent question-type, which is extended by the calculated
889 * question-type, overwrites this method because it uses multiple pages (i.e.
890 * a wizard) to set up the question and associated datasets.
891 *
892 * @param object $form The data submitted by the previous page.
893 *
894 * @return bool Whether the wizard's last page was submitted or not.
895 */
f29aeb5a 896 public function finished_edit_wizard($form) {
d1b7e03d
TH
897 //In the default case there is only one edit page.
898 return true;
62e76c67 899 }
900
eaeb6b51 901 /// IMPORT/EXPORT FUNCTIONS /////////////////
88bc20c3 902
903 /*
904 * Imports question from the Moodle XML format
905 *
906 * Imports question using information from extra_question_fields function
907 * If some of you fields contains id's you'll need to reimplement this
908 */
d1b7e03d 909 public function import_from_xml($data, $question, $format, $extra=null) {
88bc20c3 910 $question_type = $data['@']['type'];
911 if ($question_type != $this->name()) {
912 return false;
913 }
914
915 $extraquestionfields = $this->extra_question_fields();
916 if (!is_array($extraquestionfields)) {
917 return false;
918 }
919
920 //omit table name
921 array_shift($extraquestionfields);
922 $qo = $format->import_headers($data);
923 $qo->qtype = $question_type;
924
925 foreach ($extraquestionfields as $field) {
05cef658 926 $qo->$field = $format->getpath($data, array('#', $field, 0, '#'), '');
88bc20c3 927 }
928
929 // run through the answers
930 $answers = $data['#']['answer'];
931 $a_count = 0;
05cef658
JP
932 $extraanswersfields = $this->extra_answer_fields();
933 if (is_array($extraanswersfields)) {
934 array_shift($extraanswersfields);
935 }
936 foreach ($answers as $answer) {
937 $ans = $format->import_answer($answer);
938 if (!$this->has_html_answers()) {
939 $qo->answer[$a_count] = $ans->answer['text'];
940 } else {
88bc20c3 941 $qo->answer[$a_count] = $ans->answer;
88bc20c3 942 }
05cef658
JP
943 $qo->fraction[$a_count] = $ans->fraction;
944 $qo->feedback[$a_count] = $ans->feedback;
945 if (is_array($extraanswersfields)) {
946 foreach ($extraanswersfields as $field) {
947 $qo->{$field}[$a_count] =
948 $format->getpath($answer, array('#', $field, 0, '#'), '');
949 }
950 }
951 ++$a_count;
88bc20c3 952 }
953 return $qo;
954 }
955
956 /*
957 * Export question to the Moodle XML format
958 *
959 * Export question using information from extra_question_fields function
960 * If some of you fields contains id's you'll need to reimplement this
961 */
d1b7e03d 962 public function export_to_xml($question, $format, $extra=null) {
88bc20c3 963 $extraquestionfields = $this->extra_question_fields();
964 if (!is_array($extraquestionfields)) {
965 return false;
966 }
967
968 //omit table name
969 array_shift($extraquestionfields);
970 $expout='';
971 foreach ($extraquestionfields as $field) {
1b343d52 972 $exportedvalue = $format->xml_escape($question->options->$field);
2d01a916 973 $expout .= " <$field>{$exportedvalue}</$field>\n";
88bc20c3 974 }
975
05cef658
JP
976 $extraanswersfields = $this->extra_answer_fields();
977 if (is_array($extraanswersfields)) {
978 array_shift($extraanswersfields);
979 }
980 foreach ($question->options->answers as $answer) {
bbc8c321 981 // TODO this should be re-factored to use $format->write_answer().
05cef658 982 $percent = 100 * $answer->fraction;
bbc8c321 983 $expout .= " <answer fraction=\"$percent\" {$format->format($answer->answerformat)}>\n";
05cef658 984 $expout .= $format->writetext($answer->answer, 3, false);
a24e3570 985 $expout .= " <feedback {$format->format($answer->feedbackformat)}>\n";
05cef658
JP
986 $expout .= $format->writetext($answer->feedback, 4, false);
987 $expout .= " </feedback>\n";
988 if (is_array($extraanswersfields)) {
989 foreach ($extraanswersfields as $field) {
1b343d52
TH
990 $exportedvalue = $format->xml_escape($answer->$field);
991 $expout .= " <{$field}>{$exportedvalue}</{$field}>\n";
05cef658 992 }
88bc20c3 993 }
05cef658 994
05cef658 995 $expout .= " </answer>\n";
88bc20c3 996 }
997 return $expout;
998 }
999
b9bd6da4 1000 /**
1001 * Abstract function implemented by each question type. It runs all the code
1002 * required to set up and save a question of any type for testing purposes.
1003 * Alternate DB table prefix may be used to facilitate data deletion.
1004 */
d1b7e03d 1005 public function generate_test($name, $courseid=null) {
b9bd6da4 1006 $form = new stdClass();
1007 $form->name = $name;
1008 $form->questiontextformat = 1;
1009 $form->questiontext = 'test question, generated by script';
d1b7e03d
TH
1010 $form->defaultmark = 1;
1011 $form->penalty = 0.3333333;
b9bd6da4 1012 $form->generalfeedback = "Well done";
1013
1014 $context = get_context_instance(CONTEXT_COURSE, $courseid);
1015 $newcategory = question_make_default_categories(array($context));
1016 $form->category = $newcategory->id . ',1';
1017
1018 $question = new stdClass();
1019 $question->courseid = $courseid;
1020 $question->qtype = $this->qtype;
1021 return array($form, $question);
1022 }
f29aeb5a
TH
1023
1024 /**
1025 * Get question context by category id
1026 * @param int $category
1027 * @return object $context
1028 */
c7df5006 1029 protected function get_context_by_category_id($category) {
f29aeb5a
TH
1030 global $DB;
1031 $contextid = $DB->get_field('question_categories', 'contextid', array('id'=>$category));
1032 $context = get_context_instance_by_id($contextid);
1033 return $context;
1034 }
1035
1036 /**
1037 * Save the file belonging to one text field.
1038 *
1039 * @param array $field the data from the form (or from import). This will
1040 * normally have come from the formslib editor element, so it will be an
1041 * array with keys 'text', 'format' and 'itemid'. However, when we are
1042 * importing, it will be an array with keys 'text', 'format' and 'files'
1043 * @param object $context the context the question is in.
1044 * @param string $component indentifies the file area question.
eaeb6b51
TH
1045 * @param string $filearea indentifies the file area questiontext,
1046 * generalfeedback, answerfeedback, etc.
f7970e3c 1047 * @param int $itemid identifies the file area.
f29aeb5a
TH
1048 *
1049 * @return string the text for this field, after files have been processed.
1050 */
1051 protected function import_or_save_files($field, $context, $component, $filearea, $itemid) {
1052 if (!empty($field['itemid'])) {
1053 // This is the normal case. We are safing the questions editing form.
1054 return file_save_draft_area_files($field['itemid'], $context->id, $component,
1055 $filearea, $itemid, $this->fileoptions, trim($field['text']));
1056
1057 } else if (!empty($field['files'])) {
1058 // This is the case when we are doing an import.
1059 foreach ($field['files'] as $file) {
1060 $this->import_file($context, $component, $filearea, $itemid, $file);
1061 }
1062 }
1063 return trim($field['text']);
1064 }
1065
1066 /**
1067 * Move all the files belonging to this question from one context to another.
f7970e3c
TH
1068 * @param int $questionid the question being moved.
1069 * @param int $oldcontextid the context it is moving from.
1070 * @param int $newcontextid the context it is moving to.
f29aeb5a
TH
1071 */
1072 public function move_files($questionid, $oldcontextid, $newcontextid) {
1073 $fs = get_file_storage();
1074 $fs->move_area_files_to_new_context($oldcontextid,
1075 $newcontextid, 'question', 'questiontext', $questionid);
1076 $fs->move_area_files_to_new_context($oldcontextid,
1077 $newcontextid, 'question', 'generalfeedback', $questionid);
1078 }
1079
1080 /**
1081 * Move all the files belonging to this question's answers when the question
1082 * is moved from one context to another.
f7970e3c
TH
1083 * @param int $questionid the question being moved.
1084 * @param int $oldcontextid the context it is moving from.
1085 * @param int $newcontextid the context it is moving to.
1086 * @param bool $answerstoo whether there is an 'answer' question area,
f29aeb5a
TH
1087 * as well as an 'answerfeedback' one. Default false.
1088 */
eaeb6b51
TH
1089 protected function move_files_in_answers($questionid, $oldcontextid,
1090 $newcontextid, $answerstoo = false) {
f29aeb5a
TH
1091 global $DB;
1092 $fs = get_file_storage();
1093
1094 $answerids = $DB->get_records_menu('question_answers',
1095 array('question' => $questionid), 'id', 'id,1');
1096 foreach ($answerids as $answerid => $notused) {
1097 if ($answerstoo) {
1098 $fs->move_area_files_to_new_context($oldcontextid,
1099 $newcontextid, 'question', 'answer', $answerid);
1100 }
1101 $fs->move_area_files_to_new_context($oldcontextid,
1102 $newcontextid, 'question', 'answerfeedback', $answerid);
1103 }
1104 }
1105
a23bda41
TH
1106 /**
1107 * Move all the files belonging to this question's answers when the question
1108 * is moved from one context to another.
1109 * @param int $questionid the question being moved.
1110 * @param int $oldcontextid the context it is moving from.
1111 * @param int $newcontextid the context it is moving to.
1112 * @param bool $answerstoo whether there is an 'answer' question area,
1113 * as well as an 'answerfeedback' one. Default false.
1114 */
1115 protected function move_files_in_combined_feedback($questionid, $oldcontextid,
1116 $newcontextid) {
1117 global $DB;
1118 $fs = get_file_storage();
1119
1120 $fs->move_area_files_to_new_context($oldcontextid,
1121 $newcontextid, 'question', 'correctfeedback', $questionid);
1122 $fs->move_area_files_to_new_context($oldcontextid,
1123 $newcontextid, 'question', 'partiallycorrectfeedback', $questionid);
1124 $fs->move_area_files_to_new_context($oldcontextid,
1125 $newcontextid, 'question', 'incorrectfeedback', $questionid);
1126 }
1127
f29aeb5a
TH
1128 /**
1129 * Delete all the files belonging to this question.
f7970e3c
TH
1130 * @param int $questionid the question being deleted.
1131 * @param int $contextid the context the question is in.
f29aeb5a
TH
1132 */
1133 protected function delete_files($questionid, $contextid) {
1134 $fs = get_file_storage();
1135 $fs->delete_area_files($contextid, 'question', 'questiontext', $questionid);
1136 $fs->delete_area_files($contextid, 'question', 'generalfeedback', $questionid);
1137 }
1138
1139 /**
1140 * Delete all the files belonging to this question's answers.
f7970e3c
TH
1141 * @param int $questionid the question being deleted.
1142 * @param int $contextid the context the question is in.
1143 * @param bool $answerstoo whether there is an 'answer' question area,
f29aeb5a
TH
1144 * as well as an 'answerfeedback' one. Default false.
1145 */
1146 protected function delete_files_in_answers($questionid, $contextid, $answerstoo = false) {
1147 global $DB;
1148 $fs = get_file_storage();
1149
1150 $answerids = $DB->get_records_menu('question_answers',
1151 array('question' => $questionid), 'id', 'id,1');
1152 foreach ($answerids as $answerid => $notused) {
1153 if ($answerstoo) {
1154 $fs->delete_area_files($contextid, 'question', 'answer', $answerid);
1155 }
1156 $fs->delete_area_files($contextid, 'question', 'answerfeedback', $answerid);
1157 }
1158 }
1159
a23bda41
TH
1160 /**
1161 * Delete all the files belonging to this question's answers.
1162 * @param int $questionid the question being deleted.
1163 * @param int $contextid the context the question is in.
1164 * @param bool $answerstoo whether there is an 'answer' question area,
1165 * as well as an 'answerfeedback' one. Default false.
1166 */
1167 protected function delete_files_in_combined_feedback($questionid, $contextid) {
1168 global $DB;
1169 $fs = get_file_storage();
1170
1171 $fs->delete_area_files($contextid,
1172 'question', 'correctfeedback', $questionid);
1173 $fs->delete_area_files($contextid,
1174 'question', 'partiallycorrectfeedback', $questionid);
1175 $fs->delete_area_files($contextid,
1176 'question', 'incorrectfeedback', $questionid);
1177 }
1178
f902a54e 1179 public function import_file($context, $component, $filearea, $itemid, $file) {
f29aeb5a 1180 $fs = get_file_storage();
0ff4bd08 1181 $record = new stdClass();
f29aeb5a
TH
1182 if (is_object($context)) {
1183 $record->contextid = $context->id;
1184 } else {
1185 $record->contextid = $context;
1186 }
1187 $record->component = $component;
1188 $record->filearea = $filearea;
1189 $record->itemid = $itemid;
1190 $record->filename = $file->name;
1191 $record->filepath = '/';
1192 return $fs->create_file_from_string($record, $this->decode_file($file));
1193 }
1194
c7df5006 1195 protected function decode_file($file) {
f29aeb5a 1196 switch ($file->encoding) {
eaeb6b51
TH
1197 case 'base64':
1198 default:
1199 return base64_decode($file->content);
f29aeb5a
TH
1200 }
1201 }
d1b7e03d 1202}
aeb15530 1203
cde2709a 1204
d1b7e03d
TH
1205/**
1206 * This class is used in the return value from
1207 * {@link question_type::get_possible_responses()}.
1208 *
7764183a
TH
1209 * @copyright 2010 The Open University
1210 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
d1b7e03d
TH
1211 */
1212class question_possible_response {
9203b705 1213 /**
d1b7e03d
TH
1214 * @var string the classification of this response the student gave to this
1215 * part of the question. Must match one of the responseclasses returned by
1216 * {@link question_type::get_possible_responses()}.
9203b705 1217 */
d1b7e03d
TH
1218 public $responseclass;
1219 /** @var string the actual response the student gave to this part. */
1220 public $fraction;
9203b705 1221 /**
d1b7e03d
TH
1222 * Constructor, just an easy way to set the fields.
1223 * @param string $responseclassid see the field descriptions above.
1224 * @param string $response see the field descriptions above.
1225 * @param number $fraction see the field descriptions above.
9203b705 1226 */
d1b7e03d
TH
1227 public function __construct($responseclass, $fraction) {
1228 $this->responseclass = $responseclass;
1229 $this->fraction = $fraction;
cde2709a
DC
1230 }
1231
d1b7e03d
TH
1232 public static function no_response() {
1233 return new question_possible_response(get_string('noresponse', 'question'), 0);
cde2709a 1234 }
fe6ce234 1235}