MDL-27649 support question variants as a first-class concept in the question engine.
[moodle.git] / question / type / calculatedmulti / question.php
CommitLineData
cdece95e
TH
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 * Calculated multiple-choice question definition class.
19 *
20 * @package qtype
21 * @subpackage calculatedmulti
22 * @copyright 2011 The Open University
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
26
27defined('MOODLE_INTERNAL') || die();
28
29require_once($CFG->dirroot . '/question/type/multichoice/question.php');
30require_once($CFG->dirroot . '/question/type/calculated/question.php');
31
32
33/**
34 * Represents a calculated multiple-choice multiple-response question.
35 *
36 * @copyright 2011 The Open University
37 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38 */
39class qtype_calculatedmulti_single_question extends qtype_multichoice_single_question
40 implements qtype_calculated_question_with_expressions {
e35ba43c 41
cdece95e
TH
42 /** @var qtype_calculated_dataset_loader helper for loading the dataset. */
43 public $datasetloader;
44
45 /** @var qtype_calculated_variable_substituter stores the dataset we are using. */
46 public $vs;
47
e35ba43c
TH
48 /**
49 * @var bool wheter the dataset item to use should be chose based on attempt
50 * start time, rather than randomly.
51 */
52 public $synchronised;
53
1da821bb 54 public function start_attempt(question_attempt_step $step, $variant) {
cdece95e
TH
55 qtype_calculated_question_helper::start_attempt($this, $step);
56 parent::start_attempt($step);
57 }
58
59 public function apply_attempt_state(question_attempt_step $step) {
60 qtype_calculated_question_helper::apply_attempt_state($this, $step);
61 parent::apply_attempt_state($step);
62 }
63
64 public function calculate_all_expressions() {
65 qtype_calculatedmulti_calculate_helper::calculate_all_expressions($this);
66 }
67}
68
69
70/**
71 * Represents a calculated multiple-choice multiple-response question.
72 *
73 * @copyright 2011 The Open University
74 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
75 */
76class qtype_calculatedmulti_multi_question extends qtype_multichoice_multi_question
77 implements qtype_calculated_question_with_expressions {
e35ba43c 78
cdece95e
TH
79 /** @var qtype_calculated_dataset_loader helper for loading the dataset. */
80 public $datasetloader;
81
82 /** @var qtype_calculated_variable_substituter stores the dataset we are using. */
83 public $vs;
84
e35ba43c
TH
85 /**
86 * @var bool wheter the dataset item to use should be chose based on attempt
87 * start time, rather than randomly.
88 */
89 public $synchronised;
90
1da821bb 91 public function start_attempt(question_attempt_step $step, $variant) {
cdece95e 92 qtype_calculated_question_helper::start_attempt($this, $step);
1da821bb 93 parent::start_attempt($step, $variant);
cdece95e
TH
94 }
95
96 public function apply_attempt_state(question_attempt_step $step) {
97 qtype_calculated_question_helper::apply_attempt_state($this, $step);
98 parent::apply_attempt_state($step);
99 }
100
101 public function calculate_all_expressions() {
102 qtype_calculatedmulti_calculate_helper::calculate_all_expressions($this);
103 }
104}
105
106
107/**
108 * Helper to abstract common code between qtype_calculatedmulti_single_question
109 * and qtype_calculatedmulti_multi_question.
110 *
111 * @copyright 2011 The Open University
112 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
113 */
114abstract class qtype_calculatedmulti_calculate_helper {
115 /**
116 * Calculate all the exressions in a qtype_calculatedmulti_single_question
117 * or qtype_calculatedmulti_multi_question.
118 * @param unknown_type $question
119 */
120 public static function calculate_all_expressions(
121 qtype_calculated_question_with_expressions $question) {
122 $question->questiontext = $question->vs->replace_expressions_in_text(
123 $question->questiontext);
124 $question->generalfeedback = $question->vs->replace_expressions_in_text(
125 $question->generalfeedback);
126
127 foreach ($question->answers as $ans) {
128 if ($ans->answer && $ans->answer !== '*') {
129 $ans->answer = $question->vs->replace_expressions_in_text($ans->answer,
130 $ans->correctanswerlength, $ans->correctanswerformat);
131 }
132 $ans->feedback = $question->vs->replace_expressions_in_text($ans->feedback,
133 $ans->correctanswerlength, $ans->correctanswerformat);
134 }
135 }
136}