questiontypebase.php 13.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Question type class for the embedded element in question text question types.
 *
20
 * @package    qtype_gapselect
21
22
 * @copyright  2011 The Open University
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23
24
 */

25
26
defined('MOODLE_INTERNAL') || die();

27
28
29
30
31
32
33
34
require_once($CFG->libdir . '/questionlib.php');
require_once($CFG->dirroot . '/question/engine/lib.php');
require_once($CFG->dirroot . '/question/format/xml/format.php');


/**
 * The embedded element in question text question type class.
 *
35
36
 * @copyright  2011 The Open University
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37
 */
38
abstract class qtype_gapselect_base extends question_type {
39
40
41
42
43
44
45
46
47
48
49
    /**
     * Choices are stored in the question_answers table, and any options need to
     * be put into the feedback field somehow. This method is responsible for
     * converting all the options to a single string for this purpose. It is used
     * by {@link save_question_options()}.
     * @param array $choice the form data relating to this choice.
     * @return string ready to store in the database.
     */
    protected abstract function choice_options_to_feedback($choice);

    public function save_question_options($question) {
50
51
        global $DB;
        $context = $question->context;
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

        // This question type needs the choices to be consecutively numbered, but
        // there is no reason why the question author should have done that,
        // so renumber if necessary.
        // Insert all the new answers.
        $nonblankchoices = [];
        $questiontext = $question->questiontext;
        $newkey = 0;
        foreach ($question->choices as $key => $choice) {
            if (trim($choice['answer']) == '') {
                continue;
            }

            $nonblankchoices[] = $choice;
            if ($newkey != $key) {
                // Safe to do this in this order, because we will always be replacing
                // a bigger number with a smaller number that is not present.
                // Numbers in the question text always one bigger than the array index.
                $questiontext = str_replace('[[' . ($key + 1) . ']]', '[[' . ($newkey + 1) . ']]',
                        $questiontext);
            }
            $newkey += 1;
        }
        $question->choices = $nonblankchoices;
        if ($questiontext !== $question->questiontext) {
            $DB->set_field('question', 'questiontext', $questiontext,
                    ['id' => $question->id]);
            $question->questiontext = $questiontext;
        }
81

82
83
        $oldanswers = $DB->get_records('question_answers',
                array('question' => $question->id), 'id ASC');
84

85
        // Insert all the new answers.
86
87
        foreach ($question->choices as $key => $choice) {

88
            // Answer guaranteed to be non-blank. See above.
89
90
91

            $feedback = $this->choice_options_to_feedback($choice);

92
            if ($answer = array_shift($oldanswers)) {
93
                $answer->answer = trim($choice['answer']);
94
                $answer->feedback = $feedback;
95
96
                $DB->update_record('question_answers', $answer);

97
            } else {
98
                $answer = new stdClass();
99
                $answer->question = $question->id;
100
101
                $answer->answer = $choice['answer'];
                $answer->answerformat = FORMAT_HTML;
102
103
                $answer->fraction = 0;
                $answer->feedback = $feedback;
104
105
                $answer->feedbackformat = 0;
                $DB->insert_record('question_answers', $answer);
106
107
108
            }
        }

109
        // Delete old answer records.
110
        foreach ($oldanswers as $oa) {
111
            $DB->delete_records('question_answers', array('id' => $oa->id));
112
113
        }

114
115
        $options = $DB->get_record('question_' . $this->name(),
                array('questionid' => $question->id));
116
        if (!$options) {
117
            $options = new stdClass();
118
            $options->questionid = $question->id;
119
120
121
122
            $options->correctfeedback = '';
            $options->partiallycorrectfeedback = '';
            $options->incorrectfeedback = '';
            $options->id = $DB->insert_record('question_' . $this->name(), $options);
123
124
125
        }

        $options->shuffleanswers = !empty($question->shuffleanswers);
126
127
        $options = $this->save_combined_feedback_helper($options, $question, $context, true);
        $DB->update_record('question_' . $this->name(), $options);
128
129
130
131
132

        $this->save_hints($question, true);
    }

