weekly on-sync release 3.6dev
[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
4509be22 204 if (core_tag_tag::is_enabled('core_question', 'question')) {
081eb156 205 $this->add_tag_fields($mform);
4509be22
SL
206 }
207
2b7da645 208 if (!empty($this->question->id)) {
eaeb6b51
TH
209 $mform->addElement('header', 'createdmodifiedheader',
210 get_string('createdmodifiedheader', 'question'));
7f389342 211 $a = new stdClass();
2b7da645 212 if (!empty($this->question->createdby)) {
271e6dec 213 $a->time = userdate($this->question->timecreated);
eaeb6b51
TH
214 $a->user = fullname($DB->get_record(
215 'user', array('id' => $this->question->createdby)));
271e6dec 216 } else {
217 $a->time = get_string('unknown', 'question');
218 $a->user = get_string('unknown', 'question');
219 }
eaeb6b51
TH
220 $mform->addElement('static', 'created', get_string('created', 'question'),
221 get_string('byandon', 'question', $a));
2b7da645 222 if (!empty($this->question->modifiedby)) {
7f389342 223 $a = new stdClass();
271e6dec 224 $a->time = userdate($this->question->timemodified);
eaeb6b51
TH
225 $a->user = fullname($DB->get_record(
226 'user', array('id' => $this->question->modifiedby)));
227 $mform->addElement('static', 'modified', get_string('modified', 'question'),
228 get_string('byandon', 'question', $a));
271e6dec 229 }
230 }
231
72553162 232 $this->add_hidden_fields();
36703ed7 233
72553162
TH
234 $mform->addElement('hidden', 'qtype');
235 $mform->setType('qtype', PARAM_ALPHA);
fa583f5f 236
e0c41591
K
237 $mform->addElement('hidden', 'makecopy');
238 $mform->setType('makecopy', PARAM_INT);
239
375ed78a 240 $buttonarray = array();
8011be18 241 $buttonarray[] = $mform->createElement('submit', 'updatebutton',
7756e2bc 242 get_string('savechangesandcontinueediting', 'question'));
8011be18
TH
243 if ($this->can_preview()) {
244 $previewlink = $PAGE->get_renderer('core_question')->question_preview_link(
245 $this->question->id, $this->context, true);
7756e2bc 246 $buttonarray[] = $mform->createElement('static', 'previewlink', '', $previewlink);
375ed78a 247 }
7756e2bc 248
8011be18
TH
249 $mform->addGroup($buttonarray, 'updatebuttonar', '', array(' '), false);
250 $mform->closeHeaderBefore('updatebuttonar');
7756e2bc
K
251
252 $this->add_action_buttons(true, get_string('savechanges'));
271e6dec 253
435d3279 254 if ((!empty($this->question->id)) && (!($this->question->formoptions->canedit ||
eaeb6b51 255 $this->question->formoptions->cansaveasnew))) {
271e6dec 256 $mform->hardFreezeAllVisibleExcept(array('categorymoveto', 'buttonar', 'currentgrp'));
257 }
36703ed7 258 }
fa583f5f 259
36703ed7 260 /**
261 * Add any question-type specific form fields.
1d284fbd 262 *
263 * @param object $mform the form being built.
36703ed7 264 */
2b7da645 265 protected function definition_inner($mform) {
36703ed7 266 // By default, do nothing.
267 }
1d284fbd 268
8011be18
TH
269 /**
270 * Is the question being edited in a state where it can be previewed?
271 * @return bool whether to show the preview link.
272 */
273 protected function can_preview() {
274 return empty($this->question->beingcopied) && !empty($this->question->id) &&
275 $this->question->formoptions->canedit;
276 }
277
2aef1fe5 278 /**
279 * Get the list of form elements to repeat, one for each answer.
280 * @param object $mform the form being built.
281 * @param $label the label to use for each option.
282 * @param $gradeoptions the possible grades for each answer.
283 * @param $repeatedoptions reference to array of repeated options to fill
eaeb6b51
TH
284 * @param $answersoption reference to return the name of $question->options
285 * field holding an array of answers
2aef1fe5 286 * @return array of form fields.
287 */
2a6c5c52 288 protected function get_per_answer_fields($mform, $label, $gradeoptions,
eaeb6b51 289 &$repeatedoptions, &$answersoption) {
2aef1fe5 290 $repeated = array();
c7218aef
CC
291 $answeroptions = array();
292 $answeroptions[] = $mform->createElement('text', 'answer',
293 $label, array('size' => 40));
294 $answeroptions[] = $mform->createElement('select', 'fraction',
eaeb6b51 295 get_string('grade'), $gradeoptions);
c7218aef
CC
296 $repeated[] = $mform->createElement('group', 'answeroptions',
297 $label, $answeroptions, null, false);
eaeb6b51
TH
298 $repeated[] = $mform->createElement('editor', 'feedback',
299 get_string('feedback', 'question'), array('rows' => 5), $this->editoroptions);
2aef1fe5 300 $repeatedoptions['answer']['type'] = PARAM_RAW;
301 $repeatedoptions['fraction']['default'] = 0;
302 $answersoption = 'answers';
303 return $repeated;
304 }
305
081eb156
RW
306 /**
307 * Add the tag and course tag fields to the mform.
308 *
309 * If the form is being built in a course context then add the field
310 * for course tags.
311 *
312 * If the question category doesn't belong to a course context or we
313 * aren't editing in a course context then add the tags element to allow
314 * tags to be added to the question category context.
315 *
316 * @param object $mform The form being built
317 */
318 protected function add_tag_fields($mform) {
319 $hastagcapability = question_has_capability_on($this->question, 'tag');
320 // Is the question category in a course context?
321 $qcontext = $this->categorycontext;
322 $qcoursecontext = $qcontext->get_course_context(false);
323 $iscourseoractivityquestion = !empty($qcoursecontext);
324 // Is the current context we're editing in a course context?
325 $editingcontext = $this->contexts->lowest();
326 $editingcoursecontext = $editingcontext->get_course_context(false);
327 $iseditingcontextcourseoractivity = !empty($editingcoursecontext);
328
329 $mform->addElement('header', 'tagsheader', get_string('tags'));
b71f21bd
SL
330 $tags = \core_tag_tag::get_tags_by_area_in_contexts('core_question', 'question', $this->contexts->all());
331 $tagstrings = [];
332 foreach ($tags as $tag) {
333 $tagstrings[$tag->name] = $tag->name;
334 }
335 $options = [
336 'tags' => true,
337 'multiple' => true,
338 'noselectionstring' => get_string('anytags', 'quiz'),
339 ];
340 $mform->addElement('autocomplete', 'tags', get_string('tags'), $tagstrings, $options);
081eb156
RW
341
342 if (!$hastagcapability) {
343 $mform->hardFreeze('tags');
344 }
345
346 if ($iseditingcontextcourseoractivity && !$iscourseoractivityquestion) {
347 // If the question is being edited in a course or activity context
348 // and the question isn't a course or activity level question then
349 // allow course tags to be added to the course.
350 $coursetagheader = get_string('questionformtagheader', 'core_question',
351 $editingcoursecontext->get_context_name(true));
352 $mform->addElement('header', 'coursetagsheader', $coursetagheader);
b71f21bd 353 $mform->addElement('autocomplete', 'coursetags', get_string('tags'), $tagstrings, $options);
081eb156
RW
354
355 if (!$hastagcapability) {
356 $mform->hardFreeze('coursetags');
357 }
358 }
359 }
360
2aef1fe5 361 /**
362 * Add a set of form fields, obtained from get_per_answer_fields, to the form,
363 * one for each existing answer, with some blanks for some new ones.
364 * @param object $mform the form being built.
365 * @param $label the label to use for each option.
366 * @param $gradeoptions the possible grades for each answer.
eaeb6b51
TH
367 * @param $minoptions the minimum number of answer blanks to display.
368 * Default QUESTION_NUMANS_START.
2aef1fe5 369 * @param $addoptions the number of answer blanks to add. Default QUESTION_NUMANS_ADD.
370 */
eaeb6b51
TH
371 protected function add_per_answer_fields(&$mform, $label, $gradeoptions,
372 $minoptions = QUESTION_NUMANS_START, $addoptions = QUESTION_NUMANS_ADD) {
c7218aef
CC
373 $mform->addElement('header', 'answerhdr',
374 get_string('answers', 'question'), '');
375 $mform->setExpanded('answerhdr', 1);
2aef1fe5 376 $answersoption = '';
377 $repeatedoptions = array();
eaeb6b51
TH
378 $repeated = $this->get_per_answer_fields($mform, $label, $gradeoptions,
379 $repeatedoptions, $answersoption);
2aef1fe5 380
2b7da645 381 if (isset($this->question->options)) {
c3c65f41 382 $repeatsatstart = count($this->question->options->$answersoption);
2aef1fe5 383 } else {
c3c65f41 384 $repeatsatstart = $minoptions;
2aef1fe5 385 }
386
eaeb6b51
TH
387 $this->repeat_elements($repeated, $repeatsatstart, $repeatedoptions,
388 'noanswers', 'addanswers', $addoptions,
c7218aef 389 $this->get_more_choices_string(), true);
55748620
TH
390 }
391
392 /**
393 * Language string to use for 'Add {no} more {whatever we call answers}'.
394 */
395 protected function get_more_choices_string() {
396 return get_string('addmorechoiceblanks', 'question');
2aef1fe5 397 }
398
2b7da645
TH
399 protected function add_combined_feedback_fields($withshownumpartscorrect = false) {
400 $mform = $this->_form;
401
eaeb6b51
TH
402 $mform->addElement('header', 'combinedfeedbackhdr',
403 get_string('combinedfeedback', 'question'));
2b7da645 404
eaeb6b51
TH
405 $fields = array('correctfeedback', 'partiallycorrectfeedback', 'incorrectfeedback');
406 foreach ($fields as $feedbackname) {
086cced7
CC
407 $element = $mform->addElement('editor', $feedbackname,
408 get_string($feedbackname, 'question'),
2b7da645
TH
409 array('rows' => 5), $this->editoroptions);
410 $mform->setType($feedbackname, PARAM_RAW);
086cced7 411 // Using setValue() as setDefault() does not work for the editor class.
e0c41591 412 $element->setValue(array('text' => get_string($feedbackname.'default', 'question')));
2b7da645
TH
413
414 if ($withshownumpartscorrect && $feedbackname == 'partiallycorrectfeedback') {
f7094147 415 $mform->addElement('advcheckbox', 'shownumcorrect',
eaeb6b51 416 get_string('options', 'question'),
d5ffb789 417 get_string('shownumpartscorrectwhenfinished', 'question'));
f0a64f01 418 $mform->setDefault('shownumcorrect', true);
2b7da645
TH
419 }
420 }
421 }
422
6dbc3460
CC
423 /**
424 * Create the form elements required by one hint.
425 * @param string $withclearwrong whether this quesiton type uses the 'Clear wrong' option on hints.
426 * @param string $withshownumpartscorrect whether this quesiton type uses the 'Show num parts correct' option on hints.
427 * @return array form field elements for one hint.
428 */
2b7da645
TH
429 protected function get_hint_fields($withclearwrong = false, $withshownumpartscorrect = false) {
430 $mform = $this->_form;
431
6dbc3460 432 $repeatedoptions = array();
2b7da645 433 $repeated = array();
6dbc3460 434 $repeated[] = $mform->createElement('editor', 'hint', get_string('hintn', 'question'),
7a719748 435 array('rows' => 5), $this->editoroptions);
2b7da645
TH
436 $repeatedoptions['hint']['type'] = PARAM_RAW;
437
6dbc3460 438 $optionelements = array();
2b7da645 439 if ($withclearwrong) {
6dbc3460 440 $optionelements[] = $mform->createElement('advcheckbox', 'hintclearwrong',
eaeb6b51 441 get_string('options', 'question'), get_string('clearwrongparts', 'question'));
2b7da645
TH
442 }
443 if ($withshownumpartscorrect) {
6dbc3460 444 $optionelements[] = $mform->createElement('advcheckbox', 'hintshownumcorrect', '',
eaeb6b51 445 get_string('shownumpartscorrect', 'question'));
2b7da645
TH
446 }
447
6dbc3460
CC
448 if (count($optionelements)) {
449 $repeated[] = $mform->createElement('group', 'hintoptions',
450 get_string('hintnoptions', 'question'), $optionelements, null, false);
451 }
452
2b7da645
TH
453 return array($repeated, $repeatedoptions);
454 }
455
eaeb6b51
TH
456 protected function add_interactive_settings($withclearwrong = false,
457 $withshownumpartscorrect = false) {
2b7da645
TH
458 $mform = $this->_form;
459
eaeb6b51
TH
460 $mform->addElement('header', 'multitriesheader',
461 get_string('settingsformultipletries', 'question'));
2b7da645
TH
462
463 $penalties = array(
464 1.0000000,
465 0.5000000,
466 0.3333333,
467 0.2500000,
468 0.2000000,
469 0.1000000,
470 0.0000000
471 );
472 if (!empty($this->question->penalty) && !in_array($this->question->penalty, $penalties)) {
473 $penalties[] = $this->question->penalty;
474 sort($penalties);
475 }
476 $penaltyoptions = array();
477 foreach ($penalties as $penalty) {
f4fe3968 478 $penaltyoptions["{$penalty}"] = (100 * $penalty) . '%';
2b7da645 479 }
eaeb6b51
TH
480 $mform->addElement('select', 'penalty',
481 get_string('penaltyforeachincorrecttry', 'question'), $penaltyoptions);
068b4594 482 $mform->addHelpButton('penalty', 'penaltyforeachincorrecttry', 'question');
2b7da645
TH
483 $mform->setDefault('penalty', 0.3333333);
484
485 if (isset($this->question->hints)) {
486 $counthints = count($this->question->hints);
487 } else {
488 $counthints = 0;
489 }
490
491 if ($this->question->formoptions->repeatelements) {
492 $repeatsatstart = max(self::DEFAULT_NUM_HINTS, $counthints);
493 } else {
494 $repeatsatstart = $counthints;
495 }
496
497 list($repeated, $repeatedoptions) = $this->get_hint_fields(
498 $withclearwrong, $withshownumpartscorrect);
499 $this->repeat_elements($repeated, $repeatsatstart, $repeatedoptions,
6dbc3460 500 'numhints', 'addhint', 1, get_string('addanotherhint', 'question'), true);
2b7da645
TH
501 }
502
503 public function set_data($question) {
f9b0500f 504 question_bank::get_qtype($question->qtype)->set_default_options($question);
2b7da645 505
c7218aef 506 // Prepare question text.
fe6ce234
DC
507 $draftid = file_get_submitted_draft_itemid('questiontext');
508
509 if (!empty($question->questiontext)) {
510 $questiontext = $question->questiontext;
511 } else {
1a2de1c7
TH
512 $questiontext = $this->_form->getElement('questiontext')->getValue();
513 $questiontext = $questiontext['text'];
271ffe3f 514 }
eaeb6b51
TH
515 $questiontext = file_prepare_draft_area($draftid, $this->context->id,
516 'question', 'questiontext', empty($question->id) ? null : (int) $question->id,
517 $this->fileoptions, $questiontext);
fe6ce234
DC
518
519 $question->questiontext = array();
520 $question->questiontext['text'] = $questiontext;
eaeb6b51
TH
521 $question->questiontext['format'] = empty($question->questiontextformat) ?
522 editors_get_preferred_format() : $question->questiontextformat;
fe6ce234
DC
523 $question->questiontext['itemid'] = $draftid;
524
c7218aef 525 // Prepare general feedback.
fe6ce234
DC
526 $draftid = file_get_submitted_draft_itemid('generalfeedback');
527
528 if (empty($question->generalfeedback)) {
1a2de1c7
TH
529 $generalfeedback = $this->_form->getElement('generalfeedback')->getValue();
530 $question->generalfeedback = $generalfeedback['text'];
fe6ce234
DC
531 }
532
eaeb6b51
TH
533 $feedback = file_prepare_draft_area($draftid, $this->context->id,
534 'question', 'generalfeedback', empty($question->id) ? null : (int) $question->id,
535 $this->fileoptions, $question->generalfeedback);
fe6ce234
DC
536 $question->generalfeedback = array();
537 $question->generalfeedback['text'] = $feedback;
eaeb6b51
TH
538 $question->generalfeedback['format'] = empty($question->generalfeedbackformat) ?
539 editors_get_preferred_format() : $question->generalfeedbackformat;
fe6ce234 540 $question->generalfeedback['itemid'] = $draftid;
295043c2 541
9152f6a5 542 // Remove unnecessary trailing 0s form grade fields.
cfd24d98 543 if (isset($question->defaultgrade)) {
544 $question->defaultgrade = 0 + $question->defaultgrade;
545 }
546 if (isset($question->penalty)) {
547 $question->penalty = 0 + $question->penalty;
548 }
9152f6a5 549
295043c2 550 // Set any options.
eaeb6b51
TH
551 $extraquestionfields = question_bank::get_qtype($question->qtype)->extra_question_fields();
552 if (is_array($extraquestionfields) && !empty($question->options)) {
553 array_shift($extraquestionfields);
554 foreach ($extraquestionfields as $field) {
a8e577de 555 if (property_exists($question->options, $field)) {
8e652f02 556 $question->$field = $question->options->$field;
557 }
295043c2 558 }
559 }
c9c989a0 560
c7218aef 561 // Subclass adds data_preprocessing code here.
fe6ce234 562 $question = $this->data_preprocessing($question);
2b7da645 563
32db0d42 564 parent::set_data($question);
36703ed7 565 }
1d284fbd 566
fe6ce234 567 /**
fdd015b7
TH
568 * Perform an preprocessing needed on the data passed to {@link set_data()}
569 * before it is used to initialise the form.
570 * @param object $question the data being passed to the form.
571 * @return object $question the modified data.
fe6ce234 572 */
c7df5006 573 protected function data_preprocessing($question) {
7a719748
TH
574 return $question;
575 }
576
fdd015b7
TH
577 /**
578 * Perform the necessary preprocessing for the fields added by
579 * {@link add_per_answer_fields()}.
580 * @param object $question the data being passed to the form.
581 * @return object $question the modified data.
582 */
2a6c5c52 583 protected function data_preprocessing_answers($question, $withanswerfiles = false) {
7a719748
TH
584 if (empty($question->options->answers)) {
585 return $question;
586 }
587
588 $key = 0;
eaeb6b51 589 foreach ($question->options->answers as $answer) {
2a6c5c52 590 if ($withanswerfiles) {
c7218aef 591 // Prepare the feedback editor to display files in draft area.
2a6c5c52 592 $draftitemid = file_get_submitted_draft_itemid('answer['.$key.']');
593 $question->answer[$key]['text'] = file_prepare_draft_area(
3d9645ae 594 $draftitemid, // Draftid
2a6c5c52 595 $this->context->id, // context
596 'question', // component
597 'answer', // filarea
598 !empty($answer->id) ? (int) $answer->id : null, // itemid
599 $this->fileoptions, // options
3d9645ae 600 $answer->answer // text.
2a6c5c52 601 );
602 $question->answer[$key]['itemid'] = $draftitemid;
603 $question->answer[$key]['format'] = $answer->answerformat;
604 } else {
605 $question->answer[$key] = $answer->answer;
606 }
607
7a719748
TH
608 $question->fraction[$key] = 0 + $answer->fraction;
609 $question->feedback[$key] = array();
610
611 // Evil hack alert. Formslib can store defaults in two ways for
eaeb6b51
TH
612 // repeat elements:
613 // ->_defaultValues['fraction[0]'] and
614 // ->_defaultValues['fraction'][0].
615 // The $repeatedoptions['fraction']['default'] = 0 bit above means
616 // that ->_defaultValues['fraction[0]'] has already been set, but we
617 // are using object notation here, so we will be setting
618 // ->_defaultValues['fraction'][0]. That does not work, so we have
c7218aef 619 // to unset ->_defaultValues['fraction[0]'].
f4fe3968 620 unset($this->_form->_defaultValues["fraction[{$key}]"]);
7a719748 621
c7218aef 622 // Prepare the feedback editor to display files in draft area.
7a719748
TH
623 $draftitemid = file_get_submitted_draft_itemid('feedback['.$key.']');
624 $question->feedback[$key]['text'] = file_prepare_draft_area(
3d9645ae 625 $draftitemid, // Draftid
7a719748
TH
626 $this->context->id, // context
627 'question', // component
628 'answerfeedback', // filarea
629 !empty($answer->id) ? (int) $answer->id : null, // itemid
630 $this->fileoptions, // options
3d9645ae 631 $answer->feedback // text.
7a719748
TH
632 );
633 $question->feedback[$key]['itemid'] = $draftitemid;
634 $question->feedback[$key]['format'] = $answer->feedbackformat;
635 $key++;
636 }
a68207b6
OS
637
638 // Now process extra answer fields.
639 $extraanswerfields = question_bank::get_qtype($question->qtype)->extra_answer_fields();
640 if (is_array($extraanswerfields)) {
641 // Omit table name.
642 array_shift($extraanswerfields);
643 $question = $this->data_preprocessing_extra_answer_fields($question, $extraanswerfields);
644 }
645
7a719748
TH
646 return $question;
647 }
648
a68207b6
OS
649 /**
650 * Perform the necessary preprocessing for the extra answer fields.
651 *
652 * Questions that do something not trivial when editing extra answer fields
653 * will want to override this.
654 * @param object $question the data being passed to the form.
655 * @param array $extraanswerfields extra answer fields (without table name).
656 * @return object $question the modified data.
657 */
658 protected function data_preprocessing_extra_answer_fields($question, $extraanswerfields) {
659 // Setting $question->$field[$key] won't work in PHP, so we need set an array of answer values to $question->$field.
660 // As we may have several extra fields with data for several answers in each, we use an array of arrays.
661 // Index in $extrafieldsdata is an extra answer field name, value - array of it's data for each answer.
662 $extrafieldsdata = array();
663 // First, prepare an array if empty arrays for each extra answer fields data.
664 foreach ($extraanswerfields as $field) {
665 $extrafieldsdata[$field] = array();
666 }
667
668 // Fill arrays with data from $question->options->answers.
669 $key = 0;
670 foreach ($question->options->answers as $answer) {
671 foreach ($extraanswerfields as $field) {
672 // See hack comment in {@link data_preprocessing_answers()}.
0e30442c 673 unset($this->_form->_defaultValues["{$field}[{$key}]"]);
a68207b6
OS
674 $extrafieldsdata[$field][$key] = $this->data_preprocessing_extra_answer_field($answer, $field);
675 }
676 $key++;
677 }
678
679 // Set this data in the $question object.
680 foreach ($extraanswerfields as $field) {
681 $question->$field = $extrafieldsdata[$field];
682 }
683 return $question;
684 }
685
686 /**
687 * Perfmorm preprocessing for particular extra answer field.
688 *
689 * Questions with non-trivial DB - form element relationship will
690 * want to override this.
691 * @param object $answer an answer object to get extra field from.
692 * @param string $field extra answer field name.
693 * @return field value to be set to the form.
694 */
695 protected function data_preprocessing_extra_answer_field($answer, $field) {
696 return $answer->$field;
697 }
698
fdd015b7
TH
699 /**
700 * Perform the necessary preprocessing for the fields added by
701 * {@link add_combined_feedback_fields()}.
702 * @param object $question the data being passed to the form.
703 * @return object $question the modified data.
704 */
eaeb6b51
TH
705 protected function data_preprocessing_combined_feedback($question,
706 $withshownumcorrect = false) {
c9c989a0
TH
707 if (empty($question->options)) {
708 return $question;
709 }
710
eaeb6b51
TH
711 $fields = array('correctfeedback', 'partiallycorrectfeedback', 'incorrectfeedback');
712 foreach ($fields as $feedbackname) {
c9c989a0 713 $draftid = file_get_submitted_draft_itemid($feedbackname);
8b9dfc2b
TH
714 $feedback = array();
715 $feedback['text'] = file_prepare_draft_area(
3d9645ae 716 $draftid, // Draftid
c9c989a0 717 $this->context->id, // context
93cadb1e 718 'question', // component
c9c989a0
TH
719 $feedbackname, // filarea
720 !empty($question->id) ? (int) $question->id : null, // itemid
721 $this->fileoptions, // options
3d9645ae 722 $question->options->$feedbackname // text.
c9c989a0
TH
723 );
724 $feedbackformat = $feedbackname . 'format';
8b9dfc2b
TH
725 $feedback['format'] = $question->options->$feedbackformat;
726 $feedback['itemid'] = $draftid;
727
728 $question->$feedbackname = $feedback;
c9c989a0
TH
729 }
730
731 if ($withshownumcorrect) {
732 $question->shownumcorrect = $question->options->shownumcorrect;
733 }
734
735 return $question;
736 }
737
fdd015b7
TH
738 /**
739 * Perform the necessary preprocessing for the hint fields.
740 * @param object $question the data being passed to the form.
741 * @return object $question the modified data.
742 */
eaeb6b51
TH
743 protected function data_preprocessing_hints($question, $withclearwrong = false,
744 $withshownumpartscorrect = false) {
7a719748
TH
745 if (empty($question->hints)) {
746 return $question;
747 }
748
749 $key = 0;
eaeb6b51 750 foreach ($question->hints as $hint) {
7a719748
TH
751 $question->hint[$key] = array();
752
c7218aef 753 // Prepare feedback editor to display files in draft area.
7a719748
TH
754 $draftitemid = file_get_submitted_draft_itemid('hint['.$key.']');
755 $question->hint[$key]['text'] = file_prepare_draft_area(
3d9645ae 756 $draftitemid, // Draftid
7a719748
TH
757 $this->context->id, // context
758 'question', // component
759 'hint', // filarea
760 !empty($hint->id) ? (int) $hint->id : null, // itemid
761 $this->fileoptions, // options
3d9645ae 762 $hint->hint // text.
7a719748
TH
763 );
764 $question->hint[$key]['itemid'] = $draftitemid;
765 $question->hint[$key]['format'] = $hint->hintformat;
766 $key++;
7a719748 767
8b9dfc2b
TH
768 if ($withclearwrong) {
769 $question->hintclearwrong[] = $hint->clearwrong;
770 }
771 if ($withshownumpartscorrect) {
772 $question->hintshownumcorrect[] = $hint->shownumcorrect;
773 }
774 }
7a719748 775
fe6ce234
DC
776 return $question;
777 }
778
2b7da645
TH
779 public function validation($fromform, $files) {
780 $errors = parent::validation($fromform, $files);
51c5e605 781 if (empty($fromform['makecopy']) && isset($this->question->id)
eaeb6b51
TH
782 && ($this->question->formoptions->canedit ||
783 $this->question->formoptions->cansaveasnew)
51c5e605 784 && empty($fromform['usecurrentcat']) && !$this->question->formoptions->canmove) {
2b7da645
TH
785 $errors['currentgrp'] = get_string('nopermissionmove', 'question');
786 }
00cefd92 787
9275220d
SR
788 // Category.
789 if (empty($fromform['category'])) {
790 // User has provided an invalid category.
791 $errors['category'] = get_string('required');
792 }
793
00cefd92 794 // Default mark.
1aecaa3d 795 if (array_key_exists('defaultmark', $fromform) && $fromform['defaultmark'] < 0) {
00cefd92
TH
796 $errors['defaultmark'] = get_string('defaultmarkmustbepositive', 'question');
797 }
798
2b7da645
TH
799 return $errors;
800 }
801
36703ed7 802 /**
803 * Override this in the subclass to question type name.
eaeb6b51
TH
804 * @return the question type name, should be the same as the name() method
805 * in the question type class.
36703ed7 806 */
2b7da645 807 public abstract function qtype();
2a22be64 808
dff72cde
SH
809 /**
810 * Returns an array of editor options with collapsed options turned off.
0c0dfa8f 811 * @deprecated since 2.6
dff72cde
SH
812 * @return array
813 */
814 protected function get_non_collabsible_editor_options() {
0c0dfa8f
DW
815 debugging('get_non_collabsible_editor_options() is deprecated, use $this->editoroptions instead.', DEBUG_DEVELOPER);
816 return $this->editoroptions;
2a22be64 817 }
0c0dfa8f 818
36703ed7 819}