mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-15 05:25:08 +02:00
Code Issues Projects Releases Wiki Activity

Merge branch 'MDL-57657-master' of git://github.com/jleyva/moodle

Browse Source
This commit is contained in:
Dan Poltawski 2017-03-20 07:24:54 +00:00
commit 5d8d3a8ce2
5 changed files with 316 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

190
mod/lesson/classes/external.php
View File

@ -474,6 +474,26 @@ class mod_lesson_external extends external_api {
);
}
/**
* Check if the current user can retrieve lesson information (grades, attempts) about the given user.
*
* @param int $userid the user to check
* @param stdClass $course course object
* @param stdClass $cm cm object
* @param stdClass $context context object
* @throws moodle_exception
* @since Moodle 3.3
*/
protected static function check_can_view_user_data($userid, $course, $cm, $context) {
$user = core_user::get_user($userid, '*', MUST_EXIST);
core_user::require_active_user($user);
// Check permissions and that if users share group (if groups enabled).
require_capability('mod/lesson:viewreports', $context);
if (!groups_user_groups_visible($course, $user->id, $cm)) {
throw new moodle_exception('notingroup');
}
}
/**
* Describes the parameters for get_questions_attempts.
*
@ -526,13 +546,7 @@ class mod_lesson_external extends external_api {
// Extra checks so only users with permissions can view other users attempts.
if ($USER->id != $params['userid']) {
$user = core_user::get_user($params['userid'], '*', MUST_EXIST);
core_user::require_active_user($user);
// Check permissions and that if users share group (if groups enabled).
require_capability('mod/lesson:viewreports', $context);
if (!groups_user_groups_visible($course, $user->id, $cm)) {
throw new moodle_exception('notingroup');
}
self::check_can_view_user_data($params['userid'], $course, $cm, $context);
}
$result = array();
@ -570,4 +584,166 @@ class mod_lesson_external extends external_api {
)
);
}
/**
* Describes the parameters for get_user_grade.
*
* @return external_external_function_parameters
* @since Moodle 3.3
*/
public static function get_user_grade_parameters() {
return new external_function_parameters (
array(
'lessonid' => new external_value(PARAM_INT, 'lesson instance id'),
'userid' => new external_value(PARAM_INT, 'the user id (empty for current user)', VALUE_DEFAULT, null),
)
);
}
/**
* Return the final grade in the lesson for the given user.
*
* @param int $lessonid lesson instance id
* @param int $userid only fetch grades of this user
* @return array of warnings and page attempts
* @since Moodle 3.3
* @throws moodle_exception
*/
public static function get_user_grade($lessonid, $userid = null) {
global $CFG, $USER;
require_once($CFG->libdir . '/gradelib.php');
$params = array(
'lessonid' => $lessonid,
'userid' => $userid,
);
$params = self::validate_parameters(self::get_user_grade_parameters(), $params);
$warnings = array();
list($lesson, $course, $cm, $context) = self::validate_lesson($params['lessonid']);
// Default value for userid.
if (empty($params['userid'])) {
$params['userid'] = $USER->id;
}
// Extra checks so only users with permissions can view other users attempts.
if ($USER->id != $params['userid']) {
self::check_can_view_user_data($params['userid'], $course, $cm, $context);
}
$grade = null;
$formattedgrade = null;
$grades = lesson_get_user_grades($lesson, $params['userid']);
if (!empty($grades)) {
$grade = $grades[$params['userid']]->rawgrade;
$params = array(
'itemtype' => 'mod',
'itemmodule' => 'lesson',
'iteminstance' => $lesson->id,
'courseid' => $course->id,
'itemnumber' => 0
);
$gradeitem = grade_item::fetch($params);
$formattedgrade = grade_format_gradevalue($grade, $gradeitem);
}
$result = array();
$result['grade'] = $grade;
$result['formattedgrade'] = $formattedgrade;
$result['warnings'] = $warnings;
return $result;
}
/**
* Describes the get_user_grade return value.
*
* @return external_single_structure
* @since Moodle 3.3
*/
public static function get_user_grade_returns() {
return new external_single_structure(
array(
'grade' => new external_value(PARAM_FLOAT, 'The lesson final raw grade'),
'formattedgrade' => new external_value(PARAM_RAW, 'The lesson final grade formatted'),
'warnings' => new external_warnings(),
)
);
}
/**
* Describes the parameters for get_user_attempt_grade.
*
* @return external_external_function_parameters
* @since Moodle 3.3
*/
public static function get_user_attempt_grade_parameters() {
return new external_function_parameters (
array(
'lessonid' => new external_value(PARAM_INT, 'lesson instance id'),
'lessonattempt' => new external_value(PARAM_INT, 'lesson attempt number'),
'userid' => new external_value(PARAM_INT, 'the user id (empty for current user)', VALUE_DEFAULT, null),
)
);
}
/**
* Return grade information in the attempt for a given user.
*
* @param int $lessonid lesson instance id
* @param int $lessonattempt lesson attempt number
* @param int $userid only fetch attempts of the given user
* @return array of warnings and page attempts
* @since Moodle 3.3
* @throws moodle_exception
*/
public static function get_user_attempt_grade($lessonid, $lessonattempt, $userid = null) {
global $CFG, $USER;
require_once($CFG->libdir . '/gradelib.php');
$params = array(
'lessonid' => $lessonid,
'lessonattempt' => $lessonattempt,
'userid' => $userid,
);
$params = self::validate_parameters(self::get_user_attempt_grade_parameters(), $params);
$warnings = array();
list($lesson, $course, $cm, $context) = self::validate_lesson($params['lessonid']);
// Default value for userid.
if (empty($params['userid'])) {
$params['userid'] = $USER->id;
}
// Extra checks so only users with permissions can view other users attempts.
if ($USER->id != $params['userid']) {
self::check_can_view_user_data($params['userid'], $course, $cm, $context);
}
$result = (array) lesson_grade($lesson, $params['lessonattempt'], $params['userid']);
$result['warnings'] = $warnings;
return $result;
}
/**
* Describes the get_user_attempt_grade return value.
*
* @return external_single_structure
* @since Moodle 3.3
*/
public static function get_user_attempt_grade_returns() {
return new external_single_structure(
array(
'nquestions' => new external_value(PARAM_INT, 'Number of questions answered'),
'attempts' => new external_value(PARAM_INT, 'Number of question attempts'),
'total' => new external_value(PARAM_FLOAT, 'Max points possible'),
'earned' => new external_value(PARAM_FLOAT, 'Points earned by student'),
'grade' => new external_value(PARAM_FLOAT, 'Calculated percentage grade'),
'nmanual' => new external_value(PARAM_INT, 'Number of manually graded questions'),
'manualpoints' => new external_value(PARAM_FLOAT, 'Point value for manually graded questions'),
'warnings' => new external_warnings(),
)
);
}
}

