-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathbehaviour.php
200 lines (175 loc) · 7.97 KB
/
behaviour.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<?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 behaviour for students to self-assess their work.
*
* The student enters their response during the attempt, and it is saved. Later,
* when the whole attempt is finished, the attempt goes into the NEEDS_GRADING
* state, and the teacher must grade it manually.
*
* @package qbehaviour_selfassess
* @copyright 2020 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class qbehaviour_selfassess extends question_behaviour_with_save {
/** @var int special value for $options->readonly for when in the self-assess state. */
const READONLY_EXCEPT_SELFASSESS = 0x10;
public function is_compatible_question(question_definition $question): bool {
return $question instanceof question_with_responses;
}
public function adjust_display_options(question_display_options $options): void {
global $USER;
$originalreadonly = $options->readonly;
parent::adjust_display_options($options);
if ($this->qa->get_state()->is_finished()) {
if (!$originalreadonly && ($USER->id == $this->qa->get_step(0)->get_user_id())) {
$options->readonly = self::READONLY_EXCEPT_SELFASSESS;
}
}
}
public function get_expected_data(): array {
$expecteddata = parent::get_expected_data();
if (!$this->qa->get_state()->is_finished()) {
$expecteddata['submit'] = PARAM_BOOL;
} else {
$expecteddata['stars'] = PARAM_INT;
$expecteddata['selfcomment'] = PARAM_RAW;
$expecteddata['rate'] = PARAM_BOOL;
}
return $expecteddata;
}
public function process_action(question_attempt_pending_step $pendingstep): bool {
if ($pendingstep->has_behaviour_var('submit')) {
return $this->process_submit($pendingstep);
} else if ($pendingstep->has_behaviour_var('finish')) {
return $this->process_finish($pendingstep);
} else if ($pendingstep->has_behaviour_var('comment')) {
return $this->process_comment($pendingstep);
} else if ($this->qa->get_state()->is_finished()) {
// Once we have finished, any action should be treated as a potential save.
return $this->process_self_assess($pendingstep);
} else {
return $this->process_save($pendingstep);
}
}
public function process_save(question_attempt_pending_step $pendingstep): bool {
$status = parent::process_save($pendingstep);
if ($status == question_attempt::KEEP &&
$pendingstep->get_state() == question_state::$complete) {
$pendingstep->set_state(question_state::$todo);
}
return $status;
}
public function process_submit(question_attempt_pending_step $pendingstep): bool {
if ($this->qa->get_state()->is_finished()) {
return question_attempt::DISCARD;
}
if (!$this->is_complete_response($pendingstep)) {
$pendingstep->set_state(question_state::$invalid);
return question_attempt::KEEP;
}
return $this->process_finish($pendingstep);
}
public function process_finish(question_attempt_pending_step $pendingstep): bool {
if ($this->qa->get_state()->is_finished()) {
return question_attempt::DISCARD;
}
$response = $pendingstep->get_qt_data();
if (!$this->question->is_gradable_response($response)) {
$pendingstep->set_state(question_state::$gaveup);
} else {
$pendingstep->set_state(question_state::$needsgrading);
}
$pendingstep->set_new_response_summary($this->question->summarise_response($response));
return question_attempt::KEEP;
}
public function process_self_assess(question_attempt_pending_step $pendingstep): bool {
if (!$this->qa->get_state()->is_finished()) {
throw new coding_exception('Cannot self-assess a question before it is finished.');
}
if ($this->is_same_self_assessment($pendingstep)) {
return question_attempt::DISCARD;
}
if (!$pendingstep->has_behaviour_var('rate')) {
// If the student did not click the button, then add a variable
// so we can easily identify later that this was a self-rate.
$pendingstep->set_behaviour_var('_rate', 1);
}
$stars = $pendingstep->get_behaviour_var('stars');
if ($stars !== null) {
if ($stars < 0 || $stars > 5) {
throw new coding_exception('Number of stars must be between 0 and 5 inclusive.');
}
$pendingstep->set_fraction($stars / 5);
}
$pendingstep->set_state(question_state::$manfinished);
return question_attempt::KEEP;
}
/**
* Checks whether two self-assessment actions are the same.
*
* That is, whether the star rating, and comment (if given) are the same.
*
* @param question_attempt_step $pendingstep contains the new responses.
* @return bool whether the new assessment is the same as we already have.
*/
protected function is_same_self_assessment(question_attempt_step $pendingstep): bool {
// Get the previous comment, and the new one, treating missing values as an empty string.
$previouscomment = $this->qa->get_last_behaviour_var('selfcomment') ?? '';
$newcomment = $pendingstep->get_behaviour_var('selfcomment') ?? '';
if ($previouscomment != $newcomment) {
// The comment has changed.
return false;
}
// So, now we know the comment is the same, so check the mark, if present.
$previousstars = $this->qa->get_last_behaviour_var('stars');
$newstars = $pendingstep->get_behaviour_var('stars');
return (int) $previousstars === (int) $newstars;
}
public function summarise_action(question_attempt_step $step) {
if ($step->has_behaviour_var('submit')) {
return $this->summarise_submit($step);
} else if ($step->has_behaviour_var('finish')) {
return $this->summarise_finish($step);
} else if ($step->has_behaviour_var('comment')) {
return $this->summarise_manual_comment($step);
} else if ($step->has_behaviour_var('rate') || $step->has_behaviour_var('_rate')) {
return $this->summarise_self_assess($step);
} else {
return $this->summarise_save($step);
}
}
/**
* Produce a text summary of a self-assessment action.
*
* @param question_attempt_step $step the step to summarise.
* @return string a summary of the action performed.
*/
protected function summarise_self_assess(question_attempt_step $step): string {
$stars = $step->get_behaviour_var('stars');
$comment = $step->get_behaviour_var('selfcomment') ?? '';
$a = new stdClass();
$a->stars = $stars;
$a->comment = shorten_text($comment, 200);
if ($comment !== null && $comment !== '' && $stars !== null) {
return get_string('selfassessedwithcomment', 'qbehaviour_selfassess', $a);
} else if ($stars !== null) {
return get_string('selfassessed', 'qbehaviour_selfassess', $a);
} else {
return get_string('selfcommented', 'qbehaviour_selfassess', $a);
}
}
}