question/type/edit_question_form.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/>.
  16
  17 /**
  18  * A base class for question editing forms.
  19  *
  20  * @package    moodlecore
  21  * @subpackage questiontypes
  22  * @copyright  2006 The Open University
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU Public License
  24  */
  25
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  29 global $CFG;
  30 require_once($CFG->libdir.'/formslib.php');
  31
  32
  33 abstract 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
  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.
  68  *
  69  * @copyright  2006 The Open University
  70  * @license    http://www.gnu.org/copyleft/gpl.html GNU Public License
  71  */
  72 abstract class question_edit_form extends question_wizard_form {
  73     const DEFAULT_NUM_HINTS = 2;
  74
  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
  78      * form in definition_inner but data is always loaded into the form with set_data.
  79      * @var object
  80      */
  81     protected $question;
  82
  83     protected $contexts;
  84     protected $category;
  85     protected $categorycontext;
  86
  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
  96     public function __construct($submiturl, $question, $category, $contexts, $formeditable = true) {
  97         global $DB;
  98
  99         $this->question = $question;
 100         $this->contexts = $contexts;
 101
 102         $record = $DB->get_record('question_categories',
 103                 array('id' => $question->category), 'contextid');
 104         $this->context = context::instance_by_id($record->contextid);
 105
 106         $this->editoroptions = array('subdirs' => 1, 'maxfiles' => EDITOR_UNLIMITED_FILES,
 107                 'context' => $this->context);
 108         $this->fileoptions = array('subdirs' => 1, 'maxfiles' => -1, 'maxbytes' => -1);
 109
 110         $this->category = $category;
 111         $this->categorycontext = context::instance_by_id($category->contextid);
 112
 113         parent::__construct($submiturl, null, 'post', '', null, $formeditable);
 114     }
 115
 116     /**
 117      * Build the form definition.
 118      *
 119      * This adds all the form fields that the default question type supports.
 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      */
 123     protected function definition() {
 124         global $COURSE, $CFG, $DB;
 125
 126         $qtype = $this->qtype();
 127         $langfile = "qtype_$qtype";
 128
 129         $mform = $this->_form;
 130
 131         // Standard fields at the start of the form.
 132         $mform->addElement('header', 'generalheader', get_string("general", 'form'));
 133
 134         if (!isset($this->question->id)) {
 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
 141             // Adding question.
 142             $mform->addElement('questioncategory', 'category', get_string('category', 'question'),
 143                     array('contexts' => $contexts));
 144         } else if (!($this->question->formoptions->canmove ||
 145                 $this->question->formoptions->cansaveasnew)) {
 146             // Editing question with no permission to move from category.
 147             $mform->addElement('questioncategory', 'category', get_string('category', 'question'),
 148                     array('contexts' => array($this->categorycontext)));
 149         } else if ($this->question->formoptions->movecontext) {
 150             // Moving question to another context.
 151             $mform->addElement('questioncategory', 'categorymoveto',
 152                     get_string('category', 'question'),
 153                     array('contexts' => $this->contexts->having_cap('moodle/question:add')));
 154
 155         } else {
 156             // Editing question with permission to move from category or save as new q.
 157             $currentgrp = array();
 158             $currentgrp[0] = $mform->createElement('questioncategory', 'category',
 159                     get_string('categorycurrent', 'question'),
 160                     array('contexts' => array($this->categorycontext)));
 161             if ($this->question->formoptions->canedit ||
 162                     $this->question->formoptions->cansaveasnew) {
 163                 // Not move only form.
 164                 $currentgrp[1] = $mform->createElement('checkbox', 'usecurrentcat', '',
 165                         get_string('categorycurrentuse', 'question'));
 166                 $mform->setDefault('usecurrentcat', 1);
 167             }
 168             $currentgrp[0]->freeze();
 169             $currentgrp[0]->setPersistantFreeze(false);
 170             $mform->addGroup($currentgrp, 'currentgrp',
 171                     get_string('categorycurrent', 'question'), null, false);
 172
 173             $mform->addElement('questioncategory', 'categorymoveto',
 174                     get_string('categorymoveto', 'question'),
 175                     array('contexts' => array($this->categorycontext)));
 176             if ($this->question->formoptions->canedit ||
 177                     $this->question->formoptions->cansaveasnew) {
 178                 // Not move only form.
 179                 $mform->disabledIf('categorymoveto', 'usecurrentcat', 'checked');
 180             }
 181         }
 182
 183         $mform->addElement('text', 'name', get_string('questionname', 'question'),
 184                 array('size' => 50));
 185         $mform->setType('name', PARAM_TEXT);
 186         $mform->addRule('name', null, 'required', null, 'client');
 187
 188         $mform->addElement('editor', 'questiontext', get_string('questiontext', 'question'),
 189                 array('rows' => 15), $this->editoroptions);
 190         $mform->setType('questiontext', PARAM_RAW);
 191
 192         $mform->addElement('text', 'defaultmark', get_string('defaultmark', 'question'),
 193                 array('size' => 7));
 194         $mform->setType('defaultmark', PARAM_FLOAT);
 195         $mform->setDefault('defaultmark', 1);
 196         $mform->addRule('defaultmark', null, 'required', null, 'client');
 197
 198         $mform->addElement('editor', 'generalfeedback', get_string('generalfeedback', 'question'),
 199                 array('rows' => 10), $this->editoroptions);
 200         $mform->setType('generalfeedback', PARAM_RAW);
 201         $mform->addHelpButton('generalfeedback', 'generalfeedback', 'question');
 202
 203         // Any questiontype specific fields.
 204         $this->definition_inner($mform);
 205
 206         if (!empty($CFG->usetags)) {
 207             $mform->addElement('header', 'tagsheader', get_string('tags'));
 208             $mform->addElement('tags', 'tags', get_string('tags'));
 209         }
 210
 211         if (!empty($this->question->id)) {
 212             $mform->addElement('header', 'createdmodifiedheader',
 213                     get_string('createdmodifiedheader', 'question'));
 214             $a = new stdClass();
 215             if (!empty($this->question->createdby)) {
 216                 $a->time = userdate($this->question->timecreated);
 217                 $a->user = fullname($DB->get_record(
 218                         'user', array('id' => $this->question->createdby)));
 219             } else {
 220                 $a->time = get_string('unknown', 'question');
 221                 $a->user = get_string('unknown', 'question');
 222             }
 223             $mform->addElement('static', 'created', get_string('created', 'question'),
 224                      get_string('byandon', 'question', $a));
 225             if (!empty($this->question->modifiedby)) {
 226                 $a = new stdClass();
 227                 $a->time = userdate($this->question->timemodified);
 228                 $a->user = fullname($DB->get_record(
 229                         'user', array('id' => $this->question->modifiedby)));
 230                 $mform->addElement('static', 'modified', get_string('modified', 'question'),
 231                         get_string('byandon', 'question', $a));
 232             }
 233         }
 234
 235         $this->add_hidden_fields();
 236
 237         $mform->addElement('hidden', 'movecontext');
 238         $mform->setType('movecontext', PARAM_BOOL);
 239
 240         $mform->addElement('hidden', 'qtype');
 241         $mform->setType('qtype', PARAM_ALPHA);
 242
 243         $buttonarray = array();
 244         if (!empty($this->question->id)) {
 245             // Editing / moving question.
 246             if ($this->question->formoptions->movecontext) {
 247                 $buttonarray[] = $mform->createElement('submit', 'submitbutton',
 248                         get_string('moveq', 'question'));
 249             } else if ($this->question->formoptions->canedit) {
 250                 $buttonarray[] = $mform->createElement('submit', 'submitbutton',
 251                         get_string('savechanges'));
 252             }
 253             if ($this->question->formoptions->cansaveasnew) {
 254                 $buttonarray[] = $mform->createElement('submit', 'makecopy',
 255                         get_string('makecopy', 'question'));
 256             }
 257             $buttonarray[] = $mform->createElement('cancel');
 258         } else {
 259             // Adding new question.
 260             $buttonarray[] = $mform->createElement('submit', 'submitbutton',
 261                     get_string('savechanges'));
 262             $buttonarray[] = $mform->createElement('cancel');
 263         }
 264         $mform->addGroup($buttonarray, 'buttonar', '', array(' '), false);
 265         $mform->closeHeaderBefore('buttonar');
 266
 267         if ($this->question->formoptions->movecontext) {
 268             $mform->hardFreezeAllVisibleExcept(array('categorymoveto', 'buttonar'));
 269         } else if ((!empty($this->question->id)) && (!($this->question->formoptions->canedit ||
 270                 $this->question->formoptions->cansaveasnew))) {
 271             $mform->hardFreezeAllVisibleExcept(array('categorymoveto', 'buttonar', 'currentgrp'));
 272         }
 273     }
 274
 275     /**
 276      * Add any question-type specific form fields.
 277      *
 278      * @param object $mform the form being built.
 279      */
 280     protected function definition_inner($mform) {
 281         // By default, do nothing.
 282     }
 283
 284     /**
 285      * Get the list of form elements to repeat, one for each answer.
 286      * @param object $mform the form being built.
 287      * @param $label the label to use for each option.
 288      * @param $gradeoptions the possible grades for each answer.
 289      * @param $repeatedoptions reference to array of repeated options to fill
 290      * @param $answersoption reference to return the name of $question->options
 291      *      field holding an array of answers
 292      * @return array of form fields.
 293      */
 294     protected function get_per_answer_fields($mform, $label, $gradeoptions,
 295             &$repeatedoptions, &$answersoption) {
 296         $repeated = array();
 297         $answeroptions = array();
 298         $answeroptions[] = $mform->createElement('text', 'answer',
 299                 $label, array('size' => 40));
 300         $answeroptions[] = $mform->createElement('select', 'fraction',
 301                 get_string('grade'), $gradeoptions);
 302         $repeated[] = $mform->createElement('group', 'answeroptions',
 303                  $label, $answeroptions, null, false);
 304         $repeated[] = $mform->createElement('editor', 'feedback',
 305                 get_string('feedback', 'question'), array('rows' => 5), $this->editoroptions);
 306         $repeatedoptions['answer']['type'] = PARAM_RAW;
 307         $repeatedoptions['fraction']['default'] = 0;
 308         $answersoption = 'answers';
 309         return $repeated;
 310     }
 311
 312     /**
 313      * Add a set of form fields, obtained from get_per_answer_fields, to the form,
 314      * one for each existing answer, with some blanks for some new ones.
 315      * @param object $mform the form being built.
 316      * @param $label the label to use for each option.
 317      * @param $gradeoptions the possible grades for each answer.
 318      * @param $minoptions the minimum number of answer blanks to display.
 319      *      Default QUESTION_NUMANS_START.
 320      * @param $addoptions the number of answer blanks to add. Default QUESTION_NUMANS_ADD.
 321      */
 322     protected function add_per_answer_fields(&$mform, $label, $gradeoptions,
 323             $minoptions = QUESTION_NUMANS_START, $addoptions = QUESTION_NUMANS_ADD) {
 324         $mform->addElement('header', 'answerhdr',
 325                     get_string('answers', 'question'), '');
 326         $mform->setExpanded('answerhdr', 1);
 327         $answersoption = '';
 328         $repeatedoptions = array();
 329         $repeated = $this->get_per_answer_fields($mform, $label, $gradeoptions,
 330                 $repeatedoptions, $answersoption);
 331
 332         if (isset($this->question->options)) {
 333             $repeatsatstart = count($this->question->options->$answersoption);
 334         } else {
 335             $repeatsatstart = $minoptions;
 336         }
 337
 338         $this->repeat_elements($repeated, $repeatsatstart, $repeatedoptions,
 339                 'noanswers', 'addanswers', $addoptions,
 340                 $this->get_more_choices_string(), true);
 341     }
 342
 343     /**
 344      * Language string to use for 'Add {no} more {whatever we call answers}'.
 345      */
 346     protected function get_more_choices_string() {
 347         return get_string('addmorechoiceblanks', 'question');
 348     }
 349
 350     protected function add_combined_feedback_fields($withshownumpartscorrect = false) {
 351         $mform = $this->_form;
 352
 353         $mform->addElement('header', 'combinedfeedbackhdr',
 354                 get_string('combinedfeedback', 'question'));
 355
 356         $fields = array('correctfeedback', 'partiallycorrectfeedback', 'incorrectfeedback');
 357         foreach ($fields as $feedbackname) {
 358             $element = $mform->addElement('editor', $feedbackname,
 359                                 get_string($feedbackname, 'question'),
 360                                 array('rows' => 5), $this->editoroptions);
 361             $mform->setType($feedbackname, PARAM_RAW);
 362             // Using setValue() as setDefault() does not work for the editor class.
 363             $element->setValue(array('text'=>get_string($feedbackname.'default', 'question')));
 364
 365             if ($withshownumpartscorrect && $feedbackname == 'partiallycorrectfeedback') {
 366                 $mform->addElement('advcheckbox', 'shownumcorrect',
 367                         get_string('options', 'question'),
 368                         get_string('shownumpartscorrectwhenfinished', 'question'));
 369                 $mform->setDefault('shownumcorrect', true);
 370             }
 371         }
 372     }
 373
 374     /**
 375      * Create the form elements required by one hint.
 376      * @param string $withclearwrong whether this quesiton type uses the 'Clear wrong' option on hints.
 377      * @param string $withshownumpartscorrect whether this quesiton type uses the 'Show num parts correct' option on hints.
 378      * @return array form field elements for one hint.
 379      */
 380     protected function get_hint_fields($withclearwrong = false, $withshownumpartscorrect = false) {
 381         $mform = $this->_form;
 382
 383         $repeatedoptions = array();
 384         $repeated = array();
 385         $repeated[] = $mform->createElement('editor', 'hint', get_string('hintn', 'question'),
 386                 array('rows' => 5), $this->editoroptions);
 387         $repeatedoptions['hint']['type'] = PARAM_RAW;
 388
 389         $optionelements = array();
 390         if ($withclearwrong) {
 391             $optionelements[] = $mform->createElement('advcheckbox', 'hintclearwrong',
 392                     get_string('options', 'question'), get_string('clearwrongparts', 'question'));
 393         }
 394         if ($withshownumpartscorrect) {
 395             $optionelements[] = $mform->createElement('advcheckbox', 'hintshownumcorrect', '',
 396                     get_string('shownumpartscorrect', 'question'));
 397         }
 398
 399         if (count($optionelements)) {
 400             $repeated[] = $mform->createElement('group', 'hintoptions',
 401                  get_string('hintnoptions', 'question'), $optionelements, null, false);
 402         }
 403
 404         return array($repeated, $repeatedoptions);
 405     }
 406
 407     protected function add_interactive_settings($withclearwrong = false,
 408             $withshownumpartscorrect = false) {
 409         $mform = $this->_form;
 410
 411         $mform->addElement('header', 'multitriesheader',
 412                 get_string('settingsformultipletries', 'question'));
 413
 414         $penalties = array(
 415             1.0000000,
 416             0.5000000,
 417             0.3333333,
 418             0.2500000,
 419             0.2000000,
 420             0.1000000,
 421             0.0000000
 422         );
 423         if (!empty($this->question->penalty) && !in_array($this->question->penalty, $penalties)) {
 424             $penalties[] = $this->question->penalty;
 425             sort($penalties);
 426         }
 427         $penaltyoptions = array();
 428         foreach ($penalties as $penalty) {
 429             $penaltyoptions["$penalty"] = (100 * $penalty) . '%';
 430         }
 431         $mform->addElement('select', 'penalty',
 432                 get_string('penaltyforeachincorrecttry', 'question'), $penaltyoptions);
 433         $mform->addHelpButton('penalty', 'penaltyforeachincorrecttry', 'question');
 434         $mform->setDefault('penalty', 0.3333333);
 435
 436         if (isset($this->question->hints)) {
 437             $counthints = count($this->question->hints);
 438         } else {
 439             $counthints = 0;
 440         }
 441
 442         if ($this->question->formoptions->repeatelements) {
 443             $repeatsatstart = max(self::DEFAULT_NUM_HINTS, $counthints);
 444         } else {
 445             $repeatsatstart = $counthints;
 446         }
 447
 448         list($repeated, $repeatedoptions) = $this->get_hint_fields(
 449                 $withclearwrong, $withshownumpartscorrect);
 450         $this->repeat_elements($repeated, $repeatsatstart, $repeatedoptions,
 451                 'numhints', 'addhint', 1, get_string('addanotherhint', 'question'), true);
 452     }
 453
 454     public function set_data($question) {
 455         question_bank::get_qtype($question->qtype)->set_default_options($question);
 456
 457         // Prepare question text.
 458         $draftid = file_get_submitted_draft_itemid('questiontext');
 459
 460         if (!empty($question->questiontext)) {
 461             $questiontext = $question->questiontext;
 462         } else {
 463             $questiontext = $this->_form->getElement('questiontext')->getValue();
 464             $questiontext = $questiontext['text'];
 465         }
 466         $questiontext = file_prepare_draft_area($draftid, $this->context->id,
 467                 'question', 'questiontext', empty($question->id) ? null : (int) $question->id,
 468                 $this->fileoptions, $questiontext);
 469
 470         $question->questiontext = array();
 471         $question->questiontext['text'] = $questiontext;
 472         $question->questiontext['format'] = empty($question->questiontextformat) ?
 473                 editors_get_preferred_format() : $question->questiontextformat;
 474         $question->questiontext['itemid'] = $draftid;
 475
 476         // Prepare general feedback.
 477         $draftid = file_get_submitted_draft_itemid('generalfeedback');
 478
 479         if (empty($question->generalfeedback)) {
 480             $generalfeedback = $this->_form->getElement('generalfeedback')->getValue();
 481             $question->generalfeedback = $generalfeedback['text'];
 482         }
 483
 484         $feedback = file_prepare_draft_area($draftid, $this->context->id,
 485                 'question', 'generalfeedback', empty($question->id) ? null : (int) $question->id,
 486                 $this->fileoptions, $question->generalfeedback);
 487         $question->generalfeedback = array();
 488         $question->generalfeedback['text'] = $feedback;
 489         $question->generalfeedback['format'] = empty($question->generalfeedbackformat) ?
 490                 editors_get_preferred_format() : $question->generalfeedbackformat;
 491         $question->generalfeedback['itemid'] = $draftid;
 492
 493         // Remove unnecessary trailing 0s form grade fields.
 494         if (isset($question->defaultgrade)) {
 495             $question->defaultgrade = 0 + $question->defaultgrade;
 496         }
 497         if (isset($question->penalty)) {
 498             $question->penalty = 0 + $question->penalty;
 499         }
 500
 501         // Set any options.
 502         $extraquestionfields = question_bank::get_qtype($question->qtype)->extra_question_fields();
 503         if (is_array($extraquestionfields) && !empty($question->options)) {
 504             array_shift($extraquestionfields);
 505             foreach ($extraquestionfields as $field) {
 506                 if (property_exists($question->options, $field)) {
 507                     $question->$field = $question->options->$field;
 508                 }
 509             }
 510         }
 511
 512         // Subclass adds data_preprocessing code here.
 513         $question = $this->data_preprocessing($question);
 514
 515         parent::set_data($question);
 516     }
 517
 518     /**
 519      * Perform an preprocessing needed on the data passed to {@link set_data()}
 520      * before it is used to initialise the form.
 521      * @param object $question the data being passed to the form.
 522      * @return object $question the modified data.
 523      */
 524     protected function data_preprocessing($question) {
 525         return $question;
 526     }
 527
 528     /**
 529      * Perform the necessary preprocessing for the fields added by
 530      * {@link add_per_answer_fields()}.
 531      * @param object $question the data being passed to the form.
 532      * @return object $question the modified data.
 533      */
 534     protected function data_preprocessing_answers($question, $withanswerfiles = false) {
 535         if (empty($question->options->answers)) {
 536             return $question;
 537         }
 538
 539         $key = 0;
 540         foreach ($question->options->answers as $answer) {
 541             if ($withanswerfiles) {
 542                 // Prepare the feedback editor to display files in draft area.
 543                 $draftitemid = file_get_submitted_draft_itemid('answer['.$key.']');
 544                 $question->answer[$key]['text'] = file_prepare_draft_area(
 545                     $draftitemid,          // Draftid
 546                     $this->context->id,    // context
 547                     'question',            // component
 548                     'answer',              // filarea
 549                     !empty($answer->id) ? (int) $answer->id : null, // itemid
 550                     $this->fileoptions,    // options
 551                     $answer->answer        // text.
 552                 );
 553                 $question->answer[$key]['itemid'] = $draftitemid;
 554                 $question->answer[$key]['format'] = $answer->answerformat;
 555             } else {
 556                 $question->answer[$key] = $answer->answer;
 557             }
 558
 559             $question->fraction[$key] = 0 + $answer->fraction;
 560             $question->feedback[$key] = array();
 561
 562             // Evil hack alert. Formslib can store defaults in two ways for
 563             // repeat elements:
 564             //   ->_defaultValues['fraction[0]'] and
 565             //   ->_defaultValues['fraction'][0].
 566             // The $repeatedoptions['fraction']['default'] = 0 bit above means
 567             // that ->_defaultValues['fraction[0]'] has already been set, but we
 568             // are using object notation here, so we will be setting
 569             // ->_defaultValues['fraction'][0]. That does not work, so we have
 570             // to unset ->_defaultValues['fraction[0]'].
 571             unset($this->_form->_defaultValues["fraction[$key]"]);
 572
 573             // Prepare the feedback editor to display files in draft area.
 574             $draftitemid = file_get_submitted_draft_itemid('feedback['.$key.']');
 575             $question->feedback[$key]['text'] = file_prepare_draft_area(
 576                 $draftitemid,          // Draftid
 577                 $this->context->id,    // context
 578                 'question',            // component
 579                 'answerfeedback',      // filarea
 580                 !empty($answer->id) ? (int) $answer->id : null, // itemid
 581                 $this->fileoptions,    // options
 582                 $answer->feedback      // text.
 583             );
 584             $question->feedback[$key]['itemid'] = $draftitemid;
 585             $question->feedback[$key]['format'] = $answer->feedbackformat;
 586             $key++;
 587         }
 588         return $question;
 589     }
 590
 591     /**
 592      * Perform the necessary preprocessing for the fields added by
 593      * {@link add_combined_feedback_fields()}.
 594      * @param object $question the data being passed to the form.
 595      * @return object $question the modified data.
 596      */
 597     protected function data_preprocessing_combined_feedback($question,
 598             $withshownumcorrect = false) {
 599         if (empty($question->options)) {
 600             return $question;
 601         }
 602
 603         $fields = array('correctfeedback', 'partiallycorrectfeedback', 'incorrectfeedback');
 604         foreach ($fields as $feedbackname) {
 605             $draftid = file_get_submitted_draft_itemid($feedbackname);
 606             $feedback = array();
 607             $feedback['text'] = file_prepare_draft_area(
 608                 $draftid,              // Draftid
 609                 $this->context->id,    // context
 610                 'question',            // component
 611                 $feedbackname,         // filarea
 612                 !empty($question->id) ? (int) $question->id : null, // itemid
 613                 $this->fileoptions,    // options
 614                 $question->options->$feedbackname // text.
 615             );
 616             $feedbackformat = $feedbackname . 'format';
 617             $feedback['format'] = $question->options->$feedbackformat;
 618             $feedback['itemid'] = $draftid;
 619
 620             $question->$feedbackname = $feedback;
 621         }
 622
 623         if ($withshownumcorrect) {
 624             $question->shownumcorrect = $question->options->shownumcorrect;
 625         }
 626
 627         return $question;
 628     }
 629
 630     /**
 631      * Perform the necessary preprocessing for the hint fields.
 632      * @param object $question the data being passed to the form.
 633      * @return object $question the modified data.
 634      */
 635     protected function data_preprocessing_hints($question, $withclearwrong = false,
 636             $withshownumpartscorrect = false) {
 637         if (empty($question->hints)) {
 638             return $question;
 639         }
 640
 641         $key = 0;
 642         foreach ($question->hints as $hint) {
 643             $question->hint[$key] = array();
 644
 645             // Prepare feedback editor to display files in draft area.
 646             $draftitemid = file_get_submitted_draft_itemid('hint['.$key.']');
 647             $question->hint[$key]['text'] = file_prepare_draft_area(
 648                 $draftitemid,          // Draftid
 649                 $this->context->id,    // context
 650                 'question',            // component
 651                 'hint',                // filarea
 652                 !empty($hint->id) ? (int) $hint->id : null, // itemid
 653                 $this->fileoptions,    // options
 654                 $hint->hint            // text.
 655             );
 656             $question->hint[$key]['itemid'] = $draftitemid;
 657             $question->hint[$key]['format'] = $hint->hintformat;
 658             $key++;
 659
 660             if ($withclearwrong) {
 661                 $question->hintclearwrong[] = $hint->clearwrong;
 662             }
 663             if ($withshownumpartscorrect) {
 664                 $question->hintshownumcorrect[] = $hint->shownumcorrect;
 665             }
 666         }
 667
 668         return $question;
 669     }
 670
 671     public function validation($fromform, $files) {
 672         $errors = parent::validation($fromform, $files);
 673         if (empty($fromform['makecopy']) && isset($this->question->id)
 674                 && ($this->question->formoptions->canedit ||
 675                         $this->question->formoptions->cansaveasnew)
 676                 && empty($fromform['usecurrentcat']) && !$this->question->formoptions->canmove) {
 677             $errors['currentgrp'] = get_string('nopermissionmove', 'question');
 678         }
 679
 680         // Default mark.
 681         if (array_key_exists('defaultmark', $fromform) && $fromform['defaultmark'] < 0) {
 682             $errors['defaultmark'] = get_string('defaultmarkmustbepositive', 'question');
 683         }
 684
 685         return $errors;
 686     }
 687
 688     /**
 689      * Override this in the subclass to question type name.
 690      * @return the question type name, should be the same as the name() method
 691      *      in the question type class.
 692      */
 693     public abstract function qtype();
 694
 695     /**
 696      * Returns an array of editor options with collapsed options turned off.
 697      * @deprecated since 2.6
 698      * @return array
 699      */
 700     protected function get_non_collabsible_editor_options() {
 701         debugging('get_non_collabsible_editor_options() is deprecated, use $this->editoroptions instead.', DEBUG_DEVELOPER);
 702         return $this->editoroptions;
 703     }
 704
 705 }