16
mod/lesson/db/services.php
View File

@ -60,4 +60,20 @@ $functions = array(
'capabilities' => 'mod/lesson:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_lesson_get_user_grade' => array(
'classname' => 'mod_lesson_external',
'methodname' => 'get_user_grade',
'description' => 'Return the final grade in the lesson for the given user.',
'type' => 'read',
'capabilities' => 'mod/lesson:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_lesson_get_user_attempt_grade' => array(
'classname' => 'mod_lesson_external',
'methodname' => 'get_user_attempt_grade',
'description' => 'Return grade information in the attempt for a given user.',
'type' => 'read',
'capabilities' => 'mod/lesson:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
);

2
mod/lesson/lib.php
View File

@ -718,7 +718,7 @@ function lesson_cron () {
* @global object
* @param int $lessonid id of lesson
* @param int $userid optional user id, 0 means all users
* @return array array of grades, false if none
* @return array array of grades
*/
function lesson_get_user_grades($lesson, $userid=0) {
global $CFG, $DB;

115
mod/lesson/tests/external_test.php
View File

@ -464,4 +464,119 @@ class mod_lesson_external_testcase extends externallib_advanced_testcase {
$this->expectException('moodle_exception');
$result = mod_lesson_external::get_questions_attempts($this->lesson->id, $attemptnumber, false, null, $this->teacher->id);
}
/**
* Test get user grade.
*/
public function test_get_user_grade() {
global $DB;
// Add grades for the user.
$newgrade = [
'lessonid' => $this->lesson->id,
'userid' => $this->student->id,
'grade' => 50,
'late' => 0,
'completed' => time(),
];
$DB->insert_record('lesson_grades', (object) $newgrade);
$newgrade = [
'lessonid' => $this->lesson->id,
'userid' => $this->student->id,
'grade' => 100,
'late' => 0,
'completed' => time(),
];
$DB->insert_record('lesson_grades', (object) $newgrade);
$this->setUser($this->student);
// Test lesson without multiple attemps. The first result must be returned.
$result = mod_lesson_external::get_user_grade($this->lesson->id);
$result = external_api::clean_returnvalue(mod_lesson_external::get_user_grade_returns(), $result);
$this->assertCount(0, $result['warnings']);
$this->assertEquals(50, $result['grade']);
$this->assertEquals('50.00', $result['formattedgrade']);
// With retakes. By default average.
$DB->set_field('lesson', 'retake', 1, array('id' => $this->lesson->id));
$result = mod_lesson_external::get_user_grade($this->lesson->id, $this->student->id);
$result = external_api::clean_returnvalue(mod_lesson_external::get_user_grade_returns(), $result);
$this->assertCount(0, $result['warnings']);
$this->assertEquals(75, $result['grade']);
$this->assertEquals('75.00', $result['formattedgrade']);
// With retakes. With max grade setting.
$DB->set_field('lesson', 'usemaxgrade', 1, array('id' => $this->lesson->id));
$result = mod_lesson_external::get_user_grade($this->lesson->id, $this->student->id);
$result = external_api::clean_returnvalue(mod_lesson_external::get_user_grade_returns(), $result);
$this->assertCount(0, $result['warnings']);
$this->assertEquals(100, $result['grade']);
$this->assertEquals('100.00', $result['formattedgrade']);
// Test as teacher we get the same result.
$this->setUser($this->teacher);
$result = mod_lesson_external::get_user_grade($this->lesson->id, $this->student->id);
$result = external_api::clean_returnvalue(mod_lesson_external::get_user_grade_returns(), $result);
$this->assertCount(0, $result['warnings']);
$this->assertEquals(100, $result['grade']);
$this->assertEquals('100.00', $result['formattedgrade']);
// Test exception. As student try to retrieve grades from teacher.
$this->setUser($this->student);
$this->expectException('moodle_exception');
$result = mod_lesson_external::get_user_grade($this->lesson->id, $this->teacher->id);
}
/**
* Test get_user_attempt_grade
*/
public function test_get_user_attempt_grade() {
global $DB;
// Create a fake attempt for the first possible answer.
$attemptnumber = 1;
$p2answers = $DB->get_records('lesson_answers', array('lessonid' => $this->lesson->id, 'pageid' => $this->page2->id), 'id');
$answerid = reset($p2answers)->id;
$newpageattempt = [
'lessonid' => $this->lesson->id,
'pageid' => $this->page2->id,
'userid' => $this->student->id,
'answerid' => $answerid,
'retry' => $attemptnumber,
'correct' => 1,
'useranswer' => '1',
'timeseen' => time(),
];
$DB->insert_record('lesson_attempts', (object) $newpageattempt);
// Test first without custom scoring. All questions receive the same value if correctly responsed.
$DB->set_field('lesson', 'custom', 0, array('id' => $this->lesson->id));
$this->setUser($this->student);
$result = mod_lesson_external::get_user_attempt_grade($this->lesson->id, $attemptnumber, $this->student->id);
$result = external_api::clean_returnvalue(mod_lesson_external::get_user_attempt_grade_returns(), $result);
$this->assertCount(0, $result['warnings']);
$this->assertEquals(1, $result['nquestions']);
$this->assertEquals(1, $result['attempts']);
$this->assertEquals(1, $result['total']);
$this->assertEquals(1, $result['earned']);
$this->assertEquals(100, $result['grade']);
$this->assertEquals(0, $result['nmanual']);
$this->assertEquals(0, $result['manualpoints']);
// With custom scoring, in this case, we don't retrieve any values since we are using questions without particular score.
$DB->set_field('lesson', 'custom', 1, array('id' => $this->lesson->id));
$result = mod_lesson_external::get_user_attempt_grade($this->lesson->id, $attemptnumber, $this->student->id);
$result = external_api::clean_returnvalue(mod_lesson_external::get_user_attempt_grade_returns(), $result);
$this->assertCount(0, $result['warnings']);
$this->assertEquals(1, $result['nquestions']);
$this->assertEquals(1, $result['attempts']);
$this->assertEquals(0, $result['total']);
$this->assertEquals(0, $result['earned']);
$this->assertEquals(0, $result['grade']);
$this->assertEquals(0, $result['nmanual']);
$this->assertEquals(0, $result['manualpoints']);
}
}

2
mod/lesson/version.php
View File

@ -24,7 +24,7 @@
defined('MOODLE_INTERNAL') || die();
$plugin->version = 2016120504; // The current module version (Date: YYYYMMDDXX)
$plugin->version = 2016120505; // The current module version (Date: YYYYMMDDXX)
$plugin->requires = 2016112900; // Requires this Moodle version
$plugin->component = 'mod_lesson'; // Full name of the plugin (used for diagnostics)
$plugin->cron = 0;