MDL-61132 Questions: Add "Top" categories by default when don't exist
[moodle.git] / question / type / edit_question_form.php
CommitLineData
aeb15530 1<?php
fe6ce234
DC
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
36703ed7 17/**
18 * A base class for question editing forms.
19 *
7764183a 20 * @package moodlecore
2b7da645 21 * @subpackage questiontypes
b04a4319
TH
22 * @copyright 2006 The Open University
23 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
fe6ce234 24 */
36703ed7 25
2b7da645 26
a17b297d
TH
27defined('MOODLE_INTERNAL') || die();
28
603bd001
PS
29global $CFG;
30require_once($CFG->libdir.'/formslib.php');
31
a17b297d 32
72553162
TH
33abstract class question_wizard_form extends moodleform {
34 /**
35 * Add all the hidden form fields used by question/question.php.
36 */
37 protected function add_hidden_fields() {
38 $mform = $this->_form;
39
40 $mform->addElement('hidden', 'id');
41 $mform->setType('id', PARAM_INT);
42
43 $mform->addElement('hidden', 'inpopup');
44 $mform->setType('inpopup', PARAM_INT);
45
46 $mform->addElement('hidden', 'cmid');
47 $mform->setType('cmid', PARAM_INT);
48
49 $mform->addElement('hidden', 'courseid');
50 $mform->setType('courseid', PARAM_INT);
51
52 $mform->addElement('hidden', 'returnurl');
53 $mform->setType('returnurl', PARAM_LOCALURL);
54
55 $mform->addElement('hidden', 'scrollpos');
56 $mform->setType('scrollpos', PARAM_INT);
57
58 $mform->addElement('hidden', 'appendqnumstring');
59 $mform->setType('appendqnumstring', PARAM_ALPHA);
60 }
61}
62
36703ed7 63/**
64 * Form definition base class. This defines the common fields that
65 * all question types need. Question types should define their own
66 * class that inherits from this one, and implements the definition_inner()
67 * method.
271e6dec 68 *
7764183a
TH
69 * @copyright 2006 The Open University
70 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
36703ed7 71 */
72553162 72abstract class question_edit_form extends question_wizard_form {
2b7da645
TH
73 const DEFAULT_NUM_HINTS = 2;
74
271ffe3f 75 /**
76 * Question object with options and answers already loaded by get_question_options
77 * Be careful how you use this it is needed sometimes to set up the structure of the
32db0d42 78 * form in definition_inner but data is always loaded into the form with set_data.
271ffe3f 79 * @var object
80 */
2b7da645
TH
81 protected $question;
82
83 protected $contexts;
84 protected $category;
85 protected $categorycontext;
271e6dec 86
fe6ce234
DC
87 /** @var object current context */
88 public $context;
89 /** @var array html editor options */
90 public $editoroptions;
91 /** @var array options to preapre draft area */
92 public $fileoptions;
93 /** @var object instance of question type */
94 public $instance;
95
2b7da645 96 public function __construct($submiturl, $question, $category, $contexts, $formeditable = true) {
fe6ce234 97 global $DB;
271e6dec 98
271ffe3f 99 $this->question = $question;
271e6dec 100 $this->contexts = $contexts;
101
eaeb6b51
TH
102 $record = $DB->get_record('question_categories',
103 array('id' => $question->category), 'contextid');
d197ea43 104 $this->context = context::instance_by_id($record->contextid);
fe6ce234 105
eaeb6b51 106 $this->editoroptions = array('subdirs' => 1, 'maxfiles' => EDITOR_UNLIMITED_FILES,
0c0dfa8f 107 'context' => $this->context);
41dcc2a5 108 $this->fileoptions = array('subdirs' => 1, 'maxfiles' => -1, 'maxbytes' => -1);
fe6ce234 109
271e6dec 110 $this->category = $category;
d197ea43 111 $this->categorycontext = context::instance_by_id($category->contextid);
271e6dec 112
2b7da645 113 parent::__construct($submiturl, null, 'post', '', null, $formeditable);
271ffe3f 114 }
8e652f02 115
36703ed7 116 /**
117 * Build the form definition.
1d284fbd 118 *
295043c2 119 * This adds all the form fields that the default question type supports.
36703ed7 120 * If your question type does not support all these fields, then you can
121 * override this method and remove the ones you don't want with $mform->removeElement().
122 */
c7df5006 123 protected function definition() {
8011be18 124 global $COURSE, $CFG, $DB, $PAGE;
1d284fbd 125
36703ed7 126 $qtype = $this->qtype();
f4fe3968 127 $langfile = "qtype_{$qtype}";
1d284fbd 128
f9b0500f 129 $mform = $this->_form;
36703ed7 130
131 // Standard fields at the start of the form.
271ffe3f 132 $mform->addElement('header', 'generalheader', get_string("general", 'form'));
1d284fbd 133
2b7da645 134 if (!isset($this->question->id)) {
76cf77e4
TH
135 if (!empty($this->question->formoptions->mustbeusable)) {
136 $contexts = $this->contexts->having_add_and_use();
137 } else {
138 $contexts = $this->contexts->having_cap('moodle/question:add');
139 }
140
c7218aef 141 // Adding question.
2b7da645 142 $mform->addElement('questioncategory', 'category', get_string('category', 'question'),
76cf77e4 143 array('contexts' => $contexts));
eaeb6b51
TH
144 } else if (!($this->question->formoptions->canmove ||
145 $this->question->formoptions->cansaveasnew)) {
5d548d3e 146 // Editing question with no permission to move from category.
2b7da645 147 $mform->addElement('questioncategory', 'category', get_string('category', 'question'),
271e6dec 148 array('contexts' => array($this->categorycontext)));
f276267d
TH
149 $mform->addElement('hidden', 'usecurrentcat', 1);
150 $mform->setType('usecurrentcat', PARAM_BOOL);
151 $mform->setConstant('usecurrentcat', 1);
271e6dec 152 } else {
c7218aef 153 // Editing question with permission to move from category or save as new q.
271e6dec 154 $currentgrp = array();
eaeb6b51
TH
155 $currentgrp[0] = $mform->createElement('questioncategory', 'category',
156 get_string('categorycurrent', 'question'),
271e6dec 157 array('contexts' => array($this->categorycontext)));
eaeb6b51
TH
158 if ($this->question->formoptions->canedit ||
159 $this->question->formoptions->cansaveasnew) {
c7218aef 160 // Not move only form.
eaeb6b51
TH
161 $currentgrp[1] = $mform->createElement('checkbox', 'usecurrentcat', '',
162 get_string('categorycurrentuse', 'question'));
271e6dec 163 $mform->setDefault('usecurrentcat', 1);
164 }
165 $currentgrp[0]->freeze();
166 $currentgrp[0]->setPersistantFreeze(false);
eaeb6b51
TH
167 $mform->addGroup($currentgrp, 'currentgrp',
168 get_string('categorycurrent', 'question'), null, false);
271e6dec 169
eaeb6b51
TH
170 $mform->addElement('questioncategory', 'categorymoveto',
171 get_string('categorymoveto', 'question'),
271e6dec 172 array('contexts' => array($this->categorycontext)));
eaeb6b51
TH
173 if ($this->question->formoptions->canedit ||
174 $this->question->formoptions->cansaveasnew) {
c7218aef 175 // Not move only form.
271e6dec 176 $mform->disabledIf('categorymoveto', 'usecurrentcat', 'checked');
177 }
178 }
375ed78a 179
eaeb6b51 180 $mform->addElement('text', 'name', get_string('questionname', 'question'),
b9b38ea7 181 array('size' => 50, 'maxlength' => 255));
271ffe3f 182 $mform->setType('name', PARAM_TEXT);
36703ed7 183 $mform->addRule('name', null, 'required', null, 'client');
1d284fbd 184
2b7da645 185 $mform->addElement('editor', 'questiontext', get_string('questiontext', 'question'),
0c0dfa8f 186 array('rows' => 15), $this->editoroptions);
36703ed7 187 $mform->setType('questiontext', PARAM_RAW);
363f8224 188 $mform->addRule('questiontext', null, 'required', null, 'client');
1d284fbd 189
2b7da645 190 $mform->addElement('text', 'defaultmark', get_string('defaultmark', 'question'),
d2acbd1a 191 array('size' => 7));
7664182d 192 $mform->setType('defaultmark', PARAM_FLOAT);
2b7da645
TH
193 $mform->setDefault('defaultmark', 1);
194 $mform->addRule('defaultmark', null, 'required', null, 'client');
36703ed7 195
2b7da645 196 $mform->addElement('editor', 'generalfeedback', get_string('generalfeedback', 'question'),
0c0dfa8f 197 array('rows' => 10), $this->editoroptions);
36703ed7 198 $mform->setType('generalfeedback', PARAM_RAW);
2b7da645 199 $mform->addHelpButton('generalfeedback', 'generalfeedback', 'question');
1d284fbd 200
36703ed7 201 // Any questiontype specific fields.
202 $this->definition_inner($mform);
203
b355a1c9 204 if (core_tag_tag::is_enabled('core_question', 'question')) {
c599a682 205 $mform->addElement('header', 'tagsheader', get_string('tags'));
c599a682 206 }
b355a1c9
MG
207 $mform->addElement('tags', 'tags', get_string('tags'),
208 array('itemtype' => 'question', 'component' => 'core_question'));
c599a682 209
2b7da645 210 if (!empty($this->question->id)) {
eaeb6b51
TH
211 $mform->addElement('header', 'createdmodifiedheader',
212 get_string('createdmodifiedheader', 'question'));
7f389342 213 $a = new stdClass();
2b7da645 214 if (!empty($this->question->createdby)) {
271e6dec 215 $a->time = userdate($this->question->timecreated);
eaeb6b51
TH
216 $a->user = fullname($DB->get_record(
217 'user', array('id' => $this->question->createdby)));
271e6dec 218 } else {
219 $a->time = get_string('unknown', 'question');
220 $a->user = get_string('unknown', 'question');
221 }
eaeb6b51
TH
222 $mform->addElement('static', 'created', get_string('created', 'question'),
223 get_string('byandon', 'question', $a));
2b7da645 224 if (!empty($this->question->modifiedby)) {
7f389342 225 $a = new stdClass();
271e6dec 226 $a->time = userdate($this->question->timemodified);
eaeb6b51
TH
227 $a->user = fullname($DB->get_record(
228 'user', array('id' => $this->question->modifiedby)));
229 $mform->addElement('static', 'modified', get_string('modified', 'question'),
230 get_string('byandon', 'question', $a));
271e6dec 231 }
232 }
233
72553162 234 $this->add_hidden_fields();
36703ed7 235
72553162
TH
236 $mform->addElement('hidden', 'qtype');
237 $mform->setType('qtype', PARAM_ALPHA);
fa583f5f 238
e0c41591
K
239 $mform->addElement('hidden', 'makecopy');
240 $mform->setType('makecopy', PARAM_INT);
241
375ed78a 242 $buttonarray = array();
8011be18 243 $buttonarray[] = $mform->createElement('submit', 'updatebutton',
7756e2bc 244 get_string('savechangesandcontinueediting', 'question'));
8011be18
TH
245 if ($this->can_preview()) {
246 $previewlink = $PAGE->get_renderer('core_question')->question_preview_link(
247 $this->question->id, $this->context, true);
7756e2bc 248 $buttonarray[] = $mform->createElement('static', 'previewlink', '', $previewlink);
375ed78a 249 }
7756e2bc 250
8011be18
TH
251 $mform->addGroup($buttonarray, 'updatebuttonar', '', array(' '), false);
252 $mform->closeHeaderBefore('updatebuttonar');
7756e2bc
K
253
254 $this->add_action_buttons(true, get_string('savechanges'));
271e6dec 255
435d3279 256 if ((!empty($this->question->id)) && (!($this->question->formoptions->canedit ||
eaeb6b51 257 $this->question->formoptions->cansaveasnew))) {
271e6dec 258 $mform->hardFreezeAllVisibleExcept(array('categorymoveto', 'buttonar', 'currentgrp'));
259 }
36703ed7 260 }
fa583f5f 261
36703ed7 262 /**
263 * Add any question-type specific form fields.
1d284fbd 264 *
265 * @param object $mform the form being built.
36703ed7 266 */
2b7da645 267 protected function definition_inner($mform) {
36703ed7 268 // By default, do nothing.
269 }
1d284fbd 270
8011be18
TH
271 /**
272 * Is the question being edited in a state where it can be previewed?
273 * @return bool whether to show the preview link.
274 */
275 protected function can_preview() {
276 return empty($this->question->beingcopied) && !empty($this->question->id) &&
277 $this->question->formoptions->canedit;
278 }
279
2aef1fe5 280 /**
281 * Get the list of form elements to repeat, one for each answer.
282 * @param object $mform the form being built.
283 * @param $label the label to use for each option.
284 * @param $gradeoptions the possible grades for each answer.
285 * @param $repeatedoptions reference to array of repeated options to fill
eaeb6b51
TH
286 * @param $answersoption reference to return the name of $question->options
287 * field holding an array of answers
2aef1fe5 288 * @return array of form fields.
289 */
2a6c5c52 290 protected function get_per_answer_fields($mform, $label, $gradeoptions,
eaeb6b51 291 &$repeatedoptions, &$answersoption) {
2aef1fe5 292 $repeated = array();
c7218aef
CC
293 $answeroptions = array();
294 $answeroptions[] = $mform->createElement('text', 'answer',
295 $label, array('size' => 40));
296 $answeroptions[] = $mform->createElement('select', 'fraction',
eaeb6b51 297 get_string('grade'), $gradeoptions);
c7218aef
CC
298 $repeated[] = $mform->createElement('group', 'answeroptions',
299 $label, $answeroptions, null, false);
eaeb6b51
TH
300 $repeated[] = $mform->createElement('editor', 'feedback',
301 get_string('feedback', 'question'), array('rows' => 5), $this->editoroptions);
2aef1fe5 302 $repeatedoptions['answer']['type'] = PARAM_RAW;
303 $repeatedoptions['fraction']['default'] = 0;
304 $answersoption = 'answers';
305 return $repeated;
306 }
307
308 /**
309 * Add a set of form fields, obtained from get_per_answer_fields, to the form,
310 * one for each existing answer, with some blanks for some new ones.
311 * @param object $mform the form being built.
312 * @param $label the label to use for each option.
313 * @param $gradeoptions the possible grades for each answer.
eaeb6b51
TH
314 * @param $minoptions the minimum number of answer blanks to display.
315 * Default QUESTION_NUMANS_START.
2aef1fe5 316 * @param $addoptions the number of answer blanks to add. Default QUESTION_NUMANS_ADD.
317 */
eaeb6b51
TH
318 protected function add_per_answer_fields(&$mform, $label, $gradeoptions,
319 $minoptions = QUESTION_NUMANS_START, $addoptions = QUESTION_NUMANS_ADD) {
c7218aef
CC
320 $mform->addElement('header', 'answerhdr',
321 get_string('answers', 'question'), '');
322 $mform->setExpanded('answerhdr', 1);
2aef1fe5 323 $answersoption = '';
324 $repeatedoptions = array();
eaeb6b51
TH
325 $repeated = $this->get_per_answer_fields($mform, $label, $gradeoptions,
326 $repeatedoptions, $answersoption);
2aef1fe5 327
2b7da645 328 if (isset($this->question->options)) {
c3c65f41 329 $repeatsatstart = count($this->question->options->$answersoption);
2aef1fe5 330 } else {
c3c65f41 331 $repeatsatstart = $minoptions;
2aef1fe5 332 }
333
eaeb6b51
TH
334 $this->repeat_elements($repeated, $repeatsatstart, $repeatedoptions,
335 'noanswers', 'addanswers', $addoptions,
c7218aef 336 $this->get_more_choices_string(), true);
55748620
TH
337 }
338
339 /**
340 * Language string to use for 'Add {no} more {whatever we call answers}'.
341 */
342 protected function get_more_choices_string() {
343 return get_string('addmorechoiceblanks', 'question');
2aef1fe5 344 }
345
2b7da645
TH
346 protected function add_combined_feedback_fields($withshownumpartscorrect = false) {
347 $mform = $this->_form;
348
eaeb6b51
TH
349 $mform->addElement('header', 'combinedfeedbackhdr',
350 get_string('combinedfeedback', 'question'));
2b7da645 351
eaeb6b51
TH
352 $fields = array('correctfeedback', 'partiallycorrectfeedback', 'incorrectfeedback');
353 foreach ($fields as $feedbackname) {
086cced7
CC
354 $element = $mform->addElement('editor', $feedbackname,
355 get_string($feedbackname, 'question'),
2b7da645
TH
356 array('rows' => 5), $this->editoroptions);
357 $mform->setType($feedbackname, PARAM_RAW);
086cced7 358 // Using setValue() as setDefault() does not work for the editor class.
e0c41591 359 $element->setValue(array('text' => get_string($feedbackname.'default', 'question')));
2b7da645
TH
360
361 if ($withshownumpartscorrect && $feedbackname == 'partiallycorrectfeedback') {
f7094147 362 $mform->addElement('advcheckbox', 'shownumcorrect',
eaeb6b51 363 get_string('options', 'question'),
d5ffb789 364 get_string('shownumpartscorrectwhenfinished', 'question'));
f0a64f01 365 $mform->setDefault('shownumcorrect', true);
2b7da645
TH
366 }
367 }
368 }
369
6dbc3460
CC
370 /**
371 * Create the form elements required by one hint.
372 * @param string $withclearwrong whether this quesiton type uses the 'Clear wrong' option on hints.
373 * @param string $withshownumpartscorrect whether this quesiton type uses the 'Show num parts correct' option on hints.
374 * @return array form field elements for one hint.
375 */
2b7da645
TH
376 protected function get_hint_fields($withclearwrong = false, $withshownumpartscorrect = false) {
377 $mform = $this->_form;
378
6dbc3460 379 $repeatedoptions = array();
2b7da645 380 $repeated = array();
6dbc3460 381 $repeated[] = $mform->createElement('editor', 'hint', get_string('hintn', 'question'),
7a719748 382 array('rows' => 5), $this->editoroptions);
2b7da645
TH
383 $repeatedoptions['hint']['type'] = PARAM_RAW;
384
6dbc3460 385 $optionelements = array();
2b7da645 386 if ($withclearwrong) {
6dbc3460 387 $optionelements[] = $mform->createElement('advcheckbox', 'hintclearwrong',
eaeb6b51 388 get_string('options', 'question'), get_string('clearwrongparts', 'question'));
2b7da645
TH
389 }
390 if ($withshownumpartscorrect) {
6dbc3460 391 $optionelements[] = $mform->createElement('advcheckbox', 'hintshownumcorrect', '',
eaeb6b51 392 get_string('shownumpartscorrect', 'question'));
2b7da645
TH
393 }
394
6dbc3460
CC
395 if (count($optionelements)) {
396 $repeated[] = $mform->createElement('group', 'hintoptions',
397 get_string('hintnoptions', 'question'), $optionelements, null, false);
398 }
399
2b7da645
TH
400 return array($repeated, $repeatedoptions);
401 }
402
eaeb6b51
TH
403 protected function add_interactive_settings($withclearwrong = false,
404 $withshownumpartscorrect = false) {
2b7da645
TH
405 $mform = $this->_form;
406
eaeb6b51
TH
407 $mform->addElement('header', 'multitriesheader',
408 get_string('settingsformultipletries', 'question'));
2b7da645
TH
409
410 $penalties = array(
411 1.0000000,
412 0.5000000,
413 0.3333333,
414 0.2500000,
415 0.2000000,
416 0.1000000,
417 0.0000000
418 );
419 if (!empty($this->question->penalty) && !in_array($this->question->penalty, $penalties)) {
420 $penalties[] = $this->question->penalty;
421 sort($penalties);
422 }
423 $penaltyoptions = array();
424 foreach ($penalties as $penalty) {
f4fe3968 425 $penaltyoptions["{$penalty}"] = (100 * $penalty) . '%';
2b7da645 426 }
eaeb6b51
TH
427 $mform->addElement('select', 'penalty',
428 get_string('penaltyforeachincorrecttry', 'question'), $penaltyoptions);
068b4594 429 $mform->addHelpButton('penalty', 'penaltyforeachincorrecttry', 'question');
2b7da645
TH
430 $mform->setDefault('penalty', 0.3333333);
431
432 if (isset($this->question->hints)) {
433 $counthints = count($this->question->hints);
434 } else {
435 $counthints = 0;
436 }
437
438 if ($this->question->formoptions->repeatelements) {
439 $repeatsatstart = max(self::DEFAULT_NUM_HINTS, $counthints);
440 } else {
441 $repeatsatstart = $counthints;
442 }
443
444 list($repeated, $repeatedoptions) = $this->get_hint_fields(
445 $withclearwrong, $withshownumpartscorrect);
446 $this->repeat_elements($repeated, $repeatsatstart, $repeatedoptions,
6dbc3460 447 'numhints', 'addhint', 1, get_string('addanotherhint', 'question'), true);
2b7da645
TH
448 }
449
450 public function set_data($question) {
f9b0500f 451 question_bank::get_qtype($question->qtype)->set_default_options($question);
2b7da645 452
c7218aef 453 // Prepare question text.
fe6ce234
DC
454 $draftid = file_get_submitted_draft_itemid('questiontext');
455
456 if (!empty($question->questiontext)) {
457 $questiontext = $question->questiontext;
458 } else {
1a2de1c7
TH
459 $questiontext = $this->_form->getElement('questiontext')->getValue();
460 $questiontext = $questiontext['text'];
271ffe3f 461 }
eaeb6b51
TH
462 $questiontext = file_prepare_draft_area($draftid, $this->context->id,
463 'question', 'questiontext', empty($question->id) ? null : (int) $question->id,
464 $this->fileoptions, $questiontext);
fe6ce234
DC
465
466 $question->questiontext = array();
467 $question->questiontext['text'] = $questiontext;
eaeb6b51
TH
468 $question->questiontext['format'] = empty($question->questiontextformat) ?
469 editors_get_preferred_format() : $question->questiontextformat;
fe6ce234
DC
470 $question->questiontext['itemid'] = $draftid;
471
c7218aef 472 // Prepare general feedback.
fe6ce234
DC
473 $draftid = file_get_submitted_draft_itemid('generalfeedback');
474
475 if (empty($question->generalfeedback)) {
1a2de1c7
TH
476 $generalfeedback = $this->_form->getElement('generalfeedback')->getValue();
477 $question->generalfeedback = $generalfeedback['text'];
fe6ce234
DC
478 }
479
eaeb6b51
TH
480 $feedback = file_prepare_draft_area($draftid, $this->context->id,
481 'question', 'generalfeedback', empty($question->id) ? null : (int) $question->id,
482 $this->fileoptions, $question->generalfeedback);
fe6ce234
DC
483 $question->generalfeedback = array();
484 $question->generalfeedback['text'] = $feedback;
eaeb6b51
TH
485 $question->generalfeedback['format'] = empty($question->generalfeedbackformat) ?
486 editors_get_preferred_format() : $question->generalfeedbackformat;
fe6ce234 487 $question->generalfeedback['itemid'] = $draftid;
295043c2 488
9152f6a5 489 // Remove unnecessary trailing 0s form grade fields.
cfd24d98 490 if (isset($question->defaultgrade)) {
491 $question->defaultgrade = 0 + $question->defaultgrade;
492 }
493 if (isset($question->penalty)) {
494 $question->penalty = 0 + $question->penalty;
495 }
9152f6a5 496
295043c2 497 // Set any options.
eaeb6b51
TH
498 $extraquestionfields = question_bank::get_qtype($question->qtype)->extra_question_fields();
499 if (is_array($extraquestionfields) && !empty($question->options)) {
500 array_shift($extraquestionfields);
501 foreach ($extraquestionfields as $field) {
a8e577de 502 if (property_exists($question->options, $field)) {
8e652f02 503 $question->$field = $question->options->$field;
504 }
295043c2 505 }
506 }
c9c989a0 507
c7218aef 508 // Subclass adds data_preprocessing code here.
fe6ce234 509 $question = $this->data_preprocessing($question);
2b7da645 510
32db0d42 511 parent::set_data($question);
36703ed7 512 }
1d284fbd 513
fe6ce234 514 /**
fdd015b7
TH
515 * Perform an preprocessing needed on the data passed to {@link set_data()}
516 * before it is used to initialise the form.
517 * @param object $question the data being passed to the form.
518 * @return object $question the modified data.
fe6ce234 519 */
c7df5006 520 protected function data_preprocessing($question) {
7a719748
TH
521 return $question;
522 }
523
fdd015b7
TH
524 /**
525 * Perform the necessary preprocessing for the fields added by
526 * {@link add_per_answer_fields()}.
527 * @param object $question the data being passed to the form.
528 * @return object $question the modified data.
529 */
2a6c5c52 530 protected function data_preprocessing_answers($question, $withanswerfiles = false) {
7a719748
TH
531 if (empty($question->options->answers)) {
532 return $question;
533 }
534
535 $key = 0;
eaeb6b51 536 foreach ($question->options->answers as $answer) {
2a6c5c52 537 if ($withanswerfiles) {
c7218aef 538 // Prepare the feedback editor to display files in draft area.
2a6c5c52 539 $draftitemid = file_get_submitted_draft_itemid('answer['.$key.']');
540 $question->answer[$key]['text'] = file_prepare_draft_area(
3d9645ae 541 $draftitemid, // Draftid
2a6c5c52 542 $this->context->id, // context
543 'question', // component
544 'answer', // filarea
545 !empty($answer->id) ? (int) $answer->id : null, // itemid
546 $this->fileoptions, // options
3d9645ae 547 $answer->answer // text.
2a6c5c52 548 );
549 $question->answer[$key]['itemid'] = $draftitemid;
550 $question->answer[$key]['format'] = $answer->answerformat;
551 } else {
552 $question->answer[$key] = $answer->answer;
553 }
554
7a719748
TH
555 $question->fraction[$key] = 0 + $answer->fraction;
556 $question->feedback[$key] = array();
557
558 // Evil hack alert. Formslib can store defaults in two ways for
eaeb6b51
TH
559 // repeat elements:
560 // ->_defaultValues['fraction[0]'] and
561 // ->_defaultValues['fraction'][0].
562 // The $repeatedoptions['fraction']['default'] = 0 bit above means
563 // that ->_defaultValues['fraction[0]'] has already been set, but we
564 // are using object notation here, so we will be setting
565 // ->_defaultValues['fraction'][0]. That does not work, so we have
c7218aef 566 // to unset ->_defaultValues['fraction[0]'].
f4fe3968 567 unset($this->_form->_defaultValues["fraction[{$key}]"]);
7a719748 568
c7218aef 569 // Prepare the feedback editor to display files in draft area.
7a719748
TH
570 $draftitemid = file_get_submitted_draft_itemid('feedback['.$key.']');
571 $question->feedback[$key]['text'] = file_prepare_draft_area(
3d9645ae 572 $draftitemid, // Draftid
7a719748
TH
573 $this->context->id, // context
574 'question', // component
575 'answerfeedback', // filarea
576 !empty($answer->id) ? (int) $answer->id : null, // itemid
577 $this->fileoptions, // options
3d9645ae 578 $answer->feedback // text.
7a719748
TH
579 );
580 $question->feedback[$key]['itemid'] = $draftitemid;
581 $question->feedback[$key]['format'] = $answer->feedbackformat;
582 $key++;
583 }
a68207b6
OS
584
585 // Now process extra answer fields.
586 $extraanswerfields = question_bank::get_qtype($question->qtype)->extra_answer_fields();
587 if (is_array($extraanswerfields)) {
588 // Omit table name.
589 array_shift($extraanswerfields);
590 $question = $this->data_preprocessing_extra_answer_fields($question, $extraanswerfields);
591 }
592
7a719748
TH
593 return $question;
594 }
595
a68207b6
OS
596 /**
597 * Perform the necessary preprocessing for the extra answer fields.
598 *
599 * Questions that do something not trivial when editing extra answer fields
600 * will want to override this.
601 * @param object $question the data being passed to the form.
602 * @param array $extraanswerfields extra answer fields (without table name).
603 * @return object $question the modified data.
604 */
605 protected function data_preprocessing_extra_answer_fields($question, $extraanswerfields) {
606 // Setting $question->$field[$key] won't work in PHP, so we need set an array of answer values to $question->$field.
607 // As we may have several extra fields with data for several answers in each, we use an array of arrays.
608 // Index in $extrafieldsdata is an extra answer field name, value - array of it's data for each answer.
609 $extrafieldsdata = array();
610 // First, prepare an array if empty arrays for each extra answer fields data.
611 foreach ($extraanswerfields as $field) {
612 $extrafieldsdata[$field] = array();
613 }
614
615 // Fill arrays with data from $question->options->answers.
616 $key = 0;
617 foreach ($question->options->answers as $answer) {
618 foreach ($extraanswerfields as $field) {
619 // See hack comment in {@link data_preprocessing_answers()}.
0e30442c 620 unset($this->_form->_defaultValues["{$field}[{$key}]"]);
a68207b6
OS
621 $extrafieldsdata[$field][$key] = $this->data_preprocessing_extra_answer_field($answer, $field);
622 }
623 $key++;
624 }
625
626 // Set this data in the $question object.
627 foreach ($extraanswerfields as $field) {
628 $question->$field = $extrafieldsdata[$field];
629 }
630 return $question;
631 }
632
633 /**
634 * Perfmorm preprocessing for particular extra answer field.
635 *
636 * Questions with non-trivial DB - form element relationship will
637 * want to override this.
638 * @param object $answer an answer object to get extra field from.
639 * @param string $field extra answer field name.
640 * @return field value to be set to the form.
641 */
642 protected function data_preprocessing_extra_answer_field($answer, $field) {
643 return $answer->$field;
644 }
645
fdd015b7
TH
646 /**
647 * Perform the necessary preprocessing for the fields added by
648 * {@link add_combined_feedback_fields()}.
649 * @param object $question the data being passed to the form.
650 * @return object $question the modified data.
651 */
eaeb6b51
TH
652 protected function data_preprocessing_combined_feedback($question,
653 $withshownumcorrect = false) {
c9c989a0
TH
654 if (empty($question->options)) {
655 return $question;
656 }
657
eaeb6b51
TH
658 $fields = array('correctfeedback', 'partiallycorrectfeedback', 'incorrectfeedback');
659 foreach ($fields as $feedbackname) {
c9c989a0 660 $draftid = file_get_submitted_draft_itemid($feedbackname);
8b9dfc2b
TH
661 $feedback = array();
662 $feedback['text'] = file_prepare_draft_area(
3d9645ae 663 $draftid, // Draftid
c9c989a0 664 $this->context->id, // context
93cadb1e 665 'question', // component
c9c989a0
TH
666 $feedbackname, // filarea
667 !empty($question->id) ? (int) $question->id : null, // itemid
668 $this->fileoptions, // options
3d9645ae 669 $question->options->$feedbackname // text.
c9c989a0
TH
670 );
671 $feedbackformat = $feedbackname . 'format';
8b9dfc2b
TH
672 $feedback['format'] = $question->options->$feedbackformat;
673 $feedback['itemid'] = $draftid;
674
675 $question->$feedbackname = $feedback;
c9c989a0
TH
676 }
677
678 if ($withshownumcorrect) {
679 $question->shownumcorrect = $question->options->shownumcorrect;
680 }
681
682 return $question;
683 }
684
fdd015b7
TH
685 /**
686 * Perform the necessary preprocessing for the hint fields.
687 * @param object $question the data being passed to the form.
688 * @return object $question the modified data.
689 */
eaeb6b51
TH
690 protected function data_preprocessing_hints($question, $withclearwrong = false,
691 $withshownumpartscorrect = false) {
7a719748
TH
692 if (empty($question->hints)) {
693 return $question;
694 }
695
696 $key = 0;
eaeb6b51 697 foreach ($question->hints as $hint) {
7a719748
TH
698 $question->hint[$key] = array();
699
c7218aef 700 // Prepare feedback editor to display files in draft area.
7a719748
TH
701 $draftitemid = file_get_submitted_draft_itemid('hint['.$key.']');
702 $question->hint[$key]['text'] = file_prepare_draft_area(
3d9645ae 703 $draftitemid, // Draftid
7a719748
TH
704 $this->context->id, // context
705 'question', // component
706 'hint', // filarea
707 !empty($hint->id) ? (int) $hint->id : null, // itemid
708 $this->fileoptions, // options
3d9645ae 709 $hint->hint // text.
7a719748
TH
710 );
711 $question->hint[$key]['itemid'] = $draftitemid;
712 $question->hint[$key]['format'] = $hint->hintformat;
713 $key++;
7a719748 714
8b9dfc2b
TH
715 if ($withclearwrong) {
716 $question->hintclearwrong[] = $hint->clearwrong;
717 }
718 if ($withshownumpartscorrect) {
719 $question->hintshownumcorrect[] = $hint->shownumcorrect;
720 }
721 }
7a719748 722
fe6ce234
DC
723 return $question;
724 }
725
2b7da645
TH
726 public function validation($fromform, $files) {
727 $errors = parent::validation($fromform, $files);
51c5e605 728 if (empty($fromform['makecopy']) && isset($this->question->id)
eaeb6b51
TH
729 && ($this->question->formoptions->canedit ||
730 $this->question->formoptions->cansaveasnew)
51c5e605 731 && empty($fromform['usecurrentcat']) && !$this->question->formoptions->canmove) {
2b7da645
TH
732 $errors['currentgrp'] = get_string('nopermissionmove', 'question');
733 }
00cefd92
TH
734
735 // Default mark.
1aecaa3d 736 if (array_key_exists('defaultmark', $fromform) && $fromform['defaultmark'] < 0) {
00cefd92
TH
737 $errors['defaultmark'] = get_string('defaultmarkmustbepositive', 'question');
738 }
739
2b7da645
TH
740 return $errors;
741 }
742
36703ed7 743 /**
744 * Override this in the subclass to question type name.
eaeb6b51
TH
745 * @return the question type name, should be the same as the name() method
746 * in the question type class.
36703ed7 747 */
2b7da645 748 public abstract function qtype();
2a22be64 749
dff72cde
SH
750 /**
751 * Returns an array of editor options with collapsed options turned off.
0c0dfa8f 752 * @deprecated since 2.6
dff72cde
SH
753 * @return array
754 */
755 protected function get_non_collabsible_editor_options() {
0c0dfa8f
DW
756 debugging('get_non_collabsible_editor_options() is deprecated, use $this->editoroptions instead.', DEBUG_DEVELOPER);
757 return $this->editoroptions;
2a22be64 758 }
0c0dfa8f 759
36703ed7 760}