moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-07 18:06:51 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-53034 mod_quiz: New WS mod_quiz_get_quiz_feedback_for_grade

Browse source
This commit is contained in:
Juan Leyva 2016-02-08 18:28:42 +01:00
parent 3e5c19a0ed
commit 48abca7996
4 changed files with 141 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

73
mod/quiz/classes/external.php
View file

@ -1555,4 +1555,77 @@ class mod_quiz_external extends external_api {
);
}
/**
* Describes the parameters for view_quiz.
*
* @return external_external_function_parameters
* @since Moodle 3.1
*/
public static function get_quiz_feedback_for_grade_parameters() {
return new external_function_parameters (
array(
'quizid' => new external_value(PARAM_INT, 'quiz instance id'),
'grade' => new external_value(PARAM_FLOAT, 'the grade to check'),
)
);
}
/**
* Get the feedback text that should be show to a student who got the given grade in the given quiz.
*
* @param int $quizid quiz instance id
* @param float $grade the grade to check
* @return array of warnings and status result
* @since Moodle 3.1
* @throws moodle_exception
*/
public static function get_quiz_feedback_for_grade($quizid, $grade) {
global $DB;
$params = array(
'quizid' => $quizid,
'grade' => $grade,
);
$params = self::validate_parameters(self::get_quiz_feedback_for_grade_parameters(), $params);
$warnings = array();
// Request and permission validation.
$quiz = $DB->get_record('quiz', array('id' => $params['quizid']), '*', MUST_EXIST);
list($course, $cm) = get_course_and_cm_from_instance($quiz, 'quiz');
$context = context_module::instance($cm->id);
self::validate_context($context);
$result = array();
$result['feedbacktext'] = '';
$result['feedbacktextformat'] = FORMAT_MOODLE;
$feedback = quiz_feedback_record_for_grade($params['grade'], $quiz);
if (!empty($feedback->feedbacktext)) {
list($text, $format) = external_format_text($feedback->feedbacktext, $feedback->feedbacktextformat, $context->id,
'mod_quiz', 'feedback', $feedback->id);
$result['feedbacktext'] = $text;
$result['feedbacktextformat'] = $format;
}
$result['warnings'] = $warnings;
return $result;
}
/**
* Describes the get_quiz_feedback_for_grade return value.
*
* @return external_single_structure
* @since Moodle 3.1
*/
public static function get_quiz_feedback_for_grade_returns() {
return new external_single_structure(
array(
'feedbacktext' => new external_value(PARAM_RAW, 'the comment that corresponds to this grade (empty for none)'),
'feedbacktextformat' => new external_format_value('feedbacktext', VALUE_OPTIONAL),
'warnings' => new external_warnings(),
)
);
}
}