    public function get_question_options($question) {
133
134
135
        global $DB;
        $question->options = $DB->get_record('question_'.$this->name(),
                array('questionid' => $question->id), '*', MUST_EXIST);
136
137
138
        parent::get_question_options($question);
    }

139
140
141
142
    public function delete_question($questionid, $contextid) {
        global $DB;
        $DB->delete_records('question_'.$this->name(), array('questionid' => $questionid));
        return parent::delete_question($questionid, $contextid);
143
144
145
146
147
148
149
150
151
152
153
154
155
156
    }

    /**
     * Used by {@link initialise_question_instance()} to set up the choice-specific data.
     * @param object $choicedata as loaded from the question_answers table.
     * @return object an appropriate object for representing the choice.
     */
    protected abstract function make_choice($choicedata);

    protected function initialise_question_instance(question_definition $question, $questiondata) {
        parent::initialise_question_instance($question, $questiondata);

        $question->shufflechoices = $questiondata->options->shuffleanswers;

157
        $this->initialise_combined_feedback($question, $questiondata, true);
158
159

        $question->choices = array();
160
        $choiceindexmap = array();
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

        // Store the choices in arrays by group.
        $i = 1;
        foreach ($questiondata->options->answers as $choicedata) {
            $choice = $this->make_choice($choicedata);

            if (array_key_exists($choice->choice_group(), $question->choices)) {
                $question->choices[$choice->choice_group()][] = $choice;
            } else {
                $question->choices[$choice->choice_group()][1] = $choice;
            }

            end($question->choices[$choice->choice_group()]);
            $choiceindexmap[$i] = array($choice->choice_group(),
                    key($question->choices[$choice->choice_group()]));
            $i += 1;
        }

        $question->places = array();
        $question->textfragments = array();
        $question->rightchoices = array();
        // Break up the question text, and store the fragments, places and right answers.

184
185
        $bits = preg_split('/\[\[(\d+)]]/', $question->questiontext,
                null, PREG_SPLIT_DELIM_CAPTURE);
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
        $question->textfragments[0] = array_shift($bits);
        $i = 1;

        while (!empty($bits)) {
            $choice = array_shift($bits);

            list($group, $choiceindex) = $choiceindexmap[$choice];
            $question->places[$i] = $group;
            $question->rightchoices[$i] = $choiceindex;

            $question->textfragments[$i] = array_shift($bits);
            $i += 1;
        }
    }

    protected function make_hint($hint) {
        return question_hint_with_parts::load_from_record($hint);
    }

    public function get_random_guess_score($questiondata) {
        $question = $this->make_question($questiondata);
        return $question->get_random_guess_score();
    }

    /**
     * This function should reverse {@link choice_options_to_feedback()}.
     * @param string $feedback the data loaded from the database.
     * @return array the choice options.
     */
    protected abstract function feedback_to_choice_options($feedback);

    /**
     * This method gets the choices (answers)
     * in a 2 dimentional array.
     *
     * @param object $question
     * @return array of groups
     */
    protected function get_array_of_choices($question) {
        $subquestions = $question->options->answers;
        $count = 0;
227
        foreach ($subquestions as $key => $subquestion) {
228
229
230
231
            $answers[$count]['id'] = $subquestion->id;
            $answers[$count]['answer'] = $subquestion->answer;
            $answers[$count]['fraction'] = $subquestion->fraction;
            $answers[$count] += $this->feedback_to_choice_options($subquestion->feedback);
232
            $answers[$count]['choice'] = $count + 1;
233
234
235
236
237
            ++$count;
        }
        return $answers;
    }

238
239
    /**
     * This method gets the choices (answers) and sort them by groups
240
241
242
     * in a 2 dimentional array.
     *
     * @param object $question
243
     * @param object $state Question state object
244
245
246
247
248
     * @return array of groups
     */
    protected function get_array_of_groups($question, $state) {
        $answers = $this->get_array_of_choices($question);
        $arr = array();
249
        for ($group = 1; $group < count($answers); $group++) {
250
251
            $players = $this->get_group_of_players($question, $state, $answers, $group);
            if ($players) {
252
                $arr[$group] = $players;
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
            }
        }
        return $arr;
    }

