MDL-20636 Start supporting different response formats in essay. #216
[moodle.git] / question / type / essay / questiontype.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Question type class for the essay question type.
20  *
21  * @package    qtype
22  * @subpackage essay
23  * @copyright  2005 Mark Nielsen
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
28 defined('MOODLE_INTERNAL') || die();
31 /**
32  * The essay question type.
33  *
34  * @copyright  2005 Mark Nielsen
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class qtype_essay extends question_type {
38     public function is_manual_graded() {
39         return true;
40     }
42     public function get_question_options($question) {
43         global $DB;
44         $question->options = $DB->get_record('qtype_essay_options', array('questionid' => $question->id), '*', MUST_EXIST);
45         parent::get_question_options($question);
46     }
48     public function save_question_options($formdata) {
49         global $DB;
50         $context = $formdata->context;
52         $options = $DB->get_record('qtype_essay_options', array('questionid' => $formdata->id));
53         if (!$options) {
54             $options = new stdClass();
55             $options->questionid = $formdata->id;
56             $options->id = $DB->insert_record('qtype_essay_options', $options);
57         }
59         $options->responseformat = $formdata->responseformat;
60         $options->responsefieldlines = $formdata->responsefieldlines;
61         $options->attachments = $formdata->attachments;
62         $options->graderinfo = $this->import_or_save_files($formdata->graderinfo,
63                 $context, 'qtype_essay', 'graderinfo', $formdata->id);
64         $options->graderinfoformat = $formdata->graderinfo['format'];
65         $DB->update_record('qtype_essay_options', $options);
66     }
68     protected function initialise_question_instance(question_definition $question, $questiondata) {
69         parent::initialise_question_instance($question, $questiondata);
70         $question->responseformat = $questiondata->options->responseformat;
71         $question->responsefieldlines = $questiondata->options->responsefieldlines;
72         $question->attachments = $questiondata->options->attachments;
73         $question->graderinfo = $questiondata->options->graderinfo;
74         $question->graderinfoformat = $questiondata->options->graderinfoformat;
75     }
77     /**
78      * @return array the different response formats that the question type supports.
79      * internal name => human-readable name.
80      */
81     public function respones_formats() {
82         return array(
83             'editor' => get_string('formateditor', 'qtype_essay'),
84             'editorfilepicker' => get_string('formateditorfilepicker', 'qtype_essay'),
85             'plain' => get_string('formatplain', 'qtype_essay'),
86             'monospaced' => get_string('formatmonospaced', 'qtype_essay'),
87         );
88     }
90     /**
91      * @return array the choices that should be offered for the input box size.
92      */
93     public function respones_sizes() {
94         $choices = array();
95         for ($lines = 5; $lines <= 40; $lines += 5) {
96             $choices[$lines] = get_string('nlines', 'qtype_essay', $lines);
97         }
98         return $choices;
99     }
101     /**
102      * @return array the choices that should be offered for the number of attachments.
103      */
104     public function attachment_options() {
105         return array(
106             0 => get_string('no'),
107             1 => '1',
108             2 => '2',
109             3 => '3',
110             -1 => get_string('unlimited'),
111         );
112     }
114     public function move_files($questionid, $oldcontextid, $newcontextid) {
115         parent::move_files($questionid, $oldcontextid, $newcontextid);
116         $this->move_files_in_answers($questionid, $oldcontextid, $newcontextid);
117     }
119     protected function delete_files($questionid, $contextid) {
120         parent::delete_files($questionid, $contextid);
121         $this->delete_files_in_answers($questionid, $contextid);
122     }