MDL-36088 questions: Add new events
[moodle.git] / question / type / questiontypebase.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  * The default questiontype class.
19  *
20  * @package    moodlecore
21  * @subpackage questiontypes
22  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
29 require_once($CFG->dirroot . '/question/engine/lib.php');
32 /**
33  * This is the base class for Moodle question types.
34  *
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.
37  *
38  * Note: the questiontype API should NOT be considered stable yet. Very few
39  * question types have been produced yet, so we do not yet know all the places
40  * where the current API is insufficient. I would rather learn from the
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.
44  *
45  * @copyright  1999 onwards Martin Dougiamas {@link http://moodle.com}
46  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
47  */
48 class question_type {
49     protected $fileoptions = array(
50         'subdirs' => true,
51         'maxfiles' => -1,
52         'maxbytes' => 0,
53     );
55     public function __construct() {
56     }
58     /**
59      * @return string the name of this question type.
60      */
61     public function name() {
62         return substr(get_class($this), 6);
63     }
65     /**
66      * @return string the full frankenstyle name for this plugin.
67      */
68     public function plugin_name() {
69         return get_class($this);
70     }
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() {
77         return get_string('pluginname', $this->plugin_name());
78     }
80     /**
81      * The name this question should appear as in the create new question
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.
85      *
86      * @return mixed the desired string, or false to hide this question type in the menu.
87      */
88     public function menu_name() {
89         return $this->local_name();
90     }
92     /**
93      * @return bool override this to return false if this is not really a
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;
99     }
101     /**
102      * @return bool true if this question type sometimes requires manual grading.
103      */
104     public function is_manual_graded() {
105         return false;
106     }
108     /**
109      * @param object $question a question of this type.
110      * @param string $otherquestionsinuse comma-separate list of other question ids in this attempt.
111      * @return bool true if a particular instance of this question requires manual grading.
112      */
113     public function is_question_manual_graded($question, $otherquestionsinuse) {
114         return $this->is_manual_graded();
115     }
117     /**
118      * @return bool true if this question type can be used by the random question type.
119      */
120     public function is_usable_by_random() {
121         return true;
122     }
124     /**
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      *
132      * @return bool whether this report can analyse all the student responses
133      * for things like the quiz statistics report.
134      */
135     public function can_analyse_responses() {
136         // This works in most cases.
137         return !$this->is_manual_graded();
138     }
140     /**
141      * @return whether the question_answers.answer field needs to have
142      * restore_decode_content_links_worker called on it.
143      */
144     public function has_html_answers() {
145         return false;
146     }
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      */
156     public function extra_question_fields() {
157         return null;
158     }
160     /**
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      */
164     public function questionid_column_name() {
165         return 'questionid';
166     }
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      */
175     public function extra_answer_fields() {
176         return null;
177     }
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     }
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
193      * question/type/{$this->name()}/edit_{$this->name()}_question_form.php
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      */
199     public function create_editing_form($submiturl, $question, $category,
200             $contexts, $formeditable) {
201         global $CFG;
202         require_once($CFG->dirroot . '/question/type/edit_question_form.php');
203         $definitionfile = $CFG->dirroot . '/question/type/' . $this->name() .
204                 '/edit_' . $this->name() . '_form.php';
205         if (!is_readable($definitionfile) || !is_file($definitionfile)) {
206             throw new coding_exception($this->plugin_name() .
207                     ' is missing the definition of its editing formin file ' .
208                     $definitionfile . '.');
209         }
210         require_once($definitionfile);
211         $classname = $this->plugin_name() . '_edit_form';
212         if (!class_exists($classname)) {
213             throw new coding_exception($this->plugin_name() .
214                     ' does not define the class ' . $this->plugin_name() .
215                     '_edit_form.');
216         }
217         return new $classname($submiturl, $question, $category, $contexts, $formeditable);
218     }
220     /**
221      * @return string the full path of the folder this plugin's files live in.
222      */
223     public function plugin_dir() {
224         global $CFG;
225         return $CFG->dirroot . '/question/type/' . $this->name();
226     }
228     /**
229      * @return string the URL of the folder this plugin's files live in.
230      */
231     public function plugin_baseurl() {
232         global $CFG;
233         return $CFG->wwwroot . '/question/type/' . $this->name();
234     }
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      */
244     public function display_question_editing_page($mform, $question, $wizardnow) {
245         global $OUTPUT;
246         $heading = $this->get_heading(empty($question->id));
247         echo $OUTPUT->heading_with_help($heading, 'pluginname', $this->plugin_name());
248         $mform->display();
249     }
251     /**
252      * Method called by display_question_editing_page and by question.php to get
253      * heading for breadcrumbs.
254      *
255      * @return string the heading
256      */
257     public function get_heading($adding = false) {
258         if ($adding) {
259             $string = 'pluginnameadding';
260         } else {
261             $string = 'pluginnameediting';
262         }
263         return get_string($string, $this->plugin_name());
264     }
266     /**
267      * Set any missing settings for this question to the default values. This is
268      * called before displaying the question editing form.
269      *
270      * @param object $questiondata the question data, loaded from the databsae,
271      *      or more likely a newly created question object that is only partially
272      *      initialised.
273      */
274     public function set_default_options($questiondata) {
275     }
277     /**
278      * Saves (creates or updates) a question.
279      *
280      * Given some question info and some data about the answers
281      * this function parses, organises and saves the question
282      * It is used by {@link question.php} when saving new data from
283      * a form, and also by {@link import.php} when importing questions
284      * This function in turn calls {@link save_question_options}
285      * to save question-type specific data.
286      *
287      * Whether we are saving a new question or updating an existing one can be
288      * determined by testing !empty($question->id). If it is not empty, we are updating.
289      *
290      * The question will be saved in category $form->category.
291      *
292      * @param object $question the question object which should be updated. For a
293      *      new question will be mostly empty.
294      * @param object $form the object containing the information to save, as if
295      *      from the question editing form.
296      * @param object $course not really used any more.
297      * @return object On success, return the new question object. On failure,
298      *       return an object as follows. If the error object has an errors field,
299      *       display that as an error message. Otherwise, the editing form will be
300      *       redisplayed with validation errors, from validation_errors field, which
301      *       is itself an object, shown next to the form fields. (I don't think this
302      *       is accurate any more.)
303      */
304     public function save_question($question, $form) {
305         global $USER, $DB, $OUTPUT;
307         list($question->category) = explode(',', $form->category);
308         $context = $this->get_context_by_category_id($question->category);
310         // This default implementation is suitable for most
311         // question types.
313         // First, save the basic question itself.
314         $question->name = trim($form->name);
315         $question->parent = isset($form->parent) ? $form->parent : 0;
316         $question->length = $this->actual_number_of_questions($question);
317         $question->penalty = isset($form->penalty) ? $form->penalty : 0;
319         // The trim call below has the effect of casting any strange values received,
320         // like null or false, to an appropriate string, so we only need to test for
321         // missing values. Be careful not to break the value '0' here.
322         if (!isset($form->questiontext['text'])) {
323             $question->questiontext = '';
324         } else {
325             $question->questiontext = trim($form->questiontext['text']);
326         }
327         $question->questiontextformat = !empty($form->questiontext['format']) ?
328                 $form->questiontext['format'] : 0;
330         if (empty($form->generalfeedback['text'])) {
331             $question->generalfeedback = '';
332         } else {
333             $question->generalfeedback = trim($form->generalfeedback['text']);
334         }
335         $question->generalfeedbackformat = !empty($form->generalfeedback['format']) ?
336                 $form->generalfeedback['format'] : 0;
338         if ($question->name === '') {
339             $question->name = shorten_text(strip_tags($form->questiontext['text']), 15);
340             if ($question->name === '') {
341                 $question->name = '-';
342             }
343         }
345         if ($question->penalty > 1 or $question->penalty < 0) {
346             $question->errors['penalty'] = get_string('invalidpenalty', 'question');
347         }
349         if (isset($form->defaultmark)) {
350             $question->defaultmark = $form->defaultmark;
351         }
353         if (isset($form->idnumber) && ((string) $form->idnumber !== '')) {
354             // While this check already exists in the form validation, this is a backstop preventing unnecessary errors.
355             if (strpos($form->category, ',') !== false) {
356                 list($category, $categorycontextid) = explode(',', $form->category);
357             } else {
358                 $category = $form->category;
359             }
360             if (!$DB->record_exists('question',
361                     ['idnumber' => $form->idnumber, 'category' => $category])) {
362                 $question->idnumber = $form->idnumber;
363             }
364         }
366         // If the question is new, create it.
367         $newquestion = false;
368         if (empty($question->id)) {
369             // Set the unique code.
370             $question->stamp = make_unique_id_code();
371             $question->createdby = $USER->id;
372             $question->timecreated = time();
373             $question->id = $DB->insert_record('question', $question);
374             $newquestion = true;
375         }
377         // Now, whether we are updating a existing question, or creating a new
378         // one, we have to do the files processing and update the record.
379         // Question already exists, update.
380         $question->modifiedby = $USER->id;
381         $question->timemodified = time();
383         if (!empty($question->questiontext) && !empty($form->questiontext['itemid'])) {
384             $question->questiontext = file_save_draft_area_files($form->questiontext['itemid'],
385                     $context->id, 'question', 'questiontext', (int)$question->id,
386                     $this->fileoptions, $question->questiontext);
387         }
388         if (!empty($question->generalfeedback) && !empty($form->generalfeedback['itemid'])) {
389             $question->generalfeedback = file_save_draft_area_files(
390                     $form->generalfeedback['itemid'], $context->id,
391                     'question', 'generalfeedback', (int)$question->id,
392                     $this->fileoptions, $question->generalfeedback);
393         }
394         $DB->update_record('question', $question);
396         if ($newquestion) {
397             // Log the creation of this question.
398             $event = \core\event\question_created::create_from_question_instance($question, $context);
399             $event->trigger();
400         } else {
401             // Log the update of this question.
402             $event = \core\event\question_updated::create_from_question_instance($question, $context);
403             $event->trigger();
404         }
406         // Now to save all the answers and type-specific options.
407         $form->id = $question->id;
408         $form->qtype = $question->qtype;
409         $form->category = $question->category;
410         $form->questiontext = $question->questiontext;
411         $form->questiontextformat = $question->questiontextformat;
412         // Current context.
413         $form->context = $context;
415         $result = $this->save_question_options($form);
417         if (!empty($result->error)) {
418             print_error($result->error);
419         }
421         if (!empty($result->notice)) {
422             notice($result->notice, "question.php?id={$question->id}");
423         }
425         if (!empty($result->noticeyesno)) {
426             throw new coding_exception(
427                     '$result->noticeyesno no longer supported in save_question.');
428         }
430         // Give the question a unique version stamp determined by question_hash().
431         $DB->set_field('question', 'version', question_hash($question),
432                 array('id' => $question->id));
434         return $question;
435     }
437     /**
438      * Saves question-type specific options
439      *
440      * This is called by {@link save_question()} to save the question-type specific data
441      * @return object $result->error or $result->notice
442      * @param object $question  This holds the information from the editing form,
443      *      it is not a standard question object.
444      */
445     public function save_question_options($question) {
446         global $DB;
447         $extraquestionfields = $this->extra_question_fields();
449         if (is_array($extraquestionfields)) {
450             $question_extension_table = array_shift($extraquestionfields);
452             $function = 'update_record';
453             $questionidcolname = $this->questionid_column_name();
454             $options = $DB->get_record($question_extension_table,
455                     array($questionidcolname => $question->id));
456             if (!$options) {
457                 $function = 'insert_record';
458                 $options = new stdClass();
459                 $options->$questionidcolname = $question->id;
460             }
461             foreach ($extraquestionfields as $field) {
462                 if (property_exists($question, $field)) {
463                     $options->$field = $question->$field;
464                 }
465             }
467             $DB->{$function}($question_extension_table, $options);
468         }
469     }
471     /**
472      * Save the answers, with any extra data.
473      *
474      * Questions that use answers will call it from {@link save_question_options()}.
475      * @param object $question  This holds the information from the editing form,
476      *      it is not a standard question object.
477      * @return object $result->error or $result->notice
478      */
479     public function save_question_answers($question) {
480         global $DB;
482         $context = $question->context;
483         $oldanswers = $DB->get_records('question_answers',
484                 array('question' => $question->id), 'id ASC');
486         // We need separate arrays for answers and extra answer data, so no JOINS there.
487         $extraanswerfields = $this->extra_answer_fields();
488         $isextraanswerfields = is_array($extraanswerfields);
489         $extraanswertable = '';
490         $oldanswerextras = array();
491         if ($isextraanswerfields) {
492             $extraanswertable = array_shift($extraanswerfields);
493             if (!empty($oldanswers)) {
494                 $oldanswerextras = $DB->get_records_sql("SELECT * FROM {{$extraanswertable}} WHERE " .
495                     'answerid IN (SELECT id FROM {question_answers} WHERE question = ' . $question->id . ')' );
496             }
497         }
499         // Insert all the new answers.
500         foreach ($question->answer as $key => $answerdata) {
501             // Check for, and ignore, completely blank answer from the form.
502             if ($this->is_answer_empty($question, $key)) {
503                 continue;
504             }
506             // Update an existing answer if possible.
507             $answer = array_shift($oldanswers);
508             if (!$answer) {
509                 $answer = new stdClass();
510                 $answer->question = $question->id;
511                 $answer->answer = '';
512                 $answer->feedback = '';
513                 $answer->id = $DB->insert_record('question_answers', $answer);
514             }
516             $answer = $this->fill_answer_fields($answer, $question, $key, $context);
517             $DB->update_record('question_answers', $answer);
519             if ($isextraanswerfields) {
520                 // Check, if this answer contains some extra field data.
521                 if ($this->is_extra_answer_fields_empty($question, $key)) {
522                     continue;
523                 }
525                 $answerextra = array_shift($oldanswerextras);
526                 if (!$answerextra) {
527                     $answerextra = new stdClass();
528                     $answerextra->answerid = $answer->id;
529                     // Avoid looking for correct default for any possible DB field type
530                     // by setting real values.
531                     $answerextra = $this->fill_extra_answer_fields($answerextra, $question, $key, $context, $extraanswerfields);
532                     $answerextra->id = $DB->insert_record($extraanswertable, $answerextra);
533                 } else {
534                     // Update answerid, as record may be reused from another answer.
535                     $answerextra->answerid = $answer->id;
536                     $answerextra = $this->fill_extra_answer_fields($answerextra, $question, $key, $context, $extraanswerfields);
537                     $DB->update_record($extraanswertable, $answerextra);
538                 }
539             }
540         }
542         if ($isextraanswerfields) {
543             // Delete any left over extra answer fields records.
544             $oldanswerextraids = array();
545             foreach ($oldanswerextras as $oldextra) {
546                 $oldanswerextraids[] = $oldextra->id;
547             }
548             $DB->delete_records_list($extraanswertable, 'id', $oldanswerextraids);
549         }
551         // Delete any left over old answer records.
552         $fs = get_file_storage();
553         foreach ($oldanswers as $oldanswer) {
554             $fs->delete_area_files($context->id, 'question', 'answerfeedback', $oldanswer->id);
555             $DB->delete_records('question_answers', array('id' => $oldanswer->id));
556         }
557     }
559     /**
560      * Returns true is answer with the $key is empty in the question data and should not be saved in DB.
561      *
562      * The questions using question_answers table may want to overload this. Default code will work
563      * for shortanswer and similar question types.
564      * @param object $questiondata This holds the information from the question editing form or import.
565      * @param int $key A key of the answer in question.
566      * @return bool True if answer shouldn't be saved in DB.
567      */
568     protected function is_answer_empty($questiondata, $key) {
569         return trim($questiondata->answer[$key]) == '' && $questiondata->fraction[$key] == 0 &&
570                     html_is_blank($questiondata->feedback[$key]['text']);
571     }
573     /**
574      * Return $answer, filling necessary fields for the question_answers table.
575      *
576      * The questions using question_answers table may want to overload this. Default code will work
577      * for shortanswer and similar question types.
578      * @param stdClass $answer Object to save data.
579      * @param object $questiondata This holds the information from the question editing form or import.
580      * @param int $key A key of the answer in question.
581      * @param object $context needed for working with files.
582      * @return $answer answer with filled data.
583      */
584     protected function fill_answer_fields($answer, $questiondata, $key, $context) {
585         $answer->answer   = $questiondata->answer[$key];
586         $answer->fraction = $questiondata->fraction[$key];
587         $answer->feedback = $this->import_or_save_files($questiondata->feedback[$key],
588                 $context, 'question', 'answerfeedback', $answer->id);
589         $answer->feedbackformat = $questiondata->feedback[$key]['format'];
590         return $answer;
591     }
593     /**
594      * Returns true if extra answer fields for answer with the $key is empty
595      * in the question data and should not be saved in DB.
596      *
597      * Questions where extra answer fields are optional will want to overload this.
598      * @param object $questiondata This holds the information from the question editing form or import.
599      * @param int $key A key of the answer in question.
600      * @return bool True if extra answer data shouldn't be saved in DB.
601      */
602     protected function is_extra_answer_fields_empty($questiondata, $key) {
603         // No extra answer data in base class.
604         return true;
605     }
607     /**
608      * Return $answerextra, filling necessary fields for the extra answer fields table.
609      *
610      * The questions may want to overload it to save files or do other data processing.
611      * @param stdClass $answerextra Object to save data.
612      * @param object $questiondata This holds the information from the question editing form or import.
613      * @param int $key A key of the answer in question.
614      * @param object $context needed for working with files.
615      * @param array $extraanswerfields extra answer fields (without table name).
616      * @return $answer answerextra with filled data.
617      */
618     protected function fill_extra_answer_fields($answerextra, $questiondata, $key, $context, $extraanswerfields) {
619         foreach ($extraanswerfields as $field) {
620             // The $questiondata->$field[$key] won't work in PHP, break it down to two strings of code.
621             $fieldarray = $questiondata->$field;
622             $answerextra->$field = $fieldarray[$key];
623         }
624         return $answerextra;
625     }
627     public function save_hints($formdata, $withparts = false) {
628         global $DB;
629         $context = $formdata->context;
631         $oldhints = $DB->get_records('question_hints',
632                 array('questionid' => $formdata->id), 'id ASC');
635         $numhints = $this->count_hints_on_form($formdata, $withparts);
637         for ($i = 0; $i < $numhints; $i += 1) {
638             if (html_is_blank($formdata->hint[$i]['text'])) {
639                 $formdata->hint[$i]['text'] = '';
640             }
642             if ($withparts) {
643                 $clearwrong = !empty($formdata->hintclearwrong[$i]);
644                 $shownumcorrect = !empty($formdata->hintshownumcorrect[$i]);
645             }
647             if ($this->is_hint_empty_in_form_data($formdata, $i, $withparts)) {
648                 continue;
649             }
651             // Update an existing hint if possible.
652             $hint = array_shift($oldhints);
653             if (!$hint) {
654                 $hint = new stdClass();
655                 $hint->questionid = $formdata->id;
656                 $hint->hint = '';
657                 $hint->id = $DB->insert_record('question_hints', $hint);
658             }
660             $hint->hint = $this->import_or_save_files($formdata->hint[$i],
661                     $context, 'question', 'hint', $hint->id);
662             $hint->hintformat = $formdata->hint[$i]['format'];
663             if ($withparts) {
664                 $hint->clearwrong = $clearwrong;
665                 $hint->shownumcorrect = $shownumcorrect;
666             }
667             $hint->options = $this->save_hint_options($formdata, $i, $withparts);
668             $DB->update_record('question_hints', $hint);
669         }
671         // Delete any remaining old hints.
672         $fs = get_file_storage();
673         foreach ($oldhints as $oldhint) {
674             $fs->delete_area_files($context->id, 'question', 'hint', $oldhint->id);
675             $DB->delete_records('question_hints', array('id' => $oldhint->id));
676         }
677     }
679     /**
680      * Count number of hints on the form.
681      * Overload if you use custom hint controls.
682      * @param object $formdata the data from the form.
683      * @param bool $withparts whether to take into account clearwrong and shownumcorrect options.
684      * @return int count of hints on the form.
685      */
686     protected function count_hints_on_form($formdata, $withparts) {
687         if (!empty($formdata->hint)) {
688             $numhints = max(array_keys($formdata->hint)) + 1;
689         } else {
690             $numhints = 0;
691         }
693         if ($withparts) {
694             if (!empty($formdata->hintclearwrong)) {
695                 $numclears = max(array_keys($formdata->hintclearwrong)) + 1;
696             } else {
697                 $numclears = 0;
698             }
699             if (!empty($formdata->hintshownumcorrect)) {
700                 $numshows = max(array_keys($formdata->hintshownumcorrect)) + 1;
701             } else {
702                 $numshows = 0;
703             }
704             $numhints = max($numhints, $numclears, $numshows);
705         }
706         return $numhints;
707     }
709     /**
710      * Determine if the hint with specified number is not empty and should be saved.
711      * Overload if you use custom hint controls.
712      * @param object $formdata the data from the form.
713      * @param int $number number of hint under question.
714      * @param bool $withparts whether to take into account clearwrong and shownumcorrect options.
715      * @return bool is this particular hint data empty.
716      */
717     protected function is_hint_empty_in_form_data($formdata, $number, $withparts) {
718         if ($withparts) {
719             return empty($formdata->hint[$number]['text']) && empty($formdata->hintclearwrong[$number]) &&
720                     empty($formdata->hintshownumcorrect[$number]);
721         } else {
722             return  empty($formdata->hint[$number]['text']);
723         }
724     }
726     /**
727      * Save additional question type data into the hint optional field.
728      * Overload if you use custom hint information.
729      * @param object $formdata the data from the form.
730      * @param int $number number of hint to get options from.
731      * @param bool $withparts whether question have parts.
732      * @return string value to save into the options field of question_hints table.
733      */
734     protected function save_hint_options($formdata, $number, $withparts) {
735         return null;    // By default, options field is unused.
736     }
738     /**
739      * Can be used to {@link save_question_options()} to transfer the combined
740      * feedback fields from $formdata to $options.
741      * @param object $options the $question->options object being built.
742      * @param object $formdata the data from the form.
743      * @param object $context the context the quetsion is being saved into.
744      * @param bool $withparts whether $options->shownumcorrect should be set.
745      */
746     protected function save_combined_feedback_helper($options, $formdata,
747             $context, $withparts = false) {
748         $options->correctfeedback = $this->import_or_save_files($formdata->correctfeedback,
749                 $context, 'question', 'correctfeedback', $formdata->id);
750         $options->correctfeedbackformat = $formdata->correctfeedback['format'];
752         $options->partiallycorrectfeedback = $this->import_or_save_files(
753                 $formdata->partiallycorrectfeedback,
754                 $context, 'question', 'partiallycorrectfeedback', $formdata->id);
755         $options->partiallycorrectfeedbackformat = $formdata->partiallycorrectfeedback['format'];
757         $options->incorrectfeedback = $this->import_or_save_files($formdata->incorrectfeedback,
758                 $context, 'question', 'incorrectfeedback', $formdata->id);
759         $options->incorrectfeedbackformat = $formdata->incorrectfeedback['format'];
761         if ($withparts) {
762             $options->shownumcorrect = !empty($formdata->shownumcorrect);
763         }
765         return $options;
766     }
768     /**
769      * Loads the question type specific options for the question.
770      *
771      * This function loads any question type specific options for the
772      * question from the database into the question object. This information
773      * is placed in the $question->options field. A question type is
774      * free, however, to decide on a internal structure of the options field.
775      * @return bool            Indicates success or failure.
776      * @param object $question The question object for the question. This object
777      *                         should be updated to include the question type
778      *                         specific information (it is passed by reference).
779      */
780     public function get_question_options($question) {
781         global $CFG, $DB, $OUTPUT;
783         if (!isset($question->options)) {
784             $question->options = new stdClass();
785         }
787         $extraquestionfields = $this->extra_question_fields();
788         if (is_array($extraquestionfields)) {
789             $question_extension_table = array_shift($extraquestionfields);
790             $extra_data = $DB->get_record($question_extension_table,
791                     array($this->questionid_column_name() => $question->id),
792                     implode(', ', $extraquestionfields));
793             if ($extra_data) {
794                 foreach ($extraquestionfields as $field) {
795                     $question->options->$field = $extra_data->$field;
796                 }
797             } else {
798                 echo $OUTPUT->notification('Failed to load question options from the table ' .
799                         $question_extension_table . ' for questionid ' . $question->id);
800                 return false;
801             }
802         }
804         $extraanswerfields = $this->extra_answer_fields();
805         if (is_array($extraanswerfields)) {
806             $answerextensiontable = array_shift($extraanswerfields);
807             // Use LEFT JOIN in case not every answer has extra data.
808             $question->options->answers = $DB->get_records_sql("
809                     SELECT qa.*, qax." . implode(', qax.', $extraanswerfields) . '
810                     FROM {question_answers} qa ' . "
811                     LEFT JOIN {{$answerextensiontable}} qax ON qa.id = qax.answerid
812                     WHERE qa.question = ?
813                     ORDER BY qa.id", array($question->id));
814             if (!$question->options->answers) {
815                 echo $OUTPUT->notification('Failed to load question answers from the table ' .
816                         $answerextensiontable . 'for questionid ' . $question->id);
817                 return false;
818             }
819         } else {
820             // Don't check for success or failure because some question types do
821             // not use the answers table.
822             $question->options->answers = $DB->get_records('question_answers',
823                     array('question' => $question->id), 'id ASC');
824         }
826         $question->hints = $DB->get_records('question_hints',
827                 array('questionid' => $question->id), 'id ASC');
829         return true;
830     }
832     /**
833      * Create an appropriate question_definition for the question of this type
834      * using data loaded from the database.
835      * @param object $questiondata the question data loaded from the database.
836      * @return question_definition the corresponding question_definition.
837      */
838     public function make_question($questiondata) {
839         $question = $this->make_question_instance($questiondata);
840         $this->initialise_question_instance($question, $questiondata);
841         return $question;
842     }
844     /**
845      * Create an appropriate question_definition for the question of this type
846      * using data loaded from the database.
847      * @param object $questiondata the question data loaded from the database.
848      * @return question_definition an instance of the appropriate question_definition subclass.
849      *      Still needs to be initialised.
850      */
851     protected function make_question_instance($questiondata) {
852         question_bank::load_question_definition_classes($this->name());
853         $class = 'qtype_' . $this->name() . '_question';
854         return new $class();
855     }
857     /**
858      * Initialise the common question_definition fields.
859      * @param question_definition $question the question_definition we are creating.
860      * @param object $questiondata the question data loaded from the database.
861      */
862     protected function initialise_question_instance(question_definition $question, $questiondata) {
863         $question->id = $questiondata->id;
864         $question->category = $questiondata->category;
865         $question->contextid = $questiondata->contextid;
866         $question->parent = $questiondata->parent;
867         $question->qtype = $this;
868         $question->name = $questiondata->name;
869         $question->questiontext = $questiondata->questiontext;
870         $question->questiontextformat = $questiondata->questiontextformat;
871         $question->generalfeedback = $questiondata->generalfeedback;
872         $question->generalfeedbackformat = $questiondata->generalfeedbackformat;
873         $question->defaultmark = $questiondata->defaultmark + 0;
874         $question->length = $questiondata->length;
875         $question->penalty = $questiondata->penalty;
876         $question->stamp = $questiondata->stamp;
877         $question->version = $questiondata->version;
878         $question->hidden = $questiondata->hidden;
879         $question->idnumber = $questiondata->idnumber;
880         $question->timecreated = $questiondata->timecreated;
881         $question->timemodified = $questiondata->timemodified;
882         $question->createdby = $questiondata->createdby;
883         $question->modifiedby = $questiondata->modifiedby;
885         // Fill extra question fields values.
886         $extraquestionfields = $this->extra_question_fields();
887         if (is_array($extraquestionfields)) {
888             // Omit table name.
889             array_shift($extraquestionfields);
890             foreach ($extraquestionfields as $field) {
891                 $question->$field = $questiondata->options->$field;
892             }
893         }
895         $this->initialise_question_hints($question, $questiondata);
896     }
898     /**
899      * Initialise question_definition::hints field.
900      * @param question_definition $question the question_definition we are creating.
901      * @param object $questiondata the question data loaded from the database.
902      */
903     protected function initialise_question_hints(question_definition $question, $questiondata) {
904         if (empty($questiondata->hints)) {
905             return;
906         }
907         foreach ($questiondata->hints as $hint) {
908             $question->hints[] = $this->make_hint($hint);
909         }
910     }
912     /**
913      * Create a question_hint, or an appropriate subclass for this question,
914      * from a row loaded from the database.
915      * @param object $hint the DB row from the question hints table.
916      * @return question_hint
917      */
918     protected function make_hint($hint) {
919         return question_hint::load_from_record($hint);
920     }
922     /**
923      * Initialise the combined feedback fields.
924      * @param question_definition $question the question_definition we are creating.
925      * @param object $questiondata the question data loaded from the database.
926      * @param bool $withparts whether to set the shownumcorrect field.
927      */
928     protected function initialise_combined_feedback(question_definition $question,
929             $questiondata, $withparts = false) {
930         $question->correctfeedback = $questiondata->options->correctfeedback;
931         $question->correctfeedbackformat = $questiondata->options->correctfeedbackformat;
932         $question->partiallycorrectfeedback = $questiondata->options->partiallycorrectfeedback;
933         $question->partiallycorrectfeedbackformat =
934                 $questiondata->options->partiallycorrectfeedbackformat;
935         $question->incorrectfeedback = $questiondata->options->incorrectfeedback;
936         $question->incorrectfeedbackformat = $questiondata->options->incorrectfeedbackformat;
937         if ($withparts) {
938             $question->shownumcorrect = $questiondata->options->shownumcorrect;
939         }
940     }
942     /**
943      * Initialise question_definition::answers field.
944      * @param question_definition $question the question_definition we are creating.
945      * @param object $questiondata the question data loaded from the database.
946      * @param bool $forceplaintextanswers most qtypes assume that answers are
947      *      FORMAT_PLAIN, and dont use the answerformat DB column (it contains
948      *      the default 0 = FORMAT_MOODLE). Therefore, by default this method
949      *      ingores answerformat. Pass false here to use answerformat. For example
950      *      multichoice does this.
951      */
952     protected function initialise_question_answers(question_definition $question,
953             $questiondata, $forceplaintextanswers = true) {
954         $question->answers = array();
955         if (empty($questiondata->options->answers)) {
956             return;
957         }
958         foreach ($questiondata->options->answers as $a) {
959             $question->answers[$a->id] = $this->make_answer($a);
960             if (!$forceplaintextanswers) {
961                 $question->answers[$a->id]->answerformat = $a->answerformat;
962             }
963         }
964     }
966     /**
967      * Create a question_answer, or an appropriate subclass for this question,
968      * from a row loaded from the database.
969      * @param object $answer the DB row from the question_answers table plus extra answer fields.
970      * @return question_answer
971      */
972     protected function make_answer($answer) {
973         return new question_answer($answer->id, $answer->answer,
974                     $answer->fraction, $answer->feedback, $answer->feedbackformat);
975     }
977     /**
978      * Deletes the question-type specific data when a question is deleted.
979      * @param int $question the question being deleted.
980      * @param int $contextid the context this quesiotn belongs to.
981      */
982     public function delete_question($questionid, $contextid) {
983         global $DB;
985         $this->delete_files($questionid, $contextid);
987         $extraquestionfields = $this->extra_question_fields();
988         if (is_array($extraquestionfields)) {
989             $question_extension_table = array_shift($extraquestionfields);
990             $DB->delete_records($question_extension_table,
991                     array($this->questionid_column_name() => $questionid));
992         }
994         $extraanswerfields = $this->extra_answer_fields();
995         if (is_array($extraanswerfields)) {
996             $answer_extension_table = array_shift($extraanswerfields);
997             $DB->delete_records_select($answer_extension_table,
998                     'answerid IN (SELECT qa.id FROM {question_answers} qa WHERE qa.question = ?)',
999                     array($questionid));
1000         }
1002         $DB->delete_records('question_answers', array('question' => $questionid));
1004         $DB->delete_records('question_hints', array('questionid' => $questionid));
1005     }
1007     /**
1008      * Returns the number of question numbers which are used by the question
1009      *
1010      * This function returns the number of question numbers to be assigned
1011      * to the question. Most question types will have length one; they will be
1012      * assigned one number. The 'description' type, however does not use up a
1013      * number and so has a length of zero. Other question types may wish to
1014      * handle a bundle of questions and hence return a number greater than one.
1015      * @return int         The number of question numbers which should be
1016      *                         assigned to the question.
1017      * @param object $question The question whose length is to be determined.
1018      *                         Question type specific information is included.
1019      */
1020     public function actual_number_of_questions($question) {
1021         // By default, each question is given one number.
1022         return 1;
1023     }
1025     /**
1026      * @param object $question
1027      * @return number|null either a fraction estimating what the student would
1028      * score by guessing, or null, if it is not possible to estimate.
1029      */
1030     public function get_random_guess_score($questiondata) {
1031         return 0;
1032     }
1034     /**
1035      * Whether or not to break down question stats and response analysis, for a question defined by $questiondata.
1036      *
1037      * @param object $questiondata The full question definition data.
1038      * @return bool
1039      */
1040     public function break_down_stats_and_response_analysis_by_variant($questiondata) {
1041         return true;
1042     }
1044     /**
1045      * This method should return all the possible types of response that are
1046      * recognised for this question.
1047      *
1048      * The question is modelled as comprising one or more subparts. For each
1049      * subpart, there are one or more classes that that students response
1050      * might fall into, each of those classes earning a certain score.
1051      *
1052      * For example, in a shortanswer question, there is only one subpart, the
1053      * text entry field. The response the student gave will be classified according
1054      * to which of the possible $question->options->answers it matches.
1055      *
1056      * For the matching question type, there will be one subpart for each
1057      * question stem, and for each stem, each of the possible choices is a class
1058      * of student's response.
1059      *
1060      * A response is an object with two fields, ->responseclass is a string
1061      * presentation of that response, and ->fraction, the credit for a response
1062      * in that class.
1063      *
1064      * Array keys have no specific meaning, but must be unique, and must be
1065      * the same if this function is called repeatedly.
1066      *
1067      * @param object $question the question definition data.
1068      * @return array keys are subquestionid, values are arrays of possible
1069      *      responses to that subquestion.
1070      */
1071     public function get_possible_responses($questiondata) {
1072         return array();
1073     }
1075     /**
1076      * Utility method used by {@link qtype_renderer::head_code()}. It looks
1077      * for any of the files script.js or script.php that exist in the plugin
1078      * folder and ensures they get included.
1079      */
1080     public function find_standard_scripts() {
1081         global $PAGE;
1083         $plugindir = $this->plugin_dir();
1084         $plugindirrel = 'question/type/' . $this->name();
1086         if (file_exists($plugindir . '/script.js')) {
1087             $PAGE->requires->js('/' . $plugindirrel . '/script.js');
1088         }
1089         if (file_exists($plugindir . '/script.php')) {
1090             $PAGE->requires->js('/' . $plugindirrel . '/script.php');
1091         }
1092     }
1094     /**
1095      * Returns true if the editing wizard is finished, false otherwise.
1096      *
1097      * The default implementation returns true, which is suitable for all question-
1098      * types that only use one editing form. This function is used in
1099      * question.php to decide whether we can regrade any states of the edited
1100      * question and redirect to edit.php.
1101      *
1102      * The dataset dependent question-type, which is extended by the calculated
1103      * question-type, overwrites this method because it uses multiple pages (i.e.
1104      * a wizard) to set up the question and associated datasets.
1105      *
1106      * @param object $form  The data submitted by the previous page.
1107      *
1108      * @return bool      Whether the wizard's last page was submitted or not.
1109      */
1110     public function finished_edit_wizard($form) {
1111         // In the default case there is only one edit page.
1112         return true;
1113     }
1115     // IMPORT/EXPORT FUNCTIONS --------------------------------- .
1117     /*
1118      * Imports question from the Moodle XML format
1119      *
1120      * Imports question using information from extra_question_fields function
1121      * If some of you fields contains id's you'll need to reimplement this
1122      */
1123     public function import_from_xml($data, $question, qformat_xml $format, $extra=null) {
1124         $question_type = $data['@']['type'];
1125         if ($question_type != $this->name()) {
1126             return false;
1127         }
1129         $extraquestionfields = $this->extra_question_fields();
1130         if (!is_array($extraquestionfields)) {
1131             return false;
1132         }
1134         // Omit table name.
1135         array_shift($extraquestionfields);
1136         $qo = $format->import_headers($data);
1137         $qo->qtype = $question_type;
1139         foreach ($extraquestionfields as $field) {
1140             $qo->$field = $format->getpath($data, array('#', $field, 0, '#'), '');
1141         }
1143         // Run through the answers.
1144         $answers = $data['#']['answer'];
1145         $a_count = 0;
1146         $extraanswersfields = $this->extra_answer_fields();
1147         if (is_array($extraanswersfields)) {
1148             array_shift($extraanswersfields);
1149         }
1150         foreach ($answers as $answer) {
1151             $ans = $format->import_answer($answer);
1152             if (!$this->has_html_answers()) {
1153                 $qo->answer[$a_count] = $ans->answer['text'];
1154             } else {
1155                 $qo->answer[$a_count] = $ans->answer;
1156             }
1157             $qo->fraction[$a_count] = $ans->fraction;
1158             $qo->feedback[$a_count] = $ans->feedback;
1159             if (is_array($extraanswersfields)) {
1160                 foreach ($extraanswersfields as $field) {
1161                     $qo->{$field}[$a_count] =
1162                         $format->getpath($answer, array('#', $field, 0, '#'), '');
1163                 }
1164             }
1165             ++$a_count;
1166         }
1167         return $qo;
1168     }
1170     /*
1171      * Export question to the Moodle XML format
1172      *
1173      * Export question using information from extra_question_fields function
1174      * If some of you fields contains id's you'll need to reimplement this
1175      */
1176     public function export_to_xml($question, qformat_xml $format, $extra=null) {
1177         $extraquestionfields = $this->extra_question_fields();
1178         if (!is_array($extraquestionfields)) {
1179             return false;
1180         }
1182         // Omit table name.
1183         array_shift($extraquestionfields);
1184         $expout='';
1185         foreach ($extraquestionfields as $field) {
1186             $exportedvalue = $format->xml_escape($question->options->$field);
1187             $expout .= "    <{$field}>{$exportedvalue}</{$field}>\n";
1188         }
1190         $extraanswersfields = $this->extra_answer_fields();
1191         if (is_array($extraanswersfields)) {
1192             array_shift($extraanswersfields);
1193         }
1194         foreach ($question->options->answers as $answer) {
1195             $extra = '';
1196             if (is_array($extraanswersfields)) {
1197                 foreach ($extraanswersfields as $field) {
1198                     $exportedvalue = $format->xml_escape($answer->$field);
1199                     $extra .= "      <{$field}>{$exportedvalue}</{$field}>\n";
1200                 }
1201             }
1203             $expout .= $format->write_answer($answer, $extra);
1204         }
1205         return $expout;
1206     }
1208     /**
1209      * Abstract function implemented by each question type. It runs all the code
1210      * required to set up and save a question of any type for testing purposes.
1211      * Alternate DB table prefix may be used to facilitate data deletion.
1212      */
1213     public function generate_test($name, $courseid=null) {
1214         $form = new stdClass();
1215         $form->name = $name;
1216         $form->questiontextformat = 1;
1217         $form->questiontext = 'test question, generated by script';
1218         $form->defaultmark = 1;
1219         $form->penalty = 0.3333333;
1220         $form->generalfeedback = "Well done";
1222         $context = context_course::instance($courseid);
1223         $newcategory = question_make_default_categories(array($context));
1224         $form->category = $newcategory->id . ',1';
1226         $question = new stdClass();
1227         $question->courseid = $courseid;
1228         $question->qtype = $this->qtype;
1229         return array($form, $question);
1230     }
1232     /**
1233      * Get question context by category id
1234      * @param int $category
1235      * @return object $context
1236      */
1237     protected function get_context_by_category_id($category) {
1238         global $DB;
1239         $contextid = $DB->get_field('question_categories', 'contextid', array('id'=>$category));
1240         $context = context::instance_by_id($contextid, IGNORE_MISSING);
1241         return $context;
1242     }
1244     /**
1245      * Save the file belonging to one text field.
1246      *
1247      * @param array $field the data from the form (or from import). This will
1248      *      normally have come from the formslib editor element, so it will be an
1249      *      array with keys 'text', 'format' and 'itemid'. However, when we are
1250      *      importing, it will be an array with keys 'text', 'format' and 'files'
1251      * @param object $context the context the question is in.
1252      * @param string $component indentifies the file area question.
1253      * @param string $filearea indentifies the file area questiontext,
1254      *      generalfeedback, answerfeedback, etc.
1255      * @param int $itemid identifies the file area.
1256      *
1257      * @return string the text for this field, after files have been processed.
1258      */
1259     protected function import_or_save_files($field, $context, $component, $filearea, $itemid) {
1260         if (!empty($field['itemid'])) {
1261             // This is the normal case. We are safing the questions editing form.
1262             return file_save_draft_area_files($field['itemid'], $context->id, $component,
1263                     $filearea, $itemid, $this->fileoptions, trim($field['text']));
1265         } else if (!empty($field['files'])) {
1266             // This is the case when we are doing an import.
1267             foreach ($field['files'] as $file) {
1268                 $this->import_file($context, $component,  $filearea, $itemid, $file);
1269             }
1270         }
1271         return trim($field['text']);
1272     }
1274     /**
1275      * Move all the files belonging to this question from one context to another.
1276      * @param int $questionid the question being moved.
1277      * @param int $oldcontextid the context it is moving from.
1278      * @param int $newcontextid the context it is moving to.
1279      */
1280     public function move_files($questionid, $oldcontextid, $newcontextid) {
1281         $fs = get_file_storage();
1282         $fs->move_area_files_to_new_context($oldcontextid,
1283                 $newcontextid, 'question', 'questiontext', $questionid);
1284         $fs->move_area_files_to_new_context($oldcontextid,
1285                 $newcontextid, 'question', 'generalfeedback', $questionid);
1286     }
1288     /**
1289      * Move all the files belonging to this question's answers when the question
1290      * is moved from one context to another.
1291      * @param int $questionid the question being moved.
1292      * @param int $oldcontextid the context it is moving from.
1293      * @param int $newcontextid the context it is moving to.
1294      * @param bool $answerstoo whether there is an 'answer' question area,
1295      *      as well as an 'answerfeedback' one. Default false.
1296      */
1297     protected function move_files_in_answers($questionid, $oldcontextid,
1298             $newcontextid, $answerstoo = false) {
1299         global $DB;
1300         $fs = get_file_storage();
1302         $answerids = $DB->get_records_menu('question_answers',
1303                 array('question' => $questionid), 'id', 'id,1');
1304         foreach ($answerids as $answerid => $notused) {
1305             if ($answerstoo) {
1306                 $fs->move_area_files_to_new_context($oldcontextid,
1307                         $newcontextid, 'question', 'answer', $answerid);
1308             }
1309             $fs->move_area_files_to_new_context($oldcontextid,
1310                     $newcontextid, 'question', 'answerfeedback', $answerid);
1311         }
1312     }
1314     /**
1315      * Move all the files belonging to this question's hints when the question
1316      * is moved from one context to another.
1317      * @param int $questionid the question being moved.
1318      * @param int $oldcontextid the context it is moving from.
1319      * @param int $newcontextid the context it is moving to.
1320      * @param bool $answerstoo whether there is an 'answer' question area,
1321      *      as well as an 'answerfeedback' one. Default false.
1322      */
1323     protected function move_files_in_hints($questionid, $oldcontextid, $newcontextid) {
1324         global $DB;
1325         $fs = get_file_storage();
1327         $hintids = $DB->get_records_menu('question_hints',
1328                 array('questionid' => $questionid), 'id', 'id,1');
1329         foreach ($hintids as $hintid => $notused) {
1330             $fs->move_area_files_to_new_context($oldcontextid,
1331                     $newcontextid, 'question', 'hint', $hintid);
1332         }
1333     }
1335     /**
1336      * Move all the files belonging to this question's answers when the question
1337      * is moved from one context to another.
1338      * @param int $questionid the question being moved.
1339      * @param int $oldcontextid the context it is moving from.
1340      * @param int $newcontextid the context it is moving to.
1341      * @param bool $answerstoo whether there is an 'answer' question area,
1342      *      as well as an 'answerfeedback' one. Default false.
1343      */
1344     protected function move_files_in_combined_feedback($questionid, $oldcontextid,
1345             $newcontextid) {
1346         global $DB;
1347         $fs = get_file_storage();
1349         $fs->move_area_files_to_new_context($oldcontextid,
1350                 $newcontextid, 'question', 'correctfeedback', $questionid);
1351         $fs->move_area_files_to_new_context($oldcontextid,
1352                 $newcontextid, 'question', 'partiallycorrectfeedback', $questionid);
1353         $fs->move_area_files_to_new_context($oldcontextid,
1354                 $newcontextid, 'question', 'incorrectfeedback', $questionid);
1355     }
1357     /**
1358      * Delete all the files belonging to this question.
1359      * @param int $questionid the question being deleted.
1360      * @param int $contextid the context the question is in.
1361      */
1362     protected function delete_files($questionid, $contextid) {
1363         $fs = get_file_storage();
1364         $fs->delete_area_files($contextid, 'question', 'questiontext', $questionid);
1365         $fs->delete_area_files($contextid, 'question', 'generalfeedback', $questionid);
1366     }
1368     /**
1369      * Delete all the files belonging to this question's answers.
1370      * @param int $questionid the question being deleted.
1371      * @param int $contextid the context the question is in.
1372      * @param bool $answerstoo whether there is an 'answer' question area,
1373      *      as well as an 'answerfeedback' one. Default false.
1374      */
1375     protected function delete_files_in_answers($questionid, $contextid, $answerstoo = false) {
1376         global $DB;
1377         $fs = get_file_storage();
1379         $answerids = $DB->get_records_menu('question_answers',
1380                 array('question' => $questionid), 'id', 'id,1');
1381         foreach ($answerids as $answerid => $notused) {
1382             if ($answerstoo) {
1383                 $fs->delete_area_files($contextid, 'question', 'answer', $answerid);
1384             }
1385             $fs->delete_area_files($contextid, 'question', 'answerfeedback', $answerid);
1386         }
1387     }
1389     /**
1390      * Delete all the files belonging to this question's hints.
1391      * @param int $questionid the question being deleted.
1392      * @param int $contextid the context the question is in.
1393      */
1394     protected function delete_files_in_hints($questionid, $contextid) {
1395         global $DB;
1396         $fs = get_file_storage();
1398         $hintids = $DB->get_records_menu('question_hints',
1399                 array('questionid' => $questionid), 'id', 'id,1');
1400         foreach ($hintids as $hintid => $notused) {
1401             $fs->delete_area_files($contextid, 'question', 'hint', $hintid);
1402         }
1403     }
1405     /**
1406      * Delete all the files belonging to this question's answers.
1407      * @param int $questionid the question being deleted.
1408      * @param int $contextid the context the question is in.
1409      * @param bool $answerstoo whether there is an 'answer' question area,
1410      *      as well as an 'answerfeedback' one. Default false.
1411      */
1412     protected function delete_files_in_combined_feedback($questionid, $contextid) {
1413         global $DB;
1414         $fs = get_file_storage();
1416         $fs->delete_area_files($contextid,
1417                 'question', 'correctfeedback', $questionid);
1418         $fs->delete_area_files($contextid,
1419                 'question', 'partiallycorrectfeedback', $questionid);
1420         $fs->delete_area_files($contextid,
1421                 'question', 'incorrectfeedback', $questionid);
1422     }
1424     public function import_file($context, $component, $filearea, $itemid, $file) {
1425         $fs = get_file_storage();
1426         $record = new stdClass();
1427         if (is_object($context)) {
1428             $record->contextid = $context->id;
1429         } else {
1430             $record->contextid = $context;
1431         }
1432         $record->component = $component;
1433         $record->filearea  = $filearea;
1434         $record->itemid    = $itemid;
1435         $record->filename  = $file->name;
1436         $record->filepath  = '/';
1437         return $fs->create_file_from_string($record, $this->decode_file($file));
1438     }
1440     protected function decode_file($file) {
1441         switch ($file->encoding) {
1442             case 'base64':
1443             default:
1444                 return base64_decode($file->content);
1445         }
1446     }
1450 /**
1451  * This class is used in the return value from
1452  * {@link question_type::get_possible_responses()}.
1453  *
1454  * @copyright  2010 The Open University
1455  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1456  */
1457 class question_possible_response {
1458     /**
1459      * @var string the classification of this response the student gave to this
1460      * part of the question. Must match one of the responseclasses returned by
1461      * {@link question_type::get_possible_responses()}.
1462      */
1463     public $responseclass;
1465     /** @var string the (partial) credit awarded for this responses. */
1466     public $fraction;
1468     /**
1469      * Constructor, just an easy way to set the fields.
1470      * @param string $responseclassid see the field descriptions above.
1471      * @param string $response see the field descriptions above.
1472      * @param number $fraction see the field descriptions above.
1473      */
1474     public function __construct($responseclass, $fraction) {
1475         $this->responseclass = $responseclass;
1476         $this->fraction = $fraction;
1477     }
1479     public static function no_response() {
1480         return new question_possible_response(get_string('noresponse', 'question'), 0);
1481     }