    /**
     * This method gets the correct answers in a 2 dimentional array.
     *
     * @param object $question
     * @return array of groups
     */
    protected function get_correct_answers($question) {
        $arrayofchoices = $this->get_array_of_choices($question);
        $arrayofplaceholdeers = $this->get_array_of_placeholders($question);

268
        $correctplayers = array();
269
270
271
        foreach ($arrayofplaceholdeers as $ph) {
            foreach ($arrayofchoices as $key => $choice) {
                if ($key + 1 == $ph) {
272
                    $correctplayers[] = $choice;
273
274
275
                }
            }
        }
276
        return $correctplayers;
277
278
    }

279
280
281
282
283
    /**
     * Return the list of groups used in a question.
     * @param stdClass $question the question data.
     * @return array the groups used, or false if an error occurs.
     */
284
285
286
    protected function get_array_of_placeholders($question) {
        $qtext = $question->questiontext;
        $error = '<b> ERROR</b>: Please check the form for this question. ';
287
        if (!$qtext) {
288
289
290
291
            echo $error . 'The question text is empty!';
            return false;
        }

292
        // Get the slots.
293
294
        $slots = $this->getEmbeddedTextArray($question);

295
        if (!$slots) {
296
297
298
299
300
301
            echo $error . 'The question text is not in the correct format!';
            return false;
        }

        $output = array();
        foreach ($slots as $slot) {
302
            $output[] = substr($slot, 2, strlen($slot) - 4); // 2 is for '[[' and 4 is for '[[]]'.
303
304
        }
        return $output;
305
    }
306

307
308
309
310
311
    protected function get_group_of_players($question, $state, $subquestions, $group) {
        $goupofanswers = array();
        foreach ($subquestions as $key => $subquestion) {
            if ($subquestion[$this->choice_group_key()] == $group) {
                $goupofanswers[] = $subquestion;
312
313
314
            }
        }

315
        // Shuffle answers within this group.
316
317
318
319
320
321
        if ($question->options->shuffleanswers == 1) {
            shuffle($goupofanswers);
        }
        return $goupofanswers;
    }

322
323
324
325
326
    public function save_defaults_for_new_questions(stdClass $fromform): void {
        parent::save_defaults_for_new_questions($fromform);
        $this->set_default_value('shuffleanswers', $fromform->shuffleanswers ?? 0);
    }

327
328
329
330
331
332
333
334
335
    public function get_possible_responses($questiondata) {
        $question = $this->make_question($questiondata);

        $parts = array();
        foreach ($question->places as $place => $group) {
            $choices = array();

            foreach ($question->choices[$group] as $i => $choice) {
                $choices[$i] = new question_possible_response(
336
                        html_to_text($choice->text, 0, false),
337
                        ($question->rightchoices[$place] == $i) / count($question->places));
338
339
340
341
342
343
344
345
346
            }
            $choices[null] = question_possible_response::no_response();

            $parts[$place] = $choices;
        }

        return $parts;
    }

347
    public function move_files($questionid, $oldcontextid, $newcontextid) {
348
        parent::move_files($questionid, $oldcontextid, $newcontextid);
349
        $this->move_files_in_combined_feedback($questionid, $oldcontextid, $newcontextid);
350
        $this->move_files_in_hints($questionid, $oldcontextid, $newcontextid);
351
    }
352

353
354
    protected function delete_files($questionid, $contextid) {
        parent::delete_files($questionid, $contextid);
355
        $this->delete_files_in_combined_feedback($questionid, $contextid);
356
        $this->delete_files_in_hints($questionid, $contextid);
357
    }
358
}