-
Notifications
You must be signed in to change notification settings - Fork 23
/
externallib.php
184 lines (172 loc) · 8.19 KB
/
externallib.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
<?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/>.
defined('MOODLE_INTERNAL') || die();
require_once($CFG->libdir . '/externallib.php');
require_once($CFG->libdir . '/questionlib.php');
/**
* Pattern-match question type upgrade code.
*
* @package qtype_pmatch
* @copyright 2018 The Open University
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class qtype_pmatch_external extends external_api {
/**
* Describes the parameters for check_response webservice.
*
* @return external_function_parameters
*/
public static function check_response_parameters() {
return new external_function_parameters([
'questionid' => new external_value(PARAM_INT, 'The question id'),
'response' => new external_value(PARAM_RAW, 'The response'),
]);
}
/**
* Describes the return value for check_response webservice.
*
* @return external_single_structure
*/
public static function check_response_returns() {
return new external_single_structure([
'status' => new external_value(PARAM_ALPHA, 'Status when check'),
'message' => new external_value(PARAM_RAW, 'The error message', VALUE_OPTIONAL)
]);
}
/**
* Check response for create pattern match test response.
*
* @param int $questionid The question id
* @param int $response The response to check
* @return array The status and message after checked the response.
*/
public static function check_response($questionid, $response) {
$result = [];
$result['status'] = 'success';
$params = self::validate_parameters(self::check_response_parameters(), [
'questionid' => $questionid,
'response' => $response]);
$duplicated = \qtype_pmatch\testquestion_responses::check_duplicate_response($params['questionid'], $params['response']);
if ($duplicated) {
$result['status'] = 'error';
$result['message'] = get_string('testquestionformduplicateresponse', 'qtype_pmatch');
}
return $result;
}
/**
* Describes the parameters for create_response webservice.
*
* @return external_function_parameters
*/
public static function create_response_parameters() {
return new external_function_parameters([
'questionid' => new external_value(PARAM_INT, 'The question id'),
'expectedfraction' => new external_value(PARAM_FLOAT, 'The expectedfraction'),
'response' => new external_value(PARAM_RAW, 'The response'),
'curentrow' => new external_value(PARAM_INT, 'The index of curent row editing'),
]);
}
/**
* Describes the return value for create_response
*
* @return external_single_structure
*/
public static function create_response_returns() {
return new external_single_structure([
'status' => new external_value(PARAM_ALPHA, 'Status when create'),
'message' => new external_value(PARAM_RAW, 'The error message', VALUE_OPTIONAL),
'html' => new external_value(PARAM_RAW, 'A row html for append to response table'),
'counts' => new external_single_structure([
'correct' => new external_value(PARAM_INT, '', VALUE_OPTIONAL),
'total' => new external_value(PARAM_INT, '', VALUE_OPTIONAL),
'misspositive' => new external_value(PARAM_INT, '', VALUE_OPTIONAL),
'missnegative' => new external_value(PARAM_INT, '', VALUE_OPTIONAL),
'accuracy' => new external_value(PARAM_INT, '', VALUE_OPTIONAL),
])
]);
}
/**
* Create pattern match test response
*
* @param int $questionid The question id
* @param int $expectedfraction The expectedfraction for qtype_pmatch_test_responses table
* @param string $response The response for qtype_pmatch_test_responses table
* @param int $curentrow The index of curent row editing.
*
* @return array The status and data after created the response. If not success return the error message.
*/
public static function create_response($questionid, $expectedfraction, $response, $curentrow) {
global $DB, $PAGE;
$params = self::validate_parameters(self::create_response_parameters(), [
'questionid' => $questionid,
'expectedfraction' => $expectedfraction,
'response' => $response,
'curentrow' => $curentrow]);
$question = question_bank::load_question($params['questionid']);
// To prevent notice message when calling web service.
$PAGE->set_context($question->get_context());
try {
$response = new stdClass();
$response->expectedfraction = $params['expectedfraction'];
$response->response = $params['response'];
$response->questionid = $params['questionid'];
$duplicated = \qtype_pmatch\testquestion_responses::check_duplicate_response($params['questionid'],
$params['response']);
if (!$duplicated) {
$rid = $DB->insert_record('qtype_pmatch_test_responses', $response);
} else {
throw new Exception(get_string('testquestionformduplicateresponse', 'qtype_pmatch'));
}
} catch (Exception $e) {
$result['message'] = $e->getMessage();
$result['status'] = 'error';
$result['counts'] = [];
$result['html'] = '';
return $result;
}
$result = self::update_computed_mark_and_get_row_response($rid, $question, $curentrow);
return $result;
}
/**
* Update the computed mark and get row pattern match test response
*
* @param int $rid The response id.
* @param question_definition $question loaded from the database.
* @param int $curentrow The index of curent row editing.
*
* @return array The status and row data response.
*/
public static function update_computed_mark_and_get_row_response($rid, $question, $curentrow) {
// Now update the computed mark (though this will never change), as it allows us
// to get the correct row class. It also means that if you change the human mark
// of a response that has not been computer marked yet, the computed mark will be inserted.
$responses = \qtype_pmatch\testquestion_responses::get_responses_by_ids([$rid]);
$response = $responses[$rid];
\qtype_pmatch\testquestion_responses::grade_response($response, $question);
\qtype_pmatch\testquestion_responses::save_rule_matches($question, [$rid]);
// We need the table to get a row response.
$options = new \qtype_pmatch\testquestion_options($question);
$testresponsesobj = \qtype_pmatch\testquestion_responses::create_for_question($question);
$table = new \qtype_pmatch\testquestion_table($question, $testresponsesobj, $options);
// Counts could be returned as the lang string 'testquestionresultssummary', and that
// would mean any changes in the string would not need to be replicated in updater.js, creator.js,
// but it was felt that just passing an object of integers is better.
$result['counts'] = \qtype_pmatch\testquestion_responses::get_question_grade_summary_counts($question);
$result['html'] = $table->get_row_html_for_response_table($response, $curentrow);
$result['status'] = 'success';
return $result;
}
}